org.springframework.session.data.gemfire

Class AbstractGemFireOperationsSessionRepository

java.lang.Object

org.springframework.session.data.gemfire.AbstractGemFireOperationsSessionRepository

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationEventPublisherAware, org.springframework.session.FindByIndexNameSessionRepository<org.springframework.session.Session>, org.springframework.session.SessionRepository<org.springframework.session.Session>

Direct Known Subclasses:

GemFireOperationsSessionRepository, GemFireOperationsSessionRepositorySupport

public abstract class AbstractGemFireOperationsSessionRepository
extends java.lang.Object
implements org.springframework.context.ApplicationEventPublisherAware, org.springframework.session.FindByIndexNameSessionRepository<org.springframework.session.Session>

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:

Duration, Instant, UUID, DataSerializable, DataSerializer, Delta, EntryEvent, Operation, Region, RegionAttributes, Pool, PoolManager, CacheListenerAdapter, ApplicationEvent, ApplicationEventPublisher, ApplicationEventPublisherAware, GemfireOperations, FindByIndexNameSessionRepository, Session, SessionRepository, GemFireHttpSessionConfiguration, EnableGemFireHttpSession, SessionChangedEvent, DeltaAwareDirtyPredicate, IsDirtyPredicate, SessionIdHolder, AbstractSessionEvent, SessionCreatedEvent, SessionDeletedEvent, SessionDestroyedEvent, SessionExpiredEvent

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 AbstractGemFireOperationsSessionRepository.GemFireSessionAttributes class is a container for Session attributes implementing both the DataSerializable and Delta Pivotal GemFire interfaces for efficient storage and distribution (replication) in GemFire.
protected static class	AbstractGemFireOperationsSessionRepository.SessionEventHandlerCacheListenerAdapter
protected static class	AbstractGemFireOperationsSessionRepository.SessionIdInterestRegisteringCacheListener

Field Summary

Fields inherited from interface org.springframework.session.FindByIndexNameSessionRepository

PRINCIPAL_NAME_INDEX_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractGemFireOperationsSessionRepository() Protected, default constructor used by extensions of AbstractGemFireOperationsSessionRepository in order to affect and assess SessionRepository configuration and state.
	AbstractGemFireOperationsSessionRepository(org.springframework.data.gemfire.GemfireOperations template) Constructs a new instance of AbstractGemFireOperationsSessionRepository initialized with a required GemfireOperations object, which is used to perform Apache Geode or Pivotal GemFire data access operations on the cache Region storing and managing Session state to support this SessionRepository and its operations.

Method Summary

Modifier and Type	Method and Description
protected org.springframework.session.Session	commit(org.springframework.session.Session session) Commits the given Session.
protected org.springframework.session.Session	configure(org.springframework.session.Session session)
protected org.springframework.session.Session	delete(org.springframework.session.Session session) Deletes the given Session from Apache Geode / Pivotal GemFire.
protected org.springframework.context.ApplicationEventPublisher	getApplicationEventPublisher() Returns a reference to the configured ApplicationEventPublisher used to publish Session events corresponding to Apache Geode/Pivotal GemFire cache events.
IsDirtyPredicate	getIsDirtyPredicate() Returns the configured IsDirtyPredicate strategy interface implementation used to determine whether the users' application domain objects are dirty or not.
protected org.slf4j.Logger	getLogger() Return a reference to the Logger 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.
protected java.util.Optional<AbstractGemFireOperationsSessionRepository.SessionEventHandlerCacheListenerAdapter>	getSessionEventHandler()
protected org.apache.geode.cache.Region<java.lang.Object,org.springframework.session.Session>	getSessionsRegion() Returns a reference to the configured Apache Geode / Pivotal GemFire cache Region used to store and manage (HTTP) Session data.
protected java.lang.String	getSessionsRegionName() Returns the fully-qualified name of the cache Region used to store and manage Session state.
org.springframework.data.gemfire.GemfireOperations	getSessionsTemplate() Returns a reference to the template used to perform data access operations and other interactions on the cache Region storing and managing Session state and backing this SessionRepository.
org.springframework.data.gemfire.GemfireOperations	getTemplate() Deprecated. use getSessionsTemplate().
protected void	handleDeleted(java.lang.String sessionId, org.springframework.session.Session session) Handles the deletion of the given Session.
protected boolean	isRegisterInterestEnabled() Determines whether Region register interest is enabled in the current Apache Geode / Pivotal GemFire configuration.
protected static boolean	isUsingDataSerialization() Determines whether the DataSerialization framework has been configured.
protected AbstractGemFireOperationsSessionRepository.SessionEventHandlerCacheListenerAdapter	newSessionEventHandler() Constructs a new instance of AbstractGemFireOperationsSessionRepository.SessionEventHandlerCacheListenerAdapter.
protected AbstractGemFireOperationsSessionRepository.SessionIdInterestRegisteringCacheListener	newSessionIdInterestRegistrar() Constructs a new instance of AbstractGemFireOperationsSessionRepository.SessionIdInterestRegisteringCacheListener.
protected void	publishEvent(org.springframework.context.ApplicationEvent event) Publishes the specified ApplicationEvent to the Spring container thereby notifying other (potentially) interested application components/beans.
protected void	registerInterest(java.lang.Object sessionId) Registers interest on the Session.getId() ID} of a Session.
protected org.springframework.session.Session	registerInterest(org.springframework.session.Session session) Registers interest in the given Session in order to receive notifications and updates.
protected org.apache.geode.cache.client.Pool	resolvePool(java.lang.String name) Resolves the Pool with the given name from the PoolManager.
void	setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher) Sets the configured ApplicationEventPublisher used to publish Session events corresponding to Apache Geode/Pivotal GemFire cache events.
void	setIsDirtyPredicate(IsDirtyPredicate dirtyPredicate) Configures the IsDirtyPredicate strategy interface used to determine whether the users' application domain objects are dirty or not.
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 org.springframework.session.Session	touch(org.springframework.session.Session session) Updates the Session.setLastAccessedTime(Instant) property of the Session to the current time.
protected void	unregisterInterest(java.lang.Object sessionId) Unregisters interest on the Session.getId() ID} of a Session.
protected org.springframework.session.Session	unregisterInterest(org.springframework.session.Session session) Unregisters interest in the given Session in order to stop notifications and updates.

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, findByPrincipalName

