org.apereo.cas.web.flow.resolver.impl

Class AbstractCasWebflowEventResolver

java.lang.Object

org.apereo.cas.web.flow.resolver.impl.AbstractCasWebflowEventResolver

All Implemented Interfaces:

CasWebflowEventResolver

Direct Known Subclasses:

BaseMultifactorAuthenticationProviderEventResolver, InitialAuthenticationAttemptWebflowEventResolver, NoOpCasWebflowEventResolver, RankedAuthenticationProviderWebflowEventResolver, RiskAwareAuthenticationWebflowEventResolver, ServiceTicketRequestWebflowEventResolver

public abstract class AbstractCasWebflowEventResolver
extends java.lang.Object
implements CasWebflowEventResolver

This is AbstractCasWebflowEventResolver that provides parent operations for all child event resolvers to handle core webflow changes.

Since:

5.0.0

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.context.ConfigurableApplicationContext	applicationContext The Application context.
protected AuthenticationServiceSelectionPlan	authenticationRequestServiceSelectionStrategies Extract the service specially in the event that it's proxied by a callback.
protected AuthenticationSystemSupport	authenticationSystemSupport The Authentication system support.
protected CentralAuthenticationService	centralAuthenticationService The Central authentication service.
protected org.springframework.context.ApplicationEventPublisher	eventPublisher CAS event publisher.
protected MultifactorAuthenticationProviderSelector	multifactorAuthenticationProviderSelector The mfa selector.
protected ServicesManager	servicesManager The Services manager.
protected TicketRegistrySupport	ticketRegistrySupport Ticket registry support.
protected org.springframework.web.util.CookieGenerator	warnCookieGenerator Warn cookie generator.

Constructor Summary

Constructors

Constructor and Description
AbstractCasWebflowEventResolver()

Method Summary

