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(AbstractSessionManager sessionManager, SessionStore sessionStore, boolean clusterEnabled)

Method Summary

Modifier and Type	Method	Description
ManagedSession	add(String id, long time, long inactiveInterval)	Add an entirely new session to the cache.
Set<String>	checkExpiration(Set<String> candidates)	Check a list of session ids that belong to potentially expired sessions.
boolean	checkInactiveSession(ManagedSession session)	Check a session for being inactive and thus being able to be evicted, if eviction is enabled.
void	cleanOrphans(long time)	Remove all unmanaged sessions that expired at or before the given time.
boolean	contains(String id)	Check to see if a Session is in the cache.
ManagedSession	delete(String id)	Remove a Session completely: from both this cache and the SessionStore.
protected abstract ManagedSession	doComputeIfAbsent(String id, Function<String,ManagedSession> mappingFunction)	Compute the mappingFunction to create a Session object if the session with the given id isn't already in the map, otherwise return the existing Session.
protected abstract ManagedSession	doDelete(String id)	Remove the session with this identity from the store.
protected abstract ManagedSession	doGet(String id)	Get the session matching the key.
protected abstract ManagedSession	doPutIfAbsent(String id, ManagedSession session)	Put the session into the map if it wasn't already there.
boolean	exists(String id)	Check to see if a session exists: WILL consult the SessionStore.
ManagedSession	get(String id)	Get an existing Session.
String	getComponentName()	Returns the component name.
int	getEvictionIdleSecs()
int	getEvictionIdleSecsForNew()
protected SessionManager	getSessionManager()
protected SessionStore	getSessionStore()
protected String	getSessionStoreName()
protected SessionStatistics	getStatistics()
boolean	isClusterEnabled()
boolean	isRemoveUnloadableSessions()
boolean	isSaveOnCreate()
boolean	isSaveOnInactiveEviction()	Whether we should save a session that has been inactive before we boot it from the cache.
void	refresh(ManagedSession session)	Refreshes the data of the session to be used.
void	release(ManagedSession session)	Finish using a Session.
protected void	renewSessionId(ManagedSession session, String newId)	Swap the id on a session.
ManagedSession	renewSessionId(String oldId, String newId)	Change the id of a Session.
void	setEvictionIdleSecs(int evictionIdleSecs)	Sessions in this cache can be: -1: never evicted means we never evict inactive sessions. 0: evicted once the last request exits means we evict a session after the last request for it exits. > 0: evicted after a configurable period of inactivity the number of seconds after which we evict inactive sessions from the cache.
void	setEvictionIdleSecsForNew(int evictionIdleSecsForNew)
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 a session that is newly created should be immediately saved.
void	setSaveOnInactiveEviction(boolean saveOnEvict)	Whether a session that is about to be evicted should be saved before being evicted.

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

checkAvailable, checkInitializable, checkNotDestroyed, destroy, doDestroy, doInitialize, initialize, isAvailable, isDestroyed, isDestroying, isInitializable, isInitialized, isInitializing

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

getActiveSessions, getAllSessions, getMaxActiveSessions, setMaxActiveSessions

Constructor Details

AbstractSessionCache

public AbstractSessionCache(AbstractSessionManager sessionManager,
 SessionStore sessionStore,
 boolean clusterEnabled)

Method Details

getSessionManager

protected SessionManager getSessionManager()

getSessionStore

protected SessionStore getSessionStore()

getSessionStoreName

protected String getSessionStoreName()

getStatistics

protected SessionStatistics getStatistics()

isClusterEnabled

public boolean isClusterEnabled()

Specified by:

isClusterEnabled in interface SessionCache

getEvictionIdleSecs

public int getEvictionIdleSecs()

Specified by:

getEvictionIdleSecs in interface SessionCache

Returns:

the interval in seconds to evict inactive sessions from cache

setEvictionIdleSecs

public void setEvictionIdleSecs(int evictionIdleSecs)

Sessions in this cache can be:

-1: never evicted

means we never evict inactive sessions.

0: evicted once the last request exits

means we evict a session after the last request for it exits.

> 0: evicted after a configurable period of inactivity

the number of seconds after which we evict inactive sessions from the cache.