Class OidcSessionInformation

java.lang.Object

org.springframework.security.core.session.SessionInformation

org.springframework.security.oauth2.client.oidc.session.OidcSessionInformation

All Implemented Interfaces:

Serializable

public class OidcSessionInformation
extends SessionInformation

A SessionInformation extension that enforces the principal be of type OidcUser.

Since:

6.2

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
OidcSessionInformation(String sessionId, Map<String,String> authorities, OidcUser user)	Construct an OidcSessionInformation.

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getAuthorities()	Any material needed to authorize operations on this session.
OidcUser	getPrincipal()
OidcSessionInformation	withSessionId(String sessionId)	Copy this OidcSessionInformation, using a new session identifier.

Methods inherited from class SessionInformation

expireNow, getLastRequest, getSessionId, isExpired, refreshLastRequest

Methods inherited from class Object

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

Constructor Details

OidcSessionInformation

public OidcSessionInformation(String sessionId,
 Map<String,String> authorities,
 OidcUser user)

Construct an OidcSessionInformation.

Parameters:

sessionId - the Client's session id

authorities - any material that authorizes operating on the session

user - the OIDC Provider's session and end user

Method Details

getAuthorities

public Map<String,String> getAuthorities()

Any material needed to authorize operations on this session.

Returns:

the Map of credentials

getPrincipal

public OidcUser getPrincipal()

Overrides:

getPrincipal in class SessionInformation

withSessionId

public OidcSessionInformation withSessionId(String sessionId)

Copy this OidcSessionInformation, using a new session identifier.

Parameters:

sessionId - the new session identifier to use

Returns:

a new OidcSessionInformation instance