com.kdayun.wecom.cp.config

接口 WxCpTpConfigStorage

所有已知实现类:

WxCpTpDefaultConfigImpl, WxCpTpRedissonConfigImpl

public interface WxCpTpConfigStorage

微信客户端（第三方应用）配置存储

作者:

zhenjun cai

方法概要

限定符和类型	方法和说明
boolean	autoRefreshToken() Auto refresh token boolean.
void	expireAccessToken(java.lang.String authCorpId) Expire access token.
void	expireAuthCorpJsApiTicket(java.lang.String authCorpId) Expire auth corp js api ticket.
void	expireAuthSuiteJsApiTicket(java.lang.String authCorpId) Expire auth suite js api ticket.
void	expireProviderToken() Expire provider token.
void	expireSuiteAccessToken() Expire suite access token.
void	expireSuiteTicket() Expire suite ticket.
java.lang.String	getAccessToken(java.lang.String authCorpId) 授权企业的access token相关
me.chanjar.weixin.common.bean.WxAccessToken	getAccessTokenEntity(java.lang.String authCorpId) Gets access token entity.
java.util.concurrent.locks.Lock	getAccessTokenLock(java.lang.String authCorpId) Gets access token lock.
java.lang.String	getAesKey() Gets aes key.
me.chanjar.weixin.common.util.http.apache.ApacheHttpClientBuilder	getApacheHttpClientBuilder() Gets apache http client builder.
java.lang.String	getApiUrl(java.lang.String path) 读取企业微信 API Url.
java.lang.String	getAuthCorpJsApiTicket(java.lang.String authCorpId) 授权企业的js api ticket相关
java.util.concurrent.locks.Lock	getAuthCorpJsapiTicketLock(java.lang.String authCorpId) Gets auth corp jsapi ticket lock.
java.lang.String	getAuthSuiteJsApiTicket(java.lang.String authCorpId) 授权企业的第三方应用js api ticket相关
java.lang.String	getCorpId() 企微服务商企业ID / 企业secret
java.lang.String	getCorpSecret() Gets corp secret.
java.lang.String	getHttpProxyHost() 网络代理相关
java.lang.String	getHttpProxyPassword() Gets http proxy password.
int	getHttpProxyPort() Gets http proxy port.
java.lang.String	getHttpProxyUsername() Gets http proxy username.
java.util.concurrent.locks.Lock	getProviderAccessTokenLock() Gets provider access token lock.
java.lang.String	getProviderSecret() 服务商secret
java.lang.String	getProviderToken() Gets provider token.
WxCpProviderToken	getProviderTokenEntity() Gets provider token entity.
java.lang.String	getSuiteAccessToken() 第三方应用的suite access token相关
me.chanjar.weixin.common.bean.WxAccessToken	getSuiteAccessTokenEntity() 获取suite_access_token和剩余过期时间
java.util.concurrent.locks.Lock	getSuiteAccessTokenLock() Gets suite access token lock.
java.lang.String	getSuiteId() 第三方应用的其他配置，来自于企微配置
java.util.concurrent.locks.Lock	getSuiteJsapiTicketLock(java.lang.String authCorpId) Gets suite jsapi ticket lock.
java.lang.String	getSuiteSecret() Gets suite secret.
java.lang.String	getSuiteTicket() 第三方应用的suite ticket相关
java.io.File	getTmpDirFile() 已过时。
java.lang.String	getToken() Gets token.
boolean	isAccessTokenExpired(java.lang.String authCorpId) Is access token expired boolean.
boolean	isAuthCorpJsApiTicketExpired(java.lang.String authCorpId) Is auth corp js api ticket expired boolean.
boolean	isAuthSuiteJsApiTicketExpired(java.lang.String authCorpId) Is auth suite js api ticket expired boolean.
boolean	isProviderTokenExpired() Is provider token expired boolean.
boolean	isSuiteAccessTokenExpired() Is suite access token expired boolean.
boolean	isSuiteTicketExpired() Is suite ticket expired boolean.
void	setBaseApiUrl(java.lang.String baseUrl) 设置企业微信服务器 baseUrl.
void	updateAccessToken(java.lang.String authCorpId, java.lang.String accessToken, int expiredInSeconds) Update access token.
void	updateAuthCorpJsApiTicket(java.lang.String authCorpId, java.lang.String jsApiTicket, int expiredInSeconds) Update auth corp js api ticket.
void	updateAuthSuiteJsApiTicket(java.lang.String authCorpId, java.lang.String jsApiTicket, int expiredInSeconds) Update auth suite js api ticket.
void	updateProviderToken(java.lang.String providerToken, int expiredInSeconds) Update provider token.
void	updateSuiteAccessToken(java.lang.String suiteAccessToken, int expiresInSeconds) Update suite access token.
void	updateSuiteAccessToken(me.chanjar.weixin.common.bean.WxAccessToken suiteAccessToken) Update suite access token.
void	updateSuiteTicket(java.lang.String suiteTicket, int expiresInSeconds) Update suite ticket.

