org.apereo.cas.ticket.registry

Class EhCacheTicketRegistry

java.lang.Object

org.apereo.cas.ticket.registry.AbstractTicketRegistry

org.apereo.cas.ticket.registry.EhCacheTicketRegistry

All Implemented Interfaces:

TicketRegistry

public class EhCacheTicketRegistry
extends AbstractTicketRegistry

Ehcache based distributed ticket registry.

Since:

3.5

Field Summary

Fields inherited from class org.apereo.cas.ticket.registry.AbstractTicketRegistry

cipherExecutor

Constructor Summary

Constructors

Constructor and Description
EhCacheTicketRegistry(net.sf.ehcache.Cache ticketCache, CipherExecutor cipher) Instantiates a new EhCache ticket registry.

Method Summary

Modifier and Type	Method and Description
void	addTicket(Ticket ticketToAdd) Add a ticket to the registry.
long	deleteAll() Delete all tickets from the registry.
boolean	deleteSingleTicket(java.lang.String ticketId) Delete a single ticket instance from the store.
Ticket	getTicket(java.lang.String ticketIdToGet) Retrieve a ticket from the registry.
java.util.Collection<Ticket>	getTickets() Retrieve all tickets from the registry.
java.lang.String	toString()
Ticket	updateTicket(Ticket ticket) Update the received ticket.

Methods inherited from class org.apereo.cas.ticket.registry.AbstractTicketRegistry

decodeTicket, decodeTickets, deleteChildren, deleteSingleTicket, deleteTicket, encodeTicket, encodeTicketId, getTicket, isCipherExecutorEnabled, serviceTicketCount, sessionCount, setCipherExecutor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EhCacheTicketRegistry

public EhCacheTicketRegistry(net.sf.ehcache.Cache ticketCache,
                             CipherExecutor cipher)

Instantiates a new EhCache ticket registry.

Parameters:

ticketCache - the ticket cache

cipher - the cipher

Method Detail

addTicket

public void addTicket(Ticket ticketToAdd)

Description copied from interface: TicketRegistry

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

Parameters:

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

deleteSingleTicket

public boolean deleteSingleTicket(java.lang.String ticketId)

Delete a single ticket instance from the store. Either the element is removed from the cache or it's not found in the cache and is already removed. Thus the result of this op would always be true.

Specified by:

deleteSingleTicket in class AbstractTicketRegistry

Parameters:

ticketId - the ticket id

Returns:

true/false

deleteAll

public long deleteAll()

Description copied from interface: TicketRegistry

Delete all tickets from the registry.

Returns:

the number of tickets deleted.

getTicket

public Ticket getTicket(java.lang.String ticketIdToGet)

Description copied from interface: TicketRegistry

Retrieve a ticket from the registry.

Parameters:

ticketIdToGet - the id of the ticket we wish to retrieve

Returns:

the requested ticket.

getTickets

public java.util.Collection<Ticket> getTickets()

Description copied from interface: TicketRegistry

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.

updateTicket

public Ticket updateTicket(Ticket ticket)

Description copied from interface: TicketRegistry

Update the received ticket.

Parameters:

ticket - the ticket

Returns:

the updated ticket

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object