org.apereo.cas

Class AbstractCentralAuthenticationService

java.lang.Object

org.apereo.cas.AbstractCentralAuthenticationService

All Implemented Interfaces:

java.io.Serializable, org.apereo.cas.CentralAuthenticationService, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationEventPublisherAware

Direct Known Subclasses:

CentralAuthenticationServiceImpl

public abstract class AbstractCentralAuthenticationService
extends java.lang.Object
implements org.apereo.cas.CentralAuthenticationService, java.io.Serializable, org.springframework.context.ApplicationEventPublisherAware

An abstract implementation of the CentralAuthenticationService that provides access to the needed scaffolding and services that are necessary to CAS, such as ticket registry, service registry, etc. The intention here is to allow extensions to easily benefit these already-configured components without having to to duplicate them again.

Since:

4.2.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.context.ApplicationEventPublisher	applicationEventPublisher Application event publisher.
protected org.apereo.cas.CipherExecutor<java.lang.String,java.lang.String>	cipherExecutor Cipher executor to handle ticket validation.
protected org.slf4j.Logger	logger Log instance for logging events, info, warnings, errors, etc.
protected org.apereo.cas.logout.LogoutManager	logoutManager The logout manager.
protected org.apereo.cas.authentication.principal.PrincipalFactory	principalFactory Factory to create the principal type.
protected org.apereo.cas.authentication.ContextualAuthenticationPolicyFactory<org.apereo.cas.services.ServiceContext>	serviceContextAuthenticationPolicyFactory Authentication policy that uses a service context to produce stateful security policies to apply when authenticating credentials.
protected org.apereo.cas.services.ServicesManager	servicesManager Implementation of Service Manager.
protected org.apereo.cas.ticket.TicketFactory	ticketFactory The ticket factory.
protected org.apereo.cas.ticket.registry.TicketRegistry	ticketRegistry TicketRegistry for storing and retrieving tickets as needed.
protected java.util.List<org.apereo.cas.validation.ValidationServiceSelectionStrategy>	validationServiceSelectionStrategies The service selection strategy during validation events.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCentralAuthenticationService() Instantiates a new Central authentication service impl.
	AbstractCentralAuthenticationService(org.apereo.cas.ticket.registry.TicketRegistry ticketRegistry, org.apereo.cas.ticket.TicketFactory ticketFactory, org.apereo.cas.services.ServicesManager servicesManager, org.apereo.cas.logout.LogoutManager logoutManager) Build the central authentication service implementation.

Method Summary

Modifier and Type	Method and Description
protected void	doPublishEvent(org.springframework.context.ApplicationEvent e) Publish CAS events.
protected void	evaluateProxiedServiceIfNeeded(org.apereo.cas.authentication.principal.Service service, org.apereo.cas.ticket.TicketGrantingTicket ticketGrantingTicket, org.apereo.cas.services.RegisteredService registeredService) Evaluate proxied service if needed.
protected org.apereo.cas.authentication.Authentication	getAuthenticationSatisfiedByPolicy(org.apereo.cas.authentication.Authentication authentication, org.apereo.cas.services.ServiceContext context) Gets the authentication satisfied by policy.
<T extends org.apereo.cas.ticket.Ticket> T	getTicket(java.lang.String ticketId)
<T extends org.apereo.cas.ticket.Ticket> T	getTicket(java.lang.String ticketId, java.lang.Class<T> clazz)
java.util.Collection<org.apereo.cas.ticket.Ticket>	getTickets(com.google.common.base.Predicate<org.apereo.cas.ticket.Ticket> predicate)
void	setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher)
void	setCipherExecutor(org.apereo.cas.CipherExecutor<java.lang.String,java.lang.String> cipherExecutor)
void	setLogoutManager(org.apereo.cas.logout.LogoutManager logoutManager)
void	setPrincipalFactory(org.apereo.cas.authentication.principal.PrincipalFactory principalFactory) Sets principal factory to create principal objects.
void	setServiceContextAuthenticationPolicyFactory(org.apereo.cas.authentication.ContextualAuthenticationPolicyFactory<org.apereo.cas.services.ServiceContext> policy)
void	setServicesManager(org.apereo.cas.services.ServicesManager servicesManager)
void	setTicketFactory(org.apereo.cas.ticket.TicketFactory ticketFactory)
void	setTicketRegistry(org.apereo.cas.ticket.registry.TicketRegistry ticketRegistry)
void	setValidationServiceSelectionStrategies(java.util.List list)
org.apereo.cas.ticket.Ticket	updateTicket(org.apereo.cas.ticket.Ticket ticket)
protected void	verifyTicketState(org.apereo.cas.ticket.Ticket ticket, java.lang.String id, java.lang.Class clazz) Validate ticket expiration policy and throws exception if ticket is no longer valid.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apereo.cas.CentralAuthenticationService