方法详细资料

setBaseApiUrl

void setBaseApiUrl(java.lang.String baseUrl)

设置企业微信服务器 baseUrl. 默认值是 https://qyapi.weixin.qq.com , 如果使用默认值，则不需要调用 setBaseApiUrl

参数:

baseUrl - 企业微信服务器 Url

getApiUrl

java.lang.String getApiUrl(java.lang.String path)

读取企业微信 API Url. 支持私有化企业微信服务器.

参数:

path - the path

返回:

the api url

getSuiteAccessToken

java.lang.String getSuiteAccessToken()

第三方应用的suite access token相关

返回:

the suite access token

getSuiteAccessTokenEntity

me.chanjar.weixin.common.bean.WxAccessToken getSuiteAccessTokenEntity()

获取suite_access_token和剩余过期时间

返回:

suite access token and the remaining expiration time

isSuiteAccessTokenExpired

boolean isSuiteAccessTokenExpired()

Is suite access token expired boolean.

返回:

the boolean

expireSuiteAccessToken

void expireSuiteAccessToken()

Expire suite access token.

updateSuiteAccessToken

void updateSuiteAccessToken(me.chanjar.weixin.common.bean.WxAccessToken suiteAccessToken)

Update suite access token.

参数:

suiteAccessToken - the suite access token

updateSuiteAccessToken

void updateSuiteAccessToken(java.lang.String suiteAccessToken,
                            int expiresInSeconds)

Update suite access token.

参数:

suiteAccessToken - the suite access token

expiresInSeconds - the expires in seconds

getSuiteTicket

java.lang.String getSuiteTicket()

第三方应用的suite ticket相关

返回:

the suite ticket

isSuiteTicketExpired

boolean isSuiteTicketExpired()

Is suite ticket expired boolean.

返回:

the boolean

expireSuiteTicket

void expireSuiteTicket()

Expire suite ticket.

updateSuiteTicket

void updateSuiteTicket(java.lang.String suiteTicket,
                       int expiresInSeconds)

Update suite ticket.

参数:

suiteTicket - the suite ticket

expiresInSeconds - the expires in seconds

getSuiteId

java.lang.String getSuiteId()

第三方应用的其他配置，来自于企微配置

返回:

the suite id

getSuiteSecret

java.lang.String getSuiteSecret()

Gets suite secret.

返回:

the suite secret

getToken

java.lang.String getToken()

Gets token.

返回:

the token

getAesKey

java.lang.String getAesKey()

Gets aes key.

返回:

the aes key

getCorpId

java.lang.String getCorpId()

企微服务商企业ID / 企业secret

返回:

the corp id

getCorpSecret

java.lang.String getCorpSecret()

Gets corp secret.

返回:

the corp secret

getProviderSecret

java.lang.String getProviderSecret()

服务商secret

返回:

the provider secret

getAccessToken

java.lang.String getAccessToken(java.lang.String authCorpId)

授权企业的access token相关

参数:

authCorpId - the auth corp id

返回:

the access token

getAccessTokenEntity

me.chanjar.weixin.common.bean.WxAccessToken getAccessTokenEntity(java.lang.String authCorpId)

Gets access token entity.

参数:

authCorpId - the auth corp id

返回:

the access token entity

isAccessTokenExpired

boolean isAccessTokenExpired(java.lang.String authCorpId)

Is access token expired boolean.

参数:

authCorpId - the auth corp id

返回:

the boolean

expireAccessToken

void expireAccessToken(java.lang.String authCorpId)

Expire access token.

参数:

authCorpId - the auth corp id

updateAccessToken

void updateAccessToken(java.lang.String authCorpId,
                       java.lang.String accessToken,
                       int expiredInSeconds)

Update access token.

参数:

authCorpId - the auth corp id

accessToken - the access token

expiredInSeconds - the expired in seconds

getAuthCorpJsApiTicket

java.lang.String getAuthCorpJsApiTicket(java.lang.String authCorpId)

授权企业的js api ticket相关

参数:

authCorpId - the auth corp id

返回:

