WxCpConfigStorage (WxJava - CP Java SDK 4.8.2.B API)

所有已知实现类:

AbstractWxCpInRedisConfigImpl, WxCpDefaultConfigImpl, WxCpJedisConfigImpl, WxCpRedisConfigImpl, WxCpRedissonConfigImpl, WxCpRedisTemplateConfigImpl
```
public interface WxCpConfigStorage
```
微信客户端配置存储.

作者:

Daniel Qian

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`long`	`acquireMsgAuditSdk()` 获取当前SDK并增加引用计数（原子操作）如果SDK未初始化或已过期，返回0而不增加引用计数此方法用于在获取SDK后立即增加引用计数，避免并发问题
`boolean`	`autoRefreshToken()` 是否自动刷新token
`int`	`decrementMsgAuditSdkRefCount(long sdk)` 减少会话存档SDK的引用计数当引用计数降为0时，自动销毁SDK以释放资源
`void`	`expireAccessToken()` 强制将access token过期掉.
`void`	`expireAgentJsapiTicket()` 强制将jsapi ticket过期掉.
`void`	`expireJsapiTicket()` 强制将jsapi ticket过期掉.
`void`	`expireMsgAuditAccessToken()` 强制将会话存档access token过期掉
`void`	`expireMsgAuditSdk()` 使会话存档SDK过期
`String`	`getAccessToken()` Gets access token.
`Lock`	`getAccessTokenLock()` Gets access token lock.
`String`	`getAesKey()` Gets aes key.
`Integer`	`getAgentId()` Gets agent id.
`String`	`getAgentJsapiTicket()` Gets agent jsapi ticket.
`Lock`	`getAgentJsapiTicketLock()` Gets agent jsapi ticket lock.
`ApacheHttpClientBuilder`	`getApacheHttpClientBuilder()` http client builder.
`String`	`getApiUrl(String path)` 读取企业微信 API Url.
`String`	`getCorpId()` Gets corp id.
`String`	`getCorpSecret()` Gets corp secret.
`long`	`getExpiresTime()` Gets expires time.
`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()` Gets jsapi ticket.
`Lock`	`getJsapiTicketLock()` Gets jsapi ticket lock.
`String`	`getMsgAuditAccessToken()` 获取会话存档的access token
`Lock`	`getMsgAuditAccessTokenLock()` 获取会话存档access token的锁
`String`	`getMsgAuditLibPath()` 获取企微会话存档系统库绝对路径
`String`	`getMsgAuditPriKey()` 企微会话存档私钥
`long`	`getMsgAuditSdk()` 获取会话存档SDK 会话存档SDK初始化后有效期为7200秒，无需每次重新初始化
`int`	`getMsgAuditSdkRefCount(long sdk)` 获取会话存档SDK的引用计数
`String`	`getMsgAuditSecret()` 获取会话存档的secret
`String`	`getOauth2redirectUri()` Gets oauth 2 redirect uri.
`File`	`getTmpDirFile()` Gets tmp dir file.
`String`	`getToken()` Gets token.
`String`	`getWebhookKey()` 获取群机器人webhook的key
`int`	`incrementMsgAuditSdkRefCount(long sdk)` 增加会话存档SDK的引用计数用于支持多线程安全的SDK生命周期管理
`boolean`	`isAccessTokenExpired()` Is access token expired boolean.
`boolean`	`isAgentJsapiTicketExpired()` Is agent jsapi ticket expired boolean.
`boolean`	`isJsapiTicketExpired()` Is jsapi ticket expired boolean.
`boolean`	`isMsgAuditAccessTokenExpired()` 检查会话存档access token是否已过期
`boolean`	`isMsgAuditSdkExpired()` 检查会话存档SDK是否已过期
`void`	`releaseMsgAuditSdk(long sdk)` 减少SDK引用计数并在必要时释放（原子操作）此方法确保引用计数递减和SDK检查在同一个同步块内完成
`void`	`setBaseApiUrl(String baseUrl)` 设置企业微信服务器 baseUrl.
`void`	`updateAccessToken(String accessToken, int expiresIn)` Update access token.
`void`	`updateAccessToken(WxAccessToken accessToken)` Update access token.
`void`	`updateAgentJsapiTicket(String jsapiTicket, int expiresInSeconds)` 应该是线程安全的.
`void`	`updateJsapiTicket(String jsapiTicket, int expiresInSeconds)` 应该是线程安全的.
`void`	`updateMsgAuditAccessToken(String accessToken, int expiresInSeconds)` 更新会话存档access token
`void`	`updateMsgAuditSdk(long sdk, int expiresInSeconds)` 更新会话存档SDK

- 方法详细资料
  - setBaseApiUrl
```
void setBaseApiUrl(String baseUrl)
```
    设置企业微信服务器 baseUrl. 默认值是 https://qyapi.weixin.qq.com , 如果使用默认值，则不需要调用 setBaseApiUrl
    
    参数:
    
    baseUrl - 企业微信服务器 Url
  - getApiUrl
