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 ------------------------------------------------------------------
| 限定符和类型 | 字段和说明 |
|---|---|
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() |
| 限定符和类型 | 方法和说明 |
|---|---|
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) |
public static final String SSO_TOKEN_ATTR
拦截器判断后设置 Token至当前请求,减少Token解密次数: request.setAttribute("ssotoken_attr", token)
使用获取方式: SSOHelper.attrToken(request)
public static final String SSO_COOKIE_MAXAGE
-1 浏览器关闭时自动删除 0 立即删除 120 表示Cookie有效期2分钟(以秒为单位)
public static final Charset CHARSET_ENCODING
public static SSOConfig getInstance()
public static void init(Properties props)
public static PropertiesUtil getSSOProperties()
public static String getSSOEncoding()
public String getRunMode()
-------------------- dev_mode 开发模式 test_mode 测试模式 online_mode 生产模式 --------------------
public void setRunMode(String runMode)
public String getRole()
该属性为跨域区分当前系统使用,与 token 变量应用系统 app 参数自动设置为该属性值。
该值非空则自动开启跨域功能,单点登录系统名必须设置为 sso.role=sso
public void setRole(String role)
public String getEncoding()
public void setEncoding(String encoding)
public String getSecretkey()
public void setSecretkey(String secretkey)
public String getCookieName()
public void setCookieName(String cookieName)
public String getCookieDomain()
public void setCookieDomain(String cookieDomain)
public String getCookiePath()
public void setCookiePath(String cookiePath)
public boolean getCookieSecure()
public void setCookieSecure(boolean cookieSecure)
public boolean getCookieHttponly()
public void setCookieHttponly(boolean cookieHttponly)
public int getCookieMaxage()
-1 浏览器关闭时自动删除 0 立即删除 120 表示Cookie有效期2分钟(以秒为单位)
public void setCookieMaxage(int cookieMaxage)
public boolean getCookieBrowser()
public void setCookieBrowser(boolean cookieBrowser)
public boolean getCookieCheckip()
public void setCookieCheckip(boolean cookieCheckip)
public String getLoginUrl()
public void setLoginUrl(String loginUrl)
public String getLogoutUrl()
public void setLogoutUrl(String logoutUrl)
public String getParamReturl()
默认:ReturnURL
public void setParamReturl(String paramReturl)
public String getAuthCookieName()
public void setAuthCookieName(String authCookieName)
public int getAuthCookieMaxage()
-1 浏览器关闭时自动删除 0 立即删除 120 表示Cookie有效期2分钟(以秒为单位)
public void setAuthCookieMaxage(int authCookieMaxage)
public Token getToken()
public void setToken(Token token)
public SSOParser getParser()
public void setParser(SSOParser parser)
public SSOEncrypt getEncrypt()
public void setEncrypt(SSOEncrypt encrypt)
public SSOCache getCache()
public void setCache(SSOCache cache)
public int getCacheExpires()
缓存过期时间,小于0不过期,单位时间 s 秒
设置缓存Token 如缓存不存在将自动退出登录
public void setCacheExpires(int cacheExpires)
public SSOStatistic getStatistic()
public void setStatistic(SSOStatistic statistic)
Copyright © 2016. All rights reserved.