H.Session (OSGL HTTP 1.1.1 API)

java.lang.Object
- org.osgl.http.H.KV<H.Session>
- - org.osgl.http.H.Session

All Implemented Interfaces:

Serializable

Enclosing class:

H
```
public static final class H.Session
extends H.KV<H.Session>
```
Defines a data structure to encapsulate a stateless session which accept only String type value, and will be persisted at client side as a cookie. This means the entire size of the information stored in session including names and values shall not exceed 4096 bytes.
To store typed value or big value, use the cache methods of the session class. However it is subject to the implementation to decide whether cache methods are provided and how it is implemented

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`KEY_AUTHENTICITY_TOKEN` Stores the authenticity token in the session
`static String`	`KEY_EXPIRATION` Stores the expiration date in the session
`static String`	`KEY_EXPIRE_INDICATOR` Used to mark if a session has just expired
`static String`	`KEY_FINGER_PRINT` Stores the fingerprint to the session
`static String`	`KEY_ID` Session identifier

Fields inherited from class org.osgl.http.H.KV
data

Constructor Summary

Constructors
Constructor and Description

Session()

Constructors
Constructor and Description
`Session()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`H.Session`	`cache(String key, Object obj)` Store an object into cache using key specified.
`H.Session`	`cache(String key, Object obj, int expiration)` Store an object into cache with expiration specified
`<T> T`	`cached(String key)` Retrieve an object from cache by key.
`<T> T`	`cached(String key, Class<T> clz)` Retrieve an object from cache by key.
`H.Session`	`cacheFor10Min(String key, Object obj)` Store an object into cache for 10 minutes
`H.Session`	`cacheFor1Hr(String key, Object obj)` Store an object into cache for 1 hour
`H.Session`	`cacheFor1Min(String key, Object obj)` Store an object into cache for 1 minutes
`H.Session`	`cacheFor30Min(String key, Object obj)` Store an object into cache for 30 minutes
`static H.Session`	`current()` Return a session instance of the current execution context, For example from a `ThreadLocal`
`static void`	`current(H.Session session)` Set a session instance into the current execution context, for example into a `ThreadLocal`
`boolean`	`empty()` Returns `true` if the session is empty.
`boolean`	`equals(Object obj)`
`H.Session`	`evict(String key)` Evict an object from cache
`boolean`	`expired()` Check if the session is expired.
`H.Session`	`expireOn(long expiry)` Set session expiry in milliseconds
`long`	`expiry()` Returns the expiration time in milliseconds of this session.
`String`	`id()` Returns the session identifier
`boolean`	`isEmpty()` Returns `true` if internal data map is empty
`static H.Session`	`resolve(H.Cookie sessionCookie, int ttl)` Resolve a Session instance from a session cookie
`H.Cookie`	`serialize(String sessionKey)` Serialize this session into a cookie.

Methods inherited from class org.osgl.http.H.KV
changed, clear, contains, containsKey, dirty, get, hashCode, keySet, load, me, put, put, remove, size, toString

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

- Field Detail
  - KEY_ID
```
public static final String KEY_ID
```
    Session identifier
    
    See Also:
    
    Constant Field Values
  - KEY_EXPIRATION
```
public static final String KEY_EXPIRATION
```
    Stores the expiration date in the session
    
    See Also:
    
    Constant Field Values
  - KEY_AUTHENTICITY_TOKEN
```
public static final String KEY_AUTHENTICITY_TOKEN
```
    Stores the authenticity token in the session
    
    See Also:
    
    Constant Field Values
  - KEY_EXPIRE_INDICATOR
```
public static final String KEY_EXPIRE_INDICATOR
```
    Used to mark if a session has just expired
    
    See Also:
    
    Constant Field Values
  - KEY_FINGER_PRINT
```
public static final String KEY_FINGER_PRINT
```
    Stores the fingerprint to the session
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Session
```
public Session()
```
- Method Detail
  - id
```
public String id()
```
    Returns the session identifier
    
    Returns:
    
    id of the session
  - empty
```
public boolean empty()
```
    Returns true if the session is empty. e.g. does not contain anything else than the timestamp
    
    Overrides:
    
    empty in class H.KV<H.Session>
    
    Returns:
    
    true if data is empty or false otherwise
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from class: H.KV
    
    Returns true if internal data map is empty
    
    Overrides:
    
    isEmpty in class H.KV<H.Session>
    
    Returns:
    
    if data is empty
  - expired
```
public boolean expired()
```
    Check if the session is expired. A session is considered to be expired if it has a timestamp and the timestamp is non negative number and is less than System.currentTimeMillis()
    
    Returns:
    
    true if the session is expired
  - expiry
```
public long expiry()
```
    Returns the expiration time in milliseconds of this session. If there is no expiration set up, then this method return -1
    
    Returns:
    
    the difference, measured in milliseconds, between the expiry of the session and midnight, January 1, 1970 UTC, or -1 if the session has no expiry
  - expireOn
```
public H.Session expireOn(long expiry)
```
    Set session expiry in milliseconds
    
    Parameters:
    
    expiry - the difference, measured in milliseconds, between the expiry and midnight, January 1, 1970 UTC.
    
    Returns:
    
    the session instance
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class H.KV<H.Session>
  - cache
```
public H.Session cache(String key,
                       Object obj)
