CacheHttpSession (com.yuweix:assist4j-session 1.0.0 API)

java.lang.Object
- com.yuweix.assist4j.session.CacheHttpSession

All Implemented Interfaces:

javax.servlet.http.HttpSession
```
public class CacheHttpSession
extends Object
implements javax.servlet.http.HttpSession
```
一个HttpSession的实现，实际的属性会储存在指定的缓存实现中。

Author:

yuwei

Constructor Summary

Constructors
Constructor and Description

CacheHttpSession(String id)
初始化时必须指定一个id字符串和缓存引擎实现。

Constructors
Constructor and Description
`CacheHttpSession(String id)` 初始化时必须指定一个id字符串和缓存引擎实现。

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`access()` 表示此Session被访问。
`boolean`	`equals(Object obj)`
`Object`	`getAttribute(String attributeName)` 获取属性值。
`Enumeration<String>`	`getAttributeNames()`
`long`	`getCreationTime()` 获取此Session的创建时间。
`String`	`getId()` 此Session的ID值。这里返回存入cache的key值
`long`	`getLastAccessedTime()` 获取最后访问时间。
`int`	`getMaxInactiveInterval()`
`javax.servlet.ServletContext`	`getServletContext()`
`SessionAttribute`	`getSessionAttribute()` 获取当前的属性键值对。
`javax.servlet.http.HttpSessionContext`	`getSessionContext()`
`Object`	`getValue(String name)`
`String[]`	`getValueNames()`
`int`	`hashCode()`
`void`	`invalidate()` Session过期。
`boolean`	`isInvalid()` 判断是否已经超过了最大活动时间。
`boolean`	`isNew()` 判断此Session是否为新的。
`void`	`putValue(String name, Object value)`
`void`	`removeAttribute(String attributeName)` 移除已有的属性。
`void`	`removeSessionFromCache()`
`void`	`removeValue(String name)`
`void`	`setAttribute(String attributeName, Object attributeValue)` 更新属性。
`void`	`setMaxInactiveInterval(int interval)`
`String`	`sync()` 更新当前Session至缓存。如果已经失效，从缓存中删除。

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CacheHttpSession
```
public CacheHttpSession(String id)
```
    初始化时必须指定一个id字符串和缓存引擎实现。
    
    Parameters:
    
    id - id字符串。
- Method Detail
  - getId
```
public String getId()
```
    此Session的ID值。这里返回存入cache的key值
    
    Specified by:
    
    getId in interface javax.servlet.http.HttpSession
    
    Returns:
    
    id值。
  - getCreationTime
```
public long getCreationTime()
```
    获取此Session的创建时间。
    
    Specified by:
    
    getCreationTime in interface javax.servlet.http.HttpSession
    
    Returns:
    
    创建时间。
  - getLastAccessedTime
```
public long getLastAccessedTime()
```
    获取最后访问时间。
    
    Specified by:
    
    getLastAccessedTime in interface javax.servlet.http.HttpSession
    
    Returns:
    
    最后访问时间。
  - getSessionAttribute
```
public SessionAttribute getSessionAttribute()
```
    获取当前的属性键值对。
    
    Returns:
    
    属性键值对。
  - access
```
public void access()
```
    表示此Session被访问。
  - setMaxInactiveInterval
```
public void setMaxInactiveInterval(int interval)
```
    Specified by:
    
    setMaxInactiveInterval in interface javax.servlet.http.HttpSession
    
    Parameters:
    
    interval - 秒
  - getMaxInactiveInterval
```
public int getMaxInactiveInterval()
```
    Specified by:
    
    getMaxInactiveInterval in interface javax.servlet.http.HttpSession
  - getAttribute
```
public Object getAttribute(String attributeName)
```
    获取属性值。
    
    Specified by:
    
    getAttribute in interface javax.servlet.http.HttpSession
    
    Parameters:
    
    attributeName - 属性名称。
    
    Returns:
    
    属性值。
  - setAttribute
```
public void setAttribute(String attributeName,
                         Object attributeValue)
```
    更新属性。
    
    Specified by:
    
    setAttribute in interface javax.servlet.http.HttpSession
    
    Parameters:
    
    attributeName - 属性名称。
    
    attributeValue - 属性值。
  - removeAttribute
```
public void removeAttribute(String attributeName)
```
    移除已有的属性。
    
    Specified by:
    
    removeAttribute in interface javax.servlet.http.HttpSession
    
    Parameters:
    
    attributeName - 属性名称。
  - invalidate
```
public void invalidate()
```
    Session过期。
    
    Specified by:
    
    invalidate in interface javax.servlet.http.HttpSession
  - isInvalid
```
public boolean isInvalid()
```
    判断是否已经超过了最大活动时间。
    
    Returns:
    
    true超过，false没有超过。
  - isNew
```
public boolean isNew()
```
    判断此Session是否为新的。
    
    Specified by:
    
    isNew in interface javax.servlet.http.HttpSession
    
    Returns:
    
    true 为新的，false为非新的。
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - removeSessionFromCache
```
public void removeSessionFromCache()
```
  - sync
```
public String sync()
```
    更新当前Session至缓存。如果已经失效，从缓存中删除。
    
    Returns:
    
    sessionId
  - getAttributeNames
```
public Enumeration<String> getAttributeNames()
```
    Specified by:
    
    getAttributeNames in interface javax.servlet.http.HttpSession
  - getServletContext
```
public javax.servlet.ServletContext getServletContext()
```
    Specified by:
    
    getServletContext in interface javax.servlet.http.HttpSession
  - getSessionContext
```
public javax.servlet.http.HttpSessionContext getSessionContext()
```
    Specified by:
    
    getSessionContext in interface javax.servlet.http.HttpSession
  - getValue
```
public Object getValue(String name)
```
    Specified by:
    
    getValue in interface javax.servlet.http.HttpSession
  - getValueNames
```
public String[] getValueNames()
```
    Specified by:
    
    getValueNames in interface javax.servlet.http.HttpSession
  - putValue
```
public void putValue(String name,
                     Object value)
```
    Specified by:
    
    putValue in interface javax.servlet.http.HttpSession
  - removeValue
```
public void removeValue(String name)
```
    Specified by:
    
    removeValue in interface javax.servlet.http.HttpSession

Class CacheHttpSession

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CacheHttpSession

Method Detail

getId

getCreationTime

getLastAccessedTime

getSessionAttribute

access

setMaxInactiveInterval

getMaxInactiveInterval

getAttribute

setAttribute

removeAttribute

invalidate

isInvalid

isNew

hashCode

equals

removeSessionFromCache

sync

getAttributeNames

getServletContext

getSessionContext

getValue

getValueNames

putValue

removeValue