BTGSessionPlugin (btg-httpsession 4.0.11 API)

java.lang.Object
- cn.zcltd.btg.httpsession.servlet.plugin.BTGSessionPlugin

所有已实现的接口:: com.jfinal.plugin.IPlugin

public class BTGSessionPlugin
extends Object
implements com.jfinal.plugin.IPlugin

BTG httpsession jfinal插件

构造器概要

构造器
构造器和说明

BTGSessionPlugin()

BTGSessionPlugin(BTGSessionDao sessionDao)

构造器
构造器和说明
`BTGSessionPlugin()`
`BTGSessionPlugin(BTGSessionDao sessionDao)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`active(BTGSession session)` 激活session
`void`	`addSession(BTGSession session)` 添加一个session
`void`	`clear()` 清空session容器
`void`	`clearTimeout()` 清理超时的session
`void`	`disableCache()` 禁用二级缓存
`void`	`enableCache()` 启用二级缓存
`int`	`getMaxClearTimeoutSeconds()` 获取过期session清理机制触发周期(毫秒)
`int`	`getMaxUpdateLastActiveTimeSeconds()` 获取session最后访问时间同步更新机制触发周期(秒)
`BTGSession`	`getNewSession()` 获取一个新的session
`javax.servlet.ServletContext`	`getServletContext()` 获取ServletContext
`BTGSession`	`getSession(String sessionId)` 根据session id获取一个session
`BTGStandardSessionContext`	`getSessionContext()` 获取SessionContext
`BTGStandardSessionContext`	`getSessionContext(javax.servlet.ServletContext servletContext)` 获取SessionContext
`BTGStandardSessionContext`	`getSessionContext(javax.servlet.ServletContext servletContext, BTGSessionDao sessionDao)` 获取SessionContext
`String`	`getSessionCookiePath()` 获取session cookie默认path
`BTGSessionDao`	`getSessionDao()` 获取session存储器
`BTGSessionIdGenerator`	`getSessionIdGenerator()` 获取sessionId生成器
`String`	`getSessionIdKey()` 获取session id名称key
`Hashtable<String,BTGSession>`	`getSessions()` 获取所有session
`int`	`getSessionTimeoutSeconds()` 获取session超时时间
`boolean`	`isDisableSimpleSSO()` 获取是否禁用简单单点登录
`boolean`	`isUseCache()` 获取是否使用缓存
`void`	`refreshSession(BTGSession session)` 刷新一个session
`void`	`removeSession(String sessionId)` 根据session id移除一个session
`void`	`setDisableSimpleSSO(boolean disableSimpleSSO)` 设置是否禁用简单单点登录
`void`	`setMaxClearTimeoutSeconds(int maxClearTimeoutSeconds)` 设置过期session清理机制触发周期(毫秒)
`void`	`setMaxUpdateLastActiveTimeSeconds(int maxUpdateLastActiveTimeSeconds)` 设置session最后访问时间同步更新机制触发周期(秒)
`void`	`setServletContext(javax.servlet.ServletContext servletContext)` 设置ServletContext
`void`	`setSessionCookiePath(String sessionCookiePath)` 设置session cookie默认path
`void`	`setSessionDao(BTGSessionDao sessionDao)` 设置session存储器
`void`	`setSessionIdGenerator(BTGSessionIdGenerator sessionIdGenerator)` 设置sessionId生成器
`void`	`setSessionIdKey(String sessionIdKey)` 设置session id名称key
`void`	`setSessionTimeoutSeconds(int sessionTimeoutSeconds)` 设置session超时时间
`void`	`setUseCache(boolean useCache)` 设置是否使用缓存
`boolean`	`start()`
`boolean`	`stop()`

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

- 构造器详细资料
  - BTGSessionPlugin
```
public BTGSessionPlugin()
```
  - BTGSessionPlugin
```
public BTGSessionPlugin(BTGSessionDao sessionDao)
```
- 方法详细资料
  - start
```
public boolean start()
```
    指定者:
    
    start 在接口中 com.jfinal.plugin.IPlugin
  - stop
```
public boolean stop()
```
    指定者:
    
    stop 在接口中 com.jfinal.plugin.IPlugin
  - getSessionContext
```
public BTGStandardSessionContext getSessionContext()
```
    获取SessionContext
    
    返回:
    
    SessionKit
  - getSessionContext
```
public BTGStandardSessionContext getSessionContext(javax.servlet.ServletContext servletContext)
```
    获取SessionContext
    
    参数:
    
    servletContext - servletContext
    
    返回:
    
    SessionKit
  - getSessionContext
```
public BTGStandardSessionContext getSessionContext(javax.servlet.ServletContext servletContext,
                                                   BTGSessionDao sessionDao)
