org.jasig.cas.ticket.registry

Class AbstractTicketRegistry

java.lang.Object

org.jasig.cas.ticket.registry.AbstractTicketRegistry

All Implemented Interfaces:

TicketRegistryState, TicketRegistry

Direct Known Subclasses:

AbstractDistributedTicketRegistry, DefaultTicketRegistry

public abstract class AbstractTicketRegistry
extends Object
implements TicketRegistry, TicketRegistryState

Since:

3.0.4

This is a published and supported CAS Server 3 API.

Author:

Scott Battaglia

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger The Commons Logging logger instance.

Constructor Summary

Constructors

Constructor and Description
AbstractTicketRegistry()

Method Summary

Methods

Modifier and Type	Method and Description
<T extends Ticket> T	getTicket(String ticketId, Class<? extends Ticket> clazz) Retrieve a ticket from the registry.
int	serviceTicketCount() Computes the number of service tickets stored in the ticket registry.
int	sessionCount() Computes the number of SSO sessions stored in the ticket registry.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jasig.cas.ticket.registry.TicketRegistry

addTicket, deleteTicket, getTicket, getTickets

Field Detail

logger

protected final org.slf4j.Logger logger

The Commons Logging logger instance.

Constructor Detail

AbstractTicketRegistry

public AbstractTicketRegistry()

Method Detail

getTicket

public final <T extends Ticket> T 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.

Specified by:

getTicket in interface TicketRegistry

Type Parameters:

T - the generic ticket type to return that extends Ticket

Parameters:

ticketId - the id of the ticket we wish to retrieve.

clazz - The expected class of the ticket we wish to retrieve.

Returns:

specified ticket from the registry

Throws:

IllegalArgumentException - if class is null.

ClassCastException - if class does not match requested ticket class.

sessionCount

public int sessionCount()

Description copied from interface: TicketRegistryState

Computes the number of SSO sessions stored in the ticket registry.

Specified by:

sessionCount in interface TicketRegistryState

Returns:

Number of ticket-granting tickets in the registry at time of invocation or Integer.MIN_VALUE if unknown.

serviceTicketCount

public int serviceTicketCount()

Description copied from interface: TicketRegistryState

Computes the number of service tickets stored in the ticket registry.

Specified by:

serviceTicketCount in interface TicketRegistryState

Returns:

Number of service tickets in the registry at time of invocation or Integer.MIN_VALUE if unknown.