org.jasig.cas.client.proxy
Interface ProxyGrantingTicketStorage

All Known Implementing Classes:

ProxyGrantingTicketStorageImpl

public interface ProxyGrantingTicketStorage

Interface for the storage and retrieval of ProxyGrantingTicketIds by mapping them to a specific ProxyGrantingTicketIou.

Since:

3.0

Version:

$Revision: 11729 $ $Date: 2007-09-26 14:22:30 -0400 (Tue, 26 Sep 2007) $

Author:

Scott Battaglia

Method Summary

void	cleanUp() Called on a regular basis by an external timer, giving implementations a chance to remove stale data.
java.lang.String	retrieve(java.lang.String proxyGrantingTicketIou) Method to retrieve a ProxyGrantingTicket based on the ProxyGrantingTicketIou.
void	save(java.lang.String proxyGrantingTicketIou, java.lang.String proxyGrantingTicket) Method to save the ProxyGrantingTicket to the backing storage facility.

Method Detail

save

void save(java.lang.String proxyGrantingTicketIou,
          java.lang.String proxyGrantingTicket)

Method to save the ProxyGrantingTicket to the backing storage facility.

Parameters:

proxyGrantingTicketIou - used as the key

proxyGrantingTicket - used as the value

retrieve

java.lang.String retrieve(java.lang.String proxyGrantingTicketIou)

Method to retrieve a ProxyGrantingTicket based on the ProxyGrantingTicketIou. Note that implementations are not guaranteed to return the same result if retrieve is called twice with the same proxyGrantingTicketIou.

Parameters:

proxyGrantingTicketIou - used as the key

Returns:

the ProxyGrantingTicket Id or null if it can't be found

cleanUp

void cleanUp()

Called on a regular basis by an external timer, giving implementations a chance to remove stale data.