org.apereo.cas.ticket

Class ProxyGrantingTicketImpl

java.lang.Object

org.apereo.cas.ticket.AbstractTicket

org.apereo.cas.ticket.TicketGrantingTicketImpl

org.apereo.cas.ticket.ProxyGrantingTicketImpl

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Ticket>, ProxyGrantingTicket, Ticket, TicketGrantingTicket, TicketState

@Entity
public class ProxyGrantingTicketImpl
extends TicketGrantingTicketImpl
implements ProxyGrantingTicket

Concrete implementation of a proxy granting ticket (PGT). A PGT is used by a service to obtain proxy tickets for obtaining access to a back-end service on behalf of a client. It is analogous to a ticket-granting ticket but only for proxying purposes. Proxy tickets will be issued off of a given proxy granting ticket.

NOTE: A PGT shares the same implementation as a TicketGrantingTicket. The intention of this implementation at this point is make explicit and visible the use and declaration of a PGT per the CAS protocol.

Since:

4.1

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.apereo.cas.ticket.proxy.ProxyGrantingTicket

PROXY_GRANTING_TICKET_IOU_PREFIX, PROXY_GRANTING_TICKET_PREFIX

Fields inherited from interface org.apereo.cas.ticket.TicketGrantingTicket

PREFIX

Constructor Summary

Constructors

Constructor and Description
ProxyGrantingTicketImpl(java.lang.String id, Authentication authentication, ExpirationPolicy policy) Instantiates a new proxy granting ticket impl.
ProxyGrantingTicketImpl(java.lang.String id, Service proxiedBy, TicketGrantingTicket parentTicketGrantingTicket, Authentication authentication, ExpirationPolicy expirationPolicy) Instantiates a new proxy granting ticket impl.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPrefix() Gets prefix.
ProxyTicket	grantProxyTicket(java.lang.String id, Service service, ExpirationPolicy expirationPolicy, boolean onlyTrackMostRecentSession) Grant a proxy ticket for a specific service.

Methods inherited from class org.apereo.cas.ticket.TicketGrantingTicketImpl

getChainedAuthentications, getRoot, grantServiceTicket, isRoot, removeAllServices, trackServiceSession

Methods inherited from class org.apereo.cas.ticket.AbstractTicket

compareTo, getAuthentication, getTicketGrantingTicket, isExpired, isExpiredInternal, markTicketExpired, toString, update

Methods inherited from class java.lang.Object

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

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

getAuthentication, getChainedAuthentications, getDescendantTickets, getProxiedBy, getProxyGrantingTickets, getRoot, getServices, grantServiceTicket, isRoot, removeAllServices

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

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

Methods inherited from interface java.lang.Comparable

compareTo

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

getCountOfUses, getCreationTime, getLastTimeUsed, getPreviousTimeUsed

Constructor Detail

ProxyGrantingTicketImpl

public ProxyGrantingTicketImpl(java.lang.String id,
                               Authentication authentication,
                               ExpirationPolicy policy)

Instantiates a new proxy granting ticket impl.

Parameters:

id - the id

authentication - the authentication

policy - the policy

ProxyGrantingTicketImpl

public ProxyGrantingTicketImpl(java.lang.String id,
                               Service proxiedBy,
                               TicketGrantingTicket parentTicketGrantingTicket,
                               Authentication authentication,
                               ExpirationPolicy expirationPolicy)

Instantiates a new proxy granting ticket impl.

Parameters:

id - the id

proxiedBy - the proxied by

parentTicketGrantingTicket - the ticket granting ticket

authentication - the authentication

expirationPolicy - the policy

Method Detail

grantProxyTicket

public ProxyTicket grantProxyTicket(java.lang.String id,
                                    Service service,
                                    ExpirationPolicy expirationPolicy,
                                    boolean onlyTrackMostRecentSession)

Description copied from interface: ProxyGrantingTicket

Grant a proxy ticket for a specific service.

Specified by:

grantProxyTicket in interface ProxyGrantingTicket

Parameters:

id - The unique identifier for this ticket.

service - The service for which we are granting a ticket

expirationPolicy - the expiration policy.

onlyTrackMostRecentSession - track the most recent session by keeping the latest service ticket

Returns:

the service ticket granted to a specific service for the principal of the TicketGrantingTicket

getPrefix

public java.lang.String getPrefix()

Description copied from interface: Ticket

Gets prefix.

Specified by:

getPrefix in interface Ticket

Overrides:

getPrefix in class TicketGrantingTicketImpl

Returns:

the prefix