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

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 java.lang.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:

Duration, Optional, Session, SessionExpirationPolicy, SessionExpirationTimeoutAware

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.session.data.gemfire.expiration.SessionExpirationPolicy

SessionExpirationPolicy.ExpirationAction

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.time.Duration	DEFAULT_IDLE_TIMEOUT

Constructor Summary

Constructors

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.

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.util.Optional<java.time.Duration>	getIdleTimeout() Return an optionally configured expiration idle timeout.
void	setExpirationTimeout(java.time.Duration idleTimeout) Configures the expiration idle 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 Detail

DEFAULT_IDLE_TIMEOUT

protected static final java.time.Duration DEFAULT_IDLE_TIMEOUT

Constructor Detail

IdleTimeoutSessionExpirationPolicy

public IdleTimeoutSessionExpirationPolicy()

Constructs a new IdleTimeoutSessionExpirationPolicy initialized with the DEFAULT_IDLE_TIMEOUT.

See Also:

#DEFAULT_IDLE_TIMEOUT

IdleTimeoutSessionExpirationPolicy

public IdleTimeoutSessionExpirationPolicy(@Nullable
                                          java.time.Duration idleTimeout)

Constructs a new IdleTimeoutSessionExpirationPolicy initialized with the given idle timeout.

Parameters:

idleTimeout - length of time until an idle, or inactive Session should expire; Maybe null to suggest the Session should not expire.

See Also:

Duration

Method Detail

setExpirationTimeout

public void setExpirationTimeout(@Nullable
                                 java.time.Duration idleTimeout)

Configures the expiration idle timeout.

Specified by:

setExpirationTimeout in interface SessionExpirationTimeoutAware

Parameters:

idleTimeout - length of time until an idle, or inactive Session should expire; Maybe null to suggest the Session should not expire.

See Also:

Duration

getIdleTimeout

protected java.util.Optional<java.time.Duration> getIdleTimeout()

Return an optionally configured expiration idle timeout.

Returns:

the optionally configured expiration idle timeout.

See Also:

Duration, Optional

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

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