Methods inherited from interface org.springframework.session.SessionRepository

createSession, deleteById, findById, save

Constructor Detail

AbstractGemFireOperationsSessionRepository

protected AbstractGemFireOperationsSessionRepository()

Protected, default constructor used by extensions of AbstractGemFireOperationsSessionRepository in order to affect and assess SessionRepository configuration and state.

AbstractGemFireOperationsSessionRepository

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

Constructs a new instance of AbstractGemFireOperationsSessionRepository initialized with a required GemfireOperations object, which is used to perform Apache Geode or Pivotal GemFire data access operations on the cache Region storing and managing Session state to support this SessionRepository and its operations.

Parameters:

template - GemfireOperations object used to interact with the Apache Geode or Pivotal GemFire cache Region storing and managing Session state; must not be null.

Throws:

java.lang.IllegalArgumentException - if GemfireOperations is null.

See Also:

GemfireOperations, resolveSessionsRegion(GemfireOperations), initializeSessionsRegion(Region), newLogger()

Method Detail

resolvePool

@Nullable
protected org.apache.geode.cache.client.Pool resolvePool(java.lang.String name)

Resolves the Pool with the given name from the PoolManager.

Parameters:

name - String containing the name of the Pool to resolve.

Returns:

the resolved Pool for the given name.

See Also:

PoolManager.find(String), Pool

newSessionEventHandler

protected AbstractGemFireOperationsSessionRepository.SessionEventHandlerCacheListenerAdapter newSessionEventHandler()

Constructs a new instance of AbstractGemFireOperationsSessionRepository.SessionEventHandlerCacheListenerAdapter.

Returns:

a new instance of AbstractGemFireOperationsSessionRepository.SessionEventHandlerCacheListenerAdapter.

See Also:

AbstractGemFireOperationsSessionRepository.SessionEventHandlerCacheListenerAdapter

newSessionIdInterestRegistrar

protected AbstractGemFireOperationsSessionRepository.SessionIdInterestRegisteringCacheListener newSessionIdInterestRegistrar()

Constructs a new instance of AbstractGemFireOperationsSessionRepository.SessionIdInterestRegisteringCacheListener.

Returns:

a new instance of AbstractGemFireOperationsSessionRepository.SessionIdInterestRegisteringCacheListener.

See Also:

AbstractGemFireOperationsSessionRepository.SessionIdInterestRegisteringCacheListener

setApplicationEventPublisher

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

Sets the configured ApplicationEventPublisher used to publish Session events corresponding to Apache Geode/Pivotal GemFire cache events.

Specified by:

setApplicationEventPublisher in interface org.springframework.context.ApplicationEventPublisherAware

Parameters:

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

Throws:

java.lang.IllegalArgumentException - if ApplicationEventPublisher is null.

See Also:

ApplicationEventPublisher

getApplicationEventPublisher

@NonNull
protected org.springframework.context.ApplicationEventPublisher getApplicationEventPublisher()

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

Returns:

the configured ApplicationEventPublisher used to publish Session events.

See Also:

ApplicationEventPublisher

setIsDirtyPredicate

public void setIsDirtyPredicate(IsDirtyPredicate dirtyPredicate)

Configures the IsDirtyPredicate strategy interface used to determine whether the users' application domain objects are dirty or not.

Parameters:

dirtyPredicate - IsDirtyPredicate strategy interface implementation used to determine whether the users' application domain objects are dirty or not.

See Also:

IsDirtyPredicate

getIsDirtyPredicate

public IsDirtyPredicate getIsDirtyPredicate()

