org.apereo.cas.ticket

Class ServiceTicketImpl

java.lang.Object

org.apereo.cas.ticket.AbstractTicket

org.apereo.cas.ticket.ServiceTicketImpl

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Ticket>, ServiceTicket, Ticket, TicketState

Direct Known Subclasses:

ProxyTicketImpl

@Entity
public class ServiceTicketImpl
extends AbstractTicket
implements ServiceTicket

Domain object representing a Service Ticket. A service ticket grants specific access to a particular service. It will only work for a particular service. Generally, it is a one time use Ticket, but the specific expiration policy can be anything.

Since:

3.0.0

See Also:

Serialized Form

Field Summary

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

PREFIX

Constructor Summary

Constructors

Constructor and Description
ServiceTicketImpl(java.lang.String id, TicketGrantingTicket ticket, Service service, boolean credentialProvided, ExpirationPolicy policy) Constructs a new ServiceTicket with a Unique Id, a TicketGrantingTicket, a Service, Expiration Policy and a flag to determine if the ticket creation was from a new Login or not.

Method Summary

Modifier and Type	Method and Description
Authentication	getAuthentication() Authentication information from the ticket.
java.lang.String	getPrefix() Gets prefix.
ProxyGrantingTicket	grantProxyGrantingTicket(java.lang.String id, Authentication authentication, ExpirationPolicy expirationPolicy) Method to grant a TicketGrantingTicket from this service to the authentication.
boolean	isValidFor(Service serviceToValidate) Attempts to ensure that the service specified matches the service associated with the ticket.

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

compareTo, 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.ServiceTicket

getService, isFromNewLogin

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

ServiceTicketImpl

public ServiceTicketImpl(java.lang.String id,
                         @NonNull
                         TicketGrantingTicket ticket,
                         @NonNull
                         Service service,
                         boolean credentialProvided,
                         ExpirationPolicy policy)

Constructs a new ServiceTicket with a Unique Id, a TicketGrantingTicket, a Service, Expiration Policy and a flag to determine if the ticket creation was from a new Login or not.

Parameters:

id - the unique identifier for the ticket.

ticket - the TicketGrantingTicket parent.

service - the service this ticket is for.

credentialProvided - current credential that prompted this service ticket. May be null.

policy - the expiration policy for the Ticket.

Throws:

java.lang.IllegalArgumentException - if the TicketGrantingTicket or the Service are null.

Method Detail

isValidFor

public boolean isValidFor(Service serviceToValidate)

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

The state of the ticket is affected by this operation and the ticket will be considered used regardless of the match result. The state update subsequently may impact the ticket expiration policy in that, depending on the policy configuration, the ticket may be considered expired.

Specified by:

isValidFor in interface ServiceTicket

Parameters:

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

Returns:

true, if the match is successful.

grantProxyGrantingTicket

public ProxyGrantingTicket grantProxyGrantingTicket(java.lang.String id,
                                                    Authentication authentication,
                                                    ExpirationPolicy expirationPolicy)
                                             throws AbstractTicketException

Description copied from interface: ServiceTicket

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

Specified by:

grantProxyGrantingTicket in interface ServiceTicket

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.

Throws:

AbstractTicketException - ticket exception thrown when generating the ticket

getAuthentication

public Authentication getAuthentication()

Description copied from interface: TicketState

Authentication information from the ticket. This may be null.

Specified by:

getAuthentication in interface TicketState

Overrides:

getAuthentication in class AbstractTicket

Returns:

the authentication information.

getPrefix

public java.lang.String getPrefix()

Description copied from interface: Ticket

Gets prefix.

Specified by:

getPrefix in interface Ticket

Returns:

the prefix