createProxyGrantingTicket, createTicketGrantingTicket, destroyTicketGrantingTicket, grantProxyTicket, grantServiceTicket, validateServiceTicket

Field Detail

logger

protected transient org.slf4j.Logger logger

Log instance for logging events, info, warnings, errors, etc.

applicationEventPublisher

@Autowired
protected org.springframework.context.ApplicationEventPublisher applicationEventPublisher

Application event publisher.

ticketRegistry

protected org.apereo.cas.ticket.registry.TicketRegistry ticketRegistry

TicketRegistry for storing and retrieving tickets as needed.

servicesManager

protected org.apereo.cas.services.ServicesManager servicesManager

Implementation of Service Manager.

logoutManager

protected org.apereo.cas.logout.LogoutManager logoutManager

The logout manager.

ticketFactory

protected org.apereo.cas.ticket.TicketFactory ticketFactory

The ticket factory.

validationServiceSelectionStrategies

protected java.util.List<org.apereo.cas.validation.ValidationServiceSelectionStrategy> validationServiceSelectionStrategies

The service selection strategy during validation events.

serviceContextAuthenticationPolicyFactory

protected org.apereo.cas.authentication.ContextualAuthenticationPolicyFactory<org.apereo.cas.services.ServiceContext> serviceContextAuthenticationPolicyFactory

Authentication policy that uses a service context to produce stateful security policies to apply when authenticating credentials.

principalFactory

protected org.apereo.cas.authentication.principal.PrincipalFactory principalFactory

Factory to create the principal type.

cipherExecutor

protected org.apereo.cas.CipherExecutor<java.lang.String,java.lang.String> cipherExecutor

Cipher executor to handle ticket validation.

Constructor Detail

AbstractCentralAuthenticationService

protected AbstractCentralAuthenticationService()

Instantiates a new Central authentication service impl.

AbstractCentralAuthenticationService

public AbstractCentralAuthenticationService(org.apereo.cas.ticket.registry.TicketRegistry ticketRegistry,
                                            org.apereo.cas.ticket.TicketFactory ticketFactory,
                                            org.apereo.cas.services.ServicesManager servicesManager,
                                            org.apereo.cas.logout.LogoutManager logoutManager)

Build the central authentication service implementation.

Parameters:

ticketRegistry - the tickets registry.

ticketFactory - the ticket factory

servicesManager - the services manager.

logoutManager - the logout manager.

Method Detail

setServiceContextAuthenticationPolicyFactory

public void setServiceContextAuthenticationPolicyFactory(org.apereo.cas.authentication.ContextualAuthenticationPolicyFactory<org.apereo.cas.services.ServiceContext> policy)

setTicketFactory

public void setTicketFactory(org.apereo.cas.ticket.TicketFactory ticketFactory)

setPrincipalFactory

public void setPrincipalFactory(org.apereo.cas.authentication.principal.PrincipalFactory principalFactory)

Sets principal factory to create principal objects.

Parameters:

principalFactory - the principal factory

doPublishEvent

protected void doPublishEvent(org.springframework.context.ApplicationEvent e)

Publish CAS events.

Parameters:

e - the event

getTicket

@Transactional(readOnly=true,
               transactionManager="ticketTransactionManager",
               noRollbackFor=org.apereo.cas.ticket.InvalidTicketException.class)
 @Timed(name="GET_TICKET_TIMER")
 @Metered(name="GET_TICKET_METER")
 @Counted(name="GET_TICKET_COUNTER",
         monotonic=true)
