@FunctionalInterface
public interface SessionExpirationPolicy
SessionExpirationPolicy
interface is a Strategy Interface defining a contract for users to implement
custom application expiration policies and rules for Session
state management.
Examples of different Session
expiration strategies might include, but are not limited to:
idle expiration timeouts, fixed duration expiration timeouts, Time-To-Live (TTL) expiration, and so on.FunctionalInterface
,
Region
,
Session
,
FixedTimeoutSessionExpirationPolicy
,
IdleTimeoutSessionExpirationPolicy
Modifier and Type | Interface and Description |
---|---|
static class |
SessionExpirationPolicy.ExpirationAction
Enumeration of different actions to take when a
Session expires. |
Modifier and Type | Method and Description |
---|---|
java.util.Optional<java.time.Duration> |
determineExpirationTimeout(org.springframework.session.Session session)
Determines an
Optional length of time until the given Session will expire. |
default SessionExpirationPolicy.ExpirationAction |
getExpirationAction()
Specifies the
action to take when the Session expires. |
java.util.Optional<java.time.Duration> determineExpirationTimeout(@NonNull org.springframework.session.Session session)
Optional
length of time
until the given Session
will expire.
A Zero
or Negative Duration
indicates that
the Session
has expired.
May return Optional.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, an Optional.EMPTY
return value will indicate that it
should default to the configured Entry Idle Timeout (TTI) Expiration Policy of the Region
managing
Session
state to determine exactly when the Session
will expire.session
- Session
to evaluate. Session
is required.Optional
Duration
specifying the length of time until the Session
will expire.Session
,
Duration
,
Optional
default SessionExpirationPolicy.ExpirationAction getExpirationAction()
action
to take when the Session
expires.
Defaults to SessionExpirationPolicy.ExpirationAction.INVALIDATE
.SessionExpirationPolicy.ExpirationAction
specifying the action to take when the Session
expires.SessionExpirationPolicy.ExpirationAction