ome.services.sessions.state

Class SessionCache

java.lang.Object

ome.services.sessions.state.SessionCache

All Implemented Interfaces:

ApplicationContextAware

public class SessionCache
extends Object
implements ApplicationContextAware

Synchronized and lockable state for the SessionManager. Maps from Session uuid to SessionContext in memory, with each mapping also having an additional cache which may spill over to disk, listeners. Uses MapMaker and various implementations from java.util.concurrent.atomic to provide a lock-free implementation.

Since:

4.2.1

Author:

Josh Moore, josh at glencoesoftware.com

See Also:

ticket:3173

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SessionCache.StaleCacheListener Observer pattern used to refresh sessions in doUpdate.

Constructor Summary

Constructors

Constructor and Description
SessionCache()

Method Summary

Modifier and Type	Method and Description
boolean	addSessionCallback(String session, SessionCallback cb)
protected net.sf.ehcache.Ehcache	createCache(String key, boolean inMemory, int maxInMemory)
void	doUpdate() Will only ever be accessed by a single thread.
Set<String>	getIds() Since all methods which use getIds() will subsequently check for the existing session, we do not block here.
long	getLastUpdated()
SessionContext	getSessionContext(String uuid) Retrieve a session possibly raising either RemovedSessionException or SessionTimeoutException.
SessionContext	getSessionContext(String uuid, boolean quietly) Retrieve a session possibly raising either RemovedSessionException or SessionTimeoutException.
Map<String,Object>	getSessionData(String uuid, boolean quietly) Returns all the data contained in the internal implementation of this manager.
net.sf.ehcache.Ehcache	inMemoryCache(String uuid)
net.sf.ehcache.Ehcache	onDiskCache(String uuid)
void	putSession(String uuid, SessionContext sessionContext) Puts a session blindly into the context.
void	refresh(String uuid, SessionContext replacement) Used externally to refresh the SessionContext instance associated with the session uuid
void	reload(String id) Provides the reloading logic of the SessionCache for the SessionManagerImpl to use.
void	removeSession(String uuid)
boolean	removeSessionCallback(String session, SessionCallback cb)
void	setApplicationContext(ApplicationContext ctx) Context injector.
void	setCacheManager(net.sf.ehcache.CacheManager manager) Injection method, also performs the creation of sessions
void	setStaleCacheListener(SessionCache.StaleCacheListener staleCacheListener)
void	setUpdateInterval(long milliseconds) Inject time in milliseconds between updates.
void	updateEvent(UserGroupUpdateEvent ugue) Adds a new entry to state.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SessionCache

public SessionCache()

Method Detail

setCacheManager

public void setCacheManager(net.sf.ehcache.CacheManager manager)

Injection method, also performs the creation of sessions

setApplicationContext

public void setApplicationContext(ApplicationContext ctx)
                           throws BeansException

Context injector.

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException

setUpdateInterval

public void setUpdateInterval(long milliseconds)

Inject time in milliseconds between updates.

setStaleCacheListener

public void setStaleCacheListener(SessionCache.StaleCacheListener staleCacheListener)

addSessionCallback

public boolean addSessionCallback(String session,
                                  SessionCallback cb)

removeSessionCallback

public boolean removeSessionCallback(String session,
                                     SessionCallback cb)

putSession

public void putSession(String uuid,
                       SessionContext sessionContext)

Puts a session blindly into the context. This does nothing to a context which was previously present (e.g. call internalRemove, etc.) and therefore usage should be proceeded by a check.

refresh

public void refresh(String uuid,
                    SessionContext replacement)

Used externally to refresh the SessionContext instance associated with the session uuid

Parameters:

uuid -

replacement -

getSessionContext

public SessionContext getSessionContext(String uuid)

Retrieve a session possibly raising either RemovedSessionException or SessionTimeoutException.

getSessionContext

public SessionContext getSessionContext(String uuid,
                                        boolean quietly)

Retrieve a session possibly raising either RemovedSessionException or SessionTimeoutException.

Parameters:

quietly - If true, then the access time for the given UUID will not be updated.

getSessionData

public Map<String,Object> getSessionData(String uuid,
                                         boolean quietly)

Returns all the data contained in the internal implementation of this manager.

Parameters:

quietly - If true, then the access time for the given UUID will not be updated.

removeSession

public void removeSession(String uuid)

getIds

public Set<String> getIds()

Since all methods which use getIds() will subsequently check for the existing session, we do not block here. Blocking is primarily useful for post-admintype changes which can add or remove a user from a group. The existence of a session (which is what getIds specifies) is not significantly effected.

inMemoryCache

public net.sf.ehcache.Ehcache inMemoryCache(String uuid)

onDiskCache

public net.sf.ehcache.Ehcache onDiskCache(String uuid)

createCache

protected net.sf.ehcache.Ehcache createCache(String key,
                                             boolean inMemory,
                                             int maxInMemory)

getLastUpdated

public long getLastUpdated()

updateEvent

public void updateEvent(UserGroupUpdateEvent ugue)

Adds a new entry to state. If the timestamp on the event is invalid, then System.currentTimeMillis() will be used.

doUpdate

public void doUpdate()

Will only ever be accessed by a single thread. Rechecks the target update time again in case a second write thread was blocking the current one. active gets set to true value to specify that this method is currently running.

reload

public void reload(String id)

Provides the reloading logic of the SessionCache for the SessionManagerImpl to use.

See Also:

ticket:4011, ticket:5849