Package org.springframework.session.data.gemfire

Class AbstractGemFireOperationsSessionRepository.GemFireSession<T extends AbstractGemFireOperationsSessionRepository.GemFireSessionAttributes>

java.lang.Object

org.springframework.session.data.gemfire.AbstractGemFireOperationsSessionRepository.GemFireSession<T>

All Implemented Interfaces:

Comparable<org.springframework.session.Session>, org.springframework.session.Session

Direct Known Subclasses:

AbstractGemFireOperationsSessionRepository.DeltaCapableGemFireSession

Enclosing class:

AbstractGemFireOperationsSessionRepository

public static class AbstractGemFireOperationsSessionRepository.GemFireSession<T extends AbstractGemFireOperationsSessionRepository.GemFireSessionAttributes>
extends Object
implements Comparable<org.springframework.session.Session>, org.springframework.session.Session

AbstractGemFireOperationsSessionRepository.GemFireSession is a Abstract Data Type (ADT) for a Spring Session that stores and manages Session state in Apache Geode or Pivotal GemFire.

See Also:

• Comparable
• Session
• AbstractGemFireOperationsSessionRepository.GemFireSessionAttributes

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	GEMFIRE_SESSION_TO_STRING
protected static final String	SPRING_SECURITY_CONTEXT

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GemFireSession()	Constructs a new, default instance of AbstractGemFireOperationsSessionRepository.GemFireSession initialized with a generated Session Identifier.
protected	GemFireSession(String id)	Constructs a new instance of AbstractGemFireOperationsSessionRepository.GemFireSession initialized with the given Session Identifier.
protected	GemFireSession(org.springframework.session.Session session)	Constructs a new instance of AbstractGemFireOperationsSessionRepository.GemFireSession copied from the given Session.

Method Summary

