org.apereo.cas.ticket.factory

Class DefaultProxyGrantingTicketFactory

java.lang.Object

org.apereo.cas.ticket.factory.DefaultProxyGrantingTicketFactory

All Implemented Interfaces:

ProxyGrantingTicketFactory, TicketFactory

public class DefaultProxyGrantingTicketFactory
extends java.lang.Object
implements ProxyGrantingTicketFactory

The DefaultProxyGrantingTicketFactory is responsible for creating ProxyGrantingTicket objects.

Since:

4.2

Field Summary

Fields

Modifier and Type	Field and Description
protected CipherExecutor<java.lang.String,java.lang.String>	cipherExecutor The ticket cipher.
protected ExpirationPolicy	ticketGrantingTicketExpirationPolicy Expiration policy for ticket granting tickets.
protected UniqueTicketIdGenerator	ticketGrantingTicketUniqueTicketIdGenerator Used to generate ids for TicketGrantingTickets created.

Constructor Summary

Constructors

Constructor and Description
DefaultProxyGrantingTicketFactory(UniqueTicketIdGenerator ticketGrantingTicketUniqueTicketIdGenerator, ExpirationPolicy ticketGrantingTicketExpirationPolicy, CipherExecutor<java.lang.String,java.lang.String> cipherExecutor)

Method Summary

Modifier and Type	Method and Description
<T extends ProxyGrantingTicket> T	create(ServiceTicket serviceTicket, Authentication authentication) Create the ticket object.
<T extends TicketFactory> T	get(java.lang.Class<? extends Ticket> clazz) Get ticket factory.
protected <T extends ProxyGrantingTicket> T	produceTicket(ServiceTicket serviceTicket, Authentication authentication, java.lang.String pgtId) Produce ticket.
protected java.lang.String	produceTicketIdentifier() Produce ticket identifier string.

Methods inherited from class java.lang.Object

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

Field Detail

ticketGrantingTicketUniqueTicketIdGenerator

protected UniqueTicketIdGenerator ticketGrantingTicketUniqueTicketIdGenerator

Used to generate ids for TicketGrantingTickets created.

ticketGrantingTicketExpirationPolicy

protected ExpirationPolicy ticketGrantingTicketExpirationPolicy

Expiration policy for ticket granting tickets.

cipherExecutor

protected CipherExecutor<java.lang.String,java.lang.String> cipherExecutor

The ticket cipher.

Constructor Detail

DefaultProxyGrantingTicketFactory

public DefaultProxyGrantingTicketFactory(UniqueTicketIdGenerator ticketGrantingTicketUniqueTicketIdGenerator,
                                         ExpirationPolicy ticketGrantingTicketExpirationPolicy,
                                         CipherExecutor<java.lang.String,java.lang.String> cipherExecutor)

Method Detail

create

public <T extends ProxyGrantingTicket> T create(ServiceTicket serviceTicket,
                                                Authentication authentication)
                                         throws AbstractTicketException

Description copied from interface: ProxyGrantingTicketFactory

Create the ticket object.

Specified by:

create in interface ProxyGrantingTicketFactory

Type Parameters:

T - the type parameter

Parameters:

serviceTicket - the ticket

authentication - the authentication

Returns:

the ticket instance

Throws:

AbstractTicketException - the abstract ticket exception

produceTicket

protected <T extends ProxyGrantingTicket> T produceTicket(ServiceTicket serviceTicket,
                                                          Authentication authentication,
                                                          java.lang.String pgtId)

Produce ticket.

Type Parameters:

T - the type parameter

Parameters:

serviceTicket - the service ticket

authentication - the authentication

pgtId - the pgt id

Returns:

the ticket

produceTicketIdentifier

protected java.lang.String produceTicketIdentifier()

Produce ticket identifier string.

Returns:

the ticket

get

public <T extends TicketFactory> T get(java.lang.Class<? extends Ticket> clazz)

Description copied from interface: TicketFactory

Get ticket factory.

Specified by:

get in interface TicketFactory

Type Parameters:

T - the type parameter

Parameters:

clazz - the clazz

Returns:

ticket factory object