Modifier and Type	Class and Description
private class	InMemoryWebSessionStore.ExpiredSessionChecker
private class	InMemoryWebSessionStore.InMemoryWebSession
private static enum	InMemoryWebSessionStore.State

Modifier and Type	Field and Description
private Clock	clock
private final InMemoryWebSessionStore.ExpiredSessionChecker	expiredSessionChecker
private static final IdGenerator	idGenerator
private int	maxSessions
private final Map<String, InMemoryWebSessionStore.InMemoryWebSession>	sessions

Access	Constructor and Description
public	InMemoryWebSessionStore()

Modifier and Type	Method and Description
public Mono<WebSession>	createWebSession() Implements org.springframework.web.server.session.WebSessionStore.createWebSession. Create a new WebSession.
public Clock	getClock() Return the configured clock for session lastAccessTime calculations.
public int	getMaxSessions() Return the maximum number of sessions that can be stored.
public Map<String, WebSession>	getSessions() Return the map of sessions with an `unmodifiable` wrapper.
public void	removeExpiredSessions() Check for expired sessions and remove them.
public Mono<Void>	removeSession(String the id of the session to remove id) Implements org.springframework.web.server.session.WebSessionStore.removeSession. Remove the WebSession for the specified id.
public Mono<WebSession>	retrieveSession(String the session to load id) Implements org.springframework.web.server.session.WebSessionStore.retrieveSession. Return the WebSession for the given id. Note This method should perform an expiration check, and if it has expired remove the session and return empty.
public void	setClock(Clock the clock to use clock) Configure the `Clock` to use to set lastAccessTime on every created session and to calculate if it is expired.
public void	setMaxSessions(int the maximum number of sessions maxSessions) Set the maximum number of sessions that can be stored.
public Mono<WebSession>	updateLastAccessTime(WebSession the session to update session) Implements org.springframework.web.server.session.WebSessionStore.updateLastAccessTime. Update the last accessed timestamp to "now".

clock	back to summary
private Clock clock

expiredSessionChecker	back to summary
private final InMemoryWebSessionStore.ExpiredSessionChecker expiredSessionChecker

idGenerator	back to summary
private static final IdGenerator idGenerator

maxSessions	back to summary
private int maxSessions

sessions	back to summary
private final Map<String, InMemoryWebSessionStore.InMemoryWebSession> sessions

InMemoryWebSessionStore	back to summary
public InMemoryWebSessionStore()

Method Detail

createWebSession back to summary

createWebSession	back to summary
public Mono<WebSession> createWebSession() Implements org.springframework.web.server.session.WebSessionStore.createWebSession. Doc from org.springframework.web.server.session.WebSessionStore.createWebSession. Create a new WebSession. Note that this does nothing more than create a new instance. The session can later be started explicitly via `WebSession#start()` or implicitly by adding attributes -- and then persisted via `WebSession#save()`. Returns:Mono<WebSession> the created session instance Annotations @Override

public Mono<WebSession> createWebSession()

Implements org.springframework.web.server.session.WebSessionStore.createWebSession.

Doc from org.springframework.web.server.session.WebSessionStore.createWebSession.

Create a new WebSession.

Note that this does nothing more than create a new instance. The session can later be started explicitly via WebSession#start() or implicitly by adding attributes -- and then persisted via WebSession#save().

Returns:Mono<WebSession>

the created session instance

Annotations

@Override

getClock	back to summary
public Clock getClock() Return the configured clock for session lastAccessTime calculations.

getMaxSessions	back to summary
public int getMaxSessions() Return the maximum number of sessions that can be stored. Since 5.0.8

getMaxSessions

back to summary

public int getMaxSessions()

Return the maximum number of sessions that can be stored.

Since: 5.0.8

getSessions back to summary

getSessions	back to summary
public Map<String, WebSession> getSessions() Return the map of sessions with an `unmodifiable` wrapper. This could be used for management purposes, to list active sessions, invalidate expired ones, etc. Since 5.0.8

public Map<String, WebSession> getSessions()

Return the map of sessions with an unmodifiable wrapper. This could be used for management purposes, to list active sessions, invalidate expired ones, etc.

