org.apereo.cas.ticket

Interface TicketState

All Known Implementing Classes:

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

public interface TicketState

Since:

3.0.0

Method Summary

Modifier and Type	Method and Description
Authentication	getAuthentication() Authentication information from the ticket.
int	getCountOfUses() Returns the number of times a ticket was used.
java.time.ZonedDateTime	getCreationTime() Get the time the ticket was created.
java.time.ZonedDateTime	getLastTimeUsed() Returns the last time the ticket was used.
java.time.ZonedDateTime	getPreviousTimeUsed() Get the second to last time used.
void	update() Records the previous last time this ticket was used as well as the last usage time.

Method Detail

getCountOfUses

int getCountOfUses()

Returns the number of times a ticket was used.

Returns:

the number of times the ticket was used.

getLastTimeUsed

java.time.ZonedDateTime getLastTimeUsed()

Returns the last time the ticket was used.

Returns:

the last time the ticket was used.

getPreviousTimeUsed

java.time.ZonedDateTime getPreviousTimeUsed()

Get the second to last time used.

Returns:

the previous time used.

getCreationTime

java.time.ZonedDateTime getCreationTime()

Get the time the ticket was created.

Returns:

the creation time of the ticket.

getAuthentication

Authentication getAuthentication()

Authentication information from the ticket. This may be null.

Returns:

the authentication information.

update

void update()

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.

Since:

5.0.0

See Also:

ExpirationPolicy