DefaultSessionManager (Tammi Framework API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.norther.tammi.spray.session
Class DefaultSessionManager

java.lang.Object
  org.norther.tammi.acorn.cache.CachedMapAdapter
      org.norther.tammi.core.cache.DefaultCache
          org.norther.tammi.spray.session.DefaultSessionManager

All Implemented Interfaces:: Serializable, ConcurrentMap, EventListener, Map, NotificationBroadcaster, NotificationEmitter, HttpSessionListener, CachedMap, Manageable, Cache, Manager, SessionManager

public class DefaultSessionManager
extends DefaultCache
implements SessionManager, HttpSessionListener
extends DefaultCache
implements SessionManager, HttpSessionListener

A session manager implementation.

Author:: Ilkka Priha
See Also:: Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map
`Map.Entry<K,V>`

Field Summary
`static String`	`DEFAULT_SESSION_STORE` The default session store path.

Fields inherited from class org.norther.tammi.core.cache.DefaultCache
`DEFAULT_CAPACITY, DEFAULT_LOAD_FACTOR`

Fields inherited from class org.norther.tammi.acorn.cache.CachedMapAdapter
`DEFAULT_EXPIRATION_SLEEP_INTERVAL, DEFAULT_EXPIRATION_TIME`

Fields inherited from interface org.norther.tammi.spray.session.Manager
`ALLOW_MULTIPLE_USER_SESSIONS, EXPIRE_EXISTING_USER_SESSION, JOIN_EXISTING_USER_SESSION`

Constructor Summary
`DefaultSessionManager()` Constructs a new session manager.
`DefaultSessionManager(int max)` Constructs a new session cache with max expiration time.
`DefaultSessionManager(int max, int def)` Constructs a new session cache with max and default expiration times.
`DefaultSessionManager(int max, int def, int sleep)` Constructs a new session cache with max and default expiration times and expiration sleep interval.
`DefaultSessionManager(int max, int def, int sleep, int capacity)` Constructs a new session cache with max and default expiration times, an expiration sleep interval and initial capacity.
`DefaultSessionManager(int max, int def, int sleep, int capacity, float loadFactor)` Constructs a new session cache with max and default expiration times, an expiration sleep interval, initial capacity and load factor.

Method Summary
`AuthenticatedSession`	`createSession()` Constructs a new session based on the default settings specified by manager properties.
`AuthenticatedSession`	`createSession(String id)` Constructs a new session based on the default settings specified by manager properties.
`void`	`expireAll()` Expires all entries.
`void`	`expireSession(String id)` Expires the specified session.
`int`	`getIdLength()` Gets the length of session ids.
`int`	`getInitialExpirationTime()` Gets the initial expiration time for new sessions.
`String`	`getSerializedSessionsPath()` Gets the path to store serialized sessions.
`ServletContext`	`getServletContext()` Gets a servlet context.
`AuthenticatedSession`	`getSession(String id)` Gets the active session with the specified session id.
`int`	`getUserSessionPolicy()` Gets the policy for multiple sessions for the same principal.
`String[]`	`getUserSessions(Principal principal)` Gets ids of active sessions of the specified principal.
`String[]`	`getUserSessions(String username)` Gets ids of active sessions of the named user.
`boolean`	`isDistributable()` Checks the distributable flag for the sessions.
`void`	`load()` Loads currently active sessions that were previously unloaded to the appropriate persistence mechanism, if any.
`AuthenticatedSession`	`registerUserPrincipal(Principal principal, String id)` Registers a user principal to a session.
`void`	`sessionCreated(HttpSessionEvent event)`
`void`	`sessionDestroyed(HttpSessionEvent event)`
`void`	`setDistributable(boolean flag)` Sets the distributable flag for the sessions.
`void`	`setIdLength(int l)` Sets the length of session ids.
`void`	`setInitialExpirationTime(int t)` Sets the initial expiration time for new sessions.
`void`	`setSerializedSessionsPath(String path)` Sets the path to store serialized sessions.
`void`	`setSessionExpirationTime(String id, int t)` Sets the expiration time for a specific session.
`void`	`setUserSessionPolicy(int policy)` Sets the policy for multiple sessions for the same principal.
`void`	`unload()` Saves currently active sessions in the appropriate persistence mechanism, if any.
`void`	`unregisterUserPrincipal(Principal principal, String id)` Unregisters a user principal from a session.
`Set`	`userPrincipalSet()` Returns a read-only set of registered user principals.

Methods inherited from class org.norther.tammi.core.cache.DefaultCache
`addNotificationListener, getMBeanDelegate, getNotificationInfo, postmanaged, premanaged, removeNotificationListener, removeNotificationListener, setAllowExpired, setDefaultExpirationTime, setDiscardOverloaded, setExpirationLimit, setExpirationSleepInterval, setExpirationThreshold, setMaxExpirationTime, toString, unmanaged`

Methods inherited from class org.norther.tammi.acorn.cache.CachedMapAdapter
add, add, clear, containsKey, containsValue, entrySet, equals, expire, expireFraction, get, get, getDefaultExpirationTime, getExpirationLimit, getExpirationSleepInterval, getExpirationThreshold, getExpirationTimer, getMaxExpirationTime, getSwapOutHandler, hashCode, isAllowExpired, isAutoRefreshDeclined, isDiscardOverloaded, isEmpty, keySet, put, put, putAll, putIfAbsent, putIfAbsent, refresh, refresh, remove, remove, replace, replace, setAutoRefreshDeclined, setExpirationTimer, setSwapOutHandler, size, values

Methods inherited from class org.norther.tammi.acorn.cache.CachedMapAdapter

add, add, clear, containsKey, containsValue, entrySet, equals, expire, expireFraction, get, get, getDefaultExpirationTime, getExpirationLimit, getExpirationSleepInterval, getExpirationThreshold, getExpirationTimer, getMaxExpirationTime, getSwapOutHandler, hashCode, isAllowExpired, isAutoRefreshDeclined, isDiscardOverloaded, isEmpty, keySet, put, put, putAll, putIfAbsent, putIfAbsent, refresh, refresh, remove, remove, replace, replace, setAutoRefreshDeclined, setExpirationTimer, setSwapOutHandler, size, values

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

Methods inherited from interface org.norther.tammi.acorn.cache.CachedMap
`add, add, expire, expireFraction, get, getDefaultExpirationTime, getExpirationLimit, getExpirationSleepInterval, getExpirationThreshold, getMaxExpirationTime, isAllowExpired, isAutoRefreshDeclined, isDiscardOverloaded, put, putIfAbsent, refresh, refresh, setAllowExpired, setAutoRefreshDeclined, setDefaultExpirationTime, setDiscardOverloaded, setExpirationLimit, setExpirationSleepInterval, setExpirationThreshold, setMaxExpirationTime`

Methods inherited from interface org.norther.tammi.acorn.cache.CachedMap

add, add, expire, expireFraction, get, getDefaultExpirationTime, getExpirationLimit, getExpirationSleepInterval, getExpirationThreshold, getMaxExpirationTime, isAllowExpired, isAutoRefreshDeclined, isDiscardOverloaded, put, putIfAbsent, refresh, refresh, setAllowExpired, setAutoRefreshDeclined, setDefaultExpirationTime, setDiscardOverloaded, setExpirationLimit, setExpirationSleepInterval, setExpirationThreshold, setMaxExpirationTime

Methods inherited from interface java.util.concurrent.ConcurrentMap
`putIfAbsent, remove, replace, replace`

Methods inherited from interface java.util.Map
`clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values`

Methods inherited from interface org.norther.tammi.spray.session.Manager
`getDefaultExpirationTime, setDefaultExpirationTime`

Field Detail

DEFAULT_SESSION_STORE

public static final String DEFAULT_SESSION_STORE

The default session store path.

See Also:: Constant Field Values

Constructor Detail

DefaultSessionManager

public DefaultSessionManager()

Constructs a new session manager.

DefaultSessionManager

public DefaultSessionManager(int max)

Constructs a new session cache with max expiration time.

Parameters:: max - a max expiration time (0 = default, -1 = infinite).

DefaultSessionManager

public DefaultSessionManager(int max,
                             int def)

Constructs a new session cache with max and default expiration times.

Parameters:: max - a max expiration time in secs (0 = default, -1 = infinite).; def - a default expiration time in secs (0 = default, -1 = infinite).

DefaultSessionManager

public DefaultSessionManager(int max,
                             int def,
                             int sleep)

Constructs a new session cache with max and default expiration times and expiration sleep interval.

Parameters:: max - a max expiration time in secs (0 = default, -1 = infinite).; def - a default expiration time in secs (0 = default, -1 = infinite).; sleep - an expiration sleep interval in secs (0 = default, -1 = infinite).

DefaultSessionManager

public DefaultSessionManager(int max,
                             int def,
                             int sleep,
                             int capacity)

Constructs a new session cache with max and default expiration times, an expiration sleep interval and initial capacity.

Parameters:: max - a max expiration time in secs (0 = default, -1 = infinite).; def - a default expiration time in secs (0 = default, -1 = infinite).; sleep - an expiration sleep interval in secs (0 = default, -1 = infinite).; capacity - an initial capacity.

DefaultSessionManager

public DefaultSessionManager(int max,
                             int def,
                             int sleep,
                             int capacity,
                             float loadFactor)

Constructs a new session cache with max and default expiration times, an expiration sleep interval, initial capacity and load factor.

Parameters:: max - a max expiration time in secs (0 = default, -1 = infinite).; def - a default expiration time in secs (0 = default, -1 = infinite).; sleep - an expiration sleep interval in secs (0 = default, -1 = infinite).; capacity - an initial capacity.; loadFactor - a load factor.

Method Detail