org.jasig.cas.ticket.registry

Class EhCacheTicketRegistry

java.lang.Object

org.jasig.cas.ticket.registry.AbstractTicketRegistry

org.jasig.cas.ticket.registry.AbstractDistributedTicketRegistry

org.jasig.cas.ticket.registry.encrypt.AbstractCrypticTicketRegistry

org.jasig.cas.ticket.registry.EhCacheTicketRegistry

All Implemented Interfaces:

org.jasig.cas.ticket.registry.TicketRegistry, org.jasig.cas.ticket.registry.TicketRegistryState, org.springframework.beans.factory.InitializingBean

@Component(value="ehcacheTicketRegistry")
public final class EhCacheTicketRegistry
extends org.jasig.cas.ticket.registry.encrypt.AbstractCrypticTicketRegistry
implements org.springframework.beans.factory.InitializingBean

Ehcache based distributed ticket registry.

Use distinct caches for ticket granting tickets (TGT) and service tickets (ST) for:

• Tuning : use cache level time to live with different values for TGT an ST.
• Monitoring : follow separately the number of TGT and ST.

Since:

3.5

Field Summary

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

logger

Constructor Summary

Constructors

Constructor and Description
EhCacheTicketRegistry() Instantiates a new EhCache ticket registry.
EhCacheTicketRegistry(net.sf.ehcache.Cache serviceTicketsCache, net.sf.ehcache.Cache ticketGrantingTicketsCache) Instantiates a new EhCache ticket registry.
EhCacheTicketRegistry(net.sf.ehcache.Cache serviceTicketsCache, net.sf.ehcache.Cache ticketGrantingTicketsCache, boolean supportRegistryState) Instantiates a new EhCache ticket registry.

Method Summary

Methods

Modifier and Type	Method and Description
void	addTicket(org.jasig.cas.ticket.Ticket ticketToAdd)
void	afterPropertiesSet()
boolean	deleteTicket(java.lang.String ticketIdToDelete)
org.jasig.cas.ticket.Ticket	getTicket(java.lang.String ticketIdToGet)
java.util.Collection<org.jasig.cas.ticket.Ticket>	getTickets()
protected boolean	needsCallback()
int	serviceTicketCount()
int	sessionCount()
void	setServiceTicketsCache(net.sf.ehcache.Cache serviceTicketsCache)
void	setSupportRegistryState(boolean supportRegistryState) Flag to indicate whether this registry instance should participate in reporting its state with default value set to true.
void	setTicketGrantingTicketsCache(net.sf.ehcache.Cache ticketGrantingTicketsCache)
java.lang.String	toString()
protected void	updateTicket(org.jasig.cas.ticket.Ticket ticket)

Methods inherited from class org.jasig.cas.ticket.registry.encrypt.AbstractCrypticTicketRegistry

decodeTicket, decodeTickets, encodeTicket, encodeTicketId, setCipherExecutor

Methods inherited from class org.jasig.cas.ticket.registry.AbstractDistributedTicketRegistry

getProxiedTicketInstance

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

getTicket

Methods inherited from class java.lang.Object

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

Constructor Detail

EhCacheTicketRegistry

public EhCacheTicketRegistry()

Instantiates a new EhCache ticket registry.

EhCacheTicketRegistry

public EhCacheTicketRegistry(net.sf.ehcache.Cache serviceTicketsCache,
                     net.sf.ehcache.Cache ticketGrantingTicketsCache)

Instantiates a new EhCache ticket registry.

Parameters:

serviceTicketsCache - the service tickets cache

ticketGrantingTicketsCache - the ticket granting tickets cache

EhCacheTicketRegistry

public EhCacheTicketRegistry(net.sf.ehcache.Cache serviceTicketsCache,
                     net.sf.ehcache.Cache ticketGrantingTicketsCache,
                     boolean supportRegistryState)

Instantiates a new EhCache ticket registry.

Parameters:

serviceTicketsCache - the service tickets cache

ticketGrantingTicketsCache - the ticket granting tickets cache

supportRegistryState - the support registry state

Method Detail

addTicket

public void addTicket(org.jasig.cas.ticket.Ticket ticketToAdd)

Specified by:

addTicket in interface org.jasig.cas.ticket.registry.TicketRegistry

deleteTicket

public boolean deleteTicket(java.lang.String ticketIdToDelete)

Specified by:

deleteTicket in interface org.jasig.cas.ticket.registry.TicketRegistry

getTicket

public org.jasig.cas.ticket.Ticket getTicket(java.lang.String ticketIdToGet)

Specified by:

getTicket in interface org.jasig.cas.ticket.registry.TicketRegistry

getTickets

public java.util.Collection<org.jasig.cas.ticket.Ticket> getTickets()

Specified by:

getTickets in interface org.jasig.cas.ticket.registry.TicketRegistry

setServiceTicketsCache

public void setServiceTicketsCache(net.sf.ehcache.Cache serviceTicketsCache)

setTicketGrantingTicketsCache

public void setTicketGrantingTicketsCache(net.sf.ehcache.Cache ticketGrantingTicketsCache)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

updateTicket

protected void updateTicket(org.jasig.cas.ticket.Ticket ticket)

Specified by:

updateTicket in class org.jasig.cas.ticket.registry.AbstractDistributedTicketRegistry

needsCallback

protected boolean needsCallback()

Specified by:

needsCallback in class org.jasig.cas.ticket.registry.AbstractDistributedTicketRegistry

setSupportRegistryState

public void setSupportRegistryState(boolean supportRegistryState)

Flag to indicate whether this registry instance should participate in reporting its state with default value set to true. Based on the EhCache documentation, determining the number of service tickets and the total session count from the cache can be considered an expensive operation with the time taken as O(n), where n is the number of elements in the cache.

Therefore, the flag provides a level of flexibility such that depending on the cache and environment settings, reporting statistics can be set to false and disabled.

Parameters:

supportRegistryState - true, if the registry is to support registry state

See Also:

sessionCount(), serviceTicketCount()

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

sessionCount

public int sessionCount()

Specified by:

sessionCount in interface org.jasig.cas.ticket.registry.TicketRegistryState

Overrides:

sessionCount in class org.jasig.cas.ticket.registry.AbstractTicketRegistry

serviceTicketCount

public int serviceTicketCount()

Specified by:

serviceTicketCount in interface org.jasig.cas.ticket.registry.TicketRegistryState

Overrides:

serviceTicketCount in class org.jasig.cas.ticket.registry.AbstractTicketRegistry