Returns the configured IsDirtyPredicate strategy interface implementation used to determine whether the users' application domain objects are dirty or not. Defaults to GemFireHttpSessionConfiguration.DEFAULT_IS_DIRTY_PREDICATE.

Returns:

the configured IsDirtyPredicate strategy interface used to determine whether the users' application domain objects are dirty or not.

See Also:

IsDirtyPredicate

getLogger

protected org.slf4j.Logger getLogger()

Return a reference to the Logger used to log messages.

Returns:

a reference to the Logger 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()

isRegisterInterestEnabled

protected boolean isRegisterInterestEnabled()

Determines whether Region register interest is enabled in the current Apache Geode / Pivotal GemFire configuration.

Returns:

a boolean value indicating whether interest registration is enabled.

getSessionEventHandler

protected java.util.Optional<AbstractGemFireOperationsSessionRepository.SessionEventHandlerCacheListenerAdapter> getSessionEventHandler()

getSessionsRegion

@NonNull
protected org.apache.geode.cache.Region<java.lang.Object,org.springframework.session.Session> getSessionsRegion()

Returns a reference to the configured Apache Geode / Pivotal GemFire cache Region used to store and manage (HTTP) Session data.

Returns:

a reference to the configured Sessions Region.

See Also:

Session, Region

getSessionsRegionName

protected java.lang.String getSessionsRegionName()

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.

See Also:

getSessionsRegion()

getSessionsTemplate

@NonNull
public org.springframework.data.gemfire.GemfireOperations getSessionsTemplate()

Returns a reference to the template used to perform data access operations and other interactions on the cache Region storing and managing Session state and backing this SessionRepository.

Returns:

a reference to the template used to interact the Region storing and managing Session state.

See Also:

GemfireOperations

getTemplate

@Deprecated
 @NonNull
public org.springframework.data.gemfire.GemfireOperations getTemplate()

Deprecated. use getSessionsTemplate().

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.

See Also:

resolveSystemUsingDataSerialization()

commit

@Nullable
protected org.springframework.session.Session commit(@Nullable
                                                               org.springframework.session.Session session)

Commits the given Session.

Parameters:

session - Session to commit, iff the Session is committable.

Returns:

the given Session

See Also:

AbstractGemFireOperationsSessionRepository.GemFireSession.commit()

configure

@Nullable
protected org.springframework.session.Session configure(@Nullable
                                                                  org.springframework.session.Session session)

delete

@Nullable
protected org.springframework.session.Session delete(@NonNull
                                                               org.springframework.session.Session session)

Deletes the given Session from Apache Geode / Pivotal GemFire.

Parameters:

session - Session to delete.

Returns:

null.

See Also:

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

handleDeleted

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

Handles the deletion of the given Session.

Parameters:

sessionId - String containing the Session.getId() of the given Session.

session - deleted Session.

See Also:

AbstractGemFireOperationsSessionRepository.SessionEventHandlerCacheListenerAdapter.afterDelete(String, Session), Session, unregisterInterest(Object)

publishEvent

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

Publishes the specified ApplicationEvent to the Spring container thereby notifying other (potentially) interested application components/beans.

Parameters:

event - ApplicationEvent to publish.

See Also:

ApplicationEventPublisher.publishEvent(ApplicationEvent), ApplicationEvent

registerInterest

protected org.springframework.session.Session registerInterest(@Nullable
                                                               org.springframework.session.Session session)

Registers interest in the given Session in order to receive notifications and updates.

Parameters:

session - Session of interest to this application that will be registered.

Returns:

the given Session.

See Also:

Session.getId(), Session, registerInterest(Object)

registerInterest

protected void registerInterest(@Nullable
                                java.lang.Object sessionId)

Registers interest on the Session.getId() ID} of a Session. And, only registers interest in the given Session ID iff we have not already registered interest in this Session ID before.

Parameters:

sessionId - ID of the Session of interest to this application.

See Also:

Region.registerInterest(Object, InterestResultPolicy, boolean, boolean), isRegisterInterestEnabled()

touch

@NonNull
protected org.springframework.session.Session touch(@NonNull
                                                             org.springframework.session.Session session)

Updates the Session.setLastAccessedTime(Instant) property of the Session to the current time.

Parameters:

session - Session to touch.

Returns:

the Session.

See Also:

Session.setLastAccessedTime(Instant), Session, Instant.now()

unregisterInterest

protected org.springframework.session.Session unregisterInterest(@Nullable
                                                                 org.springframework.session.Session session)

Unregisters interest in the given Session in order to stop notifications and updates.

Parameters:

session - Session no longer of any interest to this application that will be unregistered.

Returns:

the given Session.

See Also:

Session.getId(), Session, unregisterInterest(Object)

unregisterInterest

protected void unregisterInterest(@Nullable
                                  java.lang.Object sessionId)

Unregisters interest on the Session.getId() ID} of a Session.

Parameters:

sessionId - ID of the Session no longer of any interest to this application.

See Also:

Region.unregisterInterest(Object), isRegisterInterestEnabled()