me.chanjar.weixin.open.api

接口 WxOpenConfigStorage

所有已知实现类:

AbstractWxOpenInRedisConfigStorage, WxOpenInMemoryConfigStorage, WxOpenInRedisConfigStorage, WxOpenInRedissonConfigStorage, WxOpenInRedisTemplateConfigStorage

public interface WxOpenConfigStorage

The interface Wx open config storage.

作者:

007

方法概要

限定符和类型	方法和说明
boolean	autoRefreshToken() 是否自动刷新token
void	expireAuthorizerAccessToken(String appId) 强制将access token过期掉
void	expireCardApiTicket(String appId) 强制将卡券api ticket过期掉
void	expireComponentAccessToken() Expire component access token.
void	expireJsapiTicket(String appId) 强制将jsapi ticket过期掉
ApacheHttpClientBuilder	getApacheHttpClientBuilder() Gets apache http client builder.
String	getAuthorizerAccessToken(String appId) Gets authorizer access token.
String	getAuthorizerRefreshToken(String appId) Gets authorizer refresh token.
String	getCardApiTicket(String appId) Gets card api ticket.
String	getComponentAccessToken() Gets component access token.
Lock	getComponentAccessTokenLock() Gets component access token lock.
String	getComponentAesKey() Gets component aes key.
String	getComponentApiSignatureAesKey() 第三方平台设置API签名 AES KEY
String	getComponentApiSignatureAesKeySn() 第三方平台设置API签名 AES key 序号
String	getComponentApiSignatureRsaPrivateKey() 第三方平台设置API签名 RSA 私钥
String	getComponentApiSignatureRsaPrivateKeySn() 第三方平台设置API签名 RSA 私钥 序号
String	getComponentAppId() Gets component app id.
String	getComponentAppSecret() Gets component app secret.
String	getComponentToken() Gets component token.
String	getComponentVerifyTicket() Gets component verify ticket.
String	getHttpProxyHost() Gets http proxy host.
String	getHttpProxyPassword() Gets http proxy password.
int	getHttpProxyPort() Gets http proxy port.
String	getHttpProxyUsername() Gets http proxy username.
String	getJsapiTicket(String appId) Gets jsapi ticket.
Lock	getLockByKey(String key) Gets lock by key.
int	getMaxRetryTimes() http 请求最大重试次数 BaseWxMpServiceImpl.setMaxRetryTimes(int) BaseWxMaServiceImpl.setMaxRetryTimes(int)
int	getRetrySleepMillis() http 请求重试间隔 BaseWxMpServiceImpl.setRetrySleepMillis(int) BaseWxMaServiceImpl.setRetrySleepMillis(int)
WxMaConfig	getWxMaConfig(String appId) Gets wx ma config.
WxMpConfigStorage	getWxMpConfigStorage(String appId) Gets wx mp config storage.
boolean	isAuthorizerAccessTokenExpired(String appId) Is authorizer access token expired boolean.
boolean	isCardApiTicketExpired(String appId) Is card api ticket expired boolean.
boolean	isComponentAccessTokenExpired() Is component access token expired boolean.
boolean	isJsapiTicketExpired(String appId) Is jsapi ticket expired boolean.
void	setAuthorizerRefreshToken(String appId, String authorizerRefreshToken) Sets authorizer refresh token.
void	setComponentAesKey(String componentAesKey) Sets component aes key.
void	setComponentApiSignatureAesKey(String apiSignatureAesKey)
void	setComponentApiSignatureAesKeySn(String apiSignatureAesKeySn)
void	setComponentApiSignatureRsaPrivateKey(String apiSignatureRsaPrivateKey)
void	setComponentApiSignatureRsaPrivateKeySn(String apiSignatureRsaPrivateKeySn)
void	setComponentAppId(String componentAppId) Sets component app id.
void	setComponentAppSecret(String componentAppSecret) Sets component app secret.
void	setComponentToken(String componentToken) Sets component token.
void	setComponentVerifyTicket(String componentVerifyTicket) Sets component verify ticket.
void	setWxOpenInfo(String componentAppId, String componentAppSecret, String componentToken, String componentAesKey) 设置第三方平台基础信息
void	updateAuthorizerAccessToken(String appId, String authorizerAccessToken, int expiresInSeconds) 应该是线程安全的
void	updateAuthorizerAccessToken(String appId, WxOpenAuthorizerAccessToken authorizerAccessToken) 应该是线程安全的
void	updateAuthorizerRefreshToken(String appId, String authorizerRefreshToken) setAuthorizerRefreshToken(String appId, String authorizerRefreshToken) 方法重载方法
void	updateCardApiTicket(String appId, String cardApiTicket, int expiresInSeconds) 应该是线程安全的
void	updateComponentAccessToken(String componentAccessToken, int expiresInSeconds) 应该是线程安全的
void	updateComponentAccessToken(WxOpenComponentAccessToken componentAccessToken) Update component access token.
void	updateJsapiTicket(String appId, String jsapiTicket, int expiresInSeconds) 应该是线程安全的