Since: 5.0.8

removeExpiredSessions back to summary

removeExpiredSessions	back to summary
public void removeExpiredSessions() Check for expired sessions and remove them. Typically such checks are kicked off lazily during calls to `create` or `retrieve`, no less than 60 seconds apart. This method can be called to force a check at a specific time. Since 5.0.8

public void removeExpiredSessions()

Check for expired sessions and remove them. Typically such checks are kicked off lazily during calls to create or retrieve, no less than 60 seconds apart. This method can be called to force a check at a specific time.

Since: 5.0.8

removeSession	back to summary
public Mono<Void> removeSession(String id) Implements org.springframework.web.server.session.WebSessionStore.removeSession. Doc from org.springframework.web.server.session.WebSessionStore.removeSession. Remove the WebSession for the specified id. Parameters id:String the id of the session to remove Returns:Mono<Void> a completion notification (success or error) Annotations @Override

removeSession

back to summary

public Mono<Void> removeSession(String id)

Implements org.springframework.web.server.session.WebSessionStore.removeSession.

Doc from org.springframework.web.server.session.WebSessionStore.removeSession.

Remove the WebSession for the specified id.

Parameters

id:String: the id of the session to remove

Returns:Mono<Void>

a completion notification (success or error)

Annotations

@Override

retrieveSession back to summary

retrieveSession	back to summary
public Mono<WebSession> retrieveSession(String id) Implements org.springframework.web.server.session.WebSessionStore.retrieveSession. Doc from org.springframework.web.server.session.WebSessionStore.retrieveSession. Return the WebSession for the given id. Note This method should perform an expiration check, and if it has expired remove the session and return empty. This method should also update the lastAccessTime of retrieved sessions. Parameters id:String the session to load Returns:Mono<WebSession> the session, or an empty `Mono` Annotations @Override

public Mono<WebSession> retrieveSession(String id)

Implements org.springframework.web.server.session.WebSessionStore.retrieveSession.

Doc from org.springframework.web.server.session.WebSessionStore.retrieveSession.

Return the WebSession for the given id.

Note

This method should perform an expiration check, and if it has expired remove the session and return empty. This method should also update the lastAccessTime of retrieved sessions.

Parameters

id:String: the session to load

Returns:Mono<WebSession>

the session, or an empty Mono

Annotations

@Override

setClock back to summary

setClock	back to summary
public void setClock(Clock clock) Configure the `Clock` to use to set lastAccessTime on every created session and to calculate if it is expired. This may be useful to align to different timezone or to set the clock back in a test, e.g. `Clock.offset(clock, Duration.ofMinutes(-31))` in order to simulate session expiration. By default this is `Clock.system(ZoneId.of("GMT"))`. Parameters clock:Clock the clock to use

public void setClock(Clock clock)

Configure the Clock to use to set lastAccessTime on every created session and to calculate if it is expired.

This may be useful to align to different timezone or to set the clock back in a test, e.g. Clock.offset(clock, Duration.ofMinutes(-31)) in order to simulate session expiration.

By default this is Clock.system(ZoneId.of("GMT")).

Parameters

clock:Clock: the clock to use

setMaxSessions back to summary

setMaxSessions	back to summary
public void setMaxSessions(int maxSessions) Set the maximum number of sessions that can be stored. Once the limit is reached, any attempt to store an additional session will result in an `IllegalStateException`. By default set to 10000. Parameters maxSessions:int the maximum number of sessions Since 5.0.8

public void setMaxSessions(int maxSessions)

Set the maximum number of sessions that can be stored. Once the limit is reached, any attempt to store an additional session will result in an IllegalStateException.

By default set to 10000.

Parameters

maxSessions:int: the maximum number of sessions

Since

5.0.8

updateLastAccessTime	back to summary
public Mono<WebSession> updateLastAccessTime(WebSession session) Implements org.springframework.web.server.session.WebSessionStore.updateLastAccessTime. Doc from org.springframework.web.server.session.WebSessionStore.updateLastAccessTime. Update the last accessed timestamp to "now". Parameters session:WebSession the session to update Returns:Mono<WebSession> the session with the updated last access time Annotations @Override

