Package org.wildfly.clustering.web.session.oob

Class OOBSession<L,B extends Batch>

java.lang.Object

org.wildfly.clustering.web.session.oob.OOBSession<L,B>

All Implemented Interfaces:

AutoCloseable, ImmutableSession, ImmutableSessionAttributes, ImmutableSessionMetaData, Session<L>, SessionAttributes, SessionExpirationMetaData, SessionMetaData

public class OOBSession<L,B extends Batch>
extends Object
implements Session<L>, SessionMetaData, SessionAttributes

Out-of-band session implementation, for use outside the context of a request.

Author:

Paul Ferraro

Constructor Summary

Constructors

Constructor	Description
OOBSession(SessionManager<L,B> manager, String id, L localContext)

Method Summary

Modifier and Type	Method	Description
void	close()	Indicates that the application thread is finished with this session.
Object	getAttribute(String name)	Retrieves the value of the specified attribute.
Set<String>	getAttributeNames()	Returns the names of the attributes of this session.
SessionAttributes	getAttributes()	Returns this session's attributes.
Instant	getCreationTime()	Returns the time this session was created.
String	getId()	Specifies this session's unique identifier.
Instant	getLastAccessEndTime()	Returns the end time of the last request to access this session.
Instant	getLastAccessStartTime()	Returns the start time of the last request to access this session.
L	getLocalContext()	Returns the local context of this session.
Duration	getMaxInactiveInterval()	Returns the time interval since SessionExpirationMetaData.getLastAccessEndTime() after which this session will expire.
SessionMetaData	getMetaData()	Returns this session's meta data.
void	invalidate()	Invalidates this session.
boolean	isExpired()	Indicates whether or not this session was previously idle for longer than the maximum inactive interval.
boolean	isNew()	Indicates whether or not this session was created by the current thread.
boolean	isValid()	Indicates whether or not this session is valid.
Object	removeAttribute(String name)	Removes the specified attribute.
Object	setAttribute(String name, Object value)	Sets the specified attribute to the specified value.
void	setLastAccess(Instant startTime, Instant endTime)	Sets the time this session was last accessed.
void	setMaxInactiveInterval(Duration duration)	Set the time interval as a duration, after which this session will expire.

Methods inherited from class java.lang.Object

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

Constructor Detail

OOBSession

public OOBSession(SessionManager<L,B> manager,
                  String id,
                  L localContext)

Method Detail

getId

public String getId()

Description copied from interface: ImmutableSession

Specifies this session's unique identifier.

Specified by:

getId in interface ImmutableSession

Returns:

a unique identifier for this session.

isValid

public boolean isValid()

Description copied from interface: ImmutableSession

Indicates whether or not this session is valid.

Specified by:

isValid in interface ImmutableSession

Returns:

true, if this session is valid, false otherwise

getMetaData

public SessionMetaData getMetaData()

Description copied from interface: Session

Returns this session's meta data.

Specified by:

getMetaData in interface ImmutableSession

Specified by:

getMetaData in interface Session<L>

Returns:

this session's meta data

invalidate

public void invalidate()

Description copied from interface: Session

Invalidates this session.

Specified by:

invalidate in interface Session<L>

getAttributes

public SessionAttributes getAttributes()

Description copied from interface: Session

Returns this session's attributes.

Specified by:

getAttributes in interface ImmutableSession

Specified by:

getAttributes in interface Session<L>

Returns:

this session's attributes

getLocalContext

public L getLocalContext()

Description copied from interface: Session

Returns the local context of this session. The local context is *not* replicated to other nodes in the cluster.

Specified by:

getLocalContext in interface Session<L>

Returns:

a local context

close

public void close()

Description copied from interface: Session

Indicates that the application thread is finished with this session. This method is intended to be invoked within the context of a batch.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Session<L>

isNew

public boolean isNew()

Description copied from interface: ImmutableSessionMetaData

Indicates whether or not this session was created by the current thread.

Specified by:

isNew in interface ImmutableSessionMetaData

Returns:

true, if this session is new, false otherwise

isExpired

public boolean isExpired()

Description copied from interface: SessionExpirationMetaData

Indicates whether or not this session was previously idle for longer than the maximum inactive interval.

Specified by:

isExpired in interface SessionExpirationMetaData

Returns:

true, if this session is expired, false otherwise

getCreationTime

public Instant getCreationTime()

Description copied from interface: ImmutableSessionMetaData

Returns the time this session was created.

Specified by:

getCreationTime in interface ImmutableSessionMetaData

Returns:

the time this session was created

getLastAccessStartTime

public Instant getLastAccessStartTime()

Description copied from interface: ImmutableSessionMetaData

Returns the start time of the last request to access this session.

Specified by:

getLastAccessStartTime in interface ImmutableSessionMetaData

Returns:

the start time of the last request to access this session.

getLastAccessEndTime

public Instant getLastAccessEndTime()

Description copied from interface: SessionExpirationMetaData

Returns the end time of the last request to access this session.

Specified by:

getLastAccessEndTime in interface SessionExpirationMetaData

Returns:

the end time of the last request to access this session.

getMaxInactiveInterval

public Duration getMaxInactiveInterval()

Description copied from interface: SessionExpirationMetaData

Returns the time interval since SessionExpirationMetaData.getLastAccessEndTime() after which this session will expire.

Specified by:

getMaxInactiveInterval in interface SessionExpirationMetaData

Returns:

a time interval

setLastAccess

public void setLastAccess(Instant startTime,
                          Instant endTime)

Description copied from interface: SessionMetaData

Sets the time this session was last accessed.

Specified by:

setLastAccess in interface SessionMetaData

setMaxInactiveInterval

public void setMaxInactiveInterval(Duration duration)

Description copied from interface: SessionMetaData

Set the time interval as a duration, after which this session will expire.

Specified by:

setMaxInactiveInterval in interface SessionMetaData

Parameters:

duration - a time duration

getAttributeNames

public Set<String> getAttributeNames()

Description copied from interface: ImmutableSessionAttributes

Returns the names of the attributes of this session.

Specified by:

getAttributeNames in interface ImmutableSessionAttributes

Returns:

a set of unique attribute names

getAttribute

public Object getAttribute(String name)

Description copied from interface: ImmutableSessionAttributes

Retrieves the value of the specified attribute.

Specified by:

getAttribute in interface ImmutableSessionAttributes

Parameters:

name - a unique attribute name

Returns:

the attribute value, or null if the attribute does not exist.

removeAttribute

public Object removeAttribute(String name)

Description copied from interface: SessionAttributes

Removes the specified attribute.

Specified by:

removeAttribute in interface SessionAttributes

Parameters:

name - a unique attribute name

Returns:

the removed attribute value, or null if the attribute does not exist.

setAttribute

public Object setAttribute(String name,
                           Object value)

Description copied from interface: SessionAttributes

Sets the specified attribute to the specified value.

Specified by:

setAttribute in interface SessionAttributes

Parameters:

name - a unique attribute name

value - the attribute value

Returns:

the old attribute value, or null if the attribute did not previously exist.