Class FixedTimeoutSessionExpirationPolicy
java.lang.Object
org.springframework.session.data.gemfire.expiration.support.IdleTimeoutSessionExpirationPolicy
org.springframework.session.data.gemfire.expiration.support.FixedTimeoutSessionExpirationPolicy
- All Implemented Interfaces:
SessionExpirationTimeoutAware
,SessionExpirationPolicy
An implementation of the
SessionExpirationPolicy
interface that specifies an expiration policy based on
a fixed duration of time
.
In other words, the Session
will timeout after a fixed duration of time
even if
the Session
is still active (i.e. not idle).- 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 inherited from class org.springframework.session.data.gemfire.expiration.support.IdleTimeoutSessionExpirationPolicy
DEFAULT_IDLE_TIMEOUT
-
Constructor Summary
ConstructorDescriptionFixedTimeoutSessionExpirationPolicy
(Duration fixedTimeout) Constructs a newFixedTimeoutSessionExpirationPolicy
initialized with the givenfixed, expiration timeout
. -
Method Summary
Modifier and TypeMethodDescriptiondetermineExpirationTimeout
(org.springframework.session.Session session) protected Duration
Return the configuredfixed expiration timeout
.Methods inherited from class org.springframework.session.data.gemfire.expiration.support.IdleTimeoutSessionExpirationPolicy
getIdleTimeout, setExpirationTimeout
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
-
Constructor Details
-
FixedTimeoutSessionExpirationPolicy
Constructs a newFixedTimeoutSessionExpirationPolicy
initialized with the givenfixed, expiration timeout
.- Parameters:
fixedTimeout
-fixed length of time
until theSession
will expire.- Throws:
IllegalArgumentException
- if thefixed timeout
is null.- See Also:
-
-
Method Details
-
getFixedTimeout
Return the configuredfixed expiration timeout
.- Returns:
- the configured
fixed expiration 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
- Overrides:
determineExpirationTimeout
in classIdleTimeoutSessionExpirationPolicy
- Parameters:
session
-Session
to evaluate.Session
is required.- Returns:
- an
Optional
Duration
specifying the length of time until theSession
will expire. - See Also:
-