SSOConfig (kisso 3.5.3 API)

java.lang.Object
- com.baomidou.kisso.SSOConfig

```
public class SSOConfig
extends Object
```
SSO 配置文件解析

按照不同的运行模式启用相应的配置默认开发环境，调试方式 Eclipse 环境的 VM 参数中加上 -Dsso.run.mode=dev_mode 例如： ------------------------------------------------------------------ sso.login.url_online_mode=http://sso.online.com/login.html sso.login.url_test_mode=http://sso.test.com/login.html sso.login.url_dev_mode=http://localhost:8080/login.html ------------------------------------------------------------------

作者:

hubin

字段概要

字段
限定符和类型	字段和说明
`static Charset`	`CHARSET_ENCODING` Charset 类型编码格式
`static String`	`CUT_SYMBOL`
`static String`	`SSO_COOKIE_MAXAGE` SSO 动态设置 Cookie 参数 -1 浏览器关闭时自动删除 0 立即删除 120 表示Cookie有效期2分钟(以秒为单位)
`static String`	`SSO_TOKEN_ATTR` 拦截器判断后设置 Token至当前请求，减少Token解密次数： request.setAttribute("ssotoken_attr", token) 使用获取方式： SSOHelper.attrToken(request)

构造器概要

构造器
限定符构造器和说明

protected SSOConfig()

构造器
限定符	构造器和说明
`protected`	`SSOConfig()`

方法概要

方法
限定符和类型	方法和说明
`int`	`getAuthCookieMaxage()` 跨域 AuthCookie 超时时间 -1 浏览器关闭时自动删除 0 立即删除 120 表示Cookie有效期2分钟(以秒为单位)
`String`	`getAuthCookieName()` 跨域 AuthCookie 名称
`SSOCache`	`getCache()` 自定义 SSOCache Class
`int`	`getCacheExpires()` 自定义SSOCache Expires 缓存过期时间，小于0不过期，单位时间 s 秒设置缓存Token 如缓存不存在将自动退出登录
`boolean`	`getCookieBrowser()` Cookie 开启浏览器版本校验
`boolean`	`getCookieCheckip()` Cookie 开启IP校验
`String`	`getCookieDomain()` Cookie 所在域
`boolean`	`getCookieHttponly()` Cookie 只读, 不允许 Js访问
`int`	`getCookieMaxage()` Cookie 超时时间 -1 浏览器关闭时自动删除 0 立即删除 120 表示Cookie有效期2分钟(以秒为单位)
`String`	`getCookieName()` Cookie 名称
`String`	`getCookiePath()` Cookie 域路径
`boolean`	`getCookieSecure()` Cookie 只允许https协议传输
`String`	`getEncoding()` 编码格式默认 UTF-8
`SSOEncrypt`	`getEncrypt()` 自定义 SSOEncrypt Class
`static SSOConfig`	`getInstance()` new 当前对象
`String`	`getLoginUrl()` SSO 登录地址
`String`	`getLogoutUrl()` SSO 退出地址
`String`	`getParamReturl()` SSO 跳转参数命名默认：ReturnURL
`SSOParser`	`getParser()` 自定义 SSOParser Class
`String`	`getRole()` 系统角色（默认空）该属性为跨域区分当前系统使用，与 token 变量应用系统 app 参数自动设置为该属性值。
`String`	`getRunMode()` SSO 配置模式 -------------------- dev_mode 开发模式 test_mode 测试模式 online_mode 生产模式 --------------------
`String`	`getSecretkey()` 密钥
`static String`	`getSSOEncoding()` SSO 当前编码格式
`static PropertiesUtil`	`getSSOProperties()` SSO 配置工具类
`SSOStatistic`	`getStatistic()` 自定义 SSOStatistic Class
`Token`	`getToken()` 自定义 Token Class
`static void`	`init(Properties props)` SSO 资源文件初始化
`void`	`setAuthCookieMaxage(int authCookieMaxage)`
`void`	`setAuthCookieName(String authCookieName)`
`void`	`setCache(SSOCache cache)`
`void`	`setCacheExpires(int cacheExpires)`
`void`	`setCookieBrowser(boolean cookieBrowser)`
`void`	`setCookieCheckip(boolean cookieCheckip)`
`void`	`setCookieDomain(String cookieDomain)`
`void`	`setCookieHttponly(boolean cookieHttponly)`
`void`	`setCookieMaxage(int cookieMaxage)`
`void`	`setCookieName(String cookieName)`
`void`	`setCookiePath(String cookiePath)`
`void`	`setCookieSecure(boolean cookieSecure)`
`void`	`setEncoding(String encoding)`
`void`	`setEncrypt(SSOEncrypt encrypt)`
`void`	`setLoginUrl(String loginUrl)`
`void`	`setLogoutUrl(String logoutUrl)`
`void`	`setParamReturl(String paramReturl)`
`void`	`setParser(SSOParser parser)`
`void`	`setRole(String role)`
`void`	`setRunMode(String runMode)`
`void`	`setSecretkey(String secretkey)`
`void`	`setStatistic(SSOStatistic statistic)`
`void`	`setToken(Token token)`

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