the auth corp js api ticket

isAuthCorpJsApiTicketExpired

boolean isAuthCorpJsApiTicketExpired(java.lang.String authCorpId)

Is auth corp js api ticket expired boolean.

参数:

authCorpId - the auth corp id

返回:

the boolean

expireAuthCorpJsApiTicket

void expireAuthCorpJsApiTicket(java.lang.String authCorpId)

Expire auth corp js api ticket.

参数:

authCorpId - the auth corp id

updateAuthCorpJsApiTicket

void updateAuthCorpJsApiTicket(java.lang.String authCorpId,
                               java.lang.String jsApiTicket,
                               int expiredInSeconds)

Update auth corp js api ticket.

参数:

authCorpId - the auth corp id

jsApiTicket - the js api ticket

expiredInSeconds - the expired in seconds

getAuthSuiteJsApiTicket

java.lang.String getAuthSuiteJsApiTicket(java.lang.String authCorpId)

授权企业的第三方应用js api ticket相关

参数:

authCorpId - the auth corp id

返回:

the auth suite js api ticket

isAuthSuiteJsApiTicketExpired

boolean isAuthSuiteJsApiTicketExpired(java.lang.String authCorpId)

Is auth suite js api ticket expired boolean.

参数:

authCorpId - the auth corp id

返回:

the boolean

expireAuthSuiteJsApiTicket

void expireAuthSuiteJsApiTicket(java.lang.String authCorpId)

Expire auth suite js api ticket.

参数:

authCorpId - the auth corp id

updateAuthSuiteJsApiTicket

void updateAuthSuiteJsApiTicket(java.lang.String authCorpId,
                                java.lang.String jsApiTicket,
                                int expiredInSeconds)

Update auth suite js api ticket.

参数:

authCorpId - the auth corp id

jsApiTicket - the js api ticket

expiredInSeconds - the expired in seconds

isProviderTokenExpired

boolean isProviderTokenExpired()

Is provider token expired boolean.

返回:

the boolean

updateProviderToken

void updateProviderToken(java.lang.String providerToken,
                         int expiredInSeconds)

Update provider token.

参数:

providerToken - the provider token

expiredInSeconds - the expired in seconds

getProviderToken

java.lang.String getProviderToken()

Gets provider token.

返回:

the provider token

getProviderTokenEntity

WxCpProviderToken getProviderTokenEntity()

Gets provider token entity.

返回:

the provider token entity

expireProviderToken

void expireProviderToken()

Expire provider token.

getHttpProxyHost

java.lang.String getHttpProxyHost()

网络代理相关

返回:

the http proxy host

getHttpProxyPort

int getHttpProxyPort()

Gets http proxy port.

返回:

the http proxy port

getHttpProxyUsername

java.lang.String getHttpProxyUsername()

Gets http proxy username.

返回:

the http proxy username

getHttpProxyPassword

java.lang.String getHttpProxyPassword()

Gets http proxy password.

返回:

the http proxy password

getApacheHttpClientBuilder

me.chanjar.weixin.common.util.http.apache.ApacheHttpClientBuilder getApacheHttpClientBuilder()

Gets apache http client builder.

返回:

the apache http client builder

autoRefreshToken

boolean autoRefreshToken()

Auto refresh token boolean.

返回:

the boolean

getTmpDirFile

@Deprecated
java.io.File getTmpDirFile()

已过时。

Gets tmp dir file.

返回:

the tmp dir file

getProviderAccessTokenLock

java.util.concurrent.locks.Lock getProviderAccessTokenLock()

Gets provider access token lock.

返回:

the provider access token lock

getSuiteAccessTokenLock

java.util.concurrent.locks.Lock getSuiteAccessTokenLock()

Gets suite access token lock.

返回:

the suite access token lock

getAccessTokenLock

java.util.concurrent.locks.Lock getAccessTokenLock(java.lang.String authCorpId)

Gets access token lock.

参数:

authCorpId - the auth corp id

返回:

the access token lock

getAuthCorpJsapiTicketLock

java.util.concurrent.locks.Lock getAuthCorpJsapiTicketLock(java.lang.String authCorpId)

Gets auth corp jsapi ticket lock.

参数:

authCorpId - the auth corp id

返回:

the auth corp jsapi ticket lock

getSuiteJsapiTicketLock

java.util.concurrent.locks.Lock getSuiteJsapiTicketLock(java.lang.String authCorpId)

Gets suite jsapi ticket lock.

参数:

authCorpId - the auth corp id

返回:

the suite jsapi ticket lock