org.springframework.session.data.gemfire

Class AbstractGemFireOperationsSessionRepository.SessionEventHandlerCacheListenerAdapter

java.lang.Object

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

org.springframework.session.data.gemfire.AbstractGemFireOperationsSessionRepository.SessionEventHandlerCacheListenerAdapter

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

Enclosing class:

AbstractGemFireOperationsSessionRepository

protected static class AbstractGemFireOperationsSessionRepository.SessionEventHandlerCacheListenerAdapter
extends org.apache.geode.cache.util.CacheListenerAdapter<java.lang.Object,org.springframework.session.Session>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SessionEventHandlerCacheListenerAdapter(AbstractGemFireOperationsSessionRepository sessionRepository) Constructs a new instance of the AbstractGemFireOperationsSessionRepository.SessionEventHandlerCacheListenerAdapter initialized with the given AbstractGemFireOperationsSessionRepository.

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 (put) in the Session cache Region.
protected void	afterDelete(java.lang.String sessionId, org.springframework.session.Session session) Causes Session deleted events to be published to the Spring application context.
void	afterDestroy(org.apache.geode.cache.EntryEvent<java.lang.Object,org.springframework.session.Session> event) Callback method triggered when an entry is destroyed (removed) in the Session 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 (expired) in the Session cache Region.
void	afterUpdate(org.apache.geode.cache.EntryEvent<java.lang.Object,org.springframework.session.Session> event) Callback method triggered when an entry is updated in the Session cache Region.
protected boolean	forget(org.apache.geode.cache.EntryEvent<java.lang.Object,org.springframework.session.Session> entryEvent) Forgets the Key contained in the given EntryEvent as a Session ID.
protected boolean	forget(java.lang.Object sessionId) Forgets the given Session ID.
protected AbstractGemFireOperationsSessionRepository	getSessionRepository() Returns a reference to the configured SessionRepository.
protected boolean	isLocalLoadEvent(org.apache.geode.cache.EntryEvent<?,?> event) Null-safe operation to determine whether the Region EntryEvent is a Operation.LOCAL_LOAD_CREATE or a Operation.LOCAL_LOAD_UPDATE.
protected boolean	isNotLocalLoadEvent(org.apache.geode.cache.EntryEvent<?,?> event) Null-safe operation to determine whether the Region EntryEvent is a Operation.LOCAL_LOAD_CREATE or a Operation.LOCAL_LOAD_UPDATE.
protected boolean	isRemembered(java.lang.Object sessionId) Determines whether the given Session ID has been remembered.
protected boolean	isSession(org.apache.geode.cache.EntryEvent<?,?> entryEvent) Determines whether the new value contained in the EntryEvent is a Session.
protected boolean	isSession(java.lang.Object target) Determines whether the given Object is a Session.
protected SessionChangedEvent	newSessionChangedEvent(org.springframework.session.Session session) Constructs a new SessionChangedEvent initialized with the given Session, using the SessionRepository as the event source.
protected org.springframework.session.events.SessionCreatedEvent	newSessionCreatedEvent(org.springframework.session.Session session) Constructs a new SessionCreatedEvent initialized with the given Session, using the SessionRepository as the event source.
protected org.springframework.session.events.SessionDeletedEvent	newSessionDeletedEvent(org.springframework.session.Session session) Constructs a new SessionDeletedEvent initialized with the given Session, using the SessionRepository as the event source.
protected org.springframework.session.events.SessionDestroyedEvent	newSessionDestroyedEvent(org.springframework.session.Session session) Constructs a new SessionDestroyedEvent initialized with the given Session, using the SessionRepository as the event source.
protected org.springframework.session.events.SessionExpiredEvent	newSessionExpiredEvent(org.springframework.session.Session session) Constructs a new SessionExpiredEvent initialized with the given Session, using the SessionRepository as the event source.
protected boolean	remember(org.apache.geode.cache.EntryEvent<java.lang.Object,org.springframework.session.Session> entryEvent) Remembers the Key contained by the given EntryEvent iff the Key is a valid Session ID and the new value is a Session.
protected boolean	remember(java.lang.Object sessionId) Remembers the given Session ID.
protected org.springframework.session.Session	toSession(java.lang.Object target, java.lang.Object sessionId) Casts the given Object into a Session iff the Object is a Session.

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

