net.shibboleth.idp.session

Interface SPSession

All Superinterfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.IdentifiedComponent

All Known Implementing Classes:

BasicSPSession

@ThreadSafe
public interface SPSession
extends net.shibboleth.utilities.java.support.component.IdentifiedComponent

Describes a session with a service in turn associated with an IdPSession. This is a high level interface that should be extended to expose data associated with particular protocols used to establish sessions.

Method Summary

Methods

Modifier and Type	Method and Description
long	getCreationInstant() Get the time, in milliseconds since the epoch, when this session was created.
long	getExpirationInstant() Get the time, in milliseconds since the epoch, when this session will expire.
String	getSPSessionKey() Get a unique key identifying this subject's session with the service.

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

getId

Method Detail

getCreationInstant

@Positive
long getCreationInstant()

Get the time, in milliseconds since the epoch, when this session was created.

Returns:

time, in milliseconds since the epoch, when this session was created, never less than 0

getExpirationInstant

@Positive
long getExpirationInstant()

Get the time, in milliseconds since the epoch, when this session will expire.

Returns:

time, in milliseconds since the epoch, when this session will expire, never less than 0

getSPSessionKey

@Nullable
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.

Returns:

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