org.jasig.cas.ticket

Interface TicketGrantingTicket

All Superinterfaces:

Serializable, Ticket

All Known Implementing Classes:

TicketGrantingTicketImpl

public interface TicketGrantingTicket
extends Ticket

Interface for a ticket granting ticket. A TicketGrantingTicket is the main access into the CAS service layer. Without a TicketGrantingTicket, a user of CAS cannot do anything.

Since:

3.0

Author:

Scott Battaglia

Field Summary

Fields

Modifier and Type	Field and Description
static String	PREFIX The prefix to use when generating an id for a TicketGrantingTicket.

Method Summary

Methods

Modifier and Type	Method and Description
Authentication	getAuthentication() Method to retrieve the authentication.
List<Authentication>	getChainedAuthentications() Gets all authentications (getAuthentication(), getSupplementalAuthentications()) from this instance and all dependent tickets that reference this one.
TicketGrantingTicket	getRoot() Gets the ticket-granting ticket at the root of the ticket hierarchy.
Map<String,Service>	getServices() Gets an immutable map of service ticket and services accessed by this ticket-granting ticket.
List<Authentication>	getSupplementalAuthentications() Gets a list of supplemental authentications associated with this ticket.
ServiceTicket	grantServiceTicket(String id, Service service, ExpirationPolicy expirationPolicy, boolean credentialsProvided) Grant a ServiceTicket for a specific service.
boolean	isRoot() Convenience method to determine if the TicketGrantingTicket is the root of the hierarchy of tickets.
void	markTicketExpired() Mark a ticket as expired.
void	removeAllServices() Remove all services of the TGT (at logout).

Methods inherited from interface org.jasig.cas.ticket.Ticket

getCountOfUses, getCreationTime, getGrantingTicket, getId, isExpired

Field Detail

PREFIX

static final String PREFIX

The prefix to use when generating an id for a TicketGrantingTicket.

See Also:

Constant Field Values

Method Detail

getAuthentication

Authentication getAuthentication()

Method to retrieve the authentication.

Returns:

the authentication

getSupplementalAuthentications

List<Authentication> getSupplementalAuthentications()

Gets a list of supplemental authentications associated with this ticket. A supplemental authentication is one other than the one used to create the ticket, for example, a forced authentication that happens after the beginning of a CAS SSO session.

Returns:

Non-null list of supplemental authentications.

grantServiceTicket

ServiceTicket grantServiceTicket(String id,
                               Service service,
                               ExpirationPolicy expirationPolicy,
                               boolean credentialsProvided)

Grant a ServiceTicket for a specific service.

Parameters:

id - The unique identifier for this ticket.

service - The service for which we are granting a ticket

expirationPolicy - the expiration policy.

credentialsProvided - if the credentials are provided.

Returns:

the service ticket granted to a specific service for the principal of the TicketGrantingTicket

getServices

Map<String,Service> getServices()

Gets an immutable map of service ticket and services accessed by this ticket-granting ticket.

Returns:

an immutable map of service ticket and services accessed by this ticket-granting ticket.

removeAllServices

void removeAllServices()

Remove all services of the TGT (at logout).

markTicketExpired

void markTicketExpired()

Mark a ticket as expired.

isRoot

boolean isRoot()

Convenience method to determine if the TicketGrantingTicket is the root of the hierarchy of tickets.

Returns:

true if it has no parent, false otherwise.

getRoot

TicketGrantingTicket getRoot()

Gets the ticket-granting ticket at the root of the ticket hierarchy.

Returns:

Non-null root ticket-granting ticket.

getChainedAuthentications

List<Authentication> getChainedAuthentications()

Gets all authentications (getAuthentication(), getSupplementalAuthentications()) from this instance and all dependent tickets that reference this one.

Returns:

Non-null list of authentication associated with this ticket in leaf-first order.