AuthClient (Authing Java SDK 1.0.3 API)

java.lang.Object
- cn.authing.sdk.java.client.AuthingBaseClient
- - cn.authing.sdk.java.client.AuthClient

```
public class AuthClient
extends AuthingBaseClient
```
AuthClient 登录认证客户端，初始化一次即可

字段概要

字段
限定符和类型字段和说明

protected String appId
app id

protected ProtocolEnum protocol
app protocol

protected String redirectUri
重定向地址
- 从类继承的字段 cn.authing.sdk.java.client.AuthingBaseClient
  endpoint, HTTP_CLIENT, log, PATH_PREFIX, userPoolId, userPoolSecret, VERSION

字段
限定符和类型	字段和说明
`protected String`	`appId` app id
`protected ProtocolEnum`	`protocol` app protocol
`protected String`	`redirectUri` 重定向地址

构造器概要

构造器
构造器和说明
`AuthClient()` 构造器
`AuthClient(String endpoint)` 构造方式二
`AuthClient(String endpoint, org.apache.http.impl.client.CloseableHttpClient client)` 构造方式三
`AuthClient(String endpoint, String appId)` 构造方式一

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`String`	`buildAuthorizeUrl(CasParams params)` 拼接 CAS 协议授权链接
`String`	`buildAuthorizeUrl(OauthParams params)` 拼接 OAUTH 协议授权链接
`String`	`buildAuthorizeUrl(OidcParams params)` 拼接 OIDC 协议授权链接
`String`	`buildAuthorizeUrl(SamlParams params)` 拼接 SAML 协议授权链接
`String`	`buildLogoutUrl(LogoutParams params)` 拼接登出 url
`PasswordSecurityLevel`	`computedPasswordSecurityLevel(String password)` 计算密码安全等级
`<R> R`	`execute(AfterLoginRequest request, Class<R> clazz, String token)` 执行 http 请求
`<R> R`	`execute(AfterLoginRequest request, Class<R> clazz, String token, String traceId)` 执行 http 请求，可以携带请求唯一标识
`<R> R`	`execute(BeforeLoginRequest request, Class<R> clazz)` 执行 http 请求
`<R> R`	`execute(BeforeLoginRequest request, Class<R> clazz, String token, String traceId)` 执行 http 请求，可以携带请求唯一标识
`String`	`generateCodeChallenge()` 生成一个 PKCE 校验码，长度必须大于等于 43。
`protected Map<String,String>`	`getAddedHeaders()`
`String`	`getAppId()`
`String`	`getCodeChallengeDigest(CodeChallengeDigestParam param)` 生成一个 PKCE 校验码摘要值
`ProtocolEnum`	`getProtocol()`
`String`	`getRedirectUri()`
`void`	`setAppId(String appId)`
`void`	`setProtocol(ProtocolEnum protocol)`
`void`	`setRedirectUri(String redirectUri)`

从类继承的方法 cn.authing.sdk.java.client.AuthingBaseClient
buildExt, execute, execute, getEndpoint, getUserPoolId, getUserPoolSecret, setEndpoint, setPublicKey, setUserPoolId, setUserPoolSecret

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - appId
```
protected String appId
```
    app id
  - protocol
```
protected ProtocolEnum protocol
```
    app protocol
  - redirectUri
```
protected String redirectUri
```
    重定向地址
- 构造器详细资料
  - AuthClient
```
public AuthClient()
```
    构造器
  - AuthClient
```
public AuthClient(String endpoint,
                  String appId)
```
    构造方式一
    
    参数:
    
    endpoint - endpoint
    
    appId - App Id
  - AuthClient
```
public AuthClient(String endpoint)
```
    构造方式二
    
    参数:
    
    endpoint - 调用地址 https://ip:port
  - AuthClient
```
public AuthClient(String endpoint,
                  org.apache.http.impl.client.CloseableHttpClient client)
```
    构造方式三
    
    参数:
    
    endpoint - 调用地址 https://ip:port
    
    client - client
- 方法详细资料
  - execute
```
public <R> R execute(BeforeLoginRequest request,
                     Class<R> clazz)
```
    执行 http 请求
    
    类型参数:
    
    R - 响应对象的类型
    
    参数:
    
    request - 请求对象
    
    clazz - 响应对象的类型
    
    返回:
    
    响应对象
  - execute
