Package com.aspectran.core.component.session

Class AbstractSessionCache

java.lang.Object

com.aspectran.core.component.AbstractComponent

com.aspectran.core.component.session.AbstractSessionCache

All Implemented Interfaces:

Component, SessionCache

Direct Known Subclasses:

DefaultSessionCache

public abstract class AbstractSessionCache
extends AbstractComponent
implements SessionCache

A base implementation of the SessionCache interface for managing a set of Session objects pertaining to a context in memory.

Created: 2017. 6. 24.

Field Summary

Fields inherited from interface com.aspectran.core.component.session.SessionCache

EVICT_ON_INACTIVITY, EVICT_ON_SESSION_EXIT, NEVER_EVICT

Constructor Summary

Constructors

Constructor	Description
AbstractSessionCache(SessionHandler sessionHandler, SessionDataStore sessionDataStore)

Method Summary

Modifier and Type	Method	Description
BasicSession	add(java.lang.String id, long time, long maxInactiveInterval)	Add an entirely new session to the cache.
java.util.Set<java.lang.String>	checkExpiration(java.util.Set<java.lang.String> candidates)	Check a list of session ids that belong to potentially expired sessions.
void	checkInactiveSession(BasicSession session)	Check a session for being inactive and thus being able to be evicted, if eviction is enabled.
boolean	contains(java.lang.String id)	Check to see if a Session is in the cache.
BasicSession	delete(java.lang.String id)	Remove a Session completely: from both this cache and the SessionDataStore.
abstract BasicSession	doDelete(java.lang.String id)	Remove the session with this identity from the store.
abstract BasicSession	doGet(java.lang.String id)	Get the session matching the key.
abstract BasicSession	doPutIfAbsent(java.lang.String id, BasicSession session)	Put the session into the map if it wasn't already there.
abstract boolean	doReplace(java.lang.String id, BasicSession oldValue, BasicSession newValue)	Replace the mapping from id to oldValue with newValue.
boolean	exists(java.lang.String id)	Check to see if a session exists: WILL consult the SessionDataStore.
BasicSession	get(java.lang.String id)	Get an existing Session.
int	getEvictionIdleSecs()
protected SessionDataStore	getSessionDataStore()
protected SessionHandler	getSessionHandler()
boolean	isRemoveUnloadableSessions()
boolean	isSaveOnCreate()
boolean	isSaveOnInactiveEviction()	Whether we should save a session that has been inactive before we boot it from the cache.
void	release(java.lang.String id, BasicSession session)	Finish using a Session.
protected void	renewSessionId(BasicSession session, java.lang.String newId)	Swap the id on a session.
BasicSession	renewSessionId(java.lang.String oldId, java.lang.String newId)	Change the id of a Session.
void	setEvictionIdleSecs(int evictionTimeout)	-1 means we never evict inactive sessions.
void	setRemoveUnloadableSessions(boolean removeUnloadableSessions)	If a session's data cannot be loaded from the store without error, remove it from the persistent store.
void	setSaveOnCreate(boolean saveOnCreate)	Whether or not a session that is newly created should be immediately saved.
void	setSaveOnInactiveEviction(boolean saveOnEvict)	Whether or not a a session that is about to be evicted should be saved before being evicted.

Methods inherited from class com.aspectran.core.component.AbstractComponent

destroy, doDestroy, doInitialize, getComponentName, initialize, isAvailable, isDestroyed, isDestroying, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aspectran.core.component.session.SessionCache

destroy, getActiveSessionCount, getAllSessions, getCreatedSessionCount, getExpiredSessionCount, getHighestSessionCount, getMaxSessions, getRejectedSessionCount, resetStatistics, setMaxSessions

Constructor Detail

AbstractSessionCache

public AbstractSessionCache(SessionHandler sessionHandler,
                            SessionDataStore sessionDataStore)

Method Detail

getSessionHandler

protected SessionHandler getSessionHandler()

getSessionDataStore

protected SessionDataStore getSessionDataStore()

getEvictionIdleSecs

public int getEvictionIdleSecs()

Specified by:

getEvictionIdleSecs in interface SessionCache

setEvictionIdleSecs

public void setEvictionIdleSecs(int evictionTimeout)

-1 means we never evict inactive sessions. 0 means we evict a session after the last request for it exits >0 is the number of seconds after which we evict inactive sessions from the cache

Specified by:

setEvictionIdleSecs in interface SessionCache

Parameters:

evictionTimeout - -1 is never evict; 0 is evict-on-exit; and any other positive value is the time in seconds that a session can be idle before it can be evicted.

isSaveOnCreate

public boolean isSaveOnCreate()

Specified by:

isSaveOnCreate in interface SessionCache

Returns:

if true the newly created session will be saved immediately

setSaveOnCreate

public void setSaveOnCreate(boolean saveOnCreate)

Description copied from interface: SessionCache

Whether or not a session that is newly created should be immediately saved. If false, a session that is created and invalidated within a single request is never persisted.

Specified by:

setSaveOnCreate in interface SessionCache

Parameters:

saveOnCreate - if true, immediately save the newly created session

isSaveOnInactiveEviction

public boolean isSaveOnInactiveEviction()

Whether we should save a session that has been inactive before we boot it from the cache.

Specified by:

isSaveOnInactiveEviction in interface SessionCache

Returns:

true if an inactive session will be saved before being evicted

setSaveOnInactiveEviction

public void setSaveOnInactiveEviction(boolean saveOnEvict)