afterRegionClear, afterRegionCreate, afterRegionDestroy, afterRegionInvalidate, afterRegionLive, close

Methods inherited from class java.lang.Object

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

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

init, initialize

Constructor Detail

SessionEventHandlerCacheListenerAdapter

protected SessionEventHandlerCacheListenerAdapter(AbstractGemFireOperationsSessionRepository sessionRepository)

Constructs a new instance of the AbstractGemFireOperationsSessionRepository.SessionEventHandlerCacheListenerAdapter initialized with the given AbstractGemFireOperationsSessionRepository.

Parameters:

sessionRepository - AbstractGemFireOperationsSessionRepository used by this event handler to manage Session Events.

Throws:

java.lang.IllegalArgumentException - if AbstractGemFireOperationsSessionRepository is null.

See Also:

AbstractGemFireOperationsSessionRepository

Method Detail

getSessionRepository

@NonNull
protected AbstractGemFireOperationsSessionRepository getSessionRepository()

Returns a reference to the configured SessionRepository.

Returns:

a reference to the configured SessionRepository.

See Also:

AbstractGemFireOperationsSessionRepository

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 (put) in the Session 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 operation.

See Also:

SessionCreatedEvent, Session, EntryEvent, newSessionCreatedEvent(Session), AbstractGemFireOperationsSessionRepository.publishEvent(ApplicationEvent), toSession(Object, Object), forget(Object)

afterDelete

protected void afterDelete(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), AbstractGemFireOperationsSessionRepository.publishEvent(ApplicationEvent), toSession(Object, Object), forget(Object)

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 (removed) in the Session 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 - EntryEvent containing the details of the cache operation.

See Also:

SessionDestroyedEvent, Session, EntryEvent, newSessionDestroyedEvent(Session), AbstractGemFireOperationsSessionRepository.publishEvent(ApplicationEvent), toSession(Object, Object), forget(Object)

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 (expired) in the Session 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 - EntryEvent containing the details of the cache operation.

See Also:

SessionExpiredEvent, Session, EntryEvent, newSessionExpiredEvent(Session), AbstractGemFireOperationsSessionRepository.publishEvent(ApplicationEvent), toSession(Object, Object), forget(Object)

afterUpdate

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

Callback method triggered when an entry is updated in the Session cache Region.

Specified by:

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

Overrides:

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

Parameters:

event - EntryEvent containing the details of the cache operation.

See Also:

SessionChangedEvent, Session, EntryEvent, newSessionChangedEvent(Session), AbstractGemFireOperationsSessionRepository.publishEvent(ApplicationEvent), toSession(Object, Object)

newSessionCreatedEvent

protected org.springframework.session.events.SessionCreatedEvent newSessionCreatedEvent(org.springframework.session.Session session)

Constructs a new SessionCreatedEvent initialized with the given Session, using the SessionRepository as the event source.

Parameters:

session - Session that is the subject of the event.

Returns:

a new SessionCreatedEvent.

See Also:

SessionCreatedEvent, Session, getSessionRepository()

newSessionChangedEvent

protected SessionChangedEvent newSessionChangedEvent(org.springframework.session.Session session)

Constructs a new SessionChangedEvent initialized with the given Session, using the SessionRepository as the event source.

Parameters:

session - Session that is the subject of the change event.

Returns:

a new SessionChangedEvent.

See Also:

SessionChangedEvent, Session, getSessionRepository()

newSessionDeletedEvent

protected org.springframework.session.events.SessionDeletedEvent newSessionDeletedEvent(org.springframework.session.Session session)

Constructs a new SessionDeletedEvent initialized with the given Session, using the SessionRepository as the event source.

Parameters:

session - Session that is the subject of the event.

Returns:

a new SessionDeletedEvent.

See Also:

SessionDeletedEvent, Session, getSessionRepository()

newSessionDestroyedEvent

protected org.springframework.session.events.SessionDestroyedEvent newSessionDestroyedEvent(org.springframework.session.Session session)

Constructs a new SessionDestroyedEvent initialized with the given Session, using the SessionRepository as the event source.

Parameters:

session - Session that is the subject of the event.

Returns:

a new SessionDestroyedEvent.

See Also:

SessionDestroyedEvent, Session, getSessionRepository()

newSessionExpiredEvent

protected org.springframework.session.events.SessionExpiredEvent newSessionExpiredEvent(org.springframework.session.Session session)