Modifier and Type	Method and Description
protected static java.util.Map<java.lang.String,java.lang.Object>	buildEventAttributeMap(Principal principal, RegisteredService service, MultifactorAuthenticationProvider provider) Build event attribute map map.
protected java.util.Set<org.springframework.webflow.execution.Event>	evaluateEventForProviderInContext(Principal principal, RegisteredService service, org.springframework.webflow.execution.RequestContext context, MultifactorAuthenticationProvider provider) Verify provider for current context and validate event id.
protected org.springframework.webflow.execution.Event	getAuthenticationFailureErrorEvent(org.springframework.webflow.execution.RequestContext context) Gets authentication failure error event.
protected java.util.Collection<MultifactorAuthenticationProvider>	getAuthenticationProviderForService(RegisteredService service) Gets authentication provider for service.
protected Credential	getCredentialFromContext(org.springframework.webflow.execution.RequestContext context) Gets credential from context.
protected java.util.Optional<MultifactorAuthenticationProvider>	getMultifactorAuthenticationProviderFromApplicationContext(java.lang.String providerId) Find the MultifactorAuthenticationProvider in the application contact that matches the specified providerId (e.g.
protected java.util.Map<java.lang.String,java.lang.Object>	getPrincipalAttributesForMultifactorAuthentication(Principal principal) Gets principal attributes for multifactor authentication.
protected java.util.Set<org.springframework.webflow.execution.Event>	getResolvedEventsAsAttribute(org.springframework.webflow.execution.RequestContext context) Gets resolved events as attribute.
protected org.springframework.webflow.execution.Event	grantTicketGrantingTicketToAuthenticationResult(org.springframework.webflow.execution.RequestContext context, AuthenticationResultBuilder authenticationResultBuilder, Service service) Grant ticket granting ticket.
protected java.util.Set<org.springframework.webflow.execution.Event>	handleAuthenticationTransactionAndGrantTicketGrantingTicket(org.springframework.webflow.execution.RequestContext context) Handle authentication transaction and grant ticket granting ticket.
protected org.springframework.webflow.execution.Event	newEvent(java.lang.String id) New event event.
protected org.springframework.webflow.execution.Event	newEvent(java.lang.String id, org.springframework.webflow.core.collection.AttributeMap attributes) New event based on the given id.
protected org.springframework.webflow.execution.Event	newEvent(java.lang.String id, java.lang.Exception error) New event based on the id, which contains an error attribute referring to the exception occurred.
protected void	putResolvedEventsAsAttribute(org.springframework.webflow.execution.RequestContext context, java.util.Set<org.springframework.webflow.execution.Event> resolvedEvents) Put resolved events as attribute.
java.util.Set<org.springframework.webflow.execution.Event>	resolve(org.springframework.webflow.execution.RequestContext context) Resolve event.
protected java.util.Set<org.springframework.webflow.execution.Event>	resolveEventViaAuthenticationAttribute(Authentication authentication, java.util.Collection<java.lang.String> attributeNames, RegisteredService service, org.springframework.webflow.execution.RequestContext context, java.util.Collection<MultifactorAuthenticationProvider> providers, java.util.function.Predicate<java.lang.String> predicate) Resolve event via authentication attribute set.
protected java.util.Set<org.springframework.webflow.execution.Event>	resolveEventViaPrincipalAttribute(Principal principal, java.util.Collection<java.lang.String> attributeNames, RegisteredService service, org.springframework.webflow.execution.RequestContext context, java.util.Collection<MultifactorAuthenticationProvider> providers, java.util.function.Predicate<java.lang.String> predicate) Resolve event via principal attribute set.
protected Service	resolveServiceFromAuthenticationRequest(org.springframework.webflow.execution.RequestContext context) Resolve service from authentication request service.
protected Service	resolveServiceFromAuthenticationRequest(Service service) Resolve service from authentication request.
org.springframework.webflow.execution.Event	resolveSingle(org.springframework.webflow.execution.RequestContext context) Resolve single event.
protected org.springframework.webflow.execution.Event	validateEventIdForMatchingTransitionInContext(java.lang.String eventId, org.springframework.webflow.execution.RequestContext context, java.util.Map<java.lang.String,java.lang.Object> attributes) Validate event for transition.

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.web.flow.resolver.CasWebflowEventResolver

getName, resolveInternal

Field Detail

eventPublisher

@Autowired
protected org.springframework.context.ApplicationEventPublisher eventPublisher

CAS event publisher.

applicationContext

@Autowired
protected org.springframework.context.ConfigurableApplicationContext applicationContext

The Application context.

authenticationSystemSupport

protected final AuthenticationSystemSupport authenticationSystemSupport

The Authentication system support.

centralAuthenticationService

protected final CentralAuthenticationService centralAuthenticationService

The Central authentication service.

servicesManager

protected final ServicesManager servicesManager

The Services manager.

ticketRegistrySupport

protected final TicketRegistrySupport ticketRegistrySupport

Ticket registry support.

warnCookieGenerator

protected final org.springframework.web.util.CookieGenerator warnCookieGenerator

Warn cookie generator.

authenticationRequestServiceSelectionStrategies

protected final AuthenticationServiceSelectionPlan authenticationRequestServiceSelectionStrategies

Extract the service specially in the event that it's proxied by a callback.

multifactorAuthenticationProviderSelector

protected final MultifactorAuthenticationProviderSelector multifactorAuthenticationProviderSelector

The mfa selector.

Constructor Detail

AbstractCasWebflowEventResolver

public AbstractCasWebflowEventResolver()

Method Detail

newEvent

protected org.springframework.webflow.execution.Event newEvent(java.lang.String id,
                                                               java.lang.Exception error)

New event based on the id, which contains an error attribute referring to the exception occurred.

Parameters:

id - the id

error - the error

Returns:

the event

newEvent

protected org.springframework.webflow.execution.Event newEvent(java.lang.String id)

New event event.

Parameters:

id - the id

Returns:

the event

newEvent

protected org.springframework.webflow.execution.Event newEvent(java.lang.String id,
                                                               org.springframework.webflow.core.collection.AttributeMap attributes)

New event based on the given id.

Parameters:

id - the id

attributes - the attributes

Returns:

the event

getCredentialFromContext

protected Credential getCredentialFromContext(org.springframework.webflow.execution.RequestContext context)

Gets credential from context.

Parameters:

context - the context

Returns:

the credential from context

grantTicketGrantingTicketToAuthenticationResult

protected org.springframework.webflow.execution.Event grantTicketGrantingTicketToAuthenticationResult(org.springframework.webflow.execution.RequestContext context,
                                                                                                      AuthenticationResultBuilder authenticationResultBuilder,
                                                                                                      Service service)

Grant ticket granting ticket.

Parameters:

context - the context

authenticationResultBuilder - the authentication result builder

service - the service

Returns:

the event

getAuthenticationProviderForService

protected java.util.Collection<MultifactorAuthenticationProvider> getAuthenticationProviderForService(RegisteredService service)

Gets authentication provider for service.

Parameters:

service - the service

Returns:

the authentication provider for service

validateEventIdForMatchingTransitionInContext

protected org.springframework.webflow.execution.Event validateEventIdForMatchingTransitionInContext(java.lang.String eventId,
                                                                                                    org.springframework.webflow.execution.RequestContext context,
                                                                                                    java.util.Map<java.lang.String,java.lang.Object> attributes)

Validate event for transition.

Parameters:

eventId - the event id

context - the context

attributes - the attributes

Returns:

the event

buildEventAttributeMap

protected static java.util.Map<java.lang.String,java.lang.Object> buildEventAttributeMap(Principal principal,
                                                                                         RegisteredService service,
                                                                                         MultifactorAuthenticationProvider provider)

Build event attribute map map.

Parameters:

principal - the principal

service - the service

provider - the provider

Returns:

the map

evaluateEventForProviderInContext

protected java.util.Set<org.springframework.webflow.execution.Event> evaluateEventForProviderInContext(Principal principal,
                                                                                                       RegisteredService service,
                                                                                                       org.springframework.webflow.execution.RequestContext context,
                                                                                                       MultifactorAuthenticationProvider provider)

Verify provider for current context and validate event id.

Parameters:

principal - the principal

service - the service

context - the context

provider - the provider

Returns:

the set

resolveEventViaAuthenticationAttribute

protected java.util.Set<org.springframework.webflow.execution.Event> resolveEventViaAuthenticationAttribute(Authentication authentication,
                                                                                                            java.util.Collection<java.lang.String> attributeNames,
                                                                                                            RegisteredService service,
                                                                                                            org.springframework.webflow.execution.RequestContext context,
                                                                                                            java.util.Collection<MultifactorAuthenticationProvider> providers,
                                                                                                            java.util.function.Predicate<java.lang.String> predicate)

Resolve event via authentication attribute set.

Parameters:

authentication - the authentication

attributeNames - the attribute name

service - the service

context - the context

providers - the providers

predicate - the predicate

Returns:

the set of resolved events

resolveEventViaPrincipalAttribute

protected java.util.Set<org.springframework.webflow.execution.Event> resolveEventViaPrincipalAttribute(Principal principal,
                                                                                                       java.util.Collection<java.lang.String> attributeNames,
                                                                                                       RegisteredService service,
                                                                                                       org.springframework.webflow.execution.RequestContext context,
                                                                                                       java.util.Collection<MultifactorAuthenticationProvider> providers,
                                                                                                       java.util.function.Predicate<java.lang.String> predicate)

Resolve event via principal attribute set.

Parameters:

principal - the principal

attributeNames - the attribute name

service - the service

context - the context

providers - the providers

predicate - the predicate

Returns:

the set of resolved events

resolve

public java.util.Set<org.springframework.webflow.execution.Event> resolve(org.springframework.webflow.execution.RequestContext context)

Description copied from interface: CasWebflowEventResolver

Resolve event.

Specified by:

resolve in interface CasWebflowEventResolver

Parameters:

context - the context

Returns:

the event

resolveSingle

public org.springframework.webflow.execution.Event resolveSingle(org.springframework.webflow.execution.RequestContext context)

Description copied from interface: CasWebflowEventResolver

Resolve single event.

Specified by:

resolveSingle in interface CasWebflowEventResolver

Parameters:

context - the context

Returns:

the event

getMultifactorAuthenticationProviderFromApplicationContext

protected java.util.Optional<MultifactorAuthenticationProvider> getMultifactorAuthenticationProviderFromApplicationContext(java.lang.String providerId)

Find the MultifactorAuthenticationProvider in the application contact that matches the specified providerId (e.g. "mfa-duo").

Parameters:

providerId - the provider id

Returns:

the registered service multifactor authentication provider

putResolvedEventsAsAttribute

protected void putResolvedEventsAsAttribute(org.springframework.webflow.execution.RequestContext context,
                                            java.util.Set<org.springframework.webflow.execution.Event> resolvedEvents)

Put resolved events as attribute.

Parameters:

context - the context

resolvedEvents - the resolved events

resolveServiceFromAuthenticationRequest

protected Service resolveServiceFromAuthenticationRequest(Service service)

Resolve service from authentication request.

Parameters:

service - the service

Returns:

the service

resolveServiceFromAuthenticationRequest

protected Service resolveServiceFromAuthenticationRequest(org.springframework.webflow.execution.RequestContext context)

Resolve service from authentication request service.

Parameters:

context - the context

Returns:

the service

getResolvedEventsAsAttribute

protected java.util.Set<org.springframework.webflow.execution.Event> getResolvedEventsAsAttribute(org.springframework.webflow.execution.RequestContext context)

Gets resolved events as attribute.

Parameters:

context - the context

Returns:

the resolved events as attribute

handleAuthenticationTransactionAndGrantTicketGrantingTicket

protected java.util.Set<org.springframework.webflow.execution.Event> handleAuthenticationTransactionAndGrantTicketGrantingTicket(org.springframework.webflow.execution.RequestContext context)

Handle authentication transaction and grant ticket granting ticket.

Parameters:

context - the context

Returns:

the set

getAuthenticationFailureErrorEvent

protected org.springframework.webflow.execution.Event getAuthenticationFailureErrorEvent(org.springframework.webflow.execution.RequestContext context)

Gets authentication failure error event.

Parameters:

context - the context

Returns:

the authentication failure error event

getPrincipalAttributesForMultifactorAuthentication

protected java.util.Map<java.lang.String,java.lang.Object> getPrincipalAttributesForMultifactorAuthentication(Principal principal)

Gets principal attributes for multifactor authentication.

Parameters:

principal - the principal

Returns:

the principal attributes for multifactor authentication