public <T extends org.apereo.cas.ticket.Ticket> T getTicket(java.lang.String ticketId)
                                                                                                                                                                                                                                                                                                                                                                           throws org.apereo.cas.ticket.InvalidTicketException

Specified by:

getTicket in interface org.apereo.cas.CentralAuthenticationService

Throws:

org.apereo.cas.ticket.InvalidTicketException

getTicket

@Transactional(readOnly=true,
               transactionManager="ticketTransactionManager",
               noRollbackFor=org.apereo.cas.ticket.InvalidTicketException.class)
 @Timed(name="GET_TICKET_TIMER")
 @Metered(name="GET_TICKET_METER")
 @Counted(name="GET_TICKET_COUNTER",
         monotonic=true)
public <T extends org.apereo.cas.ticket.Ticket> T getTicket(java.lang.String ticketId,
                                                                                                                                                                                                                                                                                                                                                                                  java.lang.Class<T> clazz)
                                                                                                                                                                                                                                                                                                                                                                           throws org.apereo.cas.ticket.InvalidTicketException

Note: Synchronization on ticket object in case of cache based registry doesn't serialize access to critical section. The reason is that cache pulls serialized data and builds new object, most likely for each pull. Is this synchronization needed here?

Specified by:

getTicket in interface org.apereo.cas.CentralAuthenticationService

Throws:

org.apereo.cas.ticket.InvalidTicketException

getTickets

@Transactional(readOnly=true,
               transactionManager="ticketTransactionManager")
 @Timed(name="GET_TICKETS_TIMER")
 @Metered(name="GET_TICKETS_METER")
 @Counted(name="GET_TICKETS_COUNTER",
         monotonic=true)
public java.util.Collection<org.apereo.cas.ticket.Ticket> getTickets(com.google.common.base.Predicate<org.apereo.cas.ticket.Ticket> predicate)

Specified by:

getTickets in interface org.apereo.cas.CentralAuthenticationService

getAuthenticationSatisfiedByPolicy

protected org.apereo.cas.authentication.Authentication getAuthenticationSatisfiedByPolicy(org.apereo.cas.authentication.Authentication authentication,
                                                                                          org.apereo.cas.services.ServiceContext context)
                                                                                   throws org.apereo.cas.ticket.AbstractTicketException

Gets the authentication satisfied by policy.

Parameters:

authentication - the authentication

context - the context

Returns:

the authentication satisfied by policy

Throws:

org.apereo.cas.ticket.AbstractTicketException - the ticket exception

evaluateProxiedServiceIfNeeded

protected void evaluateProxiedServiceIfNeeded(org.apereo.cas.authentication.principal.Service service,
                                              org.apereo.cas.ticket.TicketGrantingTicket ticketGrantingTicket,
                                              org.apereo.cas.services.RegisteredService registeredService)

Evaluate proxied service if needed.

Parameters:

service - the service

ticketGrantingTicket - the ticket granting ticket

registeredService - the registered service

verifyTicketState

protected void verifyTicketState(org.apereo.cas.ticket.Ticket ticket,
                                 java.lang.String id,
                                 java.lang.Class clazz)

Validate ticket expiration policy and throws exception if ticket is no longer valid. Expired tickets are also deleted from the registry immediately on demand.

Parameters:

ticket - the ticket

id - the original id

clazz - the clazz

updateTicket

public org.apereo.cas.ticket.Ticket updateTicket(org.apereo.cas.ticket.Ticket ticket)

Specified by:

updateTicket in interface org.apereo.cas.CentralAuthenticationService

setApplicationEventPublisher

public void setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher)

Specified by:

setApplicationEventPublisher in interface org.springframework.context.ApplicationEventPublisherAware

setTicketRegistry

public void setTicketRegistry(org.apereo.cas.ticket.registry.TicketRegistry ticketRegistry)

setServicesManager

public void setServicesManager(org.apereo.cas.services.ServicesManager servicesManager)

setLogoutManager

public void setLogoutManager(org.apereo.cas.logout.LogoutManager logoutManager)

setValidationServiceSelectionStrategies

public void setValidationServiceSelectionStrategies(java.util.List list)

setCipherExecutor

public void setCipherExecutor(org.apereo.cas.CipherExecutor<java.lang.String,java.lang.String> cipherExecutor)