org.springframework.session.data.gemfire

Class AbstractGemFireOperationsSessionRepository

java.lang.Object

org.apache.geode.cache.util.CacheListenerAdapter<java.lang.Object,org.springframework.session.Session>

org.springframework.session.data.gemfire.AbstractGemFireOperationsSessionRepository

All Implemented Interfaces:

org.apache.geode.cache.CacheCallback, org.apache.geode.cache.CacheListener<java.lang.Object,org.springframework.session.Session>, org.apache.geode.cache.Declarable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationEventPublisherAware, org.springframework.session.FindByIndexNameSessionRepository<org.springframework.session.Session>, org.springframework.session.SessionRepository<org.springframework.session.Session>

Direct Known Subclasses:

GemFireOperationsSessionRepository

public abstract class AbstractGemFireOperationsSessionRepository
extends org.apache.geode.cache.util.CacheListenerAdapter<java.lang.Object,org.springframework.session.Session>
implements org.springframework.context.ApplicationEventPublisherAware, org.springframework.session.FindByIndexNameSessionRepository<org.springframework.session.Session>, org.springframework.beans.factory.InitializingBean

AbstractGemFireOperationsSessionRepository is an abstract base class encapsulating functionality common to all implementations that support SessionRepository operations backed by Apache Geode.

Since:

1.1.0

See Also:

DataSerializable, DataSerializer, Delta, Instantiator, Region, CacheListenerAdapter, InitializingBean, ApplicationEventPublisher, ApplicationEventPublisherAware, GemfireOperations, Expression, FindByIndexNameSessionRepository, Session, SessionRepository, GemFireHttpSessionConfiguration, EnableGemFireHttpSession

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractGemFireOperationsSessionRepository.DeltaCapableGemFireSession
static class	AbstractGemFireOperationsSessionRepository.DeltaCapableGemFireSessionAttributes
static class	AbstractGemFireOperationsSessionRepository.GemFireSession<T extends AbstractGemFireOperationsSessionRepository.GemFireSessionAttributes> AbstractGemFireOperationsSessionRepository.GemFireSession is a Abstract Data Type (ADT) for a Spring Session that stores and manages Session state in Apache Geode or Pivotal GemFire.
static class	AbstractGemFireOperationsSessionRepository.GemFireSessionAttributes The GemFireSessionAttributes class is a container for Session attributes implementing both the DataSerializable and Delta GemFire interfaces for efficient storage and distribution (replication) in GemFire.

Field Summary

Fields inherited from interface org.springframework.session.FindByIndexNameSessionRepository

PRINCIPAL_NAME_INDEX_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractGemFireOperationsSessionRepository(org.springframework.data.gemfire.GemfireOperations template) Constructs an instance of AbstractGemFireOperationsSessionRepository with a required GemfireOperations instance used to perform GemFire data access operations and interactions supporting the SessionRepository operations.

Method Summary

Modifier and Type	Method and Description
void	afterCreate(org.apache.geode.cache.EntryEvent<java.lang.Object,org.springframework.session.Session> event) Callback method triggered when an entry is created in the GemFire cache Region.
void	afterDestroy(org.apache.geode.cache.EntryEvent<java.lang.Object,org.springframework.session.Session> event) Callback method triggered when an entry is destroyed in the GemFire cache Region.
void	afterInvalidate(org.apache.geode.cache.EntryEvent<java.lang.Object,org.springframework.session.Session> event) Callback method triggered when an entry is invalidated in the GemFire cache Region.
void	afterPropertiesSet() Callback method during Spring bean initialization that will capture the fully-qualified name of the cache Region used to manage Session state and register this SessionRepository as a GemFire/Geode CacheListener.
protected org.springframework.session.Session	delete(org.springframework.session.Session session) Deletes the given Session from GemFire.
protected org.springframework.context.ApplicationEventPublisher	getApplicationEventPublisher() Returns a reference to the ApplicationEventPublisher used to publish Session events corresponding to GemFire/Geode cache events.
protected java.lang.String	getFullyQualifiedRegionName() Returns the fully-qualified name of the cache Region used to store and manage Session state.
protected org.apache.commons.logging.Log	getLogger() Return a reference to the Log used to log messages.
java.time.Duration	getMaxInactiveInterval() Returns the maximum interval in which a Session can remain inactive before the Session is considered expired.
int	getMaxInactiveIntervalInSeconds() Returns the maximum interval in seconds in which a Session can remain inactive before the Session is considered expired.
org.springframework.data.gemfire.GemfireOperations	getTemplate() Gets a reference to the template used to perform data access operations and other interactions on the cache Region backing this SessionRepository.
protected void	handleCreated(java.lang.String sessionId, org.springframework.session.Session session) Causes Session created events to be published to the Spring application context.
protected void	handleDeleted(java.lang.String sessionId, org.springframework.session.Session session) Causes Session deleted events to be published to the Spring application context.
protected void	handleDestroyed(java.lang.String sessionId, org.springframework.session.Session session) Causes Session destroyed events to be published to the Spring application context.
protected void	handleExpired(java.lang.String sessionId, org.springframework.session.Session session) Causes Session expired events to be published to the Spring application context.
protected static boolean	isUsingDataSerialization() Determines whether the DataSerialization framework has been configured.
protected void	publishEvent(org.springframework.context.ApplicationEvent event) Publishes the specified ApplicationEvent to the Spring application context.
void	setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher) Sets the ApplicationEventPublisher used to publish Session events corresponding to GemFire cache events.
void	setMaxInactiveInterval(java.time.Duration maxInactiveInterval) Sets the maximum interval in which a Session can remain inactive before the Session is considered expired.
void	setMaxInactiveIntervalInSeconds(int maxInactiveIntervalInSeconds) Sets the maximum interval in seconds in which a Session can remain inactive before the Session is considered expired.
void	setUseDataSerialization(boolean useDataSerialization) Sets a condition indicating whether the DataSerialization framework has been configured.
protected <T extends org.springframework.session.Session> T	touch(T session) Updates the Session.setLastAccessedTime(Instant) property of the Session.