```
String getApiUrl(String path)
```
    读取企业微信 API Url. 支持私有化企业微信服务器.
    
    参数:
    
    path - the path
    
    返回:
    
    the api url
  - getAccessToken
```
String getAccessToken()
```
    Gets access token.
    
    返回:
    
    the access token
  - getAccessTokenLock
```
Lock getAccessTokenLock()
```
    Gets access token lock.
    
    返回:
    
    the access token lock
  - isAccessTokenExpired
```
boolean isAccessTokenExpired()
```
    Is access token expired boolean.
    
    返回:
    
    the boolean
  - expireAccessToken
```
void expireAccessToken()
```
    强制将access token过期掉.
  - updateAccessToken
```
void updateAccessToken(WxAccessToken accessToken)
```
    Update access token.
    
    参数:
    
    accessToken - the access token
  - updateAccessToken
```
void updateAccessToken(String accessToken,
                       int expiresIn)
```
    Update access token.
    
    参数:
    
    accessToken - the access token
    
    expiresIn - the expires in
  - getJsapiTicket
```
String getJsapiTicket()
```
    Gets jsapi ticket.
    
    返回:
    
    the jsapi ticket
  - getJsapiTicketLock
```
Lock getJsapiTicketLock()
```
    Gets jsapi ticket lock.
    
    返回:
    
    the jsapi ticket lock
  - isJsapiTicketExpired
```
boolean isJsapiTicketExpired()
```
    Is jsapi ticket expired boolean.
    
    返回:
    
    the boolean
  - expireJsapiTicket
```
void expireJsapiTicket()
```
    强制将jsapi ticket过期掉.
  - updateJsapiTicket
```
void updateJsapiTicket(String jsapiTicket,
                       int expiresInSeconds)
```
    应该是线程安全的.
    
    参数:
    
    jsapiTicket - the jsapi ticket
    
    expiresInSeconds - the expires in seconds
  - getAgentJsapiTicket
```
String getAgentJsapiTicket()
```
    Gets agent jsapi ticket.
    
    返回:
    
    the agent jsapi ticket
  - getAgentJsapiTicketLock
```
Lock getAgentJsapiTicketLock()
```
    Gets agent jsapi ticket lock.
    
    返回:
    
    the agent jsapi ticket lock
  - isAgentJsapiTicketExpired
```
boolean isAgentJsapiTicketExpired()
```
    Is agent jsapi ticket expired boolean.
    
    返回:
    
    the boolean
  - expireAgentJsapiTicket
```
void expireAgentJsapiTicket()
```
    强制将jsapi ticket过期掉.
  - updateAgentJsapiTicket
```
void updateAgentJsapiTicket(String jsapiTicket,
                            int expiresInSeconds)
```
    应该是线程安全的.
    
    参数:
    
    jsapiTicket - the jsapi ticket
    
    expiresInSeconds - the expires in seconds
  - getCorpId
```
String getCorpId()
```
    Gets corp id.
    
    返回:
    
    the corp id
  - getCorpSecret
```
String getCorpSecret()
```
    Gets corp secret.
    
    返回:
    
    the corp secret
  - getAgentId
```
Integer getAgentId()
```
    Gets agent id.
    
    返回:
    
    the agent id
  - getToken
```
String getToken()
```
    Gets token.
    
    返回:
    
    the token
  - getAesKey
```
String getAesKey()
```
    Gets aes key.
    
    返回:
    
    the aes key
  - getMsgAuditPriKey
```
String getMsgAuditPriKey()
```
    企微会话存档私钥
    
    返回:
    
    msg audit pri key
  - getMsgAuditLibPath
```
String getMsgAuditLibPath()
```
    获取企微会话存档系统库绝对路径
    
    返回:
    
    msg audit lib path
  - getExpiresTime
```
long getExpiresTime()
```
    Gets expires time.
    
    返回:
    
    the expires time
  - getOauth2redirectUri
```
String getOauth2redirectUri()
```
    Gets oauth 2 redirect uri.
    
    返回:
    
    the oauth 2 redirect uri
  - 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
  - getTmpDirFile
```
File getTmpDirFile()
```
    Gets tmp dir file.
    
    返回:
    
    the tmp dir file
  - getApacheHttpClientBuilder
```
ApacheHttpClientBuilder getApacheHttpClientBuilder()
```
    http client builder.
    
    返回:
    
    ApacheHttpClientBuilder apache http client builder
  - autoRefreshToken
```
boolean autoRefreshToken()
```
    是否自动刷新token
    
    返回:
    
    . boolean
  - getWebhookKey
```
String getWebhookKey()
```
    获取群机器人webhook的key
    
    返回:
    
    key webhook key
  - getMsgAuditSecret
```
String getMsgAuditSecret()
```
    获取会话存档的secret
    
    返回:
    
    msg audit secret
  - getMsgAuditAccessToken
