Cas (Buession Springboot Pac4j 2.1.0 API)

java.lang.Object
- com.buession.springboot.pac4j.config.BaseConfig
- - com.buession.springboot.pac4j.config.Cas

```
public class Cas
extends BaseConfig
```
CAS 配置

从以下版本开始:

2.0.0

作者:

Yong.Teng

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`Cas.Direct` Direct Client 配置
`static class`	`Cas.DirectProxy` Direct Proxy Client 配置
`static class`	`Cas.General` CAS 常规配置
`static class`	`Cas.RestBasicAuth` Cas Rest Basic Auth 配置
`static class`	`Cas.RestForm` CAS Rest 表单配置

从类继承的嵌套类/接口 com.buession.springboot.pac4j.config.BaseConfig
BaseConfig.BaseClientConfig

字段概要

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

static String PREFIX
- 从类继承的字段 com.buession.springboot.pac4j.config.BaseConfig
  PROPERTIES_PREFIX

字段
限定符和类型	字段和说明
`static String`	`PREFIX`

构造器概要

构造器
构造器和说明

Cas()

构造器
构造器和说明
`Cas()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`List<Class<org.pac4j.core.authorization.generator.AuthorizationGenerator>>`	`getAuthorizationGenerator()` 返回授权生成器
`String`	`getCallbackUrl()` 返回 CAS 登录成功跳转地址
`Map<String,String>`	`getCustomParameters()` 返回客户自定义参数
`Cas.Direct`	`getDirect()` 返回 Direct Client 配置
`Cas.DirectProxy`	`getDirectProxy()` 返回 Direct Proxy Client 配置
`String`	`getEncoding()` 返回编码
`Boolean`	`getGateway()` 返回 Gateway
`Cas.General`	`getGeneral()` 返回常规配置
`String`	`getLoginUrl()` 返回 CAS 登录地址
`String`	`getMethod()` 返回请求方法
`String`	`getPostLogoutUrlParameter()` 返回退出登录请求参数
`String`	`getPrefixUrl()` 返回 CAS URL 前缀
`Class<org.pac4j.cas.profile.CasProfileDefinition>`	`getProfileDefinition()` 返回 Profile 定义，可用于处理 CAS Server 登录返回字段
`org.pac4j.cas.config.CasProtocol`	`getProtocol()` 返回 CAS 协议
`Boolean`	`getRenew()` 返回是否重新认证
`Cas.RestBasicAuth`	`getRestBasicAuth()` 返回 Rest Basic Auth Client 配置
`Cas.RestForm`	`getRestForm()` 返回 Rest 表单配置
`Long`	`getTimeTolerance()`
`void`	`setAuthorizationGenerator(List<Class<org.pac4j.core.authorization.generator.AuthorizationGenerator>> authorizationGenerator)` 设置授权生成器
`void`	`setCallbackUrl(String callbackUrl)` 设置 CAS 登录成功跳转地址
`void`	`setCustomParameters(Map<String,String> customParameters)` 设置客户自定义参数
`void`	`setDirect(Cas.Direct direct)` 设置 Direct Client 配置
`void`	`setDirectProxy(Cas.DirectProxy directProxy)` 设置 Direct Proxy Client 配置
`void`	`setEncoding(String encoding)` 设置编码
`void`	`setGateway(Boolean gateway)` 设置 Gateway
`void`	`setGeneral(Cas.General general)` 设置常规配置
`void`	`setLoginUrl(String loginUrl)` 设置 CAS 登录地址
`void`	`setMethod(String method)` 设置请求方法
`void`	`setPostLogoutUrlParameter(String postLogoutUrlParameter)` 设置退出登录请求参数
`void`	`setPrefixUrl(String prefixUrl)` 设置 CAS URL 前缀
`void`	`setProfileDefinition(Class<org.pac4j.cas.profile.CasProfileDefinition> profileDefinition)` 设置 Profile 定义，可用于处理 CAS Server 登录返回字段
`void`	`setProtocol(org.pac4j.cas.config.CasProtocol protocol)` 设置 CAS 协议
`void`	`setRenew(Boolean renew)` 设置是否重新认证
`void`	`setRestBasicAuth(Cas.RestBasicAuth restBasicAuth)` 设置 Rest Basic Auth Client 配置
`void`	`setRestForm(Cas.RestForm restForm)` 设置 Rest 表单配置
`void`	`setTimeTolerance(Long timeTolerance)`

从类继承的方法 com.buession.springboot.pac4j.config.BaseConfig
getCustomProperties, setCustomProperties

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

- 字段详细资料
  - PREFIX
```
public static final String PREFIX
```
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - Cas
```
public Cas()
```
- 方法详细资料
  - getProtocol
```
public org.pac4j.cas.config.CasProtocol getProtocol()
```
    返回 CAS 协议
    
    返回:
    
    CAS 协议
  - setProtocol
```
public void setProtocol(org.pac4j.cas.config.CasProtocol protocol)
```
    设置 CAS 协议
    
    参数:
    
    protocol - CAS 协议
  - getLoginUrl
```
public String getLoginUrl()
```
    返回 CAS 登录地址
    
    返回:
    
    CAS 登录地址
  - setLoginUrl
```
public void setLoginUrl(String loginUrl)
```
    设置 CAS 登录地址
    
    参数:
    
    loginUrl - CAS 登录地址
  - getPrefixUrl
```
public String getPrefixUrl()
```
    返回 CAS URL 前缀
    
    返回:
    
    CAS URL 前缀
  - setPrefixUrl
```
public void setPrefixUrl(String prefixUrl)
```
    设置 CAS URL 前缀
    
    参数:
    
    prefixUrl - CAS URL 前缀
  - getCallbackUrl
```
public String getCallbackUrl()
```
    返回 CAS 登录成功跳转地址
    
    返回:
    
    CAS 登录成功跳转地址
  - setCallbackUrl
```
public void setCallbackUrl(String callbackUrl)
```
    设置 CAS 登录成功跳转地址
    
    参数:
    
    callbackUrl - CAS 登录成功跳转地址
  - getEncoding
```
public String getEncoding()
```
    返回编码
    
    返回:
    
    编码
  - setEncoding
```
public void setEncoding(String encoding)
```
    设置编码
    
    参数:
    
    encoding - 编码
  - getMethod
```
public String getMethod()
```
    返回请求方法
    
    返回:
    
    请求方法
  - setMethod
```
public void setMethod(String method)
```
    设置请求方法
    
    参数:
    
    method - 请求方法
  - getGateway
```
public Boolean getGateway()
```
    返回 Gateway
    
    返回:
    
    Gateway
  - setGateway
```
public void setGateway(Boolean gateway)
```
    设置 Gateway
    
    参数:
    
    gateway - Gateway
  - getRenew
```
public Boolean getRenew()
```
    返回是否重新认证
    
    返回:
    
    是否重新认证
  - setRenew
```
public void setRenew(Boolean renew)
```
    设置是否重新认证
    
    参数:
    
    renew - 是否重新认证
  - getTimeTolerance
```
public Long getTimeTolerance()
```
  - setTimeTolerance
```
public void setTimeTolerance(Long timeTolerance)
```
  - getPostLogoutUrlParameter
```
public String getPostLogoutUrlParameter()
```
    返回退出登录请求参数
    
    返回:
    
    退出登录请求参数
  - setPostLogoutUrlParameter
```
public void setPostLogoutUrlParameter(String postLogoutUrlParameter)
```
    设置退出登录请求参数
    
    参数:
    
    postLogoutUrlParameter - 退出登录请求参数
  - getProfileDefinition
```
public Class<org.pac4j.cas.profile.CasProfileDefinition> getProfileDefinition()
```
    返回 Profile 定义，可用于处理 CAS Server 登录返回字段
    
    返回:
    
    Profile 定义
  - setProfileDefinition
```
public void setProfileDefinition(Class<org.pac4j.cas.profile.CasProfileDefinition> profileDefinition)
```
    设置 Profile 定义，可用于处理 CAS Server 登录返回字段
    
    参数:
    
    profileDefinition - Profile 定义
  - getAuthorizationGenerator
```
public List<Class<org.pac4j.core.authorization.generator.AuthorizationGenerator>> getAuthorizationGenerator()
```
    返回授权生成器
    
    返回:
    
    授权生成器
  - setAuthorizationGenerator
```
public void setAuthorizationGenerator(List<Class<org.pac4j.core.authorization.generator.AuthorizationGenerator>> authorizationGenerator)
```
    设置授权生成器
    
    参数:
    
    authorizationGenerator - 授权生成器
  - getCustomParameters
```
public Map<String,String> getCustomParameters()
```
    返回客户自定义参数
    
    返回:
    
    客户自定义参数
  - setCustomParameters
```
public void setCustomParameters(Map<String,String> customParameters)
```
    设置客户自定义参数
    
    参数:
    
    customParameters - 客户自定义参数
  - getGeneral
```
public Cas.General getGeneral()
```
    返回常规配置
    
    返回:
    
    常规配置
  - setGeneral
```
public void setGeneral(Cas.General general)
```
    设置常规配置
    
    参数:
    
    general - 常规配置
  - getRestForm
```
public Cas.RestForm getRestForm()
```
    返回 Rest 表单配置
    
    返回:
    
    Rest 表单配置
  - setRestForm
```
public void setRestForm(Cas.RestForm restForm)
```
    设置 Rest 表单配置
    
    参数:
    
    restForm - Rest 表单配置
  - getDirect
```
public Cas.Direct getDirect()
```
    返回 Direct Client 配置
    
    返回:
    
    Direct Client 配置
  - setDirect
```
public void setDirect(Cas.Direct direct)
```
    设置 Direct Client 配置
    
    参数:
    
    direct - Direct Client 配置
  - getDirectProxy
```
public Cas.DirectProxy getDirectProxy()
```
    返回 Direct Proxy Client 配置
    
    返回:
    
    Direct Proxy Client 配置
  - setDirectProxy
```
public void setDirectProxy(Cas.DirectProxy directProxy)
```
    设置 Direct Proxy Client 配置
    
    参数:
    
    directProxy - Direct Proxy Client 配置
  - getRestBasicAuth
```
public Cas.RestBasicAuth getRestBasicAuth()
```
    返回 Rest Basic Auth Client 配置
    
    返回:
    
    Rest Basic Auth Client 配置
  - setRestBasicAuth
```
public void setRestBasicAuth(Cas.RestBasicAuth restBasicAuth)
```
    设置 Rest Basic Auth Client 配置
    
    参数:
    
    restBasicAuth - Rest Basic Auth Client 配置

类 Cas

嵌套类概要

从类继承的嵌套类/接口 com.buession.springboot.pac4j.config.BaseConfig

字段概要

从类继承的字段 com.buession.springboot.pac4j.config.BaseConfig

构造器概要

方法概要

从类继承的方法 com.buession.springboot.pac4j.config.BaseConfig

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

字段详细资料

PREFIX

构造器详细资料

Cas

方法详细资料

getProtocol

setProtocol

getLoginUrl

setLoginUrl

getPrefixUrl

setPrefixUrl

getCallbackUrl

setCallbackUrl

getEncoding

setEncoding

getMethod

setMethod

getGateway

setGateway

getRenew

setRenew

getTimeTolerance

setTimeTolerance

getPostLogoutUrlParameter

setPostLogoutUrlParameter

getProfileDefinition

setProfileDefinition

getAuthorizationGenerator

setAuthorizationGenerator

getCustomParameters

setCustomParameters

getGeneral

setGeneral

getRestForm

setRestForm

getDirect

setDirect

getDirectProxy

setDirectProxy

getRestBasicAuth

setRestBasicAuth