org.springframework.session.security

Class SpringSessionBackedSessionRegistry

java.lang.Object

org.springframework.session.security.SpringSessionBackedSessionRegistry

All Implemented Interfaces:

org.springframework.security.core.session.SessionRegistry

public class SpringSessionBackedSessionRegistry
extends Object
implements org.springframework.security.core.session.SessionRegistry

A SessionRegistry that retrieves session information from Spring Session, rather than maintaining it itself. This allows concurrent session management with Spring Security in a clustered environment.

Relies on being able to derive the same String-based representation of the principal given to getAllSessions(Object, boolean) as used by Spring Session in order to look up the user's sessions.

Does not support getAllPrincipals(), since that information is not available.

Since:

1.3

Author:

Joris Kuipers

Constructor Summary

Constructors

Constructor and Description
SpringSessionBackedSessionRegistry(FindByIndexNameSessionRepository<ExpiringSession> sessionRepository)

Method Summary

Modifier and Type	Method and Description
List<Object>	getAllPrincipals()
List<org.springframework.security.core.session.SessionInformation>	getAllSessions(Object principal, boolean includeExpiredSessions)
org.springframework.security.core.session.SessionInformation	getSessionInformation(String sessionId)
protected String	name(Object principal) Derives a String name for the given principal.
void	refreshLastRequest(String sessionId)
void	registerNewSession(String sessionId, Object principal)
void	removeSessionInformation(String sessionId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpringSessionBackedSessionRegistry

public SpringSessionBackedSessionRegistry(FindByIndexNameSessionRepository<ExpiringSession> sessionRepository)

Method Detail

getAllPrincipals

public List<Object> getAllPrincipals()

Specified by:

getAllPrincipals in interface org.springframework.security.core.session.SessionRegistry

getAllSessions

public List<org.springframework.security.core.session.SessionInformation> getAllSessions(Object principal,
                                                                                         boolean includeExpiredSessions)

Specified by:

getAllSessions in interface org.springframework.security.core.session.SessionRegistry

getSessionInformation

public org.springframework.security.core.session.SessionInformation getSessionInformation(String sessionId)

Specified by:

getSessionInformation in interface org.springframework.security.core.session.SessionRegistry

refreshLastRequest

public void refreshLastRequest(String sessionId)

Specified by:

refreshLastRequest in interface org.springframework.security.core.session.SessionRegistry

registerNewSession

public void registerNewSession(String sessionId,
                               Object principal)

Specified by:

registerNewSession in interface org.springframework.security.core.session.SessionRegistry

removeSessionInformation

public void removeSessionInformation(String sessionId)

Specified by:

removeSessionInformation in interface org.springframework.security.core.session.SessionRegistry

name

protected String name(Object principal)

Derives a String name for the given principal.

Parameters:

principal - as provided by Spring Security

Returns:

name of the principal, or its toString() representation if no name could be derived