net.shibboleth.idp.session

Class BasicSPSession

java.lang.Object

net.shibboleth.idp.session.BasicSPSession

All Implemented Interfaces:

SPSession, Component, IdentifiedComponent

@ThreadSafe
public class BasicSPSession
extends Object
implements SPSession

Implementation support for a concrete SPSession implementation.

Field Summary

Fields

Modifier and Type	Field and Description
private long	creationInstant The time, in milliseconds since the epoch, when this session was created.
private long	expirationInstant The time, in milliseconds since the epoch, when this session expires.
private String	serviceId The unique identifier of the service.

Constructor Summary

Constructors

Constructor and Description
BasicSPSession(String id, long creation, long expiration) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
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	getId()
String	getSPSessionKey() Get a unique key identifying this subject's session with the service.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

serviceId

@Nonnull
@NotEmpty
private final String serviceId

The unique identifier of the service.

creationInstant

@Duration
@Positive
private final long creationInstant

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

expirationInstant

@Duration
@Positive
private final long expirationInstant

The time, in milliseconds since the epoch, when this session expires.

Constructor Detail

BasicSPSession

public BasicSPSession(@Nonnull@NotEmpty
              String id,
              @Duration@Positive
              long creation,
              @Duration@Positive
              long expiration)

Constructor.

Parameters:

id - the identifier of the service associated with this session

creation - creation time of session, in milliseconds since the epoch

expiration - expiration time of session, in milliseconds since the epoch

Method Detail

getId

@Nonnull
@NotEmpty
public String getId()

Specified by:

getId in interface IdentifiedComponent

getCreationInstant

@Duration
@Positive
public long getCreationInstant()

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

Specified by:

getCreationInstant in interface SPSession

Returns:

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

getExpirationInstant

@Duration
@Positive
public long getExpirationInstant()

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

Specified by:

getExpirationInstant in interface SPSession

Returns:

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

getSPSessionKey

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

Returns:

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable
             Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object