org.springframework.session.data.gemfire.expiration.support

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

public class FixedTimeoutSessionExpirationPolicy
extends IdleTimeoutSessionExpirationPolicy

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:

Duration, Session, SessionExpirationPolicy, IdleTimeoutSessionExpirationPolicy

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

Constructors

Constructor and Description
FixedTimeoutSessionExpirationPolicy(java.time.Duration fixedTimeout) Constructs a new FixedTimeoutSessionExpirationPolicy initialized with the given fixed, expiration timeout.

Method Summary

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.time.Duration	getFixedTimeout() Return the configured fixed 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 Detail

FixedTimeoutSessionExpirationPolicy

public FixedTimeoutSessionExpirationPolicy(@NonNull
                                           java.time.Duration fixedTimeout)

Constructs a new FixedTimeoutSessionExpirationPolicy initialized with the given fixed, expiration timeout.

Parameters:

fixedTimeout - fixed length of time until the Session will expire.

Throws:

java.lang.IllegalArgumentException - if the fixed timeout is null.

See Also:

Duration

Method Detail

getFixedTimeout

protected java.time.Duration getFixedTimeout()

Return the configured fixed expiration timeout.

Returns:

the configured fixed expiration timeout.

See Also:

Duration

determineExpirationTimeout

public java.util.Optional<java.time.Duration> determineExpirationTimeout(@NonNull
                                                                         org.springframework.session.Session session)

Description copied from interface: SessionExpirationPolicy

Determines an 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.

Specified by:

determineExpirationTimeout in interface SessionExpirationPolicy

Overrides:

determineExpirationTimeout in class IdleTimeoutSessionExpirationPolicy

Parameters:

session - Session to evaluate. Session is required.

Returns:

an Optional Duration specifying the length of time until the Session will expire.

See Also:

Composite Software Design Pattern, Session, Duration, Optional