BTGSessionContext (btg-httpsession 3.0.3 API)

所有超级接口:

javax.servlet.http.HttpSessionContext, Serializable

所有已知实现类:

BTGStandardSessionContext
```
public interface BTGSessionContext
extends javax.servlet.http.HttpSessionContext, Serializable
```
session管理器接口，扩展自HttpSessionContext

方法概要

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

从接口继承的方法 javax.servlet.http.HttpSessionContext
getIds

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

接口 BTGSessionContext

方法概要

从接口继承的方法 javax.servlet.http.HttpSessionContext

方法详细资料

enableCache

disableCache

addSession

removeSession

getSession

getNewSession

refreshSession

active

getSessions

clearTimeout

checkSessionTimeout

clear

getSessionIdKey

setSessionIdKey

getSessionTimeoutMillis

setSessionTimeoutMillis

getMaxClearTimeoutMillis

setMaxClearTimeoutMillis

getSessionIdGenerator

setSessionIdGenerator

getSessionDao

setSessionDao

getServletContext

setServletContext

isUseCache

setUseCache