org.apereo.cas.ticket

Interface Ticket

All Superinterfaces:

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

All Known Subinterfaces:

AccessToken, OAuthCode, OAuthToken, ProxyGrantingTicket, ProxyTicket, RefreshToken, SecurityTokenTicket, ServiceTicket, TicketGrantingTicket

All Known Implementing Classes:

AbstractTicket, AccessTokenImpl, DefaultSecurityTokenTicket, EncodedTicket, OAuthCodeImpl, ProxyGrantingTicketImpl, ProxyTicketImpl, RefreshTokenImpl, ServiceTicketImpl, TicketGrantingTicketImpl

public interface Ticket
extends java.io.Serializable, java.lang.Comparable<Ticket>

Interface for the generic concept of a ticket.

Since:

3.0.0

Method Summary

Modifier and Type	Method and Description
int	getCountOfUses() Gets count of uses.
java.time.ZonedDateTime	getCreationTime() Method to return the time the Ticket was created.
ExpirationPolicy	getExpirationPolicy() Get expiration policy associated with ticket.
TicketGrantingTicket	getGrantingTicket() Method to retrieve the TicketGrantingTicket that granted this ticket.
java.lang.String	getId() Method to retrieve the id.
java.lang.String	getPrefix() Gets prefix.
boolean	isExpired() Determines if the ticket is expired.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getId

java.lang.String getId()

Method to retrieve the id.

Returns:

the id

isExpired

boolean isExpired()

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

Returns:

true, if the ticket is expired

See Also:

ExpirationPolicy

getGrantingTicket

TicketGrantingTicket getGrantingTicket()

Method to retrieve the TicketGrantingTicket that granted this ticket.

Returns:

the ticket or null if it has no parent

getCreationTime

java.time.ZonedDateTime getCreationTime()

Method to return the time the Ticket was created.

Returns:

the time the ticket was created.

getCountOfUses

int getCountOfUses()

Gets count of uses.

Returns:

the number of times this ticket was used.

getExpirationPolicy

ExpirationPolicy getExpirationPolicy()

Get expiration policy associated with ticket.

Returns:

the expiration policy

getPrefix

java.lang.String getPrefix()

Gets prefix.

Returns:

the prefix