org.apereo.cas.ticket.registry

Class DefaultTicketRegistryCleaner

java.lang.Object

org.apereo.cas.ticket.registry.DefaultTicketRegistryCleaner

All Implemented Interfaces:

java.io.Serializable, TicketRegistryCleaner

@Transactional(transactionManager="ticketTransactionManager")
public class DefaultTicketRegistryCleaner
extends java.lang.Object
implements TicketRegistryCleaner, java.io.Serializable

This is DefaultTicketRegistryCleaner.

Since:

5.0.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefaultTicketRegistryCleaner()

Method Summary

Modifier and Type	Method and Description
void	clean() Clean the ticket registry by collecting tickets in the storage unit that may be expired.
protected void	cleanInternal() Clean tickets.
int	cleanTicket(Ticket ticket) Cleans up after an already-expired ticket, by running the necessary processes such as logout notifications and more.
protected boolean	isCleanerSupported() Indicates whether the registry supports automated ticket cleanup.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultTicketRegistryCleaner

public DefaultTicketRegistryCleaner()

Method Detail

clean

public void clean()

Description copied from interface: TicketRegistryCleaner

Clean the ticket registry by collecting tickets in the storage unit that may be expired.

Specified by:

clean in interface TicketRegistryCleaner

cleanInternal

protected void cleanInternal()

Clean tickets.

cleanTicket

public int cleanTicket(Ticket ticket)

Description copied from interface: TicketRegistryCleaner

Cleans up after an already-expired ticket, by running the necessary processes such as logout notifications and more.

Specified by:

cleanTicket in interface TicketRegistryCleaner

Parameters:

ticket - the ticket

Returns:

the number of tickets that were cleaned up during the process.

isCleanerSupported

protected boolean isCleanerSupported()

Indicates whether the registry supports automated ticket cleanup. Generally, a registry that is able to return a collection of available tickets should be able to support the cleanup process. Default is true.

Returns:

true/false.