org.apereo.cas.ticket

Class AbstractTicket

java.lang.Object

org.apereo.cas.ticket.AbstractTicket

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultSecurityTokenTicket, OAuthCodeImpl, SamlArtifactTicketImpl, SamlAttributeQueryTicketImpl, ServiceTicketImpl, TicketGrantingTicketImpl, TransientSessionTicketImpl

@MappedSuperclass
public abstract class AbstractTicket
extends java.lang.Object
implements Ticket, TicketState

Abstract implementation of a ticket that handles all ticket state for policies. Also incorporates properties common among all tickets. As this is an abstract class, it cannot be created. It is recommended that implementations of the Ticket interface extend the AbstractTicket as it handles common functionality amongst different ticket types (such as state updating).

AbstractTicket does not provide a logger instance to avoid instantiating many such Loggers at runtime (there will be many instances of subclasses of AbstractTicket in a typical running CAS server). Instead subclasses should use static Logger instances.

Since:

3.0.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractTicket(java.lang.String id, ExpirationPolicy expirationPolicy)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Ticket o)
Authentication	getAuthentication() Authentication information from the ticket.
TicketGrantingTicket	getTicketGrantingTicket() Method to retrieve the TicketGrantingTicket that granted this ticket.
boolean	isExpired() Determines if the ticket is expired.
protected boolean	isExpiredInternal()
void	markTicketExpired() Mark a ticket as expired.
java.lang.String	toString()
void	update() Records the previous last time this ticket was used as well as the last usage time.

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

getCountOfUses, getCreationTime, getExpirationPolicy, getId, getPrefix

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

getCountOfUses, getCreationTime, getLastTimeUsed, getPreviousTimeUsed

Constructor Detail

AbstractTicket

public AbstractTicket(@NonNull
                      java.lang.String id,
                      @NonNull
                      ExpirationPolicy expirationPolicy)

Method Detail

update

public void update()

Description copied from interface: TicketState

Records the previous last time this ticket was used as well as the last usage time. The ticket usage count is also incremented.

Tickets themselves are solely responsible to maintain their state. The determination of ticket usage is left up to the implementation and the specific ticket type.

Specified by:

update in interface TicketState

See Also:

ExpirationPolicy

isExpired

public boolean isExpired()

Description copied from interface: Ticket

Determines if the ticket is expired. Most common implementations might collaborate with ExpirationPolicy strategy.

Specified by:

isExpired in interface Ticket

Returns:

true, if the ticket is expired

See Also:

ExpirationPolicy

isExpiredInternal

protected boolean isExpiredInternal()

compareTo

public int compareTo(Ticket o)

Specified by:

compareTo in interface java.lang.Comparable<Ticket>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getAuthentication

public Authentication getAuthentication()

Description copied from interface: TicketState

Authentication information from the ticket. This may be null.

Specified by:

getAuthentication in interface TicketState

Returns:

the authentication information.

getTicketGrantingTicket

public TicketGrantingTicket getTicketGrantingTicket()

Description copied from interface: Ticket

Method to retrieve the TicketGrantingTicket that granted this ticket.

Specified by:

getTicketGrantingTicket in interface Ticket

Specified by:

getTicketGrantingTicket in interface TicketState

Returns:

the ticket or null if it has no parent

markTicketExpired

public void markTicketExpired()

Description copied from interface: Ticket

Mark a ticket as expired.

Specified by:

markTicketExpired in interface Ticket