org.apereo.cas.ticket

Class TicketGrantingTicketImpl

java.lang.Object

org.apereo.cas.ticket.AbstractTicket

org.apereo.cas.ticket.TicketGrantingTicketImpl

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Ticket>, Ticket, TicketGrantingTicket, TicketState

Direct Known Subclasses:

ProxyGrantingTicketImpl

@Entity
public 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.0

See Also:

Serialized Form

Field Summary

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

PREFIX

Constructor Summary

Constructors

Constructor and Description
TicketGrantingTicketImpl(java.lang.String id, Authentication authentication, ExpirationPolicy policy) Constructs a new TicketGrantingTicket without a parent TicketGrantingTicket.
TicketGrantingTicketImpl(java.lang.String id, Service proxiedBy, TicketGrantingTicket parentTicketGrantingTicket, Authentication authentication, ExpirationPolicy policy) Constructs a new TicketGrantingTicket.

Method Summary

Modifier and Type	Method and Description
java.util.List<Authentication>	getChainedAuthentications() Gets all authentications (TicketGrantingTicket.getAuthentication() from this instance and all dependent tickets that reference this one.
java.lang.String	getPrefix() Gets prefix.
TicketGrantingTicket	getRoot() Gets the ticket-granting ticket at the root of the ticket hierarchy.
ServiceTicket	grantServiceTicket(java.lang.String id, Service service, ExpirationPolicy expirationPolicy, boolean credentialProvided, boolean onlyTrackMostRecentSession) Grant a ServiceTicket for a specific service.
boolean	isRoot() Return if the TGT has no parent.
void	removeAllServices() Remove all services of the TGT (at logout).
protected void	trackServiceSession(java.lang.String id, Service service, boolean onlyTrackMostRecentSession) Update service and track session.

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

compareTo, getAuthentication, getTicketGrantingTicket, isExpired, isExpiredInternal, markTicketExpired, toString, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apereo.cas.ticket.TicketGrantingTicket

getAuthentication, getDescendantTickets, getProxiedBy, getProxyGrantingTickets, getServices

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

getCountOfUses, getCreationTime, getExpirationPolicy, getId, getTicketGrantingTicket, isExpired, markTicketExpired

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.apereo.cas.ticket.TicketState

getCountOfUses, getCreationTime, getLastTimeUsed, getPreviousTimeUsed

Constructor Detail

TicketGrantingTicketImpl

public TicketGrantingTicketImpl(java.lang.String id,
                                Service proxiedBy,
                                TicketGrantingTicket parentTicketGrantingTicket,
                                @NonNull
                                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

proxiedBy - Service that produced this proxy ticket.

parentTicketGrantingTicket - the parent ticket

authentication - the Authentication request for this ticket

policy - the expiration policy for this ticket.

TicketGrantingTicketImpl

public TicketGrantingTicketImpl(java.lang.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

grantServiceTicket

public ServiceTicket grantServiceTicket(java.lang.String id,
                                        Service service,
                                        ExpirationPolicy expirationPolicy,
                                        boolean credentialProvided,
                                        boolean onlyTrackMostRecentSession)

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.

credentialProvided - current credential event for issuing this ticket. Could be null.

onlyTrackMostRecentSession - track the most recent session by keeping the latest service ticket

Returns:

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

trackServiceSession

protected void trackServiceSession(java.lang.String id,
                                   Service service,
                                   boolean onlyTrackMostRecentSession)

Update service and track session.

Parameters:

id - the id

service - the service

onlyTrackMostRecentSession - the only track most recent session

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.

getRoot

public TicketGrantingTicket getRoot()

Description copied from interface: TicketGrantingTicket

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.

getChainedAuthentications

public java.util.List<Authentication> getChainedAuthentications()

Description copied from interface: TicketGrantingTicket

Gets all authentications (TicketGrantingTicket.getAuthentication() 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.

getPrefix

public java.lang.String getPrefix()

Description copied from interface: Ticket

Gets prefix.

Specified by:

getPrefix in interface Ticket

Returns:

the prefix