Constructs a new SessionExpiredEvent initialized with the given Session, using the SessionRepository as the event source.

Parameters:

session - Session that is the subject of the event.

Returns:

a new SessionExpiredEvent.

See Also:

SessionExpiredEvent, Session, getSessionRepository()

isLocalLoadEvent

protected boolean isLocalLoadEvent(@Nullable
                                   org.apache.geode.cache.EntryEvent<?,?> event)

Null-safe operation to determine whether the Region EntryEvent is a Operation.LOCAL_LOAD_CREATE or a Operation.LOCAL_LOAD_UPDATE.

Parameters:

event - Region EntryEvent to evaluate.

Returns:

a boolean value indicating whether the Region EntryEvent is a local load based event.

See Also:

EntryEvent, isNotLocalLoadEvent(EntryEvent)

isNotLocalLoadEvent

protected boolean isNotLocalLoadEvent(@Nullable
                                      org.apache.geode.cache.EntryEvent<?,?> event)

Null-safe operation to determine whether the Region EntryEvent is a Operation.LOCAL_LOAD_CREATE or a Operation.LOCAL_LOAD_UPDATE.

Parameters:

event - Region EntryEvent to evaluate.

Returns:

a boolean value indicating whether the Region EntryEvent is a local load based event.

See Also:

EntryEvent, isLocalLoadEvent(EntryEvent)

isRemembered

protected boolean isRemembered(java.lang.Object sessionId)

Determines whether the given Session ID has been remembered.

Parameters:

sessionId - Session ID to evaluate.

Returns:

return a boolean value determining whether the given Session ID has been remembered.

See Also:

getCachedSessionIds()

forget

protected boolean forget(org.apache.geode.cache.EntryEvent<java.lang.Object,org.springframework.session.Session> entryEvent)

Forgets the Key contained in the given EntryEvent as a Session ID.

Parameters:

entryEvent - EntryEvent to evaluate.

Returns:

true if the Key contained in the given EntryEvent was forgotten as a Session ID.

See Also:

Session, EntryEvent, forget(Object)

forget

protected boolean forget(java.lang.Object sessionId)

Forgets the given Session ID.

Parameters:

sessionId - Object containing the Session ID to forget.

Returns:

a boolean value indicating whether the given Session ID was forgotten.

See Also:

getCachedSessionIds(), remember(Object)

remember

protected boolean remember(org.apache.geode.cache.EntryEvent<java.lang.Object,org.springframework.session.Session> entryEvent)

Remembers the Key contained by the given EntryEvent iff the Key is a valid Session ID and the new value is a Session.

Parameters:

entryEvent - EntryEvent to evaluate.

Returns:

true if the Key of the given EntryEvent is a valid Session ID.

See Also:

SessionUtils.isValidSessionId(Object), isSession(EntryEvent), remember(Object), Session, EntryEvent

remember

protected boolean remember(java.lang.Object sessionId)

Remembers the given Session ID.

Parameters:

sessionId - Object containing the Session ID to remember.

Returns:

a boolean value indicating whether Spring Session is interested in and will remember the given Session ID.

See Also:

getCachedSessionIds(), forget(Object)

isSession

protected boolean isSession(org.apache.geode.cache.EntryEvent<?,?> entryEvent)

Determines whether the new value contained in the EntryEvent is a Session.

Parameters:

entryEvent - EntryEvent to evaluate.

Returns:

a boolean value indicating whether the new value contained in the EntryEvent is a Session.

See Also:

Session, EntryEvent

isSession

protected boolean isSession(java.lang.Object target)

Determines whether the given Object is a Session.

Parameters:

target - Object to evaluate.

Returns:

a boolean value determining whether the given Object is a Session.

See Also:

Session

toSession

protected org.springframework.session.Session toSession(@Nullable
                                                        java.lang.Object target,
                                                        java.lang.Object sessionId)

Casts the given Object into a Session iff the Object is a Session. Otherwise, this method attempts to use the supplied Session ID to create a Session representation containing only the ID.

Parameters:

target - Object to evaluate as a Session.

sessionId - String containing the Session ID.

Returns:

a Session from the given Object or a Session representation containing only the supplied Session ID.

Throws:

java.lang.IllegalStateException - if the given Object is not a Session and a Session ID was not supplied.

See Also:

Session, SessionUtils.isValidSessionId(Object), isSession(Object)