updateLastAccessTime

back to summary

public Mono<WebSession> updateLastAccessTime(WebSession session)

Implements org.springframework.web.server.session.WebSessionStore.updateLastAccessTime.

Doc from org.springframework.web.server.session.WebSessionStore.updateLastAccessTime.

Update the last accessed timestamp to "now".

Parameters

session:WebSession: the session to update

Returns:Mono<WebSession>

the session with the updated last access time

Annotations

@Override

Modifier and Type	Field and Description
private static final int	CHECK_PERIOD Max time between expiration checks.
private Instant	checkTime
private final Lock	lock

Access	Constructor and Description
private	ExpiredSessionChecker()

Modifier and Type	Method and Description
public void	checkIfNecessary(Instant now)
public void	removeExpiredSessions(Instant now)

CHECK_PERIOD	back to summary
private static final int CHECK_PERIOD Max time between expiration checks.

checkTime	back to summary
private Instant checkTime

lock	back to summary
private final Lock lock

ExpiredSessionChecker	back to summary
private ExpiredSessionChecker()

checkIfNecessary	back to summary
public void checkIfNecessary(Instant now)

removeExpiredSessions	back to summary
public void removeExpiredSessions(Instant now)

org.springframework.web.server.session back to summary

private Class InMemoryWebSessionStore.InMemoryWebSession

Class Inheritance

extends Object
implements WebSession

java.lang.Object
org.springframework.web.server.session.InMemoryWebSessionStore.InMemoryWebSession

All Implemented Interfaces

org.springframework.web.server.WebSession

Field Summary

Modifier and Type	Field and Description
private final Map<String, Object>	attributes
private final Instant	creationTime
private final AtomicReference<String>	id
private volatile Instant	lastAccessTime
private volatile Duration	maxIdleTime
private final AtomicReference<InMemoryWebSessionStore.State>	state

Constructor Summary

Access	Constructor and Description
public	InMemoryWebSession(Instant creationTime)

Method Summary

Modifier and Type	Method and Description
public Mono<Void>	changeSessionId() Implements org.springframework.web.server.WebSession.changeSessionId. Generate a new id for the session and update the underlying session storage to reflect the new id. After a successful call `getId()` reflects the new session id.
private boolean	checkExpired(Instant currentTime)
private void	checkMaxSessionsLimit()
public Map<String, Object>	getAttributes() Implements org.springframework.web.server.WebSession.getAttributes. Return a map that holds session attributes.
public Instant	getCreationTime() Implements org.springframework.web.server.WebSession.getCreationTime. Return the time when the session was created.
public String	getId() Implements org.springframework.web.server.WebSession.getId. Return a unique session identifier.
public Instant	getLastAccessTime() Implements org.springframework.web.server.WebSession.getLastAccessTime. Return the last time of session access as a result of user activity such as an HTTP request.
public Duration	getMaxIdleTime() Implements org.springframework.web.server.WebSession.getMaxIdleTime. Return the maximum time after the `lastAccessTime` before a session expires.
public Mono<Void>	invalidate() Implements org.springframework.web.server.WebSession.invalidate. Invalidate the current session and clear session storage.
public boolean	isExpired() Implements org.springframework.web.server.WebSession.isExpired. Return `true` if the session expired after `maxIdleTime` elapsed.
private boolean	isExpired(Instant now)
public boolean	isStarted() Implements org.springframework.web.server.WebSession.isStarted. Whether a session with the client has been started explicitly via `start()` or implicitly by adding session attributes.
public Mono<Void>	save() Implements org.springframework.web.server.WebSession.save. Save the session through the `WebSessionStore` as follows: If the session is new (i.e. created but never persisted), it must have been started explicitly via `start()` or implicitly by adding attributes, or otherwise this method should have no effect. If the session was retrieved through the `WebSessionStore`, the implementation for this method must check whether the session was `invalidated` and if so return an error.
public void	setMaxIdleTime(Duration maxIdleTime) Implements org.springframework.web.server.WebSession.setMaxIdleTime. Configure the max amount of time that may elapse after the `lastAccessTime` before a session is considered expired.
public void	start() Implements org.springframework.web.server.WebSession.start. Force the creation of a session causing the session id to be sent when `save()` is called.
private void	updateLastAccessTime(Instant currentTime)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

