org.jasig.cas.ticket
Interface TicketGrantingTicket

All Superinterfaces:

java.io.Serializable, Ticket

All Known Implementing Classes:

TicketGrantingTicketImpl

public interface TicketGrantingTicket
extends Ticket

Interface for a ticket granting ticket. A TicketGrantingTicket is the main access into the CAS service layer. Without a TicketGrantingTicket, a user of CAS cannot do anything.

Since:

3.0

Version:

$Revision: 46910 $ $Date: 2009-10-18 00:09:46 -0400 (Sun, 18 Oct 2009) $

Author:

Scott Battaglia

Field Summary

static java.lang.String

PREFIX The prefix to use when generating an id for a TicketGrantingTicket.

Method Summary

void	expire() Explicitly expire a ticket.
Authentication	getAuthentication() Method to retrieve the authentication.
java.util.List<Authentication>	getChainedAuthentications() Method to retrieve the chained list of Authentications for this TicketGrantingTicket.
ServiceTicket	grantServiceTicket(java.lang.String id, Service service, ExpirationPolicy expirationPolicy, boolean credentialsProvided) Grant a ServiceTicket for a specific service.
boolean	isRoot() Convenience method to determine if the TicketGrantingTicket is the root of the heirachy of tickets.

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

getCountOfUses, getCreationTime, getGrantingTicket, getId, isExpired

Field Detail

PREFIX

static final java.lang.String PREFIX

The prefix to use when generating an id for a TicketGrantingTicket.

See Also:

Constant Field Values

Method Detail

getAuthentication

Authentication getAuthentication()

Method to retrieve the authentication.

Returns:

the authentication

grantServiceTicket

ServiceTicket grantServiceTicket(java.lang.String id,
                                 Service service,
                                 ExpirationPolicy expirationPolicy,
                                 boolean credentialsProvided)

Grant a ServiceTicket for a specific service.

Parameters:

id - The unique identifier for this ticket.

service - The service for which we are granting a ticket

Returns:

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

expire

void expire()

Explicitly expire a ticket. This method will log out of any service associated with the Ticket Granting Ticket.

isRoot

boolean isRoot()

Convenience method to determine if the TicketGrantingTicket is the root of the heirachy of tickets.

Returns:

true if it has no parent, false otherwise.

getChainedAuthentications

java.util.List<Authentication> getChainedAuthentications()

Method to retrieve the chained list of Authentications for this TicketGrantingTicket.

Returns:

the list of principals