org.apereo.cas.ticket

Interface TransientSessionTicket

All Superinterfaces:

java.lang.Comparable<Ticket>, java.io.Serializable, Ticket

All Known Implementing Classes:

TransientSessionTicketImpl

public interface TransientSessionTicket
extends Ticket

This is TransientSessionTicket that allows CAS to use the ticket registry as a distributed session store for short-lived non-specific objects. The intention of this ticket is to encapsulate objects that would otherwise be tracked by the application container's session. By using the ticket registry as a generic session store, all operations that may require session awareness specially in a clustered environment can be freed from that requirement.

Note that objects/values put into the session ticket are required to be serializable, just as normal ticket properties would be, depending on the design of the underlying ticket registry. Transient tickets generally have prominent use when CAS is acting as a proxy to another identity provider where the results of current application session/request need to be stored across the cluster and remembered later.

Since:

5.3.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PREFIX Ticket prefix for the delegated authentication request.

Method Summary

Modifier and Type	Method and Description
boolean	contains(java.lang.String name) Contains property boolean.
<T extends java.io.Serializable> T	get(java.lang.String name, java.lang.Class<T> clazz) Gets property.
<T extends java.io.Serializable> T	get(java.lang.String name, java.lang.Class<T> clazz, T defaultValue) Gets property.
java.util.Map<java.lang.String,java.io.Serializable>	getProperties() Gets properties.
Service	getService() Gets service.
void	put(java.lang.String name, java.io.Serializable value) Put property.
void	putAll(java.util.Map<java.lang.String,java.io.Serializable> props) Put all properties.

Methods inherited from interface org.apereo.cas.ticket.Ticket

getCountOfUses, getCreationTime, getExpirationPolicy, getId, getPrefix, getTicketGrantingTicket, isExpired, markTicketExpired

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

PREFIX

static final java.lang.String PREFIX

Ticket prefix for the delegated authentication request.

See Also:

Constant Field Values

Method Detail

getProperties

java.util.Map<java.lang.String,java.io.Serializable> getProperties()

Gets properties.

Returns:

the properties

getService

Service getService()

Gets service.

Returns:

the service

put

void put(java.lang.String name,
         java.io.Serializable value)

Put property.

Parameters:

name - the name

value - the value

putAll

void putAll(java.util.Map<java.lang.String,java.io.Serializable> props)

Put all properties.

Parameters:

props - the props

contains

boolean contains(java.lang.String name)

Contains property boolean.

Parameters:

name - the name

Returns:

the boolean

get

<T extends java.io.Serializable> T get(java.lang.String name,
                                       java.lang.Class<T> clazz)

Gets property.

Type Parameters:

T - the type parameter

Parameters:

name - the name

clazz - the clazz

Returns:

the property

get

<T extends java.io.Serializable> T get(java.lang.String name,
                                       java.lang.Class<T> clazz,
                                       T defaultValue)

Gets property.

Type Parameters:

T - the type parameter

Parameters:

name - the name

clazz - the clazz

defaultValue - the default value

Returns:

the property