SignatureValidateRequest (alibaba-dingtalk-service-sdk 2.0.0 API)

java.lang.Object
- com.taobao.api.internal.sign.SignatureValidateRequest

All Implemented Interfaces:

TaobaoRequest<SignatureValidateResponse>, TaobaoUploadRequest<SignatureValidateResponse>
```
public class SignatureValidateRequest
extends Object
implements TaobaoUploadRequest<SignatureValidateResponse>
```
TOP API: taobao.signature.validate request

Since:

1.0, 2015.09.10

Author:

auto create

Constructor Summary

Constructors
Constructor and Description

SignatureValidateRequest()

Constructors
Constructor and Description
`SignatureValidateRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`check()` 客户端参数检查，减少服务端无效调用。
`String`	`getAlgorithm()`
`String`	`getApiMethodName()` 获取TOP的API名称。
`int`	`getBatchApiOrder()` 获取API在批量调用中的顺序，仅用于批量API调用请求。
`String`	`getBatchApiSession()` 获取API请求的用户授权码，仅用于批量API调用请求。
`FileItem`	`getBody()`
`String`	`getCharset()`
`Map<String,FileItem>`	`getFileParams()` 获取所有的Key-Value形式的文件请求参数集合。其中： Key: 请求参数名 Value: 请求参数文件元数据
`Map<String,String>`	`getHeaderMap()` 获取自定义HTTP请求头参数。
`String`	`getProxyAppKey()`
`Class<SignatureValidateResponse>`	`getResponseClass()` 获取具体响应实现类的定义。
`String`	`getSignature()`
`String`	`getTargetAppKey()` 获取被调用的目标AppKey
`Map<String,String>`	`getTextParams()` 获取所有的Key-Value形式的文本请求参数集合。其中： Key: 请求参数名 Value: 请求参数值
`Long`	`getTimestamp()` 获取请求时间戳（为空则用系统当前时间）
`String`	`getTopApiCallType()` 获取API调用方式
`String`	`getTopApiFormat()`
`String`	`getTopApiVersion()` API版本号，将作为最终API请求的v请求参数
`String`	`getTopContentType()` API对应的请求方式，包含xml,json,form
`String`	`getTopHttpMethod()` 获取Http method，例如GET,POST
`String`	`getTopResponseType()` API对应的响应格式，包含top(top标准),qimen(奇门1.0标准),qimen2(奇门2.0标准)
`void`	`putOtherTextParam(String key, String value)`
`void`	`setAlgorithm(String algorithm)`
`void`	`setBatchApiOrder(int order)` 设置API在批量调用中的顺序，仅用于批量API调用请求。
`void`	`setBatchApiSession(String session)` 设置API请求的用户授权码，仅用于批量API调用请求。
`void`	`setBody(FileItem body)`
`void`	`setCharset(String charset)`
`void`	`setProxyAppKey(String proxyAppKey)`
`void`	`setSignature(String signature)`
`void`	`setTimestamp(Long timestamp)`
`void`	`setTopApiCallType(String topApiCallType)`
`void`	`setTopApiFormat(String topApiFormat)`
`void`	`setTopApiVersion(String topApiVersion)`
`void`	`setTopContentType(String topContentType)`
`void`	`setTopHttpMethod(String topHttpMethod)`
`void`	`setTopResponseType(String topResponseType)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SignatureValidateRequest
```
public SignatureValidateRequest()
```
- Method Detail
  - setAlgorithm
```
public void setAlgorithm(String algorithm)
```
  - getAlgorithm
```
public String getAlgorithm()
```
  - setBody
```
public void setBody(FileItem body)
```
  - getBody
```
public FileItem getBody()
```
  - setCharset
```
public void setCharset(String charset)
```
  - getCharset
```
public String getCharset()
```
  - setProxyAppKey
```
public void setProxyAppKey(String proxyAppKey)
```
  - getProxyAppKey
