Package org.apereo.cas.authentication

Class MultifactorAuthenticationUtils

java.lang.Object
org.apereo.cas.authentication.MultifactorAuthenticationUtils
public final class MultifactorAuthenticationUtils extends Object
This is MultifactorAuthenticationUtils.
Since:
5.2.0

  • Method Summary

    Modifier and Type
    Method
    Description
    static Map<String,Object>
    buildEventAttributeMap(org.apereo.cas.authentication.principal.Principal principal, Optional<org.apereo.cas.authentication.principal.Service> service, Optional<org.apereo.cas.services.RegisteredService> registeredService, org.apereo.cas.authentication.MultifactorAuthenticationProvider provider)
    Build event attribute map.
    static Set<org.springframework.webflow.execution.Event>
    evaluateEventForProviderInContext(org.apereo.cas.authentication.principal.Principal principal, org.apereo.cas.services.RegisteredService registeredService, org.apereo.cas.authentication.principal.Service service, Optional<org.springframework.webflow.execution.RequestContext> context, org.apereo.cas.authentication.MultifactorAuthenticationProvider provider)
    Evaluate event for provider in context set.
    static Map<String,org.apereo.cas.authentication.MultifactorAuthenticationProvider>
    getAvailableMultifactorAuthenticationProviders(org.springframework.context.ApplicationContext applicationContext)
    Gets all multifactor authentication providers from application context.
    static Optional<org.apereo.cas.authentication.MultifactorAuthenticationProvider>
    getMultifactorAuthenticationProviderById(String providerId, org.springframework.context.ApplicationContext context)
    Method returns an Optional that will contain a MultifactorAuthenticationProvider that has the same id as the passed providerId parameter.
    static Collection<org.apereo.cas.authentication.MultifactorAuthenticationProvider>
    getMultifactorAuthenticationProviderForService(org.apereo.cas.services.RegisteredService service, org.springframework.context.ApplicationContext applicationContext)
    Gets authentication provider for service.
    static Optional<org.apereo.cas.authentication.MultifactorAuthenticationProvider>
    getMultifactorAuthenticationProviderFromApplicationContext(String providerId, org.springframework.context.ApplicationContext applicationContext)
    Gets multifactor authentication provider from application context.
    static Set<org.springframework.webflow.execution.Event>
    resolveEventViaMultivaluedAttribute(org.apereo.cas.authentication.principal.Principal principal, Object attributeValue, org.apereo.cas.services.RegisteredService registeredService, org.apereo.cas.authentication.principal.Service service, Optional<org.springframework.webflow.execution.RequestContext> context, org.apereo.cas.authentication.MultifactorAuthenticationProvider provider, BiPredicate<String,org.apereo.cas.authentication.MultifactorAuthenticationProvider> predicate)
    Resolve event via multivalued attribute set.
    static Set<org.springframework.webflow.execution.Event>
    resolveEventViaSingleAttribute(org.apereo.cas.authentication.principal.Principal principal, Object providedAttributeValue, org.apereo.cas.services.RegisteredService registeredService, org.apereo.cas.authentication.principal.Service service, Optional<org.springframework.webflow.execution.RequestContext> context, org.apereo.cas.authentication.MultifactorAuthenticationProvider provider, BiPredicate<String,org.apereo.cas.authentication.MultifactorAuthenticationProvider> predicate)
    Resolve event via single attribute set.
    static Optional<org.apereo.cas.authentication.MultifactorAuthenticationProvider>
    resolveProvider(Map<String,org.apereo.cas.authentication.MultifactorAuthenticationProvider> providers, String requestMfaMethod)
    Resolve provider optional.
    static Optional<org.apereo.cas.authentication.MultifactorAuthenticationProvider>
    resolveProvider(Map<String,org.apereo.cas.authentication.MultifactorAuthenticationProvider> providers, Collection<String> requestMfaMethod)
    Resolve provider optional.
    static org.springframework.webflow.execution.Event
    validateEventIdForMatchingTransitionInContext(String eventId, Optional<org.springframework.webflow.execution.RequestContext> context, Map<String,Object> attributes)
    Validate event id for matching transition in context event.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • buildEventAttributeMap

      public static Map<String,Object> buildEventAttributeMap(org.apereo.cas.authentication.principal.Principal principal, Optional<org.apereo.cas.authentication.principal.Service> service, Optional<org.apereo.cas.services.RegisteredService> registeredService, org.apereo.cas.authentication.MultifactorAuthenticationProvider provider)
      Build event attribute map.
      Parameters:
      principal - the principal
      service - the service
      registeredService - the service
      provider - the provider
      Returns:
      the map

    • validateEventIdForMatchingTransitionInContext

      public static org.springframework.webflow.execution.Event validateEventIdForMatchingTransitionInContext(String eventId, Optional<org.springframework.webflow.execution.RequestContext> context, Map<String,Object> attributes)
      Validate event id for matching transition in context event.
      Parameters:
      eventId - the event id
      context - the context
      attributes - the attributes
      Returns:
      the event

    • resolveEventViaMultivaluedAttribute

      public static Set<org.springframework.webflow.execution.Event> resolveEventViaMultivaluedAttribute(org.apereo.cas.authentication.principal.Principal principal, Object attributeValue, org.apereo.cas.services.RegisteredService registeredService, org.apereo.cas.authentication.principal.Service service, Optional<org.springframework.webflow.execution.RequestContext> context, org.apereo.cas.authentication.MultifactorAuthenticationProvider provider, BiPredicate<String,org.apereo.cas.authentication.MultifactorAuthenticationProvider> predicate)
      Resolve event via multivalued attribute set.
      Parameters:
      principal - the principal
      attributeValue - the attribute value
      registeredService - the service
      service - the service
      context - the context
      provider - the provider
      predicate - the predicate
      Returns:
      the set

    • resolveProvider

      public static Optional<org.apereo.cas.authentication.MultifactorAuthenticationProvider> resolveProvider(Map<String,org.apereo.cas.authentication.MultifactorAuthenticationProvider> providers, Collection<String> requestMfaMethod)
      Resolve provider optional.
      Parameters:
      providers - the providers
      requestMfaMethod - the request mfa method
      Returns:
      the optional

    • resolveProvider

      public static Optional<org.apereo.cas.authentication.MultifactorAuthenticationProvider> resolveProvider(Map<String,org.apereo.cas.authentication.MultifactorAuthenticationProvider> providers, String requestMfaMethod)
      Resolve provider optional.
      Parameters:
      providers - the providers
      requestMfaMethod - the request mfa method
      Returns:
      the optional

    • resolveEventViaSingleAttribute

      public static Set<org.springframework.webflow.execution.Event> resolveEventViaSingleAttribute(org.apereo.cas.authentication.principal.Principal principal, Object providedAttributeValue, org.apereo.cas.services.RegisteredService registeredService, org.apereo.cas.authentication.principal.Service service, Optional<org.springframework.webflow.execution.RequestContext> context, org.apereo.cas.authentication.MultifactorAuthenticationProvider provider, BiPredicate<String,org.apereo.cas.authentication.MultifactorAuthenticationProvider> predicate)
      Resolve event via single attribute set.
      Parameters:
      principal - the principal
      providedAttributeValue - the attribute value
      registeredService - the service
      service - the service
      context - the context
      provider - the provider
      predicate - the predicate
      Returns:
      the set

    • getMultifactorAuthenticationProviderForService

      public static Collection<org.apereo.cas.authentication.MultifactorAuthenticationProvider> getMultifactorAuthenticationProviderForService(org.apereo.cas.services.RegisteredService service, org.springframework.context.ApplicationContext applicationContext)
      Gets authentication provider for service.
      Parameters:
      service - the service
      applicationContext - the application context
      Returns:
      the authentication provider for service

    • getMultifactorAuthenticationProviderFromApplicationContext

      public static Optional<org.apereo.cas.authentication.MultifactorAuthenticationProvider> getMultifactorAuthenticationProviderFromApplicationContext(String providerId, org.springframework.context.ApplicationContext applicationContext)
      Gets multifactor authentication provider from application context.
      Parameters:
      providerId - the provider id
      applicationContext - the application context
      Returns:
      the multifactor authentication provider from application context

    • evaluateEventForProviderInContext

      public static Set<org.springframework.webflow.execution.Event> evaluateEventForProviderInContext(org.apereo.cas.authentication.principal.Principal principal, org.apereo.cas.services.RegisteredService registeredService, org.apereo.cas.authentication.principal.Service service, Optional<org.springframework.webflow.execution.RequestContext> context, org.apereo.cas.authentication.MultifactorAuthenticationProvider provider)
      Evaluate event for provider in context set.
      Parameters:
      principal - the principal
      registeredService - the service
      service - the service
      context - the context
      provider - the provider
      Returns:
      the set

    • getAvailableMultifactorAuthenticationProviders

      public static Map<String,org.apereo.cas.authentication.MultifactorAuthenticationProvider> getAvailableMultifactorAuthenticationProviders(org.springframework.context.ApplicationContext applicationContext)
      Gets all multifactor authentication providers from application context.
      Parameters:
      applicationContext - the application context
      Returns:
      the all multifactor authentication providers from application context

    • getMultifactorAuthenticationProviderById

      public static Optional<org.apereo.cas.authentication.MultifactorAuthenticationProvider> getMultifactorAuthenticationProviderById(String providerId, org.springframework.context.ApplicationContext context)
      Method returns an Optional that will contain a MultifactorAuthenticationProvider that has the same id as the passed providerId parameter.
      Parameters:
      providerId - - the id to match
      context - - ApplicationContext
      Returns:
      - Optional