Methods inherited from class org.apache.geode.cache.util.CacheListenerAdapter

afterRegionClear, afterRegionCreate, afterRegionDestroy, afterRegionInvalidate, afterRegionLive, afterUpdate, close

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.session.FindByIndexNameSessionRepository

findByIndexNameAndIndexValue

Methods inherited from interface org.springframework.session.SessionRepository

createSession, deleteById, findById, save

Methods inherited from interface org.apache.geode.cache.Declarable

init

Constructor Detail

AbstractGemFireOperationsSessionRepository

public AbstractGemFireOperationsSessionRepository(org.springframework.data.gemfire.GemfireOperations template)

Constructs an instance of AbstractGemFireOperationsSessionRepository with a required GemfireOperations instance used to perform GemFire data access operations and interactions supporting the SessionRepository operations.

Parameters:

template - GemfireOperations instance used to interact with GemFire; must not be null.

Throws:

java.lang.IllegalArgumentException - if GemfireOperations is null.

See Also:

GemfireOperations

Method Detail

setApplicationEventPublisher

public void setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher)

Sets the ApplicationEventPublisher used to publish Session events corresponding to GemFire cache events.

Specified by:

setApplicationEventPublisher in interface org.springframework.context.ApplicationEventPublisherAware

Parameters:

applicationEventPublisher - the Spring ApplicationEventPublisher used to publish Session-based events; must not be null.

Throws:

java.lang.IllegalArgumentException - if ApplicationEventPublisher is null.

See Also:

ApplicationEventPublisher

getApplicationEventPublisher

protected org.springframework.context.ApplicationEventPublisher getApplicationEventPublisher()

Returns a reference to the ApplicationEventPublisher used to publish Session events corresponding to GemFire/Geode cache events.

Returns:

the Spring ApplicationEventPublisher used to publish Session events.

See Also:

ApplicationEventPublisher

getFullyQualifiedRegionName

protected java.lang.String getFullyQualifiedRegionName()

Returns the fully-qualified name of the cache Region used to store and manage Session state.

Returns:

a String containing the fully qualified name of the cache Region used to store and manage Session data.

getLogger

protected org.apache.commons.logging.Log getLogger()

Return a reference to the Log used to log messages.

Returns:

a reference to the Log used to log messages.

See Also:

Log

setMaxInactiveInterval

public void setMaxInactiveInterval(java.time.Duration maxInactiveInterval)

Sets the maximum interval in which a Session can remain inactive before the Session is considered expired.

Parameters:

maxInactiveInterval - Duration specifying the maximum interval that a Session can remain inactive before the Session is considered expired.

See Also:

Duration

getMaxInactiveInterval

public java.time.Duration getMaxInactiveInterval()

Returns the maximum interval in which a Session can remain inactive before the Session is considered expired.

Returns:

a Duration specifying the maximum interval that a Session can remain inactive before the Session is considered expired.

See Also:

Duration

setMaxInactiveIntervalInSeconds

public void setMaxInactiveIntervalInSeconds(int maxInactiveIntervalInSeconds)

Sets the maximum interval in seconds in which a Session can remain inactive before the Session is considered expired.

Parameters:

maxInactiveIntervalInSeconds - an integer value specifying the maximum interval in seconds that a Session can remain inactive before the Sessionis considered expired.

See Also:

setMaxInactiveInterval(Duration)

getMaxInactiveIntervalInSeconds

public int getMaxInactiveIntervalInSeconds()

Returns the maximum interval in seconds in which a Session can remain inactive before the Session is considered expired.

Returns:

an integer value specifying the maximum interval in seconds that a Session can remain inactive before the Session is considered expired.

See Also:

getMaxInactiveInterval()

setUseDataSerialization

public void setUseDataSerialization(boolean useDataSerialization)

Sets a condition indicating whether the DataSerialization framework has been configured.

Parameters:

useDataSerialization - boolean indicating whether the DataSerialization framework has been configured.

isUsingDataSerialization

protected static boolean isUsingDataSerialization()

Determines whether the DataSerialization framework has been configured.

Returns:

a boolean indicating whether the DataSerialization framework has been configured.

