org.apereo.cas.ticket.registry

Class RedisTicketRegistry

java.lang.Object

org.apereo.cas.ticket.registry.AbstractTicketRegistry

org.apereo.cas.ticket.registry.RedisTicketRegistry

All Implemented Interfaces:

TicketRegistry

public class RedisTicketRegistry
extends AbstractTicketRegistry

Key-value ticket registry implementation that stores tickets in redis keyed on the ticket ID.

Since:

5.1.0

Field Summary

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

cipherExecutor

Constructor Summary

Constructors

Constructor and Description
RedisTicketRegistry()

Method Summary

Modifier and Type	Method and Description
void	addTicket(Ticket ticket) 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 ticketId) Retrieve a ticket from the registry.
java.util.Collection<Ticket>	getTickets() Retrieve all tickets from the registry.
java.util.stream.Stream<Ticket>	getTicketsStream() Gets tickets stream.
Ticket	updateTicket(Ticket ticket) Update the received ticket.

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

decodeTicket, decodeTickets, decodeTickets, deleteChildren, deleteTicket, deleteTicket, deleteTickets, deleteTickets, encodeTicket, encodeTicketId, getTicket, isCipherExecutorEnabled, serviceTicketCount, sessionCount

Methods inherited from class java.lang.Object

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

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

getTickets

Constructor Detail

RedisTicketRegistry

public RedisTicketRegistry()

Method Detail

deleteAll

public long deleteAll()

Description copied from interface: TicketRegistry

Delete all tickets from the registry.

Returns:

the number of tickets deleted.

deleteSingleTicket

public boolean deleteSingleTicket(java.lang.String ticketId)

Description copied from class: AbstractTicketRegistry

Delete a single ticket instance from the store.

Specified by:

deleteSingleTicket in class AbstractTicketRegistry

Parameters:

ticketId - the ticket id

Returns:

true/false

addTicket

public void addTicket(Ticket ticket)

Description copied from interface: TicketRegistry

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

Parameters:

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

getTicket

public Ticket getTicket(java.lang.String ticketId)

Description copied from interface: TicketRegistry

Retrieve a ticket from the registry.

Parameters:

ticketId - 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.

getTicketsStream

public java.util.stream.Stream<Ticket> getTicketsStream()

Description copied from interface: TicketRegistry

Gets tickets stream. The returning stream may be bound to an IO channel (such as database connection), so it should be properly closed after usage.

Returns:

the tickets stream

updateTicket

public Ticket updateTicket(Ticket ticket)

Description copied from interface: TicketRegistry

Update the received ticket.

Parameters:

ticket - the ticket

Returns:

the updated ticket