Description copied from interface: SessionCache

Whether or not a a session that is about to be evicted should be saved before being evicted.

Specified by:

setSaveOnInactiveEviction in interface SessionCache

Parameters:

saveOnEvict - if true, save the session before eviction

isRemoveUnloadableSessions

public boolean isRemoveUnloadableSessions()

Specified by:

isRemoveUnloadableSessions in interface SessionCache

Returns:

true if sessions that can't be loaded are deleted from the store

setRemoveUnloadableSessions

public void setRemoveUnloadableSessions(boolean removeUnloadableSessions)

If a session's data cannot be loaded from the store without error, remove it from the persistent store.

Specified by:

setRemoveUnloadableSessions in interface SessionCache

Parameters:

removeUnloadableSessions - whether to delete sessions that can not be loaded

get

public BasicSession get(java.lang.String id)
                 throws java.lang.Exception

Description copied from interface: SessionCache

Get an existing Session. If necessary, the cache will load the data for the session from the configured SessionDataStore.

Specified by:

get in interface SessionCache

Parameters:

id - the session id

Returns:

the Session if one exists, null otherwise

Throws:

java.lang.Exception - if an error occurs

add

public BasicSession add(java.lang.String id,
                        long time,
                        long maxInactiveInterval)
                 throws java.lang.Exception

Description copied from interface: SessionCache

Add an entirely new session to the cache.

Specified by:

add in interface SessionCache

Parameters:

id - the session id

time - the timestamp of the session creation

maxInactiveInterval - the max inactive time in milliseconds

Throws:

java.lang.Exception

release

public void release(java.lang.String id,
                    BasicSession session)
             throws java.lang.Exception

Description copied from interface: SessionCache

Finish using a Session. This is called by the SessionHandler once a request is finished with a Session. SessionCache implementations may want to delay writing out Session contents until the last request exits a Session.

Specified by:

release in interface SessionCache

Parameters:

id - the session id

session - the session object

Throws:

java.lang.Exception - if an error occurs

exists

public boolean exists(java.lang.String id)
               throws java.lang.Exception

Description copied from interface: SessionCache

Check to see if a session exists: WILL consult the SessionDataStore.

Specified by:

exists in interface SessionCache

Parameters:

id - the session id

Returns:

true if the session exists; false otherwise

Throws:

java.lang.Exception - if an error occurs

contains

public boolean contains(java.lang.String id)
                 throws java.lang.Exception

Description copied from interface: SessionCache

Check to see if a Session is in the cache. Does NOT consult the SessionDataStore.

Specified by:

contains in interface SessionCache

Parameters:

id - the session id

Returns:

true if a Session object matching the id is present in the cache; false otherwise

Throws:

java.lang.Exception - if an error occurs

delete

public BasicSession delete(java.lang.String id)
                    throws java.lang.Exception

Description copied from interface: SessionCache

Remove a Session completely: from both this cache and the SessionDataStore.

Specified by:

delete in interface SessionCache

Parameters:

id - the session id

Returns:

the Session that was removed, null otherwise

Throws:

java.lang.Exception - if an error occurs when deleting a session

doGet

public abstract BasicSession doGet(java.lang.String id)

Get the session matching the key.

Parameters:

id - the session id

Returns:

the Session object matching the id

doPutIfAbsent

public abstract BasicSession doPutIfAbsent(java.lang.String id,
                                           BasicSession session)

Put the session into the map if it wasn't already there.

Parameters:

id - the identity of the session

session - the session object

Returns:

null if the session wasn't already in the map, or the existing entry otherwise

doReplace

public abstract boolean doReplace(java.lang.String id,
                                  BasicSession oldValue,
                                  BasicSession newValue)

Replace the mapping from id to oldValue with newValue.

Parameters:

id - the session id

oldValue - the old value

newValue - the new value

Returns:

true if replacement was done

doDelete

public abstract BasicSession doDelete(java.lang.String id)

Remove the session with this identity from the store.

Parameters:

id - the session id

Returns:

true if removed; false otherwise

renewSessionId

public BasicSession renewSessionId(java.lang.String oldId,
                                   java.lang.String newId)
                            throws java.lang.Exception

Description copied from interface: SessionCache

Change the id of a Session.

Specified by:

renewSessionId in interface SessionCache

Parameters:

oldId - the current session id

newId - the new session id

Returns:

the Session after changing its id

Throws:

java.lang.Exception - if any error occurred

renewSessionId

protected void renewSessionId(BasicSession session,
                              java.lang.String newId)
                       throws java.lang.Exception

Swap the id on a session.

Parameters:

session - the session for which to do the swap

newId - the new id

Throws:

java.lang.Exception - if there was a failure saving the change

checkExpiration

public java.util.Set<java.lang.String> checkExpiration(java.util.Set<java.lang.String> candidates)

Description copied from interface: SessionCache

Check a list of session ids that belong to potentially expired sessions. The Session in the cache should be checked, but also the SessionDataStore, as that is the authoritative source of all session information.

Specified by:

checkExpiration in interface SessionCache

Parameters:

candidates - the session ids to check

Returns:

the set of session ids that have actually expired: this can be a superset of the original candidate list.

checkInactiveSession

public void checkInactiveSession(BasicSession session)

Check a session for being inactive and thus being able to be evicted, if eviction is enabled.

Specified by:

checkInactiveSession in interface SessionCache

Parameters:

session - the session to check