org.apereo.cas.ticket.artifact

Class SamlArtifactTicketImpl

java.lang.Object

org.apereo.cas.ticket.AbstractTicket

org.apereo.cas.ticket.artifact.SamlArtifactTicketImpl

All Implemented Interfaces:

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

@Entity
public class SamlArtifactTicketImpl
extends AbstractTicket
implements SamlArtifactTicket

This is SamlArtifactTicketImpl.

Since:

5.2.0

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.apereo.cas.ticket.artifact.SamlArtifactTicket

PREFIX

Constructor Summary

Constructors

Constructor and Description
SamlArtifactTicketImpl(java.lang.String id, Service service, Authentication authentication, ExpirationPolicy expirationPolicy, TicketGrantingTicket ticketGrantingTicket, java.lang.String issuer, java.lang.String relyingParty, java.lang.String samlObject) Constructs a new OAuth code with unique id for a service and authentication.

Method Summary

Modifier and Type	Method and Description
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	isFromNewLogin() Determine if this ticket was created at the same time as a TicketGrantingTicket.
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, 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.artifact.SamlArtifactTicket

getIssuer, getObject, getRelyingPartyId

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

getService

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

SamlArtifactTicketImpl

public SamlArtifactTicketImpl(java.lang.String id,
                              Service service,
                              Authentication authentication,
                              ExpirationPolicy expirationPolicy,
                              TicketGrantingTicket ticketGrantingTicket,
                              java.lang.String issuer,
                              java.lang.String relyingParty,
                              java.lang.String samlObject)

Constructs a new OAuth code with unique id for a service and authentication.

Parameters:

id - the unique identifier for the ticket.

service - the service this ticket is for.

authentication - the authentication.

expirationPolicy - the expiration policy.

ticketGrantingTicket - the ticket granting ticket

issuer - the issuer

relyingParty - the relying party

samlObject - the saml object

Throws:

java.lang.IllegalArgumentException - if the service or authentication are null.

Method Detail

isFromNewLogin

public boolean isFromNewLogin()

Description copied from interface: ServiceTicket

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

Specified by:

isFromNewLogin in interface ServiceTicket

Returns:

true if it is, false otherwise.

isValidFor

public boolean isValidFor(Service serviceToValidate)

Description copied from interface: ServiceTicket

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

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)

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.

getPrefix

public java.lang.String getPrefix()

Description copied from interface: Ticket

Gets prefix.

Specified by:

getPrefix in interface Ticket

Returns:

the prefix