Package org.apereo.cas.ticket.proxy

Interface ProxyGrantingTicket

All Superinterfaces:

AuthenticationAwareTicket, java.lang.Comparable<Ticket>, java.io.Serializable, Ticket, TicketGrantingTicket, TicketGrantingTicketAwareTicket

public interface ProxyGrantingTicket
extends TicketGrantingTicket

Interface for a proxy granting ticket. A proxy-granting ticket is an opaque string that is used by a service to obtain proxy tickets for obtaining access to a back-end service on behalf of a client. Proxy-granting tickets are obtained from CAS upon validation of a service ticket or a proxy ticket.

Since:

4.2

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PROXY_GRANTING_TICKET_IOU_PREFIX	The prefix to use when generating an id for a Proxy Granting Ticket IOU.
static java.lang.String	PROXY_GRANTING_TICKET_PREFIX	The prefix to use when generating an id for a Proxy Granting Ticket.

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

PREFIX

Method Summary

Modifier and Type	Method	Description
ProxyTicket	grantProxyTicket(java.lang.String id, org.apereo.cas.authentication.principal.Service service, ExpirationPolicy expirationPolicy, boolean onlyTrackMostRecentSession)	Grant a proxy ticket for a specific service.

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

getAuthentication

Methods inherited from interface java.lang.Comparable

compareTo

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

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

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

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

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

getTicketGrantingTicket

Field Detail

PROXY_GRANTING_TICKET_PREFIX

static final java.lang.String PROXY_GRANTING_TICKET_PREFIX

The prefix to use when generating an id for a Proxy Granting Ticket.

See Also:

Constant Field Values

PROXY_GRANTING_TICKET_IOU_PREFIX

static final java.lang.String PROXY_GRANTING_TICKET_IOU_PREFIX

The prefix to use when generating an id for a Proxy Granting Ticket IOU.

See Also:

Constant Field Values

Method Detail

grantProxyTicket

ProxyTicket grantProxyTicket(java.lang.String id,
                             org.apereo.cas.authentication.principal.Service service,
                             ExpirationPolicy expirationPolicy,
                             boolean onlyTrackMostRecentSession)

Grant a proxy ticket for a specific service.

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