Top Description Inners Methods
io.undertow.server.session

public Interface SessionListener

Known Direct Implementers
io.undertow.security.impl.SingleSignOnAuthenticationMechanism.SessionInvalidationListener
Imports
io.undertow.server.HttpServerExchange

A listener for session events.
Author
Stuart Douglas

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum

Method Summary

Modifier and TypeMethod and Description
public default void
attributeAdded(final Session session, final String name, final Object value)

public default void
attributeRemoved(final Session session, final String name, final Object oldValue)

public default void
attributeUpdated(final Session session, final String name, final Object newValue, final Object oldValue)

public default void
sessionCreated(final Session
The new session
session
,
final HttpServerExchange
The HttpServerExchange that created the session
exchange
)

Called when a session is created

public default void
sessionDestroyed(final Session
The new session
session
,
final HttpServerExchange
The HttpServerExchange that destroyed the session, or null if the session timed out
exchange
,
SessionListener.SessionDestroyedReason
The reason why the session was expired
reason
)

Called when a session is destroyed

public default void
sessionIdChanged(final Session session, final String oldSessionId)

Method Detail

attributeAddedback to summary
public default void attributeAdded(final Session session, final String name, final Object value)
attributeRemovedback to summary
public default void attributeRemoved(final Session session, final String name, final Object oldValue)
attributeUpdatedback to summary
public default void attributeUpdated(final Session session, final String name, final Object newValue, final Object oldValue)
sessionCreatedback to summary
public default void sessionCreated(final Session session, final HttpServerExchange exchange)

Called when a session is created

Parameters
session:Session

The new session

exchange:HttpServerExchange

The HttpServerExchange that created the session

sessionDestroyedback to summary
public default void sessionDestroyed(final Session session, final HttpServerExchange exchange, SessionListener.SessionDestroyedReason reason)

Called when a session is destroyed

Parameters
session:Session

The new session

exchange:HttpServerExchange

The HttpServerExchange that destroyed the session, or null if the session timed out

reason:SessionListener.SessionDestroyedReason

The reason why the session was expired

sessionIdChangedback to summary
public default void sessionIdChanged(final Session session, final String oldSessionId)
io.undertow.server.session back to summary

public final Enum SessionListener.SessionDestroyedReason

extends Enum<SessionListener.SessionDestroyedReason>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final SessionListener.SessionDestroyedReason
public static final SessionListener.SessionDestroyedReason
public static final SessionListener.SessionDestroyedReason

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static SessionListener.SessionDestroyedReason
public static SessionListener.SessionDestroyedReason[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

INVALIDATEDback to summary
public static final SessionListener.SessionDestroyedReason INVALIDATED
TIMEOUTback to summary
public static final SessionListener.SessionDestroyedReason TIMEOUT
UNDEPLOYback to summary
public static final SessionListener.SessionDestroyedReason UNDEPLOY

Constructor Detail

SessionDestroyedReasonback to summary
private SessionDestroyedReason()

Method Detail

valueOfback to summary
public static SessionListener.SessionDestroyedReason valueOf(String name)
valuesback to summary
public static SessionListener.SessionDestroyedReason[] values()