```
public String getProxyAppKey()
```
  - setSignature
```
public void setSignature(String signature)
```
  - getSignature
```
public String getSignature()
```
  - getTimestamp
```
public Long getTimestamp()
```
    Description copied from interface: TaobaoRequest
    
    获取请求时间戳（为空则用系统当前时间）
    
    Specified by:
    
    getTimestamp in interface TaobaoRequest<SignatureValidateResponse>
  - setTimestamp
```
public void setTimestamp(Long timestamp)
```
  - getApiMethodName
```
public String getApiMethodName()
```
    Description copied from interface: TaobaoRequest
    
    获取TOP的API名称。
    
    Specified by:
    
    getApiMethodName in interface TaobaoRequest<SignatureValidateResponse>
    
    Returns:
    
    API名称
  - getTopContentType
```
public String getTopContentType()
```
    Description copied from interface: TaobaoRequest
    
    API对应的请求方式，包含xml,json,form
    
    Specified by:
    
    getTopContentType in interface TaobaoRequest<SignatureValidateResponse>
    
    Returns:
  - setTopContentType
```
public void setTopContentType(String topContentType)
```
    Specified by:
    
    setTopContentType in interface TaobaoRequest<SignatureValidateResponse>
  - getTopResponseType
```
public String getTopResponseType()
```
    Description copied from interface: TaobaoRequest
    
    API对应的响应格式，包含top(top标准),qimen(奇门1.0标准),qimen2(奇门2.0标准)
    
    Specified by:
    
    getTopResponseType in interface TaobaoRequest<SignatureValidateResponse>
    
    Returns:
  - setTopResponseType
```
public void setTopResponseType(String topResponseType)
```
    Specified by:
    
    setTopResponseType in interface TaobaoRequest<SignatureValidateResponse>
  - getTopApiVersion
```
public String getTopApiVersion()
```
    Description copied from interface: TaobaoRequest
    
    API版本号，将作为最终API请求的v请求参数
    
    Specified by:
    
    getTopApiVersion in interface TaobaoRequest<SignatureValidateResponse>
    
    Returns:
  - setTopApiVersion
```
public void setTopApiVersion(String topApiVersion)
```
    Specified by:
    
    setTopApiVersion in interface TaobaoRequest<SignatureValidateResponse>
  - getTopApiFormat
```
public String getTopApiFormat()
```
    Specified by:
    
    getTopApiFormat in interface TaobaoRequest<SignatureValidateResponse>
  - setTopApiFormat
```
public void setTopApiFormat(String topApiFormat)
```
    Specified by:
    
    setTopApiFormat in interface TaobaoRequest<SignatureValidateResponse>
  - getTopApiCallType
```
public String getTopApiCallType()
```
    Description copied from interface: TaobaoRequest
    
    获取API调用方式
    
    Specified by:
    
    getTopApiCallType in interface TaobaoRequest<SignatureValidateResponse>
    
    Returns:
  - setTopApiCallType
```
public void setTopApiCallType(String topApiCallType)
```
    Specified by:
    
    setTopApiCallType in interface TaobaoRequest<SignatureValidateResponse>
  - getTopHttpMethod
```
public String getTopHttpMethod()
```
    Description copied from interface: TaobaoRequest
    
    获取Http method，例如GET,POST
    
    Specified by:
    
    getTopHttpMethod in interface TaobaoRequest<SignatureValidateResponse>
    
    Returns:
  - setTopHttpMethod
```
public void setTopHttpMethod(String topHttpMethod)
```
    Specified by:
    
    setTopHttpMethod in interface TaobaoRequest<SignatureValidateResponse>
  - getTextParams
```
public Map<String,String> getTextParams()
```
    Description copied from interface: TaobaoRequest
    获取所有的Key-Value形式的文本请求参数集合。其中：
    - Key: 请求参数名
    - Value: 请求参数值
    Specified by:
    
    getTextParams in interface TaobaoRequest<SignatureValidateResponse>
    
    Returns:
    
    文本请求参数集合
  - putOtherTextParam