Modifier and Type	Method	Description
String	changeSessionId()	Change the identifier of this Session.
protected void	commit()
int	compareTo(org.springframework.session.Session session)
AbstractGemFireOperationsSessionRepository.GemFireSession<T>	configureWith(Duration maxInactiveInterval)	Builder method to configure the max inactive interval before this AbstractGemFireOperationsSessionRepository.GemFireSession will expire.
AbstractGemFireOperationsSessionRepository.GemFireSession<T>	configureWith(IsDirtyPredicate dirtyPredicate)	Builder method to configure the IsDirtyPredicate strategy interface implementation to determine whether users' application domain objects stored in this AbstractGemFireOperationsSessionRepository.GemFireSession are dirty.
static AbstractGemFireOperationsSessionRepository.GemFireSession	copy(org.springframework.session.Session session)	Copy (i.e.
static <T extends AbstractGemFireOperationsSessionRepository.GemFireSessionAttributes> AbstractGemFireOperationsSessionRepository.GemFireSession<T>	create()	Factory method used to construct a new, default instance of AbstractGemFireOperationsSessionRepository.GemFireSession.
boolean	equals(Object obj)
static AbstractGemFireOperationsSessionRepository.GemFireSession	from(org.springframework.session.Session session)	Returns the given Session if the Session is a AbstractGemFireOperationsSessionRepository.GemFireSession or return a copy of the given Session as a AbstractGemFireOperationsSessionRepository.GemFireSession.
<T> T	getAttribute(String attributeName)
Set<String>	getAttributeNames()
T	getAttributes()
Instant	getCreationTime()
String	getId()
protected IsDirtyPredicate	getIsDirtyPredicate()
Instant	getLastAccessedTime()
Duration	getMaxInactiveInterval()
String	getPrincipalName()
boolean	hasDelta()	Determines whether this AbstractGemFireOperationsSessionRepository.GemFireSession has any changes (i.e.
int	hashCode()
boolean	isExpired()
protected T	newSessionAttributes(Object lock)	Constructs a new AbstractGemFireOperationsSessionRepository.GemFireSessionAttributes object to store and manage Session attributes.
void	removeAttribute(String attributeName)
void	setAttribute(String attributeName, Object attributeValue)
protected void	setIsDirtyPredicate(IsDirtyPredicate dirtyPredicate)
void	setLastAccessedTime(Instant lastAccessedTime)
void	setMaxInactiveInterval(Duration maxInactiveInterval)
void	setPrincipalName(String principalName)
String	toString()
protected void	triggerDelta()
protected void	triggerDelta(boolean delta)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.session.Session

getAttributeOrDefault, getRequiredAttribute

Field Details

GEMFIRE_SESSION_TO_STRING

protected static final String GEMFIRE_SESSION_TO_STRING

See Also:

• Constant Field Values

SPRING_SECURITY_CONTEXT

protected static final String SPRING_SECURITY_CONTEXT

See Also:

• Constant Field Values

Constructor Details

GemFireSession

protected GemFireSession()

Constructs a new, default instance of AbstractGemFireOperationsSessionRepository.GemFireSession initialized with a generated Session Identifier.

See Also:

• GemFireSession(String)
• generateSessionId()

GemFireSession

protected GemFireSession(String id)

Constructs a new instance of AbstractGemFireOperationsSessionRepository.GemFireSession initialized with the given Session Identifier. Additionally, the creationTime is set to Instant.now(), lastAccessedTime is set to creationTime and the maxInactiveInterval is set to Duration.ZERO.

Parameters:

id - String containing the unique identifier for this Session.

See Also:

• validateSessionId(String)

GemFireSession

protected GemFireSession(org.springframework.session.Session session)

Constructs a new instance of AbstractGemFireOperationsSessionRepository.GemFireSession copied from the given Session.

Parameters:

session - Session to copy.

Throws:

IllegalArgumentException - if Session is null.

See Also:

• Session

Method Details

create

public static <T extends AbstractGemFireOperationsSessionRepository.GemFireSessionAttributes>
AbstractGemFireOperationsSessionRepository.GemFireSession<T> create()

Factory method used to construct a new, default instance of AbstractGemFireOperationsSessionRepository.GemFireSession.

Type Parameters:

T - Sub-type of AbstractGemFireOperationsSessionRepository.GemFireSessionAttributes.

Returns:

a new AbstractGemFireOperationsSessionRepository.GemFireSession.

See Also:

• AbstractGemFireOperationsSessionRepository.isUsingDataSerialization()

copy

public static AbstractGemFireOperationsSessionRepository.GemFireSession copy(@NonNull
 org.springframework.session.Session session)

Copy (i.e. clone) the given Session.

Parameters:

session - Session to copy/clone.

Returns:

a new instance of AbstractGemFireOperationsSessionRepository.GemFireSession copied from the given Session.

See Also:

• Session
• AbstractGemFireOperationsSessionRepository.isUsingDataSerialization()

from

public static AbstractGemFireOperationsSessionRepository.GemFireSession from(@NonNull
 org.springframework.session.Session session)

Returns the given Session if the Session is a AbstractGemFireOperationsSessionRepository.GemFireSession or return a copy of the given Session as a AbstractGemFireOperationsSessionRepository.GemFireSession.

Parameters:

session - Session to evaluate and possibly copy.

Returns:

the given Session if the Session is a AbstractGemFireOperationsSessionRepository.GemFireSession or return a copy of the given Session as a AbstractGemFireOperationsSessionRepository.GemFireSession.

See Also:

• copy(Session)

newSessionAttributes

protected T newSessionAttributes(Object lock)

Constructs a new AbstractGemFireOperationsSessionRepository.GemFireSessionAttributes object to store and manage Session attributes.

Parameters:

lock - Object used as the mutex for concurrent access and Thread-safety.

Returns:

the new AbstractGemFireOperationsSessionRepository.GemFireSessionAttributes.

See Also:

• AbstractGemFireOperationsSessionRepository.GemFireSessionAttributes
• getIsDirtyPredicate()

changeSessionId

public String changeSessionId()

Change the identifier of this Session.

Specified by:

changeSessionId in interface org.springframework.session.Session

Returns:

the new identifier of of this Session.

See Also:

• generateSessionId()
• triggerDelta()
• getId()

commit

protected void commit()

hasDelta

public boolean hasDelta()

Determines whether this AbstractGemFireOperationsSessionRepository.GemFireSession has any changes (i.e. a delta). Changes exist if this GemFireSession's ID, last accessed time, max inactive interval or any of these attributes have changed.

Returns:

a boolean value indicating whether this AbstractGemFireOperationsSessionRepository.GemFireSession has any changes.

See Also:

• AbstractGemFireOperationsSessionRepository.GemFireSessionAttributes.hasDelta()
• getAttributes()

triggerDelta

protected void triggerDelta()

triggerDelta

protected void triggerDelta(boolean delta)

getId

public String getId()

Specified by:

getId in interface org.springframework.session.Session

setAttribute

public void setAttribute(String attributeName,
 Object attributeValue)

Specified by:

setAttribute in interface org.springframework.session.Session

removeAttribute

public void removeAttribute(String attributeName)

Specified by:

removeAttribute in interface org.springframework.session.Session

getAttribute

public <T> T getAttribute(String attributeName)

Specified by:

getAttribute in interface org.springframework.session.Session

getAttributeNames

public Set<String> getAttributeNames()

Specified by:

getAttributeNames in interface org.springframework.session.Session

getAttributes

public T getAttributes()

getCreationTime

public Instant getCreationTime()

Specified by:

getCreationTime in interface org.springframework.session.Session

isExpired

public boolean isExpired()

Specified by:

isExpired in interface org.springframework.session.Session

setIsDirtyPredicate

protected void setIsDirtyPredicate(IsDirtyPredicate dirtyPredicate)

getIsDirtyPredicate

protected IsDirtyPredicate getIsDirtyPredicate()

setLastAccessedTime

public void setLastAccessedTime(Instant lastAccessedTime)

Specified by:

setLastAccessedTime in interface org.springframework.session.Session

getLastAccessedTime

public Instant getLastAccessedTime()

Specified by:

getLastAccessedTime in interface org.springframework.session.Session

setMaxInactiveInterval

public void setMaxInactiveInterval(Duration maxInactiveInterval)

Specified by:

setMaxInactiveInterval in interface org.springframework.session.Session

getMaxInactiveInterval

public Duration getMaxInactiveInterval()

Specified by:

getMaxInactiveInterval in interface org.springframework.session.Session

setPrincipalName

public void setPrincipalName(String principalName)

getPrincipalName

public String getPrincipalName()

configureWith

public AbstractGemFireOperationsSessionRepository.GemFireSession<T> configureWith(Duration maxInactiveInterval)

Builder method to configure the max inactive interval before this AbstractGemFireOperationsSessionRepository.GemFireSession will expire.

Parameters:

maxInactiveInterval - Duration specifying the maximum time this AbstractGemFireOperationsSessionRepository.GemFireSession can remain inactive before expiration.

Returns:

this AbstractGemFireOperationsSessionRepository.GemFireSession.

See Also:

• setMaxInactiveInterval(Duration)
• Duration

configureWith

public AbstractGemFireOperationsSessionRepository.GemFireSession<T> configureWith(IsDirtyPredicate dirtyPredicate)

Builder method to configure the IsDirtyPredicate strategy interface implementation to determine whether users' application domain objects stored in this AbstractGemFireOperationsSessionRepository.GemFireSession are dirty.

Parameters:

dirtyPredicate - IsDirtyPredicate strategy interface implementation that determines whether the users' application domain objects stored in this AbstractGemFireOperationsSessionRepository.GemFireSession are dirty.

Returns:

this AbstractGemFireOperationsSessionRepository.GemFireSession.

See Also:

• IsDirtyPredicate
• setIsDirtyPredicate(IsDirtyPredicate)

compareTo

public int compareTo(org.springframework.session.Session session)

Specified by:

compareTo in interface Comparable<T extends AbstractGemFireOperationsSessionRepository.GemFireSessionAttributes>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object