Package org.apereo.cas.ticket
Interface Ticket
-
- All Superinterfaces:
java.lang.Comparable<Ticket>,java.io.Serializable
- All Known Subinterfaces:
AuthenticationAwareTicket,EncodedTicket,ProxyGrantingTicket,ProxyGrantingTicketIssuerTicket,ProxyTicket,RenewableServiceTicket,ServiceTicket,TicketGrantingTicket,TicketGrantingTicketAwareTicket,TicketState,TransientSessionTicket
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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description intgetCountOfUses()Gets count of uses.java.time.ZonedDateTimegetCreationTime()Method to return the time the Ticket was created.ExpirationPolicygetExpirationPolicy()Get expiration policy associated with ticket.java.lang.StringgetId()Method to retrieve the id.java.lang.StringgetPrefix()Gets prefix.booleanisExpired()Determines if the ticket is expired.voidmarkTicketExpired()Mark a ticket as expired.
-
-
-
Method Detail
-
getId
java.lang.String getId()
Method to retrieve the id.- Returns:
- the id
-
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.
-
getPrefix
java.lang.String getPrefix()
Gets prefix.- Returns:
- the prefix
-
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
-
getExpirationPolicy
ExpirationPolicy getExpirationPolicy()
Get expiration policy associated with ticket.- Returns:
- the expiration policy
-
markTicketExpired
void markTicketExpired()
Mark a ticket as expired.
-
-