edu.yale.its.tp.cas.ticket
Interface TicketCache

All Known Implementing Classes:

ActiveTicketCache

public interface TicketCache

Represents a generic cache of CAS tickets. Ticket caches have the following characteristics: - At any given time, they store a list of valid tickets, each indexed with a unique String that acts as a ticket identifier. - Tickets can expire based on cache-specific rules.

Method Summary

java.lang.String	addTicket(edu.yale.its.tp.cas.ticket.Ticket t) Adds a new Ticket to the cache, returning a String identifier that uniquely matches the registered Ticket.
void	deleteTicket(java.lang.String ticketId) Deletes a ticket given a ticket identifier String.
edu.yale.its.tp.cas.ticket.Ticket	getTicket(java.lang.String ticketId) Retrieves a Ticket based on a ticket identifier String.

Method Detail

addTicket

public java.lang.String addTicket(edu.yale.its.tp.cas.ticket.Ticket t)
                           throws TicketException

Adds a new Ticket to the cache, returning a String identifier that uniquely matches the registered Ticket. This String identifier need not be globally unique, but two properties must be guaranteed: - The ticket cache must associate the identifier with the Ticket for the lifetime of the ticket. - The ticket cache must ensure that once a ticket expires, its identifier does not return a valid ticket.

TicketException

getTicket

public edu.yale.its.tp.cas.ticket.Ticket getTicket(java.lang.String ticketId)

Retrieves a Ticket based on a ticket identifier String. If the identifier matches no current ticket, returns null.

deleteTicket

public void deleteTicket(java.lang.String ticketId)

Deletes a ticket given a ticket identifier String. (Implementations need not provide a meaningful implementation of this method; they must throw UnsupportedOperationException if they do not.)