cn.watsontech.webhelper.openapi.params.base

Class OpenApiParamsVo

java.lang.Object

cn.watsontech.webhelper.openapi.params.base.OpenApiParamsVo

All Implemented Interfaces:

PublicApiParams

Direct Known Subclasses:

OpenApiListParamsVo

public class OpenApiParamsVo
extends Object
implements PublicApiParams

注意：不能使用此vo直接做请求参数，缺少具体参数 Created by Watson on 2020/02/09.

Constructor Summary

Constructors

Constructor and Description
OpenApiParamsVo()

Method Summary

Modifier and Type	Method and Description
String	getAppid() 服务器分配的appid
String	getNeedSignParamString(Collection<OpenApiParams> extraApiParams)
String	getNonce() 唯一随机字符串nonce=random 服务器保存每个请求nonce直到timestamp过期 防请求重放
protected List<Field>	getNotNullFields(Class thisClaz, Object object)
String	getRequestId() 请求id
String	getSign() 1、按照请求参数名的字母升序排列非空请求参数（包含&appid=appid) 2、拼接密钥appSecret：&appSecret=secret 3、拼接url：&url=请求路径（除域名和url参数外部分，比如：http://www.xxx.com/api/v1/sms/list?paramA=1¶mB=2 的url为 /api/v1/sms/list） 3、MD5并转换为大写
Long	getTimestamp() 请求时间戳 值必须在服务器允许时间范围内，比如：60s
void	setAppid(String appid)
void	setNonce(String nonce)
void	setRequestId(String requestId)
void	setSign(String sign)
void	setTimestamp(Long timestamp)
String	toGetUrl() 根据内容生成openapi签名链接
String	toUrl() 根据内容生成openapi签名链接

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OpenApiParamsVo

public OpenApiParamsVo()

Method Detail

getNeedSignParamString

public String getNeedSignParamString(Collection<OpenApiParams> extraApiParams)

Specified by:

getNeedSignParamString in interface PublicApiParams

Parameters:

extraApiParams - 需要参与签名的额外参数对象 返回按参数名字母升序排列的非空请求参数拼接字符串

getNotNullFields

protected List<Field> getNotNullFields(Class thisClaz,
                                       Object object)
                                throws IllegalAccessException

Throws:

IllegalAccessException

getAppid

public String getAppid()

Description copied from interface: PublicApiParams

服务器分配的appid

Specified by:

getAppid in interface PublicApiParams

setAppid

public void setAppid(String appid)

getTimestamp

public Long getTimestamp()

Description copied from interface: PublicApiParams

请求时间戳 值必须在服务器允许时间范围内，比如：60s

Specified by:

getTimestamp in interface PublicApiParams

setTimestamp

public void setTimestamp(Long timestamp)

getSign

public String getSign()

Description copied from interface: PublicApiParams

1、按照请求参数名的字母升序排列非空请求参数（包含&appid=appid) 2、拼接密钥appSecret：&appSecret=secret 3、拼接url：&url=请求路径（除域名和url参数外部分，比如：http://www.xxx.com/api/v1/sms/list?paramA=1¶mB=2 的url为 /api/v1/sms/list） 3、MD5并转换为大写

Specified by:

getSign in interface PublicApiParams

setSign

public void setSign(String sign)

getNonce

public String getNonce()

Description copied from interface: PublicApiParams

唯一随机字符串nonce=random 服务器保存每个请求nonce直到timestamp过期 防请求重放

Specified by:

getNonce in interface PublicApiParams

setNonce

public void setNonce(String nonce)

getRequestId

public String getRequestId()

Description copied from interface: PublicApiParams

请求id

Specified by:

getRequestId in interface PublicApiParams

setRequestId

public void setRequestId(String requestId)

Specified by:

setRequestId in interface PublicApiParams

toUrl

public String toUrl()

根据内容生成openapi签名链接

toGetUrl

public String toGetUrl()

根据内容生成openapi签名链接