org.apereo.cas.ticket.registry

Interface TicketRegistrySupport

All Known Implementing Classes:

DefaultTicketRegistrySupport

public interface TicketRegistrySupport

Helper strategy API to ease retrieving CAS' Authentication object and its associated components from available CAS SSO String token called Ticket Granting Ticket (TGT).

Since:

4.2.0

Method Summary

Modifier and Type	Method and Description
Principal	getAuthenticatedPrincipalFrom(java.lang.String ticketGrantingTicketId) Retrieve a valid Principal object identified by the provided TGT SSO token.
Authentication	getAuthenticationFrom(java.lang.String ticketGrantingTicketId) Retrieve a valid Authentication object identified by the provided TGT SSO token.
java.util.Map<java.lang.String,java.lang.Object>	getPrincipalAttributesFrom(java.lang.String ticketGrantingTicketId) Retrieve a valid Principal's map of attributes identified by the provided TGT SSO token.
void	updateAuthentication(java.lang.String ticketGrantingTicketId, Authentication authentication) Update authentication associated with the ticket-granting ticket and restore changes back to the registry; particularly updated authentication attributes, etc.

Method Detail

getAuthenticationFrom

Authentication getAuthenticationFrom(java.lang.String ticketGrantingTicketId)

Retrieve a valid Authentication object identified by the provided TGT SSO token.

Parameters:

ticketGrantingTicketId - an SSO token identifying the requested Authentication

Returns:

valid Authentication OR NULL if there is no valid SSO session present identified by the provided TGT id SSO token

getAuthenticatedPrincipalFrom

Principal getAuthenticatedPrincipalFrom(java.lang.String ticketGrantingTicketId)

Retrieve a valid Principal object identified by the provided TGT SSO token.

Parameters:

ticketGrantingTicketId - an SSO token identifying the requested authenticated Principal

Returns:

valid Principal OR NULL if there is no valid SSO session present identified by the provided TGT id SSO token

getPrincipalAttributesFrom

java.util.Map<java.lang.String,java.lang.Object> getPrincipalAttributesFrom(java.lang.String ticketGrantingTicketId)

Retrieve a valid Principal's map of attributes identified by the provided TGT SSO token.

Parameters:

ticketGrantingTicketId - an SSO token identifying the requested authenticated Principal's attributes

Returns:

valid Principal's attributes OR NULL if there is no valid SSO session present identified by the provided TGT id SSO token

updateAuthentication

void updateAuthentication(java.lang.String ticketGrantingTicketId,
                          Authentication authentication)

Update authentication associated with the ticket-granting ticket and restore changes back to the registry; particularly updated authentication attributes, etc.

Parameters:

ticketGrantingTicketId - the ticket granting ticket id

authentication - the authentication