SessionKit (btg-httpsession 3.0.3 API)

java.lang.Object
- cn.zcltd.btg.httpsession.kit.SessionKit

```
public class SessionKit
extends Object
```
session操作工具类，提供BTGStandardSessionContext的静态访问接口

构造器概要

构造器
构造器和说明

SessionKit()

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

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static void`	`active(BTGSession session)` 激活session
`static void`	`addSession(BTGSession session)` 添加一个session
`static void`	`checkSessionTimeout()` session清理算法机制： 1、设置清理周期，默认为30分钟； 2、非绝对清理，当触发了addSession、removeSession、refreshSession、getSession、getNewSession、active时触发清理机制； 3、通过调用clearTimeout手动清理；
`static void`	`clear()` 清空session容器
`static void`	`clearTimeout()` 清理超时的session
`static void`	`disableCache()` 禁用二级缓存
`static void`	`enableCache()` 启用二级缓存
`static int`	`getMaxClearTimeoutMillis()` 获取过期session清理机制触发周期(毫秒)
`static BTGSession`	`getNewSession()` 获取一个新的session
`static javax.servlet.ServletContext`	`getServletContext()` 获取ServletContext
`static BTGSession`	`getSession(String sessionId)` 根据session id获取一个session
`static BTGStandardSessionContext`	`getSessionContext()` 获取SessionContext
`static BTGStandardSessionContext`	`getSessionContext(javax.servlet.ServletContext servletContext)` 获取SessionContext
`static BTGStandardSessionContext`	`getSessionContext(javax.servlet.ServletContext servletContext, BTGSessionDao sessionDao)` 获取SessionContext
`static String`	`getSessionCookiePath()` 获取session cookie默认path
`static BTGSessionDao`	`getSessionDao()` 获取session存储器
`static BTGSessionIdGenerator`	`getSessionIdGenerator()` 获取sessionId生成器
`static String`	`getSessionIdKey()` 获取session id名称key
`static Hashtable<String,BTGSession>`	`getSessions()` 获取所有session
`static int`	`getSessionTimeoutMillis()` 获取session超时时间
`static boolean`	`isDisableSimpleSSO()` 获取是否禁用简单单点登录
`static void`	`refreshSession(BTGSession session)` 刷新一个session
`static void`	`removeSession(String sessionId)` 根据session id移除一个session
`static void`	`setDisableSimpleSSO(boolean disableSimpleSSO)` 设置是否禁用简单单点登录
`static void`	`setMaxClearTimeoutMillis(int maxClearTimeoutMillis)` 设置过期session清理机制触发周期(毫秒)
`static void`	`setServletContext(javax.servlet.ServletContext servletContext)` 设置ServletContext
`static void`	`setSessionCookiePath(String sessionCookiePath)` 设置session cookie默认path
`static void`	`setSessionDao(BTGSessionDao sessionDao)` 设置session存储器
`static void`	`setSessionIdGenerator(BTGSessionIdGenerator sessionIdGenerator)` 设置sessionId生成器
`static void`	`setSessionIdKey(String sessionIdKey)` 设置session id名称key
`static void`	`setSessionTimeoutMillis(int sessionTimeout)` 设置session超时时间

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

- 构造器详细资料
  - SessionKit
```
public SessionKit()
```
- 方法详细资料
  - enableCache
```
public static void enableCache()
```
    启用二级缓存
  - disableCache
```
public static void disableCache()
```
    禁用二级缓存
  - getSessionContext
```
public static BTGStandardSessionContext getSessionContext()
```
    获取SessionContext
    
    返回:
    
    BTGStandardSessionContext
  - getSessionContext
```
public static BTGStandardSessionContext getSessionContext(javax.servlet.ServletContext servletContext)
```
    获取SessionContext
    
    参数:
    
    servletContext - servletContext
    
    返回:
    
    BTGStandardSessionContext
  - getSessionContext
```
public static BTGStandardSessionContext getSessionContext(javax.servlet.ServletContext servletContext,
                                                          BTGSessionDao sessionDao)