- 字段详细资料
  - SSO_TOKEN_ATTR
```
public static final String SSO_TOKEN_ATTR
```
    拦截器判断后设置 Token至当前请求，减少Token解密次数： request.setAttribute("ssotoken_attr", token)
    
    使用获取方式： SSOHelper.attrToken(request)
    
    另请参阅:
    常量字段值
  - SSO_COOKIE_MAXAGE
```
public static final String SSO_COOKIE_MAXAGE
```
    SSO 动态设置 Cookie 参数
    -1 浏览器关闭时自动删除 0 立即删除 120 表示Cookie有效期2分钟(以秒为单位)
    
    另请参阅:
    常量字段值
  - CHARSET_ENCODING
```
public static final Charset CHARSET_ENCODING
```
    Charset 类型编码格式
  - CUT_SYMBOL
```
public static final String CUT_SYMBOL
```
    另请参阅:
    常量字段值
- 构造器详细资料
  - SSOConfig
```
protected SSOConfig()
```
- 方法详细资料
  - getInstance
```
public static SSOConfig getInstance()
```
    new 当前对象
  - init
```
public static void init(Properties props)
```
    SSO 资源文件初始化
  - getSSOProperties
```
public static PropertiesUtil getSSOProperties()
```
    SSO 配置工具类
    
    返回:
    PropertiesUtil
  - getSSOEncoding
```
public static String getSSOEncoding()
```
    SSO 当前编码格式
  - getRunMode
```
public String getRunMode()
```
    SSO 配置模式
    -------------------- dev_mode 开发模式 test_mode 测试模式 online_mode 生产模式 --------------------
  - setRunMode
```
public void setRunMode(String runMode)
```
  - getRole
```
public String getRole()
```
    系统角色（默认空）
    该属性为跨域区分当前系统使用，与 token 变量应用系统 app 参数自动设置为该属性值。
    
    该值非空则自动开启跨域功能，单点登录系统名必须设置为 sso.role=sso
  - setRole
```
public void setRole(String role)
```
  - getEncoding
```
public String getEncoding()
```
    编码格式默认 UTF-8
  - setEncoding
```
public void setEncoding(String encoding)
```
  - getSecretkey
```
public String getSecretkey()
```
    密钥
  - setSecretkey
```
public void setSecretkey(String secretkey)
```
  - getCookieName
```
public String getCookieName()
```
    Cookie 名称
  - setCookieName
```
public void setCookieName(String cookieName)
```
  - getCookieDomain
```
public String getCookieDomain()
```
    Cookie 所在域
  - setCookieDomain
```
public void setCookieDomain(String cookieDomain)
```
  - getCookiePath
```
public String getCookiePath()
```
    Cookie 域路径
  - setCookiePath
```
public void setCookiePath(String cookiePath)
```
  - getCookieSecure
```
public boolean getCookieSecure()
```
    Cookie 只允许https协议传输
  - setCookieSecure
```
public void setCookieSecure(boolean cookieSecure)
```
  - getCookieHttponly
```
public boolean getCookieHttponly()
```
    Cookie 只读, 不允许 Js访问
  - setCookieHttponly