方法详细资料

getComponentAppId

String getComponentAppId()

Gets component app id.

返回:

the component app id

setComponentAppId

void setComponentAppId(String componentAppId)

Sets component app id.

参数:

componentAppId - the component app id

getComponentAppSecret

String getComponentAppSecret()

Gets component app secret.

返回:

the component app secret

setComponentAppSecret

void setComponentAppSecret(String componentAppSecret)

Sets component app secret.

参数:

componentAppSecret - the component app secret

getComponentToken

String getComponentToken()

Gets component token.

返回:

the component token

setComponentToken

void setComponentToken(String componentToken)

Sets component token.

参数:

componentToken - the component token

getComponentAesKey

String getComponentAesKey()

Gets component aes key.

返回:

the component aes key

setComponentAesKey

void setComponentAesKey(String componentAesKey)

Sets component aes key.

参数:

componentAesKey - the component aes key

getComponentVerifyTicket

String getComponentVerifyTicket()

Gets component verify ticket.

返回:

the component verify ticket

setComponentVerifyTicket

void setComponentVerifyTicket(String componentVerifyTicket)

Sets component verify ticket.

参数:

componentVerifyTicket - the component verify ticket

getComponentAccessToken

String getComponentAccessToken()

Gets component access token.

返回:

the component access token

isComponentAccessTokenExpired

boolean isComponentAccessTokenExpired()

Is component access token expired boolean.

返回:

the boolean

expireComponentAccessToken

void expireComponentAccessToken()

Expire component access token.

updateComponentAccessToken

void updateComponentAccessToken(WxOpenComponentAccessToken componentAccessToken)

Update component access token.

参数:

componentAccessToken - the component access token

getHttpProxyHost

String getHttpProxyHost()

Gets http proxy host.

返回:

the http proxy host

getHttpProxyPort

int getHttpProxyPort()

Gets http proxy port.

返回:

the http proxy port

getHttpProxyUsername

String getHttpProxyUsername()

Gets http proxy username.

返回:

the http proxy username

getHttpProxyPassword

String getHttpProxyPassword()

Gets http proxy password.

返回:

the http proxy password

getRetrySleepMillis

int getRetrySleepMillis()

http 请求重试间隔

   BaseWxMpServiceImpl.setRetrySleepMillis(int)
   BaseWxMaServiceImpl.setRetrySleepMillis(int)
 

getMaxRetryTimes

int getMaxRetryTimes()

http 请求最大重试次数

   BaseWxMpServiceImpl.setMaxRetryTimes(int)
   BaseWxMaServiceImpl.setMaxRetryTimes(int)
 

getApacheHttpClientBuilder

ApacheHttpClientBuilder getApacheHttpClientBuilder()

Gets apache http client builder.

返回:

the apache http client builder

getWxMpConfigStorage

WxMpConfigStorage getWxMpConfigStorage(String appId)

Gets wx mp config storage.

参数:

appId - the app id

返回:

the wx mp config storage

getWxMaConfig

WxMaConfig getWxMaConfig(String appId)

Gets wx ma config.

参数:

appId - the app id

返回:

the wx ma config

getComponentAccessTokenLock

Lock getComponentAccessTokenLock()

Gets component access token lock.

返回:

the component access token lock

getLockByKey

Lock getLockByKey(String key)

Gets lock by key.

参数:

key - the key

返回:

the lock by key

updateComponentAccessToken

void updateComponentAccessToken(String componentAccessToken,
                                int expiresInSeconds)

应该是线程安全的

参数:

componentAccessToken - 新的accessToken值

expiresInSeconds - 过期时间，以秒为单位

autoRefreshToken

boolean autoRefreshToken()

是否自动刷新token

返回:

the boolean

getAuthorizerRefreshToken

String getAuthorizerRefreshToken(String appId)

Gets authorizer refresh token.

参数:

appId - the app id

返回:

the authorizer refresh token

setAuthorizerRefreshToken

