Package org.springframework.session

Interface SessionRepository<S extends Session>

Type Parameters:

S - the Session type

All Known Subinterfaces:

FindByIndexNameSessionRepository<S>

All Known Implementing Classes:

HazelcastIndexedSessionRepository, JdbcIndexedSessionRepository, MapSessionRepository, MongoIndexedSessionRepository, RedisIndexedSessionRepository, RedisSessionRepository

public interface SessionRepository<S extends Session>

A repository interface for managing Session instances.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
S	createSession()	Creates a new Session that is capable of being persisted by this SessionRepository.
void	deleteById(String id)	Deletes the Session with the given Session.getId() or does nothing if the Session is not found.
S	findById(String id)	Gets the Session by the Session.getId() or null if no Session is found.
void	save(S session)	Ensures the Session created by createSession() is saved.

Method Details

createSession

S createSession()

Creates a new Session that is capable of being persisted by this SessionRepository.

This allows optimizations and customizations in how the Session is persisted. For example, the implementation returned might keep track of the changes ensuring that only the delta needs to be persisted on a save.

Returns:

a new Session that is capable of being persisted by this SessionRepository

save

void save(S session)

Ensures the Session created by createSession() is saved.

Some implementations may choose to save as the Session is updated by returning a Session that immediately persists any changes. In this case, this method may not actually do anything.

Parameters:

session - the Session to save

findById

S findById(String id)

Gets the Session by the Session.getId() or null if no Session is found.

Parameters:

id - the Session.getId() to lookup

Returns:

the Session by the Session.getId() or null if no Session is found.

deleteById

void deleteById(String id)

Deletes the Session with the given Session.getId() or does nothing if the Session is not found.

Parameters:

id - the Session.getId() to delete