```
    获取SessionContext
    
    参数:
    
    servletContext - servletContext
    
    sessionDao - sessionDao
    
    返回:
    
    BTGStandardSessionContext
  - addSession
```
public static void addSession(BTGSession session)
```
    添加一个session
    
    参数:
    
    session - BTGSession
  - removeSession
```
public static void removeSession(String sessionId)
```
    根据session id移除一个session
    
    参数:
    
    sessionId - String
  - getSession
```
public static BTGSession getSession(String sessionId)
```
    根据session id获取一个session
    
    参数:
    
    sessionId - String
    
    返回:
    
    String
  - getNewSession
```
public static BTGSession getNewSession()
```
    获取一个新的session
    
    返回:
    
    BTGSession
  - refreshSession
```
public static void refreshSession(BTGSession session)
```
    刷新一个session
    
    参数:
    
    session - BTGSession
  - active
```
public static void active(BTGSession session)
```
    激活session
    
    参数:
    
    session - session
  - getSessions
```
public static Hashtable<String,BTGSession> getSessions()
```
    获取所有session
    
    返回:
    
    Hashtable
  - clearTimeout
```
public static void clearTimeout()
```
    清理超时的session
  - checkSessionTimeout
```
public static void checkSessionTimeout()
```
    session清理算法机制： 1、设置清理周期，默认为30分钟； 2、非绝对清理，当触发了addSession、removeSession、refreshSession、getSession、getNewSession、active时触发清理机制； 3、通过调用clearTimeout手动清理；
  - clear
```
public static void clear()
```
    清空session容器
  - getSessionIdKey
```
public static String getSessionIdKey()
```
    获取session id名称key
    
    返回:
    
    String
  - setSessionIdKey
```
public static void setSessionIdKey(String sessionIdKey)
```
    设置session id名称key
    
    参数:
    
    sessionIdKey - String
  - getSessionTimeoutMillis
```
public static int getSessionTimeoutMillis()
```
    获取session超时时间
    
    返回:
    
    int
  - setSessionTimeoutMillis
```
public static void setSessionTimeoutMillis(int sessionTimeout)
```
    设置session超时时间
    
    参数:
    
    sessionTimeout - long
  - getSessionCookiePath
```
public static String getSessionCookiePath()
```
    获取session cookie默认path
    
    返回:
    
    String String
  - setSessionCookiePath
```
public static void setSessionCookiePath(String sessionCookiePath)
```
    设置session cookie默认path
    
    参数:
    
    sessionCookiePath - session cookie默认path
  - isDisableSimpleSSO
```
public static boolean isDisableSimpleSSO()
```
    获取是否禁用简单单点登录
    
    返回:
    
    boolean boolean
  - setDisableSimpleSSO
```
public static void setDisableSimpleSSO(boolean disableSimpleSSO)
```
    设置是否禁用简单单点登录
    
    参数:
    
    disableSimpleSSO - disableSimpleSSO
  - getMaxClearTimeoutMillis
```
public static int getMaxClearTimeoutMillis()
```
    获取过期session清理机制触发周期(毫秒)
    
    返回:
    
    int
  - setMaxClearTimeoutMillis
```
public static void setMaxClearTimeoutMillis(int maxClearTimeoutMillis)
```
    设置过期session清理机制触发周期(毫秒)
    
    参数:
    
    maxClearTimeoutMillis - int
  - getSessionIdGenerator
```
public static BTGSessionIdGenerator getSessionIdGenerator()
```
    获取sessionId生成器
    
    返回:
    
    BTGSessionIdGenerator
  - setSessionIdGenerator
```
public static void setSessionIdGenerator(BTGSessionIdGenerator sessionIdGenerator)
```
    设置sessionId生成器
    
    参数:
    
    sessionIdGenerator - BTGSessionIdGenerator
  - getSessionDao
```
public static BTGSessionDao getSessionDao()
```
    获取session存储器
    
    返回:
    
    BTGSessionDao
  - setSessionDao
```
public static void setSessionDao(BTGSessionDao sessionDao)
```
    设置session存储器
    
    参数:
    
    sessionDao - BTGSessionDao
  - getServletContext
```
public static javax.servlet.ServletContext getServletContext()
```
    获取ServletContext
    
    返回:
    
    ServletContext
  - setServletContext
```
public static void setServletContext(javax.servlet.ServletContext servletContext)
```
    设置ServletContext
    
    参数:
    
    servletContext - ServletContext

类 SessionKit

构造器概要

方法概要

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

构造器详细资料

SessionKit

方法详细资料

enableCache

disableCache

getSessionContext

getSessionContext

getSessionContext

addSession

removeSession

getSession

getNewSession

refreshSession

active

getSessions

clearTimeout

checkSessionTimeout

clear

getSessionIdKey

setSessionIdKey

getSessionTimeoutMillis

setSessionTimeoutMillis

getSessionCookiePath

setSessionCookiePath

isDisableSimpleSSO

setDisableSimpleSSO

getMaxClearTimeoutMillis

setMaxClearTimeoutMillis

getSessionIdGenerator

setSessionIdGenerator

getSessionDao

setSessionDao

getServletContext

setServletContext