Package net.shibboleth.idp.plugin.oidc.op.session

Class OIDCRPSession

java.lang.Object

net.shibboleth.idp.session.BasicSPSession

net.shibboleth.idp.plugin.oidc.op.session.OIDCRPSession

All Implemented Interfaces:

SPSession, Component, IdentifiedComponent

@ThreadSafe
public class OIDCRPSession
extends BasicSPSession
implements SPSession

A concrete SPSession implementation for OIDC relying parties.

Since:

4.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OIDCRPSession.Builder	Builder class for building OIDCRPSession.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	issuer	The issuer value to interact with the service.
private final String	rootTokenIdentifier	The root token identifier.
private final String	sessionIdentifier	The session identifier.
private final String	subject	The subject value.
private final boolean	supportsLogoutPropagation	The flag whether the session allows for logout propagation.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	OIDCRPSession(String id, Instant creation, Instant expiration, String iss, String rootJti, String sid, String sub, boolean supportsPropagation)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getIssuer()	Get the issuer value to interact with the service.
String	getProtocol()
String	getRootTokenIdentifier()	Get the root token identifier.
String	getSessionIdentifier()	Get the session identifier.
String	getSPSessionKey()
String	getSubject()	Get the subject value.
boolean	supportsLogoutPropagation()

Methods inherited from class net.shibboleth.idp.session.BasicSPSession

equals, getCreationInstant, getExpirationInstant, getId, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.shibboleth.shared.component.IdentifiedComponent

getId

Methods inherited from interface net.shibboleth.idp.session.SPSession

getCreationInstant, getExpirationInstant

Field Details

issuer

@Nonnull
@NotEmpty
private final String issuer

The issuer value to interact with the service.

rootTokenIdentifier

@Nullable
private final String rootTokenIdentifier

The root token identifier.

sessionIdentifier

@Nonnull
@NotEmpty
private final String sessionIdentifier

The session identifier.

subject

@Nonnull
@NotEmpty
private final String subject

The subject value.

supportsLogoutPropagation

private final boolean supportsLogoutPropagation

The flag whether the session allows for logout propagation.

Constructor Details

OIDCRPSession

private OIDCRPSession(@Nonnull @NotEmpty
 String id,
 @Nonnull
 Instant creation,
 @Nonnull
 Instant expiration,
 @Nonnull @NotEmpty
 String iss,
 @Nullable
 String rootJti,
 @Nonnull @NotEmpty
 String sid,
 @Nonnull @NotEmpty
 String sub,
 boolean supportsPropagation)

Constructor.

Parameters:

id - the identifier of the service associated with this session

creation - creation time of session

expiration - expiration time of session

iss - issuer value to interact with the service

rootJti - root token identifier

sid - session identifier

sub - subject value

supportsPropagation - flag whether the session allows for logout propagation

Method Details

getSPSessionKey

@Nonnull
@NotEmpty
public String getSPSessionKey()

Specified by:

getSPSessionKey in interface SPSession

Overrides:

getSPSessionKey in class BasicSPSession

getProtocol

@Nonnull
@NotEmpty
public String getProtocol()

Specified by:

getProtocol in interface SPSession

Overrides:

getProtocol in class BasicSPSession

getIssuer

@Nonnull
@NotEmpty
public String getIssuer()

Get the issuer value to interact with the service.

Returns:

the issuer value to interact with the service

getRootTokenIdentifier

@Nullable
@NotEmpty
public String getRootTokenIdentifier()

Get the root token identifier.

Returns:

the root token identifier

getSessionIdentifier

@Nonnull
@NotEmpty
public String getSessionIdentifier()

Get the session identifier.

Returns:

the session identifier

getSubject

@Nonnull
@NotEmpty
public String getSubject()

Get the subject value.

Returns:

The subject value

supportsLogoutPropagation

public boolean supportsLogoutPropagation()

Specified by:

supportsLogoutPropagation in interface SPSession

Overrides:

supportsLogoutPropagation in class BasicSPSession