Spring Session for VMware GemFire
Class IdleTimeoutSessionExpirationPolicy
java.lang.Object
org.springframework.session.data.gemfire.expiration.support.IdleTimeoutSessionExpirationPolicy
- All Implemented Interfaces:
SessionExpirationTimeoutAware,SessionExpirationPolicy
- Direct Known Subclasses:
FixedTimeoutSessionExpirationPolicy
public class IdleTimeoutSessionExpirationPolicy
extends Object
implements SessionExpirationPolicy, SessionExpirationTimeoutAware
An implementation of the
SessionExpirationPolicy interface that specifies an expiration policy for
Sessions that have been idle, or inactive for a predefined duration of time.- Since:
- 2.1.0
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.springframework.session.data.gemfire.expiration.SessionExpirationPolicy
SessionExpirationPolicy.ExpirationAction -
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a newIdleTimeoutSessionExpirationPolicyinitialized with theDEFAULT_IDLE_TIMEOUT.IdleTimeoutSessionExpirationPolicy(Duration idleTimeout) Constructs a newIdleTimeoutSessionExpirationPolicyinitialized with the givenidle timeout. -
Method Summary
Modifier and TypeMethodDescriptiondetermineExpirationTimeout(org.springframework.session.Session session) Return anoptionallyconfigured expirationidle timeout.voidsetExpirationTimeout(Duration idleTimeout) Configures the expirationidle timeout.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.springframework.session.data.gemfire.expiration.SessionExpirationPolicy
getExpirationAction
-
Field Details
-
DEFAULT_IDLE_TIMEOUT
-
-
Constructor Details
-
IdleTimeoutSessionExpirationPolicy
public IdleTimeoutSessionExpirationPolicy()Constructs a newIdleTimeoutSessionExpirationPolicyinitialized with theDEFAULT_IDLE_TIMEOUT.- See Also:
-
IdleTimeoutSessionExpirationPolicy
Constructs a newIdleTimeoutSessionExpirationPolicyinitialized with the givenidle timeout.- Parameters:
idleTimeout-length of timeuntil an idle, or inactiveSessionshould expire; Maybe null to suggest theSessionshould not expire.- See Also:
-
-
Method Details
-
setExpirationTimeout
Configures the expirationidle timeout.- Specified by:
setExpirationTimeoutin interfaceSessionExpirationTimeoutAware- Parameters:
idleTimeout-length of timeuntil an idle, or inactiveSessionshould expire; Maybe null to suggest theSessionshould not expire.- See Also:
-
getIdleTimeout
Return anoptionallyconfigured expirationidle timeout.- Returns:
- the
optionallyconfigured expirationidle timeout. - See Also:
-
determineExpirationTimeout
public Optional<Duration> determineExpirationTimeout(@NonNull org.springframework.session.Session session) Description copied from interface:SessionExpirationPolicyDetermines anOptionallength of timeuntil the givenSessionwill expire. AZeroorNegative Durationindicates that theSessionhas expired. May returnOptional.EMPTYas a "suggestion" that the Session should not expire or that the expiration determination should be handled by the next expiration policy in a chain of policies. Implementors are free to compose 2 or more expiration policies using Composite Software Design Pattern as necessary. In Apache Geode or Pivotal GemFire's case, anOptional.EMPTYreturn value will indicate that it should default to the configured Entry Idle Timeout (TTI) Expiration Policy of theRegionmanagingSessionstate to determine exactly when theSessionwill expire.- Specified by:
determineExpirationTimeoutin interfaceSessionExpirationPolicy- Parameters:
session-Sessionto evaluate.Sessionis required.- Returns:
- an
OptionalDurationspecifying the length of time until theSessionwill expire. - See Also:
-