attributes	back to summary
private final Map<String, Object> attributes

creationTime	back to summary
private final Instant creationTime

id	back to summary
private final AtomicReference<String> id

lastAccessTime	back to summary
private volatile Instant lastAccessTime

maxIdleTime	back to summary
private volatile Duration maxIdleTime

state	back to summary
private final AtomicReference<InMemoryWebSessionStore.State> state

Constructor Detail

InMemoryWebSession	back to summary
public InMemoryWebSession(Instant creationTime)

Method Detail

changeSessionId back to summary

changeSessionId	back to summary
public Mono<Void> changeSessionId() Implements org.springframework.web.server.WebSession.changeSessionId. Doc from org.springframework.web.server.WebSession.changeSessionId. Generate a new id for the session and update the underlying session storage to reflect the new id. After a successful call `getId()` reflects the new session id. Returns:Mono<Void> completion notification (success or error) Annotations @Override

public Mono<Void> changeSessionId()

Implements org.springframework.web.server.WebSession.changeSessionId.

Doc from org.springframework.web.server.WebSession.changeSessionId.

Generate a new id for the session and update the underlying session storage to reflect the new id. After a successful call getId() reflects the new session id.

Returns:Mono<Void>

completion notification (success or error)

Annotations

@Override

checkExpired	back to summary
private boolean checkExpired(Instant currentTime)

checkMaxSessionsLimit	back to summary
private void checkMaxSessionsLimit()

getAttributes	back to summary
public Map<String, Object> getAttributes() Implements org.springframework.web.server.WebSession.getAttributes. Doc from org.springframework.web.server.WebSession.getAttributes. Return a map that holds session attributes. Annotations @Override

getAttributes

back to summary

public Map<String, Object> getAttributes()

Implements org.springframework.web.server.WebSession.getAttributes.

Doc from org.springframework.web.server.WebSession.getAttributes.

Return a map that holds session attributes.

Annotations

@Override

getCreationTime	back to summary
public Instant getCreationTime() Implements org.springframework.web.server.WebSession.getCreationTime. Doc from org.springframework.web.server.WebSession.getCreationTime. Return the time when the session was created. Annotations @Override

getCreationTime

back to summary

public Instant getCreationTime()

Implements org.springframework.web.server.WebSession.getCreationTime.

Doc from org.springframework.web.server.WebSession.getCreationTime.

Return the time when the session was created.

Annotations

@Override

getId	back to summary
public String getId() Implements org.springframework.web.server.WebSession.getId. Doc from org.springframework.web.server.WebSession.getId. Return a unique session identifier. Annotations @Override

getId

back to summary

public String getId()

Implements org.springframework.web.server.WebSession.getId.

Doc from org.springframework.web.server.WebSession.getId.

Return a unique session identifier.

Annotations

@Override

getLastAccessTime back to summary

getLastAccessTime	back to summary
public Instant getLastAccessTime() Implements org.springframework.web.server.WebSession.getLastAccessTime. Doc from org.springframework.web.server.WebSession.getLastAccessTime. Return the last time of session access as a result of user activity such as an HTTP request. Together with `maxIdleTimeInSeconds` this helps to determine when a session is `expired`. Annotations @Override

public Instant getLastAccessTime()

Implements org.springframework.web.server.WebSession.getLastAccessTime.

Doc from org.springframework.web.server.WebSession.getLastAccessTime.

Return the last time of session access as a result of user activity such as an HTTP request. Together with maxIdleTimeInSeconds this helps to determine when a session is expired.

Annotations

@Override

getMaxIdleTime back to summary

getMaxIdleTime	back to summary
public Duration getMaxIdleTime() Implements org.springframework.web.server.WebSession.getMaxIdleTime. Doc from org.springframework.web.server.WebSession.getMaxIdleTime. Return the maximum time after the `lastAccessTime` before a session expires. A negative time indicates the session doesn't expire. Annotations @Override