```
public void putOtherTextParam(String key,
                              String value)
```
  - getFileParams
```
public Map<String,FileItem> getFileParams()
```
    Description copied from interface: TaobaoUploadRequest
    获取所有的Key-Value形式的文件请求参数集合。其中：
    - Key: 请求参数名
    - Value: 请求参数文件元数据
    Specified by:
    
    getFileParams in interface TaobaoUploadRequest<SignatureValidateResponse>
    
    Returns:
    
    文件请求参数集合
  - getResponseClass
```
public Class<SignatureValidateResponse> getResponseClass()
```
    Description copied from interface: TaobaoRequest
    
    获取具体响应实现类的定义。
    
    Specified by:
    
    getResponseClass in interface TaobaoRequest<SignatureValidateResponse>
  - check
```
public void check()
           throws ApiRuleException
```
    Description copied from interface: TaobaoRequest
    
    客户端参数检查，减少服务端无效调用。
    
    Specified by:
    
    check in interface TaobaoRequest<SignatureValidateResponse>
    
    Throws:
    
    ApiRuleException
  - getHeaderMap
```
public Map<String,String> getHeaderMap()
```
    Description copied from interface: TaobaoRequest
    
    获取自定义HTTP请求头参数。
    
    Specified by:
    
    getHeaderMap in interface TaobaoRequest<SignatureValidateResponse>
  - getTargetAppKey
```
public String getTargetAppKey()
```
    Description copied from interface: TaobaoRequest
    
    获取被调用的目标AppKey
    
    Specified by:
    
    getTargetAppKey in interface TaobaoRequest<SignatureValidateResponse>
  - getBatchApiSession
```
public String getBatchApiSession()
```
    Description copied from interface: TaobaoRequest
    
    获取API请求的用户授权码，仅用于批量API调用请求。
    
    Specified by:
    
    getBatchApiSession in interface TaobaoRequest<SignatureValidateResponse>
    
    Returns:
    
    用户授权码
  - setBatchApiSession
```
public void setBatchApiSession(String session)
```
    Description copied from interface: TaobaoRequest
    
    设置API请求的用户授权码，仅用于批量API调用请求。
    
    Specified by:
    
    setBatchApiSession in interface TaobaoRequest<SignatureValidateResponse>
    
    Parameters:
    
    session - 用户授权码
  - getBatchApiOrder
```
public int getBatchApiOrder()
```
    Description copied from interface: TaobaoRequest
    
    获取API在批量调用中的顺序，仅用于批量API调用请求。
    
    Specified by:
    
    getBatchApiOrder in interface TaobaoRequest<SignatureValidateResponse>
    
    Returns:
    
    顺序值
  - setBatchApiOrder
```
public void setBatchApiOrder(int order)
```
    Description copied from interface: TaobaoRequest
    
    设置API在批量调用中的顺序，仅用于批量API调用请求。
    
    Specified by:
    
    setBatchApiOrder in interface TaobaoRequest<SignatureValidateResponse>
    
    Parameters:
    
    order - 顺序值

Class SignatureValidateRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SignatureValidateRequest

Method Detail

setAlgorithm

getAlgorithm

setBody

getBody

setCharset

getCharset

setProxyAppKey

getProxyAppKey

setSignature

getSignature

getTimestamp

setTimestamp

getApiMethodName

getTopContentType

setTopContentType

getTopResponseType

setTopResponseType

getTopApiVersion

setTopApiVersion

getTopApiFormat

setTopApiFormat

getTopApiCallType

setTopApiCallType

getTopHttpMethod

setTopHttpMethod

getTextParams

putOtherTextParam

getFileParams

getResponseClass

check

getHeaderMap

getTargetAppKey

getBatchApiSession

setBatchApiSession

getBatchApiOrder

setBatchApiOrder