org.jasig.cas.ticket

Interface ServiceTicket

All Superinterfaces:

Serializable, Ticket

All Known Implementing Classes:

ServiceTicketImpl

public interface ServiceTicket
extends Ticket

Interface for a Service Ticket. A service ticket is used to grant access to a specific service for a principal. A Service Ticket is generally a one-time use ticket.

Since:

3.0

Author:

Scott Battaglia

Field Summary

Fields

Modifier and Type	Field and Description
static String	PREFIX Prefix generally applied to unique ids generated by UniqueIdGenenerator.

Method Summary

Methods

Modifier and Type	Method and Description
Service	getService() Retrieve the service this ticket was given for.
TicketGrantingTicket	grantTicketGrantingTicket(String id, Authentication authentication, ExpirationPolicy expirationPolicy) Method to grant a TicketGrantingTicket from this service to the authentication.
boolean	isFromNewLogin() Determine if this ticket was created at the same time as a TicketGrantingTicket.
boolean	isValidFor(Service service) Attempts to ensure that the service specified matches the service associated with the ticket.

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

getCountOfUses, getCreationTime, getGrantingTicket, getId, isExpired

Field Detail

PREFIX

static final String PREFIX

Prefix generally applied to unique ids generated by UniqueIdGenenerator.

See Also:

Constant Field Values

Method Detail

getService

Service getService()

Retrieve the service this ticket was given for.

Returns:

the server.

isFromNewLogin

boolean isFromNewLogin()

Determine if this ticket was created at the same time as a TicketGrantingTicket.

Returns:

true if it is, false otherwise.

isValidFor

boolean isValidFor(Service service)

Attempts to ensure that the service specified matches the service associated with the ticket.

Parameters:

service - The incoming service to match this service ticket against.

Returns:

true, if the match is successful.

grantTicketGrantingTicket

TicketGrantingTicket grantTicketGrantingTicket(String id,
                                             Authentication authentication,
                                             ExpirationPolicy expirationPolicy)

Method to grant a TicketGrantingTicket from this service to the authentication. Analogous to the ProxyGrantingTicket.

Parameters:

id - The unique identifier for this ticket.

authentication - The Authentication we wish to grant a ticket for.

expirationPolicy - expiration policy associated with this ticket

Returns:

The ticket granting ticket.