```
    Store an object into cache using key specified. The key will be appended with session id, so that it distinct between caching using the same key but in different user sessions.
    The object is cached for default ttl
    
    Parameters:
    
    key - the key to cache the object
    
    obj - the object to be cached
    
    Returns:
    
    this session instance
  - cache
```
public H.Session cache(String key,
                       Object obj,
                       int expiration)
```
    Store an object into cache with expiration specified
    
    Parameters:
    
    key - the key to cache the object
    
    obj - the object to be cached
    
    expiration - specify the cache expiration in seconds
    
    Returns:
    
    this session instance
    
    See Also:
    
    cache(String, Object)
  - cacheFor1Hr
```
public H.Session cacheFor1Hr(String key,
                             Object obj)
```
    Store an object into cache for 1 hour
    
    Parameters:
    
    key - the key to cache the object
    
    obj - the object to be cached
    
    Returns:
    
    the session instance
  - cacheFor30Min
```
public H.Session cacheFor30Min(String key,
                               Object obj)
```
    Store an object into cache for 30 minutes
    
    Parameters:
    
    key - the key to cache the object
    
    obj - the object to be cached
    
    Returns:
    
    the session instance
  - cacheFor10Min
```
public H.Session cacheFor10Min(String key,
                               Object obj)
```
    Store an object into cache for 10 minutes
    
    Parameters:
    
    key - the key to cache the object
    
    obj - the object to be cached
    
    Returns:
    
    the session instance
  - cacheFor1Min
```
public H.Session cacheFor1Min(String key,
                              Object obj)
```
    Store an object into cache for 1 minutes
    
    Parameters:
    
    key - the key to cache the object
    
    obj - the object to be cached
    
    Returns:
    
    the session instance
  - evict
```
public H.Session evict(String key)
```
    Evict an object from cache
    
    Parameters:
    
    key - the key to cache the object
    
    Returns:
    
    this session instance
  - cached
```
public <T> T cached(String key)
```
    Retrieve an object from cache by key. The key will be attached with session id
    
    Type Parameters:
    
    T - the object type
    
    Parameters:
    
    key - the key to get the cached object
    
    Returns:
    
    the object in the cache, or null if it cannot find the object by key specified
    
    See Also:
    
    cache(String, Object)
  - cached
```
public <T> T cached(String key,
                    Class<T> clz)
```
    Retrieve an object from cache by key. The key will be attached with session id
    
    Type Parameters:
    
    T - the object type
    
    Parameters:
    
    key - the key to get the cached object
    
    clz - the class to specify the return type
    
    Returns:
    
    the object in the cache, or null if it cannot find the object by key specified
    
    See Also:
    
    cache(String, Object)
  - current
```
public static H.Session current()
```
    Return a session instance of the current execution context, For example from a ThreadLocal
    
    Returns:
    
    the current session instance
  - current
```
public static void current(H.Session session)
```
    Set a session instance into the current execution context, for example into a ThreadLocal
    
    Parameters:
    
    session - the session to be set to current execution context
  - resolve
```
public static H.Session resolve(H.Cookie sessionCookie,
                                int ttl)
```
    Resolve a Session instance from a session cookie
    
    Parameters:
    
    sessionCookie - the cookie corresponding to a session
    
    ttl - session time to live in seconds
    
    Returns:
    
    a Session instance
    
    See Also:
    
    serialize(String)
  - serialize
```
public H.Cookie serialize(String sessionKey)
```
    Serialize this session into a cookie. Note the cookie returned has only name, value maxAge been set. It's up to the caller to set the secure, httpOnly and path attributes
    
    Parameters:
    
    sessionKey - the cookie name for the session cookie
    
    Returns:
    
    a cookie captures this session's information or null if this session is empty or this session hasn't been changed and there is no expiry
    
    See Also:
    
    resolve(org.osgl.http.H.Cookie, int)

Class H.Session

Field Summary

Fields inherited from class org.osgl.http.H.KV

Constructor Summary

Method Summary

Methods inherited from class org.osgl.http.H.KV

Methods inherited from class java.lang.Object

Field Detail

KEY_ID

KEY_EXPIRATION

KEY_AUTHENTICITY_TOKEN

KEY_EXPIRE_INDICATOR

KEY_FINGER_PRINT

Constructor Detail

Session

Method Detail

id

empty

isEmpty

expired

expiry

expireOn

equals

cache

cache

cacheFor1Hr

cacheFor30Min

cacheFor10Min

cacheFor1Min

evict

cached

cached

current

current

resolve

serialize