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 newIdleTimeoutSessionExpirationPolicy
initialized with theDEFAULT_IDLE_TIMEOUT
.IdleTimeoutSessionExpirationPolicy
(Duration idleTimeout) Constructs a newIdleTimeoutSessionExpirationPolicy
initialized with the givenidle timeout
. -
Method Summary
Modifier and TypeMethodDescriptiondetermineExpirationTimeout
(org.springframework.session.Session session) Return anoptionally
configured expirationidle timeout
.void
setExpirationTimeout
(Duration idleTimeout) Configures the expirationidle timeout
.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.data.gemfire.expiration.SessionExpirationPolicy
getExpirationAction
-
Field Details
-
DEFAULT_IDLE_TIMEOUT
-
-
Constructor Details
-
IdleTimeoutSessionExpirationPolicy
public IdleTimeoutSessionExpirationPolicy()Constructs a newIdleTimeoutSessionExpirationPolicy
initialized with theDEFAULT_IDLE_TIMEOUT
.- See Also:
-
IdleTimeoutSessionExpirationPolicy
Constructs a newIdleTimeoutSessionExpirationPolicy
initialized with the givenidle timeout
.- Parameters:
idleTimeout
-length of time
until an idle, or inactiveSession
should expire; Maybe null to suggest theSession
should not expire.- See Also:
-
-
Method Details
-
setExpirationTimeout
Configures the expirationidle timeout
.- Specified by:
setExpirationTimeout
in interfaceSessionExpirationTimeoutAware
- Parameters:
idleTimeout
-length of time
until an idle, or inactiveSession
should expire; Maybe null to suggest theSession
should not expire.- See Also:
-
getIdleTimeout
Return anoptionally
configured expirationidle timeout
.- Returns:
- the
optionally
configured expirationidle timeout
. - See Also:
-
determineExpirationTimeout
public Optional<Duration> determineExpirationTimeout(@NonNull org.springframework.session.Session session) Description copied from interface:SessionExpirationPolicy
Determines anOptional
length of time
until the givenSession
will expire. AZero
orNegative Duration
indicates that theSession
has expired. May returnOptional.EMPTY
as 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.EMPTY
return value will indicate that it should default to the configured Entry Idle Timeout (TTI) Expiration Policy of theRegion
managingSession
state to determine exactly when theSession
will expire.- Specified by:
determineExpirationTimeout
in interfaceSessionExpirationPolicy
- Parameters:
session
-Session
to evaluate.Session
is required.- Returns:
- an
Optional
Duration
specifying the length of time until theSession
will expire. - See Also:
-