Interface SessionManager

All Superinterfaces:

LifeCycle, SessionConfig

All Known Implementing Classes:

AbstractSessionManager, SessionHandler, SessionHandler

public interface SessionManager
extends LifeCycle, SessionConfig

SessionManager Non-servlet spec specific contract implemented by all SessionHandlers.

Nested Class Summary

Nested classes/interfaces inherited from interface LifeCycle

LifeCycle.Listener

Nested classes/interfaces inherited from interface SessionConfig

SessionConfig.Mutable

Field Summary

Fields inherited from interface SessionConfig

__CheckRemoteSessionEncodingProperty, __DefaultSessionCookie, __DefaultSessionDomain, __DefaultSessionIdPathParameterName, __MaxAgeProperty, __SessionCookieProperty, __SessionDomainProperty, __SessionIdPathParameterNameProperty, __SessionPathProperty

Method Summary

Modifier and Type	Method	Description
long	calculateInactivityTimeout(String id, long timeRemaining, long maxInactiveMs)
void	commit(ManagedSession session)
void	complete(ManagedSession session)
String	encodeURI(Request request, String uri, boolean cookiesInUse)
Context	getContext()
ManagedSession	getManagedSession(String id)
ManagedSession	getManagedSession(Request request)
SessionCache	getSessionCache()
HttpCookie	getSessionCookie(ManagedSession session, boolean requestIsSecure)
SessionIdManager	getSessionIdManager()
int	getSessionsCreated()
double	getSessionTimeMean()
double	getSessionTimeStdDev()
long	getSessionTimeTotal()
void	invalidate(String id)
boolean	isIdInUse(String id)
void	newSession(Request request, String requestedSessionId, Consumer<ManagedSession> consumer)
Session.API	newSessionAPIWrapper(ManagedSession session)
SessionInactivityTimer	newSessionInactivityTimer(ManagedSession session)
default void	onSessionActivation(Session session)
default void	onSessionAttributeUpdate(Session session, String name, Object oldValue, Object newValue)
default void	onSessionCreated(Session session)
default void	onSessionDestroyed(Session session)
default void	onSessionIdChanged(Session session, String oldId)
default void	onSessionPassivation(Session session)
void	recordSessionTime(ManagedSession session)
void	renewSessionId(String oldId, String oldExtendedId, String newId, String newExtendedId)
void	scavenge()
void	sessionTimerExpired(ManagedSession session, long now)
void	setSessionCache(SessionCache cache)
void	setSessionIdManager(SessionIdManager idManager)

Methods inherited from interface LifeCycle

addEventListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeEventListener, start, stop

Methods inherited from interface SessionConfig

getMaxCookieAge, getMaxInactiveInterval, getRefreshCookieAge, getSameSite, getSessionComment, getSessionCookie, getSessionDomain, getSessionIdPathParameterName, getSessionIdPathParameterNamePrefix, getSessionPath, isCheckingRemoteSessionIdEncoding, isHttpOnly, isPartitioned, isSecureCookies, isSecureRequestOnly, isUsingCookies, isUsingUriParameters

Method Details

getManagedSession

ManagedSession getManagedSession(String id)
                          throws Exception

Throws:

Exception

newSession

void newSession(Request request,
 String requestedSessionId,
 Consumer<ManagedSession> consumer)

getManagedSession

ManagedSession getManagedSession(Request request)

newSessionAPIWrapper

Session.API newSessionAPIWrapper(ManagedSession session)

sessionTimerExpired

void sessionTimerExpired(ManagedSession session,
 long now)

commit

void commit(ManagedSession session)

complete

void complete(ManagedSession session)

invalidate

void invalidate(String id)
         throws Exception

Throws:

Exception

scavenge

void scavenge()
       throws Exception

Throws:

Exception

isIdInUse

boolean isIdInUse(String id)
           throws Exception

Throws:

Exception

getSessionCookie

HttpCookie getSessionCookie(ManagedSession session,
 boolean requestIsSecure)

renewSessionId

void renewSessionId(String oldId,
 String oldExtendedId,
 String newId,
 String newExtendedId)
             throws Exception

Throws:

Exception

calculateInactivityTimeout

long calculateInactivityTimeout(String id,
 long timeRemaining,
 long maxInactiveMs)

newSessionInactivityTimer

SessionInactivityTimer newSessionInactivityTimer(ManagedSession session)

getContext

Context getContext()

getSessionIdManager

SessionIdManager getSessionIdManager()

setSessionIdManager

void setSessionIdManager(SessionIdManager idManager)

getSessionCache

SessionCache getSessionCache()

setSessionCache

void setSessionCache(SessionCache cache)

recordSessionTime

void recordSessionTime(ManagedSession session)

getSessionsCreated

int getSessionsCreated()

encodeURI

String encodeURI(Request request,
 String uri,
 boolean cookiesInUse)

onSessionIdChanged

default void onSessionIdChanged(Session session,
 String oldId)

onSessionCreated

default void onSessionCreated(Session session)

onSessionDestroyed

default void onSessionDestroyed(Session session)

onSessionAttributeUpdate

default void onSessionAttributeUpdate(Session session,
 String name,
 Object oldValue,
 Object newValue)

onSessionActivation

default void onSessionActivation(Session session)

onSessionPassivation

default void onSessionPassivation(Session session)

getSessionTimeStdDev

double getSessionTimeStdDev()

getSessionTimeMean

double getSessionTimeMean()

getSessionTimeTotal

long getSessionTimeTotal()