public Duration getMaxIdleTime()

Implements org.springframework.web.server.WebSession.getMaxIdleTime.

Doc from org.springframework.web.server.WebSession.getMaxIdleTime.

Return the maximum time after the lastAccessTime before a session expires. A negative time indicates the session doesn't expire.

Annotations

@Override

invalidate	back to summary
public Mono<Void> invalidate() Implements org.springframework.web.server.WebSession.invalidate. Doc from org.springframework.web.server.WebSession.invalidate. Invalidate the current session and clear session storage. Returns:Mono<Void> completion notification (success or error) Annotations @Override

invalidate

back to summary

public Mono<Void> invalidate()

Implements org.springframework.web.server.WebSession.invalidate.

Doc from org.springframework.web.server.WebSession.invalidate.

Invalidate the current session and clear session storage.

Returns:Mono<Void>

completion notification (success or error)

Annotations

@Override

isExpired back to summary

isExpired	back to summary
public boolean isExpired() Implements org.springframework.web.server.WebSession.isExpired. Doc from org.springframework.web.server.WebSession.isExpired. Return `true` if the session expired after `maxIdleTime` elapsed. Typically expiration checks should be automatically made when a session is accessed, a new `WebSession` instance created if necessary, at the start of request processing so that applications don't have to worry about expired session by default. Annotations @Override

public boolean isExpired()

Implements org.springframework.web.server.WebSession.isExpired.

Doc from org.springframework.web.server.WebSession.isExpired.

Return true if the session expired after maxIdleTime elapsed.

Typically expiration checks should be automatically made when a session is accessed, a new WebSession instance created if necessary, at the start of request processing so that applications don't have to worry about expired session by default.

Annotations

@Override

isExpired	back to summary
private boolean isExpired(Instant now)

isStarted back to summary

public boolean isStarted()

Implements org.springframework.web.server.WebSession.isStarted.

Doc from org.springframework.web.server.WebSession.isStarted.

Whether a session with the client has been started explicitly via start() or implicitly by adding session attributes. If "false" then the session id is not sent to the client and the save() method is essentially a no-op.

Annotations

@Override

save back to summary

public Mono<Void> save()

Implements org.springframework.web.server.WebSession.save.

Doc from org.springframework.web.server.WebSession.save.

Save the session through the WebSessionStore as follows:

If the session is new (i.e. created but never persisted), it must have been started explicitly via start() or implicitly by adding attributes, or otherwise this method should have no effect.
If the session was retrieved through the WebSessionStore, the implementation for this method must check whether the session was invalidated and if so return an error.

Note that this method is not intended for direct use by applications. Instead it is automatically invoked just before the response is committed.

Returns:Mono<Void>

Mono to indicate completion with success or error

Annotations

@Override

setMaxIdleTime back to summary

public void setMaxIdleTime(Duration maxIdleTime)

Implements org.springframework.web.server.WebSession.setMaxIdleTime.

Doc from org.springframework.web.server.WebSession.setMaxIdleTime.

Configure the max amount of time that may elapse after the lastAccessTime before a session is considered expired. A negative value indicates the session should not expire.

Annotations

@Override

start back to summary

public void start()

Implements org.springframework.web.server.WebSession.start.

Doc from org.springframework.web.server.WebSession.start.

Force the creation of a session causing the session id to be sent when save() is called.

Annotations

@Override

updateLastAccessTime	back to summary
private void updateLastAccessTime(Instant currentTime)

Modifier and Type	Field and Description
public static final InMemoryWebSessionStore.State	EXPIRED
public static final InMemoryWebSessionStore.State	NEW
public static final InMemoryWebSessionStore.State	STARTED

Modifier and Type	Method and Description
public static InMemoryWebSessionStore.State	valueOf(String name)
public static InMemoryWebSessionStore.State[]	values()

public Class InMemoryWebSessionStore

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class InMemoryWebSessionStore.ExpiredSessionChecker

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class InMemoryWebSessionStore.InMemoryWebSession

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum InMemoryWebSessionStore.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail