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() Instantiates a new ticket granting ticket impl.
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
boolean	equals(java.lang.Object object)
Authentication	getAuthentication() Method to retrieve the authentication.
java.util.List<Authentication>	getChainedAuthentications() Gets all authentications (TicketGrantingTicket.getAuthentication() from this instance and all dependent tickets that reference this one.
TicketGrantingTicket	getGrantingTicket() Method to retrieve the TicketGrantingTicket that granted this ticket.
Service	getProxiedBy() Gets the service that produced a proxy-granting ticket.
java.util.Collection<ProxyGrantingTicket>	getProxyGrantingTickets() Gets proxy granting tickets created by this TGT.
TicketGrantingTicket	getRoot() Gets the ticket-granting ticket at the root of the ticket hierarchy.
java.util.Map<java.lang.String,Service>	getServices() Gets an immutable map of service ticket and services accessed by this ticket-granting ticket.
ServiceTicket	grantServiceTicket(java.lang.String id, Service service, ExpirationPolicy expirationPolicy, boolean credentialProvided, boolean onlyTrackMostRecentSession) 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).
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, getCountOfUses, getCreationTime, getExpirationPolicy, getId, getLastTimeUsed, getPreviousTimeUsed, hashCode, isExpired, toString, update

Methods inherited from class java.lang.Object

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

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

getCountOfUses, getCreationTime, getExpirationPolicy, getId, isExpired

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

TicketGrantingTicketImpl

public TicketGrantingTicketImpl()

Instantiates a new ticket granting ticket impl.

TicketGrantingTicketImpl

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

getGrantingTicket

public TicketGrantingTicket getGrantingTicket()

Description copied from interface: Ticket

Method to retrieve the TicketGrantingTicket that granted this ticket.

Specified by:

getGrantingTicket in interface Ticket

Returns:

the ticket or null if it has no parent

getAuthentication

public Authentication getAuthentication()

Description copied from interface: TicketGrantingTicket

Method to retrieve the authentication.

Specified by:

getAuthentication in interface TicketGrantingTicket

Specified by:

getAuthentication in interface TicketState

Returns:

the authentication

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

getServices

public java.util.Map<java.lang.String,Service> getServices()

Gets an immutable map of service ticket and services accessed by this ticket-granting ticket. Unlike Collections.unmodifiableMap(java.util.Map), which is a view of a separate map which can still change, an instance of ImmutableMap contains its own data and will never change.

Specified by:

getServices in interface TicketGrantingTicket

Returns:

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

getProxyGrantingTickets

public java.util.Collection<ProxyGrantingTicket> getProxyGrantingTickets()

Description copied from interface: TicketGrantingTicket

Gets proxy granting tickets created by this TGT.

Specified by:

getProxyGrantingTickets in interface TicketGrantingTicket

Returns:

the proxy granting tickets

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()

Description copied from interface: TicketGrantingTicket

Mark a ticket as expired.

Specified by:

markTicketExpired in interface TicketGrantingTicket

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.

isExpiredInternal

public boolean isExpiredInternal()

Return if the TGT is expired.

Overrides:

isExpiredInternal in class AbstractTicket

Returns:

if the TGT is expired.

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.

getProxiedBy

public Service getProxiedBy()

Description copied from interface: TicketGrantingTicket

Gets the service that produced a proxy-granting ticket.

Specified by:

getProxiedBy in interface TicketGrantingTicket

Returns:

Service that produced proxy-granting ticket or null if this is not a proxy-granting ticket.

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object