public class IdleTimeoutSessionExpirationPolicy extends java.lang.Object implements SessionExpirationPolicy, SessionExpirationTimeoutAware
SessionExpirationPolicy
interface that specifies an expiration policy for
Sessions
that have been idle, or inactive for a predefined duration of time
.Duration
,
Optional
,
Session
,
SessionExpirationPolicy
,
SessionExpirationTimeoutAware
SessionExpirationPolicy.ExpirationAction
Modifier and Type | Field and Description |
---|---|
protected static java.time.Duration |
DEFAULT_IDLE_TIMEOUT |
Constructor and Description |
---|
IdleTimeoutSessionExpirationPolicy()
Constructs a new
IdleTimeoutSessionExpirationPolicy initialized with
the DEFAULT_IDLE_TIMEOUT . |
IdleTimeoutSessionExpirationPolicy(java.time.Duration idleTimeout)
Constructs a new
IdleTimeoutSessionExpirationPolicy initialized with
the given idle timeout . |
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. |
protected java.util.Optional<java.time.Duration> |
getIdleTimeout()
Return an
optionally configured expiration idle timeout . |
void |
setExpirationTimeout(java.time.Duration idleTimeout)
Configures the expiration
idle timeout . |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getExpirationAction
public IdleTimeoutSessionExpirationPolicy()
IdleTimeoutSessionExpirationPolicy
initialized with
the DEFAULT_IDLE_TIMEOUT
.#DEFAULT_IDLE_TIMEOUT
public IdleTimeoutSessionExpirationPolicy(@Nullable java.time.Duration idleTimeout)
IdleTimeoutSessionExpirationPolicy
initialized with
the given idle timeout
.idleTimeout
- length of time
until an idle, or inactive Session
should expire;
Maybe null to suggest the Session
should not expire.Duration
public void setExpirationTimeout(@Nullable java.time.Duration idleTimeout)
idle timeout
.setExpirationTimeout
in interface SessionExpirationTimeoutAware
idleTimeout
- length of time
until an idle, or inactive Session
should expire;
Maybe null to suggest the Session
should not expire.Duration
protected java.util.Optional<java.time.Duration> getIdleTimeout()
optionally
configured expiration idle timeout
.optionally
configured expiration idle timeout
.Duration
,
Optional
public java.util.Optional<java.time.Duration> determineExpirationTimeout(@NonNull org.springframework.session.Session session)
SessionExpirationPolicy
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.determineExpirationTimeout
in interface SessionExpirationPolicy
session
- Session
to evaluate. Session
is required.Optional
Duration
specifying the length of time until the Session
will expire.Session
,
Duration
,
Optional