```
String getMsgAuditAccessToken()
```
    获取会话存档的access token
    
    返回:
    
    msg audit access token
  - getMsgAuditAccessTokenLock
```
Lock getMsgAuditAccessTokenLock()
```
    获取会话存档access token的锁
    
    返回:
    
    msg audit access token lock
  - isMsgAuditAccessTokenExpired
```
boolean isMsgAuditAccessTokenExpired()
```
    检查会话存档access token是否已过期
    
    返回:
    
    true: 已过期, false: 未过期
  - expireMsgAuditAccessToken
```
void expireMsgAuditAccessToken()
```
    强制将会话存档access token过期掉
  - updateMsgAuditAccessToken
```
void updateMsgAuditAccessToken(String accessToken,
                               int expiresInSeconds)
```
    更新会话存档access token
    
    参数:
    
    accessToken - 会话存档access token
    
    expiresInSeconds - 过期时间（秒）
  - getMsgAuditSdk
```
long getMsgAuditSdk()
```
    获取会话存档SDK 会话存档SDK初始化后有效期为7200秒，无需每次重新初始化
    
    返回:
    
    sdk id，如果未初始化或已过期返回0
  - isMsgAuditSdkExpired
```
boolean isMsgAuditSdkExpired()
```
    检查会话存档SDK是否已过期
    
    返回:
    
    true: 已过期, false: 未过期
  - updateMsgAuditSdk
```
void updateMsgAuditSdk(long sdk,
                       int expiresInSeconds)
```
    更新会话存档SDK
    
    参数:
    
    sdk - sdk id
    
    expiresInSeconds - 过期时间（秒）
  - expireMsgAuditSdk
```
void expireMsgAuditSdk()
```
    使会话存档SDK过期
  - incrementMsgAuditSdkRefCount
```
int incrementMsgAuditSdkRefCount(long sdk)
```
    增加会话存档SDK的引用计数用于支持多线程安全的SDK生命周期管理
    
    参数:
    
    sdk - sdk id
    
    返回:
    
    增加后的引用计数，如果SDK不匹配返回-1
  - decrementMsgAuditSdkRefCount
```
int decrementMsgAuditSdkRefCount(long sdk)
```
    减少会话存档SDK的引用计数当引用计数降为0时，自动销毁SDK以释放资源
    
    参数:
    
    sdk - sdk id
    
    返回:
    
    减少后的引用计数，如果返回0表示SDK已被销毁，如果SDK不匹配返回-1
  - getMsgAuditSdkRefCount
```
int getMsgAuditSdkRefCount(long sdk)
```
    获取会话存档SDK的引用计数
    
    参数:
    
    sdk - sdk id
    
    返回:
    
    当前引用计数，如果SDK不匹配返回-1
  - acquireMsgAuditSdk
```
long acquireMsgAuditSdk()
```
    获取当前SDK并增加引用计数（原子操作）如果SDK未初始化或已过期，返回0而不增加引用计数此方法用于在获取SDK后立即增加引用计数，避免并发问题
    
    返回:
    
    当前有效的SDK id并已增加引用计数，如果SDK无效返回0
  - releaseMsgAuditSdk
```
void releaseMsgAuditSdk(long sdk)
```
    减少SDK引用计数并在必要时释放（原子操作）此方法确保引用计数递减和SDK检查在同一个同步块内完成
    
    参数:
    
    sdk - sdk id

接口 WxCpConfigStorage

方法概要

方法详细资料

setBaseApiUrl

getApiUrl

getAccessToken

getAccessTokenLock

isAccessTokenExpired

expireAccessToken

updateAccessToken

updateAccessToken

getJsapiTicket

getJsapiTicketLock

isJsapiTicketExpired

expireJsapiTicket

updateJsapiTicket

getAgentJsapiTicket

getAgentJsapiTicketLock

isAgentJsapiTicketExpired

expireAgentJsapiTicket

updateAgentJsapiTicket

getCorpId

getCorpSecret

getAgentId

getToken

getAesKey

getMsgAuditPriKey

getMsgAuditLibPath

getExpiresTime

getOauth2redirectUri

getHttpProxyHost

getHttpProxyPort

getHttpProxyUsername

getHttpProxyPassword

getTmpDirFile

getApacheHttpClientBuilder

autoRefreshToken

getWebhookKey

getMsgAuditSecret

getMsgAuditAccessToken

getMsgAuditAccessTokenLock

isMsgAuditAccessTokenExpired

expireMsgAuditAccessToken

updateMsgAuditAccessToken

getMsgAuditSdk

isMsgAuditSdkExpired

updateMsgAuditSdk

expireMsgAuditSdk

incrementMsgAuditSdkRefCount

decrementMsgAuditSdkRefCount

getMsgAuditSdkRefCount

acquireMsgAuditSdk

releaseMsgAuditSdk