```
public void setCookieHttponly(boolean cookieHttponly)
```
  - getCookieMaxage
```
public int getCookieMaxage()
```
    Cookie 超时时间
    -1 浏览器关闭时自动删除 0 立即删除 120 表示Cookie有效期2分钟(以秒为单位)
  - setCookieMaxage
```
public void setCookieMaxage(int cookieMaxage)
```
  - getCookieBrowser
```
public boolean getCookieBrowser()
```
    Cookie 开启浏览器版本校验
  - setCookieBrowser
```
public void setCookieBrowser(boolean cookieBrowser)
```
  - getCookieCheckip
```
public boolean getCookieCheckip()
```
    Cookie 开启IP校验
  - setCookieCheckip
```
public void setCookieCheckip(boolean cookieCheckip)
```
  - getLoginUrl
```
public String getLoginUrl()
```
    SSO 登录地址
  - setLoginUrl
```
public void setLoginUrl(String loginUrl)
```
  - getLogoutUrl
```
public String getLogoutUrl()
```
    SSO 退出地址
  - setLogoutUrl
```
public void setLogoutUrl(String logoutUrl)
```
  - getParamReturl
```
public String getParamReturl()
```
    SSO 跳转参数命名
    默认：ReturnURL
  - setParamReturl
```
public void setParamReturl(String paramReturl)
```
  - getAuthCookieName
```
public String getAuthCookieName()
```
    跨域 AuthCookie 名称
  - setAuthCookieName
```
public void setAuthCookieName(String authCookieName)
```
  - getAuthCookieMaxage
```
public int getAuthCookieMaxage()
```
    跨域 AuthCookie 超时时间
    -1 浏览器关闭时自动删除 0 立即删除 120 表示Cookie有效期2分钟(以秒为单位)
  - setAuthCookieMaxage
```
public void setAuthCookieMaxage(int authCookieMaxage)
```
  - getToken
```
public Token getToken()
```
    自定义 Token Class
  - setToken
```
public void setToken(Token token)
```
  - getParser
```
public SSOParser getParser()
```
    自定义 SSOParser Class
  - setParser
```
public void setParser(SSOParser parser)
```
  - getEncrypt
```
public SSOEncrypt getEncrypt()
```
    自定义 SSOEncrypt Class
  - setEncrypt
```
public void setEncrypt(SSOEncrypt encrypt)
```
  - getCache
```
public SSOCache getCache()
```
    自定义 SSOCache Class
  - setCache
```
public void setCache(SSOCache cache)
```
  - getCacheExpires
```
public int getCacheExpires()
```
    自定义SSOCache Expires
    缓存过期时间，小于0不过期，单位时间 s 秒
    
    设置缓存Token 如缓存不存在将自动退出登录
  - setCacheExpires
```
public void setCacheExpires(int cacheExpires)
```
  - getStatistic
```
public SSOStatistic getStatistic()
```
    自定义 SSOStatistic Class
  - setStatistic
```
public void setStatistic(SSOStatistic statistic)
```

类 SSOConfig

字段概要

构造器概要

方法概要

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

字段详细资料

SSO_TOKEN_ATTR

SSO_COOKIE_MAXAGE

CHARSET_ENCODING

CUT_SYMBOL

构造器详细资料

SSOConfig

方法详细资料

getInstance

init

getSSOProperties

getSSOEncoding

getRunMode

setRunMode

getRole

setRole

getEncoding

setEncoding

getSecretkey

setSecretkey

getCookieName

setCookieName

getCookieDomain

setCookieDomain

getCookiePath

setCookiePath

getCookieSecure

setCookieSecure

getCookieHttponly

setCookieHttponly

getCookieMaxage

setCookieMaxage

getCookieBrowser

setCookieBrowser

getCookieCheckip

setCookieCheckip

getLoginUrl

setLoginUrl

getLogoutUrl

setLogoutUrl

getParamReturl

setParamReturl

getAuthCookieName

setAuthCookieName

getAuthCookieMaxage

setAuthCookieMaxage

getToken

setToken

getParser

setParser

getEncrypt

setEncrypt

getCache

setCache

getCacheExpires

setCacheExpires

getStatistic

setStatistic