Package net.shibboleth.idp.cas.session.impl

Class CASSPSession

java.lang.Object

net.shibboleth.idp.session.BasicSPSession

net.shibboleth.idp.cas.session.impl.CASSPSession

All Implemented Interfaces:

SPSession, SPSessionEx, Component, IdentifiedComponent

public class CASSPSession
extends BasicSPSession
implements SPSessionEx

Describes a CAS protocol-specific service provider session created in response to a successful ticket validation.

Field Summary

Fields

Modifier and Type	Field	Description
private String	ticket	Validated ticket that started the SP session.

Constructor Summary

Constructors

Constructor	Description
CASSPSession(String id, Instant creation, Instant expiration, String ticketId)	Creates a new CAS SP session.

Method Summary

Modifier and Type	Method	Description
String	getProtocol()	Get a prototocol constant for the session suitable for metadata lookup.
String	getSPSessionKey()	Get a unique key identifying this subject's session with the service.
String	getTicketId()	Get the ticket ID.
boolean	supportsLogoutPropagation()	Gets whether the session allows for logout propagation.
String	toString()

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

equals, getCreationInstant, getExpirationInstant, getId, hashCode

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 Detail

ticket

@Nonnull
@NotEmpty
private final String ticket

Validated ticket that started the SP session.

Constructor Detail

CASSPSession

public CASSPSession(@Nonnull @NotEmpty
                    String id,
                    @Nonnull
                    Instant creation,
                    @Nonnull
                    Instant expiration,
                    @Nonnull @NotEmpty
                    String ticketId)

Creates a new CAS SP session.

Parameters:

id - the identifier of the service associated with this session

creation - creation time of session

expiration - expiration time of session

ticketId - ticket ID used to gain access to the service

Method Detail

getTicketId

@Nonnull
@NotEmpty
public String getTicketId()

Get the ticket ID.

Returns:

ticket ID

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

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

supportsLogoutPropagation

public boolean supportsLogoutPropagation()

Gets whether the session allows for logout propagation.

Specified by:

supportsLogoutPropagation in interface SPSessionEx

Returns:

whether the session allows for logout propagation

toString

public String toString()

Description copied from class: BasicSPSession

Overrides:

toString in class BasicSPSession