org.springframework.session.data.gemfire.expiration

Interface SessionExpirationPolicy

All Known Implementing Classes:

FixedTimeoutSessionExpirationPolicy, IdleTimeoutSessionExpirationPolicy

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface SessionExpirationPolicy

The 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.

Since:

2.1.0

See Also:

FunctionalInterface, Region, Session, FixedTimeoutSessionExpirationPolicy, IdleTimeoutSessionExpirationPolicy

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SessionExpirationPolicy.ExpirationAction Enumeration of different actions to take when a Session expires.

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.
default SessionExpirationPolicy.ExpirationAction	getExpirationAction() Specifies the action to take when the Session expires.

Method Detail

determineExpirationTimeout

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

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.

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

getExpirationAction

default SessionExpirationPolicy.ExpirationAction getExpirationAction()

Specifies the action to take when the Session expires. Defaults to SessionExpirationPolicy.ExpirationAction.INVALIDATE.

Returns:

an SessionExpirationPolicy.ExpirationAction specifying the action to take when the Session expires.

See Also:

SessionExpirationPolicy.ExpirationAction