getTemplate

public org.springframework.data.gemfire.GemfireOperations getTemplate()

Gets a reference to the template used to perform data access operations and other interactions on the cache Region backing this SessionRepository.

Returns:

a reference to the template used to interact with GemFire/Geode.

See Also:

GemfireOperations

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

Callback method during Spring bean initialization that will capture the fully-qualified name of the cache Region used to manage Session state and register this SessionRepository as a GemFire/Geode CacheListener. Additionally, this method registers GemFire/Geode Instantiators for the AbstractGemFireOperationsSessionRepository.GemFireSession and AbstractGemFireOperationsSessionRepository.GemFireSessionAttributes types to optimize GemFire/Geode's instantiation logic on deserialization using the data serialization framework when accessing the stored Session state.

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

java.lang.Exception - if an error occurs during the initialization process.

afterCreate

public void afterCreate(org.apache.geode.cache.EntryEvent<java.lang.Object,org.springframework.session.Session> event)

Callback method triggered when an entry is created in the GemFire cache Region.

Specified by:

afterCreate in interface org.apache.geode.cache.CacheListener<java.lang.Object,org.springframework.session.Session>

Overrides:

afterCreate in class org.apache.geode.cache.util.CacheListenerAdapter<java.lang.Object,org.springframework.session.Session>

Parameters:

event - EntryEvent containing the details of the cache Region operation.

See Also:

EntryEvent, handleCreated(String, Session)

afterDestroy

public void afterDestroy(org.apache.geode.cache.EntryEvent<java.lang.Object,org.springframework.session.Session> event)

Callback method triggered when an entry is destroyed in the GemFire cache Region.

Specified by:

afterDestroy in interface org.apache.geode.cache.CacheListener<java.lang.Object,org.springframework.session.Session>

Overrides:

afterDestroy in class org.apache.geode.cache.util.CacheListenerAdapter<java.lang.Object,org.springframework.session.Session>

Parameters:

event - an EntryEvent containing the details of the cache operation.

See Also:

EntryEvent, handleDestroyed(String, Session)

afterInvalidate

public void afterInvalidate(org.apache.geode.cache.EntryEvent<java.lang.Object,org.springframework.session.Session> event)

Callback method triggered when an entry is invalidated in the GemFire cache Region.

Specified by:

afterInvalidate in interface org.apache.geode.cache.CacheListener<java.lang.Object,org.springframework.session.Session>

Overrides:

afterInvalidate in class org.apache.geode.cache.util.CacheListenerAdapter<java.lang.Object,org.springframework.session.Session>

Parameters:

event - an EntryEvent containing the details of the cache operation.

See Also:

EntryEvent, handleExpired(String, Session)

delete

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

Deletes the given Session from GemFire.

Parameters:

session - Session to delete.

Returns:

null.

See Also:

Session.getId(), SessionRepository.deleteById(String)

handleCreated

protected void handleCreated(java.lang.String sessionId,
                             org.springframework.session.Session session)

Causes Session created events to be published to the Spring application context.

Parameters:

sessionId - a String indicating the ID of the Session.

session - a reference to the Session triggering the event.

See Also:

SessionCreatedEvent, Session, newSessionCreatedEvent(Session, String), publishEvent(ApplicationEvent)

handleDeleted

protected void handleDeleted(java.lang.String sessionId,
                             org.springframework.session.Session session)

Causes Session deleted events to be published to the Spring application context.

Parameters:

sessionId - a String indicating the ID of the Session.

session - a reference to the Session triggering the event.

See Also:

SessionDeletedEvent, Session, newSessionDeletedEvent(Session, String), publishEvent(ApplicationEvent), forget(Object)

handleDestroyed

protected void handleDestroyed(java.lang.String sessionId,
                               org.springframework.session.Session session)

Causes Session destroyed events to be published to the Spring application context.

Parameters:

sessionId - a String indicating the ID of the Session.

session - a reference to the Session triggering the event.

See Also:

SessionDestroyedEvent, Session, newSessionDestroyedEvent(Session, String), publishEvent(ApplicationEvent), forget(Object)

handleExpired

protected void handleExpired(java.lang.String sessionId,
                             org.springframework.session.Session session)

Causes Session expired events to be published to the Spring application context.

Parameters:

sessionId - a String indicating the ID of the Session.

session - a reference to the Session triggering the event.

See Also:

SessionExpiredEvent, Session, newSessionExpiredEvent(Session, String), publishEvent(ApplicationEvent), forget(Object)

publishEvent

protected void publishEvent(org.springframework.context.ApplicationEvent event)

Publishes the specified ApplicationEvent to the Spring application context.

Parameters:

event - the ApplicationEvent to publish.

See Also:

ApplicationEventPublisher.publishEvent(ApplicationEvent), ApplicationEvent

touch

protected <T extends org.springframework.session.Session> T touch(T session)

Updates the Session.setLastAccessedTime(Instant) property of the Session.

Type Parameters:

T - Class sub-type of the Session.

Parameters:

session - Session to touch.

Returns:

the Session.

See Also:

Session.setLastAccessedTime(Instant)