org.jasig.cas.ticket.registry

Interface TicketRegistry

All Known Implementing Classes:

AbstractDistributedTicketRegistry, AbstractTicketRegistry, DefaultTicketRegistry, JpaTicketRegistry

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 RegistryCleaner or a more sophisticated strategy such as LRU.

Since:

3.0

This is a published and supported CAS Server 3 API.

Version:

$Revision$ $Date$

Author:

Scott Battaglia

Method Summary

Methods

Modifier and Type	Method and Description
void	addTicket(Ticket ticket) Add a ticket to the registry.
boolean	deleteTicket(String ticketId) Remove a specific ticket from the registry.
Ticket	getTicket(String ticketId) Retrieve a ticket from the registry.
Ticket	getTicket(String ticketId, Class<? extends Ticket> clazz) Retrieve a ticket from the registry.
Collection<Ticket>	getTickets() Retrieve all tickets from the registry.

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

Ticket getTicket(String ticketId,
               Class<? extends Ticket> clazz)

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

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.

Throws:

InvalidTicketClassException - if the ticket does not match the class provided.

getTicket

Ticket getTicket(String ticketId)

Retrieve a ticket from the registry.

Parameters:

ticketId - the id of the ticket we wish to retrieve

Returns:

the requested ticket.

deleteTicket

boolean deleteTicket(String ticketId)

Remove a specific ticket from the registry.

Parameters:

ticketId - The id of the ticket to delete.

Returns:

true if the ticket was removed and false if the ticket did not exist.

getTickets

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.