org.jasig.cas.ticket

Class AbstractTicket

java.lang.Object

org.jasig.cas.ticket.AbstractTicket

All Implemented Interfaces:

Serializable, Ticket, TicketState

Direct Known Subclasses:

ServiceTicketImpl, TicketGrantingTicketImpl

@MappedSuperclass
public abstract class AbstractTicket
extends 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 cannnot be instanciated. 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 protected 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

Author:

Scott Battaglia

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTicket()
	AbstractTicket(String id, TicketGrantingTicket ticket, ExpirationPolicy expirationPolicy) Constructs a new Ticket with a unique id, a possible parent Ticket (can be null) and a specified Expiration Policy.

Method Summary

Methods

Modifier and Type	Method and Description
int	getCountOfUses() Returns the number of times a ticket was used.
long	getCreationTime() Method to return the time the Ticket was created.
TicketGrantingTicket	getGrantingTicket() Method to retrieve the TicketGrantingTicket that granted this ticket.
String	getId() Method to retrieve the id.
long	getLastTimeUsed() Returns the last time the ticket was used.
long	getPreviousTimeUsed() Get the second to last time used.
int	hashCode()
boolean	isExpired() Determines if the ticket is expired.
protected boolean	isExpiredInternal()
String	toString()
protected void	updateState() 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, notify, notifyAll, wait, wait, wait

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

getAuthentication

Constructor Detail

AbstractTicket

protected AbstractTicket()

AbstractTicket

public AbstractTicket(String id,
              TicketGrantingTicket ticket,
              ExpirationPolicy expirationPolicy)

Constructs a new Ticket with a unique id, a possible parent Ticket (can be null) and a specified Expiration Policy.

Parameters:

id - the unique identifier for the ticket

ticket - the parent TicketGrantingTicket

expirationPolicy - the expiration policy for the ticket.

Throws:

IllegalArgumentException - if the id or expiration policy is null.

Method Detail

getId

public final String getId()

Description copied from interface: Ticket

Method to retrieve the id.

Specified by:

getId in interface Ticket

Returns:

the id

updateState

protected final void updateState()

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.

See Also:

ExpirationPolicy

getCountOfUses

public final int getCountOfUses()

Description copied from interface: TicketState

Returns the number of times a ticket was used.

Specified by:

getCountOfUses in interface Ticket

Specified by:

getCountOfUses in interface TicketState

Returns:

the number of times this ticket was used.

getCreationTime

public final long getCreationTime()

Description copied from interface: Ticket

Method to return the time the Ticket was created.

Specified by:

getCreationTime in interface Ticket

Specified by:

getCreationTime in interface TicketState

Returns:

the time the ticket was created.

getGrantingTicket

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

getLastTimeUsed

public final long getLastTimeUsed()

Description copied from interface: TicketState

Returns the last time the ticket was used.

Specified by:

getLastTimeUsed in interface TicketState

Returns:

the last time the ticket was used.

getPreviousTimeUsed

public final long getPreviousTimeUsed()

Description copied from interface: TicketState

Get the second to last time used.

Specified by:

getPreviousTimeUsed in interface TicketState

Returns:

the previous time used.

isExpired

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

toString

public final String toString()

Overrides:

toString in class Object