org.apereo.cas.ticket.registry

Interface TicketRegistry

All Known Implementing Classes:

AbstractMapBasedTicketRegistry, AbstractTicketRegistry, CachingTicketRegistry, CouchbaseTicketRegistry, CouchDbTicketRegistry, DefaultTicketRegistry, DynamoDbTicketRegistry, EhCacheTicketRegistry, HazelcastTicketRegistry, IgniteTicketRegistry, InfinispanTicketRegistry, JmsTicketRegistry, JpaTicketRegistry, MemcachedTicketRegistry, MongoDbTicketRegistry, RedisTicketRegistry

public interface TicketRegistry

Interface for a registry that stores tickets. The underlying registry can be backed by anything from a normal HashMap to JGroups for having distributed registries. It is up to specific implementations to determine their clean up strategy. Strategies can include a manual clean up by a registry cleaner or a more sophisticated strategy such as LRU.

Since:

3.0.0

Method Summary

Modifier and Type	Method and Description
void	addTicket(Ticket ticket) Add a ticket to the registry.
long	deleteAll() Delete all tickets from the registry.
int	deleteTicket(java.lang.String ticketId) Remove a specific ticket from the registry.
int	deleteTicket(Ticket ticketId) Remove a specific ticket from the registry.
Ticket	getTicket(java.lang.String ticketId) Retrieve a ticket from the registry.
<T extends Ticket> T	getTicket(java.lang.String ticketId, java.lang.Class<T> clazz) Retrieve a ticket from the registry.
java.util.Collection<Ticket>	getTickets() Retrieve all tickets from the registry.
default java.util.stream.Stream<Ticket>	getTickets(java.util.function.Predicate<Ticket> predicate) Gets tickets as a stream having applied a predicate.
default java.util.stream.Stream<Ticket>	getTicketsStream() Gets tickets stream.
long	serviceTicketCount() Computes the number of service tickets stored in the ticket registry.
long	sessionCount() Computes the number of SSO sessions stored in the ticket registry.
Ticket	updateTicket(Ticket ticket) Update the received ticket.

Method Detail

addTicket

void addTicket(Ticket ticket)

Add a ticket to the registry. Ticket storage is based on the ticket id.

Parameters:

ticket - The ticket we wish to add to the cache.

getTicket

<T extends Ticket> T getTicket(java.lang.String ticketId,
                               java.lang.Class<T> clazz)

Retrieve a ticket from the registry. If the ticket retrieved does not match the expected class, an InvalidTicketException is thrown.

Type Parameters:

T - the generic ticket type to return that extends Ticket

Parameters:

ticketId - the id of the ticket we wish to retrieve.

clazz - The expected class of the ticket we wish to retrieve.

Returns:

the requested ticket.

getTicket

Ticket getTicket(java.lang.String ticketId)

Retrieve a ticket from the registry.

Parameters:

ticketId - the id of the ticket we wish to retrieve

Returns:

the requested ticket.

deleteTicket

int deleteTicket(java.lang.String ticketId)

Remove a specific ticket from the registry. If ticket to delete is TGT then related service tickets, etc are removed as well.

Parameters:

ticketId - The id of the ticket to delete.

Returns:

the number of tickets deleted including children.

deleteTicket

int deleteTicket(Ticket ticketId)

Remove a specific ticket from the registry. If ticket to delete is TGT then related service tickets, etc are removed as well.

Parameters:

ticketId - The id of the ticket to delete.

Returns:

the number of tickets deleted including children.

deleteAll

long deleteAll()

Delete all tickets from the registry.

Returns:

the number of tickets deleted.

getTickets

java.util.Collection<Ticket> getTickets()

Retrieve all tickets from the registry.

Returns:

collection of tickets currently stored in the registry. Tickets might or might not be valid i.e. expired.

getTickets

default java.util.stream.Stream<Ticket> getTickets(java.util.function.Predicate<Ticket> predicate)

Gets tickets as a stream having applied a predicate. The returning stream may be bound to an IO channel (such as database connection), so it should be properly closed after usage.

Parameters:

predicate - the predicate

Returns:

the tickets

updateTicket

Ticket updateTicket(Ticket ticket)

Update the received ticket.

Parameters:

ticket - the ticket

Returns:

the updated ticket

sessionCount

long sessionCount()

Computes the number of SSO sessions stored in the ticket registry.

Returns:

Number of ticket-granting tickets in the registry at time of invocation or Integer.MIN_VALUE if unknown.

serviceTicketCount

long serviceTicketCount()

Computes the number of service tickets stored in the ticket registry.

Returns:

Number of service tickets in the registry at time of invocation or Integer.MIN_VALUE if unknown.

getTicketsStream

default java.util.stream.Stream<Ticket> getTicketsStream()

Gets tickets stream. The returning stream may be bound to an IO channel (such as database connection), so it should be properly closed after usage.

Returns:

the tickets stream