org.springframework.session.data.gemfire.expiration.support

Class SessionExpirationPolicyCustomExpiryAdapter

java.lang.Object

org.springframework.session.data.gemfire.expiration.support.SessionExpirationPolicyCustomExpiryAdapter

All Implemented Interfaces:

org.apache.geode.cache.CacheCallback, org.apache.geode.cache.CustomExpiry<java.lang.String,java.lang.Object>, org.apache.geode.cache.Declarable

public class SessionExpirationPolicyCustomExpiryAdapter
extends java.lang.Object
implements org.apache.geode.cache.CustomExpiry<java.lang.String,java.lang.Object>

The SessionExpirationPolicyCustomExpiryAdapter class is an Apache Geode/Pivotal GemFire CustomExpiry implementation wrapping and adapting an instance of the SessionExpirationPolicy strategy interface to plugin to and affect Apache Geode/Pivotal GemFire's expiration behavior.

Since:

1.0.0

See Also:

CustomExpiry, ExpirationAction, ExpirationAttributes, Region, PdxInstance, Session, SessionExpirationPolicy

Field Summary

Fields

Modifier and Type	Field and Description
protected static SessionExpirationPolicy.ExpirationAction	DEFAULT_EXPIRATION_ACTION

Constructor Summary

Constructors

Constructor and Description
SessionExpirationPolicyCustomExpiryAdapter(SessionExpirationPolicy sessionExpirationPolicy) Constructs a new SessionExpirationPolicyCustomExpiryAdapter initialized with the given, required SessionExpirationPolicy.

Method Summary

Modifier and Type	Method and Description
org.apache.geode.cache.ExpirationAttributes	getExpiry(org.apache.geode.cache.Region.Entry<java.lang.String,java.lang.Object> regionEntry)
protected SessionExpirationPolicy	getSessionExpirationPolicy() Returns the configured SessionExpirationPolicy defining the expiration policies for all managed Sessions.
protected org.apache.geode.cache.ExpirationAttributes	newExpirationAttributes(java.time.Duration expirationTimeout) Constructs a new ExpirationAttributes initialized with the given expiration timeut and default expirtion action.
protected org.apache.geode.cache.ExpirationAttributes	newExpirationAttributes(java.time.Duration expirationTimeout, SessionExpirationPolicy.ExpirationAction expirationAction) Constructs a new ExpirationAttributes initialized with the given expiration timeout and action taken when the Session expires.

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.CacheCallback

close

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

init, initialize

Field Detail

DEFAULT_EXPIRATION_ACTION

protected static final SessionExpirationPolicy.ExpirationAction DEFAULT_EXPIRATION_ACTION

Constructor Detail

SessionExpirationPolicyCustomExpiryAdapter

public SessionExpirationPolicyCustomExpiryAdapter(@NonNull
                                                  SessionExpirationPolicy sessionExpirationPolicy)

Constructs a new SessionExpirationPolicyCustomExpiryAdapter initialized with the given, required SessionExpirationPolicy.

Parameters:

sessionExpirationPolicy - SessionExpirationPolicy used to determine the expiration policy for all Sessions.

Throws:

java.lang.IllegalArgumentException - if SessionExpirationPolicy is null.

See Also:

SessionExpirationPolicy

Method Detail

getSessionExpirationPolicy

protected SessionExpirationPolicy getSessionExpirationPolicy()

Returns the configured SessionExpirationPolicy defining the expiration policies for all managed Sessions.

Returns:

the configured SessionExpirationPolicy.

See Also:

SessionExpirationPolicy

getExpiry

@Nullable
public org.apache.geode.cache.ExpirationAttributes getExpiry(@Nullable
                                                                       org.apache.geode.cache.Region.Entry<java.lang.String,java.lang.Object> regionEntry)

Specified by:

getExpiry in interface org.apache.geode.cache.CustomExpiry<java.lang.String,java.lang.Object>

newExpirationAttributes

@NonNull
protected org.apache.geode.cache.ExpirationAttributes newExpirationAttributes(@NonNull
                                                                                       java.time.Duration expirationTimeout)

Constructs a new ExpirationAttributes initialized with the given expiration timeut and default expirtion action.

Parameters:

expirationTimeout - Duration specifying the expiration timeout.

Returns:

the new ExpirationAttributes.

See Also:

newExpirationAttributes(Duration, SessionExpirationPolicy.ExpirationAction), ExpirationAttributes, Duration

newExpirationAttributes

@NonNull
protected org.apache.geode.cache.ExpirationAttributes newExpirationAttributes(@NonNull
                                                                                       java.time.Duration expirationTimeout,
                                                                                       @Nullable
                                                                                       SessionExpirationPolicy.ExpirationAction expirationAction)

Constructs a new ExpirationAttributes initialized with the given expiration timeout and action taken when the Session expires.

Parameters:

expirationTimeout - Duration specifying the expiration timeout.

expirationAction - action taken when the Session expires.

Returns:

the new ExpirationAttributes.

See Also:

newExpirationAttributes(int, ExpirationAction), SessionExpirationPolicy.ExpirationAction, ExpirationAttributes, Duration