void setAuthorizerRefreshToken(String appId,
                               String authorizerRefreshToken)

Sets authorizer refresh token.

参数:

appId - the app id

authorizerRefreshToken - the authorizer refresh token

updateAuthorizerRefreshToken

void updateAuthorizerRefreshToken(String appId,
                                  String authorizerRefreshToken)

setAuthorizerRefreshToken(String appId, String authorizerRefreshToken) 方法重载方法

参数:

appId - the app id

authorizerRefreshToken - the authorizer refresh token

getAuthorizerAccessToken

String getAuthorizerAccessToken(String appId)

Gets authorizer access token.

参数:

appId - the app id

返回:

the authorizer access token

isAuthorizerAccessTokenExpired

boolean isAuthorizerAccessTokenExpired(String appId)

Is authorizer access token expired boolean.

参数:

appId - the app id

返回:

the boolean

expireAuthorizerAccessToken

void expireAuthorizerAccessToken(String appId)

强制将access token过期掉

参数:

appId - the app id

updateAuthorizerAccessToken

void updateAuthorizerAccessToken(String appId,
                                 WxOpenAuthorizerAccessToken authorizerAccessToken)

应该是线程安全的

参数:

appId - the app id

authorizerAccessToken - 要更新的WxAccessToken对象

updateAuthorizerAccessToken

void updateAuthorizerAccessToken(String appId,
                                 String authorizerAccessToken,
                                 int expiresInSeconds)

应该是线程安全的

参数:

appId - the app id

authorizerAccessToken - 新的accessToken值

expiresInSeconds - 过期时间，以秒为单位

getJsapiTicket

String getJsapiTicket(String appId)

Gets jsapi ticket.

参数:

appId - the app id

返回:

the jsapi ticket

isJsapiTicketExpired

boolean isJsapiTicketExpired(String appId)

Is jsapi ticket expired boolean.

参数:

appId - the app id

返回:

the boolean

expireJsapiTicket

void expireJsapiTicket(String appId)

强制将jsapi ticket过期掉

参数:

appId - the app id

updateJsapiTicket

void updateJsapiTicket(String appId,
                       String jsapiTicket,
                       int expiresInSeconds)

应该是线程安全的

参数:

appId - the app id

jsapiTicket - 新的jsapi ticket值

expiresInSeconds - 过期时间，以秒为单位

getCardApiTicket

String getCardApiTicket(String appId)

Gets card api ticket.

参数:

appId - the app id

返回:

the card api ticket

isCardApiTicketExpired

boolean isCardApiTicketExpired(String appId)

Is card api ticket expired boolean.

参数:

appId - the app id

返回:

the boolean

expireCardApiTicket

void expireCardApiTicket(String appId)

强制将卡券api ticket过期掉

参数:

appId - the app id

updateCardApiTicket

void updateCardApiTicket(String appId,
                         String cardApiTicket,
                         int expiresInSeconds)

应该是线程安全的

参数:

appId - the app id

cardApiTicket - 新的cardApi ticket值

expiresInSeconds - 过期时间，以秒为单位

setWxOpenInfo

void setWxOpenInfo(String componentAppId,
                   String componentAppSecret,
                   String componentToken,
                   String componentAesKey)

设置第三方平台基础信息

参数:

componentAppId - 第三方平台 appid

componentAppSecret - 第三方平台 appsecret

componentToken - 消息校验Token

componentAesKey - 消息加解密Key

getComponentApiSignatureRsaPrivateKey

String getComponentApiSignatureRsaPrivateKey()

第三方平台设置API签名 RSA 私钥

setComponentApiSignatureRsaPrivateKey

void setComponentApiSignatureRsaPrivateKey(String apiSignatureRsaPrivateKey)

getComponentApiSignatureAesKey

String getComponentApiSignatureAesKey()

第三方平台设置API签名 AES KEY

setComponentApiSignatureAesKey

void setComponentApiSignatureAesKey(String apiSignatureAesKey)

getComponentApiSignatureRsaPrivateKeySn

String getComponentApiSignatureRsaPrivateKeySn()

第三方平台设置API签名 RSA 私钥 序号

setComponentApiSignatureRsaPrivateKeySn

void setComponentApiSignatureRsaPrivateKeySn(String apiSignatureRsaPrivateKeySn)

getComponentApiSignatureAesKeySn

String getComponentApiSignatureAesKeySn()

第三方平台设置API签名 AES key 序号

setComponentApiSignatureAesKeySn

void setComponentApiSignatureAesKeySn(String apiSignatureAesKeySn)