```
public <R> R execute(BeforeLoginRequest request,
                     Class<R> clazz,
                     String token,
                     String traceId)
```
    执行 http 请求，可以携带请求唯一标识
    
    类型参数:
    
    R - 响应对象的类型
    
    参数:
    
    request - 请求对象
    
    clazz - 响应对象的类型
    
    token - 可以是用户池 token 也可以是应用登录时用户的 token
    
    traceId - 请求唯一标识，requestId
    
    返回:
    
    响应对象
  - execute
```
public <R> R execute(AfterLoginRequest request,
                     Class<R> clazz,
                     String token)
```
    执行 http 请求
    
    类型参数:
    
    R - 响应对象的类型
    
    参数:
    
    request - 请求对象
    
    clazz - 响应对象的类型
    
    token - 可以是用户池 token 也可以是应用登录时用户的 token
    
    返回:
    
    响应对象
  - execute
```
public <R> R execute(AfterLoginRequest request,
                     Class<R> clazz,
                     String token,
                     String traceId)
```
    执行 http 请求，可以携带请求唯一标识
    
    类型参数:
    
    R - 响应对象的类型
    
    参数:
    
    request - 请求对象
    
    clazz - 响应对象的类型
    
    token - 可以是用户池 token 也可以是应用登录时用户的 token
    
    traceId - 请求唯一标识，requestId
    
    返回:
    
    响应对象
  - computedPasswordSecurityLevel
```
public PasswordSecurityLevel computedPasswordSecurityLevel(String password)
```
    计算密码安全等级
    
    参数:
    
    password - 密码
    
    返回:
    
    安全等级
  - buildAuthorizeUrl
```
public String buildAuthorizeUrl(SamlParams params)
```
    拼接 SAML 协议授权链接
    
    参数:
    
    params - 协议需要的参数参数
    
    返回:
    
    url
  - buildAuthorizeUrl
```
public String buildAuthorizeUrl(OidcParams params)
```
    拼接 OIDC 协议授权链接
    
    参数:
    
    params - 协议需要的参数参数
    
    返回:
    
    url
  - buildAuthorizeUrl
```
public String buildAuthorizeUrl(OauthParams params)
```
    拼接 OAUTH 协议授权链接
    
    参数:
    
    params - 协议需要的参数参数
    
    返回:
    
    url
  - buildAuthorizeUrl
```
public String buildAuthorizeUrl(CasParams params)
```
    拼接 CAS 协议授权链接
    
    参数:
    
    params - 协议需要的参数参数
    
    返回:
    
    url
  - buildLogoutUrl
```
public String buildLogoutUrl(LogoutParams params)
```
    拼接登出 url
    
    参数:
    
    params - 拼接参数
    
    返回:
    
    登出 url
  - generateCodeChallenge
```
public String generateCodeChallenge()
```
    生成一个 PKCE 校验码，长度必须大于等于 43。
    
    返回:
    
    PKCE 校验码
  - getCodeChallengeDigest
```
public String getCodeChallengeDigest(CodeChallengeDigestParam param)
```
    生成一个 PKCE 校验码摘要值
    
    参数:
    
    param - 加密方式和校验码
    
    返回:
    
    摘要
  - getAddedHeaders
```
protected Map<String,String> getAddedHeaders()
```
    覆盖:
    
    getAddedHeaders 在类中 AuthingBaseClient
  - getAppId
```
public String getAppId()
```
  - setAppId
```
public void setAppId(String appId)
```
  - getProtocol
```
public ProtocolEnum getProtocol()
```
  - setProtocol
```
public void setProtocol(ProtocolEnum protocol)
```
  - getRedirectUri
```
public String getRedirectUri()
```
  - setRedirectUri
```
public void setRedirectUri(String redirectUri)
```

类 AuthClient

字段概要

从类继承的字段 cn.authing.sdk.java.client.AuthingBaseClient

构造器概要

方法概要

从类继承的方法 cn.authing.sdk.java.client.AuthingBaseClient

从类继承的方法 java.lang.Object

字段详细资料

appId

protocol

redirectUri

构造器详细资料

AuthClient

AuthClient

AuthClient

AuthClient

方法详细资料

execute

execute

execute

execute

computedPasswordSecurityLevel

buildAuthorizeUrl

buildAuthorizeUrl

buildAuthorizeUrl

buildAuthorizeUrl

buildLogoutUrl

generateCodeChallenge

getCodeChallengeDigest

getAddedHeaders

getAppId

setAppId

getProtocol

setProtocol

getRedirectUri

setRedirectUri