Package net.shibboleth.idp.saml.session

Class SAML2SPSession

java.lang.Object

net.shibboleth.idp.session.BasicSPSession

net.shibboleth.idp.saml.session.SAML2SPSession

All Implemented Interfaces:

SPSession, SPSessionEx, Component, IdentifiedComponent

public class SAML2SPSession
extends BasicSPSession
implements SPSessionEx

Extends a BasicSPSession with SAML 2.0 information required for reverse lookup in the case of a logout.

Field Summary

Fields

Modifier and Type	Field	Description
private NameID	nameID	The NameID asserted to the SP.
private String	sessionIndex	The SessionIndex asserted to the SP.

Constructor Summary

Constructors

Constructor	Description
SAML2SPSession(String id, Instant creation, Instant expiration, NameID assertedNameID, String assertedIndex)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
NameID	getNameID()	Get the NameID asserted to the SP.
String	getProtocol()	Get a prototocol constant for the session suitable for metadata lookup.
String	getSessionIndex()	Get the SessionIndex value asserted to the SP.
String	getSPSessionKey()	Get a unique key identifying this subject's session with the service.
int	hashCode()
String	toString()

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

getCreationInstant, getExpirationInstant, getId

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent

getId

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

getCreationInstant, getExpirationInstant

Field Details

nameID

@Nonnull
private final NameID nameID

The NameID asserted to the SP.

sessionIndex

@Nonnull
@NotEmpty
private final String sessionIndex

The SessionIndex asserted to the SP.

Constructor Details

SAML2SPSession

public SAML2SPSession(@Nonnull @NotEmpty
String id,
@Nonnull
Instant creation,
@Nonnull
Instant expiration,
@Nonnull
NameID assertedNameID,
@Nonnull @NotEmpty
String assertedIndex)

Constructor.

Parameters:

id - the identifier of the service associated with this session

creation - creation time of session

expiration - expiration time of session

assertedNameID - the NameID asserted to the SP

assertedIndex - the SessionIndex asserted to the SP

Method Details

getNameID

@Nonnull
public NameID getNameID()

Get the NameID asserted to the SP.

Returns:

the asserted NameID

getSessionIndex

@Nonnull
@NotEmpty
public String getSessionIndex()

Get the SessionIndex value asserted to the SP.

Returns:

the SessionIndex value

getSPSessionKey

@Nullable
public String getSPSessionKey()

Get a unique key identifying this subject's session with the service.

This will vary based on the type of session, typically based on the protocol used, but it provides a secondary lookup key that may be required in support of other use cases involving that protocol. Not all protocols may require such a key, so null may be returned.

Specified by:

getSPSessionKey in interface SPSession

Overrides:

getSPSessionKey in class BasicSPSession

Returns:

a unique key identifying this subject's session with the service, or null

getProtocol

@Nullable
@NotEmpty
public String getProtocol()

Get a prototocol constant for the session suitable for metadata lookup.

Specified by:

getProtocol in interface SPSessionEx

Returns:

a protocol constant

hashCode

public int hashCode()

Overrides:

hashCode in class BasicSPSession

equals

public boolean equals(Object obj)

Overrides:

equals in class BasicSPSession

toString

public String toString()

Overrides:

toString in class BasicSPSession