org.apereo.cas.ticket

Interface TicketDefinition

All Superinterfaces:

org.springframework.core.Ordered

All Known Implementing Classes:

DefaultTicketDefinition

public interface TicketDefinition
extends org.springframework.core.Ordered

This is TicketDefinition. Ticket definition describes additional Properties and misc settings that may be associated with a given ticket to be used by registries. Each CAS module on start up has the ability to register/alter ticket metadata that may be requires for its own specific functionality. Given each CAS module may decide to create many forms of tickets, this facility is specifically provided to dynamically register ticket types and associated properties so modules that deal with registry functionality wouldn't have to statically link to all modules and APIs.

Since:

5.1.0

See Also:

TicketCatalog

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method and Description
java.lang.Class<? extends Ticket>	getImplementationClass() Gets implementation class.
default int	getOrder() Returns order/priority associated with this definition.
java.lang.String	getPrefix() Gets prefix.
TicketDefinitionProperties	getProperties() Gets properties.

Method Detail

getPrefix

java.lang.String getPrefix()

Gets prefix.

Returns:

the prefix

getImplementationClass

java.lang.Class<? extends Ticket> getImplementationClass()

Gets implementation class.

Returns:

the implementation class

getProperties

TicketDefinitionProperties getProperties()

Gets properties.

Returns:

the properties

getOrder

default int getOrder()

Returns order/priority associated with this definition. Typically used in collection sorting and compare operations.

Specified by:

getOrder in interface org.springframework.core.Ordered

Returns:

the order.