org.jasig.cas.ticket

Class TicketGrantingTicketImpl

java.lang.Object

org.jasig.cas.ticket.AbstractTicket

org.jasig.cas.ticket.TicketGrantingTicketImpl

All Implemented Interfaces:

Serializable, Ticket, TicketGrantingTicket, TicketState

@Entity
public final class TicketGrantingTicketImpl
extends AbstractTicket
implements TicketGrantingTicket

Concrete implementation of a TicketGrantingTicket. A TicketGrantingTicket is the global identifier of a principal into the system. It grants the Principal single-sign on access to any service that opts into single-sign on. Expiration of a TicketGrantingTicket is controlled by the ExpirationPolicy specified as object creation.

Since:

3.0

Author:

Scott Battaglia

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.jasig.cas.ticket.TicketGrantingTicket

PREFIX

Constructor Summary

Constructors

Constructor and Description
TicketGrantingTicketImpl()
TicketGrantingTicketImpl(String id, Authentication authentication, ExpirationPolicy policy) Constructs a new TicketGrantingTicket without a parent TicketGrantingTicket.
TicketGrantingTicketImpl(String id, TicketGrantingTicket ticketGrantingTicket, Authentication authentication, ExpirationPolicy policy) Constructs a new TicketGrantingTicket.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object object)
Authentication	getAuthentication() Method to retrieve the authentication.
List<Authentication>	getChainedAuthentications() Gets all authentications (TicketGrantingTicket.getAuthentication(), TicketGrantingTicket.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	isExpiredInternal() Return if the TGT is expired.
boolean	isRoot() Return if the TGT has no parent.
void	markTicketExpired() Mark a ticket as expired.
void	removeAllServices() Remove all services of the TGT (at logout).

Methods inherited from class org.jasig.cas.ticket.AbstractTicket

getCountOfUses, getCreationTime, getGrantingTicket, getId, getLastTimeUsed, getPreviousTimeUsed, hashCode, isExpired, toString, updateState

Methods inherited from class java.lang.Object

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

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

getCountOfUses, getCreationTime, getGrantingTicket, getId, isExpired

Constructor Detail

TicketGrantingTicketImpl

public TicketGrantingTicketImpl()

TicketGrantingTicketImpl

public TicketGrantingTicketImpl(String id,
                        TicketGrantingTicket ticketGrantingTicket,
                        Authentication authentication,
                        ExpirationPolicy policy)

Constructs a new TicketGrantingTicket. May throw an IllegalArgumentException if the Authentication object is null.

Parameters:

id - the id of the Ticket

ticketGrantingTicket - the parent ticket

authentication - the Authentication request for this ticket

policy - the expiration policy for this ticket.

TicketGrantingTicketImpl

public TicketGrantingTicketImpl(String id,
                        Authentication authentication,
                        ExpirationPolicy policy)

Constructs a new TicketGrantingTicket without a parent TicketGrantingTicket.

Parameters:

id - the id of the Ticket

authentication - the Authentication request for this ticket

policy - the expiration policy for this ticket.

Method Detail

getAuthentication

public Authentication getAuthentication()

Method to retrieve the authentication.

Specified by:

getAuthentication in interface TicketGrantingTicket

Specified by:

getAuthentication in interface TicketState

Returns:

the authentication

grantServiceTicket

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

Grant a ServiceTicket for a specific service.

The state of the ticket is affected by this operation and the ticket will be considered used. The state update subsequently may impact the ticket expiration policy in that, depending on the policy configuration, the ticket may be considered expired.

Specified by:

grantServiceTicket in interface TicketGrantingTicket

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

public Map<String,Service> getServices()

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

Specified by:

getServices in interface TicketGrantingTicket

Returns:

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

removeAllServices

public void removeAllServices()

Remove all services of the TGT (at logout).

Specified by:

removeAllServices in interface TicketGrantingTicket

isRoot

public boolean isRoot()

Return if the TGT has no parent.

Specified by:

isRoot in interface TicketGrantingTicket

Returns:

if the TGT has no parent.

markTicketExpired

public void markTicketExpired()

Mark a ticket as expired.

Specified by:

markTicketExpired in interface TicketGrantingTicket

getRoot

public TicketGrantingTicket getRoot()

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

Specified by:

getRoot in interface TicketGrantingTicket

Returns:

Non-null root ticket-granting ticket.

isExpiredInternal

public boolean isExpiredInternal()

Return if the TGT is expired.

Overrides:

isExpiredInternal in class AbstractTicket

Returns:

if the TGT is expired.

getSupplementalAuthentications

public 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.

Specified by:

getSupplementalAuthentications in interface TicketGrantingTicket

Returns:

Non-null list of supplemental authentications.

getChainedAuthentications

public List<Authentication> getChainedAuthentications()

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

Specified by:

getChainedAuthentications in interface TicketGrantingTicket

Returns:

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

equals

public boolean equals(Object object)

Overrides:

equals in class Object