```
    获取SessionContext
    
    参数:
    
    servletContext - servletContext
    
    sessionDao - sessionDao
    
    返回:
    
    SessionKit
  - enableCache
```
public void enableCache()
```
    启用二级缓存
  - disableCache
```
public void disableCache()
```
    禁用二级缓存
  - addSession
```
public void addSession(BTGSession session)
```
    添加一个session
    
    参数:
    
    session - BTGSession
  - removeSession
```
public void removeSession(String sessionId)
```
    根据session id移除一个session
    
    参数:
    
    sessionId - String
  - refreshSession
```
public void refreshSession(BTGSession session)
```
    刷新一个session
    
    参数:
    
    session - BTGSession
  - getSession
```
public BTGSession getSession(String sessionId)
```
    根据session id获取一个session
    
    参数:
    
    sessionId - String
    
    返回:
    
    String
  - getNewSession
```
public BTGSession getNewSession()
```
    获取一个新的session
    
    返回:
    
    BTGSession
  - active
```
public void active(BTGSession session)
```
    激活session
    
    参数:
    
    session - session
  - getSessions
```
public Hashtable<String,BTGSession> getSessions()
```
    获取所有session
    
    返回:
    
    Hashtable
  - clearTimeout
```
public void clearTimeout()
```
    清理超时的session
  - clear
```
public void clear()
```
    清空session容器
  - getSessionIdKey
```
public String getSessionIdKey()
```
    获取session id名称key
    
    返回:
    
    String
  - setSessionIdKey
```
public void setSessionIdKey(String sessionIdKey)
```
    设置session id名称key
    
    参数:
    
    sessionIdKey - String
  - getSessionTimeoutSeconds
```
public int getSessionTimeoutSeconds()
```
    获取session超时时间
    
    返回:
    
    int
  - setSessionTimeoutSeconds
```
public void setSessionTimeoutSeconds(int sessionTimeoutSeconds)
```
    设置session超时时间
    
    参数:
    
    sessionTimeoutSeconds - long
  - getSessionCookiePath
```
public String getSessionCookiePath()
```
    获取session cookie默认path
    
    返回:
    
    String String
  - setSessionCookiePath
```
public void setSessionCookiePath(String sessionCookiePath)
```
    设置session cookie默认path
    
    参数:
    
    sessionCookiePath - session cookie默认path
  - isDisableSimpleSSO
```
public boolean isDisableSimpleSSO()
```
    获取是否禁用简单单点登录
    
    返回:
    
    boolean boolean
  - setDisableSimpleSSO
```
public void setDisableSimpleSSO(boolean disableSimpleSSO)
```
    设置是否禁用简单单点登录
    
    参数:
    
    disableSimpleSSO - disableSimpleSSO
  - getMaxClearTimeoutSeconds
```
public int getMaxClearTimeoutSeconds()
```
    获取过期session清理机制触发周期(毫秒)
    
    返回:
    
    int
  - setMaxClearTimeoutSeconds
```
public void setMaxClearTimeoutSeconds(int maxClearTimeoutSeconds)
```
    设置过期session清理机制触发周期(毫秒)
    
    参数:
    
    maxClearTimeoutSeconds - int
  - getMaxUpdateLastActiveTimeSeconds
```
public int getMaxUpdateLastActiveTimeSeconds()
```
    获取session最后访问时间同步更新机制触发周期(秒)
    
    返回:
    
    触发周期(秒)
  - setMaxUpdateLastActiveTimeSeconds
```
public void setMaxUpdateLastActiveTimeSeconds(int maxUpdateLastActiveTimeSeconds)
```
    设置session最后访问时间同步更新机制触发周期(秒)
    
    参数:
    
    maxUpdateLastActiveTimeSeconds - 触发周期(秒)
  - getSessionIdGenerator
```
public BTGSessionIdGenerator getSessionIdGenerator()
```
    获取sessionId生成器
    
    返回:
    
    BTGSessionIdGenerator
  - setSessionIdGenerator
```
public void setSessionIdGenerator(BTGSessionIdGenerator sessionIdGenerator)
```
    设置sessionId生成器
    
    参数:
    
    sessionIdGenerator - BTGSessionIdGenerator
  - getSessionDao
```
public BTGSessionDao getSessionDao()
```
    获取session存储器
    
    返回:
    
    BTGSessionDao
  - setSessionDao
```
public void setSessionDao(BTGSessionDao sessionDao)
```
    设置session存储器
    
    参数:
    
    sessionDao - BTGSessionDao
  - getServletContext
```
public javax.servlet.ServletContext getServletContext()
```
    获取ServletContext
    
    返回:
    
    ServletContext
  - setServletContext
```
public void setServletContext(javax.servlet.ServletContext servletContext)
```
    设置ServletContext
    
    参数:
    
    servletContext - ServletContext
  - isUseCache
```
public boolean isUseCache()
```
    获取是否使用缓存
    
    返回:
    
    是否使用缓存
  - setUseCache
```
public void setUseCache(boolean useCache)
```
    设置是否使用缓存
    
    参数:
    
    useCache - 是否使用缓存

类 BTGSessionPlugin

构造器概要

方法概要

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

构造器详细资料

BTGSessionPlugin

BTGSessionPlugin

方法详细资料

start

stop

getSessionContext

getSessionContext

getSessionContext

enableCache

disableCache

addSession

removeSession

refreshSession

getSession

getNewSession

active

getSessions

clearTimeout

clear

getSessionIdKey

setSessionIdKey

getSessionTimeoutSeconds

setSessionTimeoutSeconds

getSessionCookiePath

setSessionCookiePath

isDisableSimpleSSO

setDisableSimpleSSO

getMaxClearTimeoutSeconds

setMaxClearTimeoutSeconds

getMaxUpdateLastActiveTimeSeconds

setMaxUpdateLastActiveTimeSeconds

getSessionIdGenerator

setSessionIdGenerator

getSessionDao

setSessionDao

getServletContext

setServletContext

isUseCache

setUseCache