Module org.mule.runtime.extensions.api
Package org.mule.runtime.extension.api.security

Interface AuthenticationHandler

@MinMuleVersion("4.1") @NoImplement public interface AuthenticationHandler
This handler allows to configure the current context's authentication, used for encryption and inbound authentication, based on a given Authentication request.
Since:
1.0

  • Method Summary

    Modifier and Type
    Method
    Description
    org.mule.runtime.api.security.Authentication
    createAuthentication(org.mule.runtime.api.security.Credentials credentials)
     
    org.mule.runtime.api.security.CredentialsBuilder
    createCredentialsBuilder()
     
    Optional<org.mule.runtime.api.security.Authentication>
    getAuthentication()
     
    void
    setAuthentication(List<String> securityProviders, org.mule.runtime.api.security.Authentication authentication)
    Updates the current context with the given Authentication information.
    void
    setAuthentication(org.mule.runtime.api.security.Authentication authentication)
    Updates the current context with the given Authentication information.

  • Method Details

    • setAuthentication

      void setAuthentication(org.mule.runtime.api.security.Authentication authentication) throws org.mule.runtime.api.security.SecurityProviderNotFoundException, org.mule.runtime.api.security.SecurityException, org.mule.runtime.api.security.UnknownAuthenticationTypeException
      Updates the current context with the given Authentication information.
      Parameters:
      authentication - the Authentication used for setting up the new security context
      Throws:
      org.mule.runtime.api.security.SecurityProviderNotFoundException - if no security provider able to authenticate the given authentication is found
      org.mule.runtime.api.security.SecurityException - if an error occurs during the update of the security context
      org.mule.runtime.api.security.UnknownAuthenticationTypeException - if no security provider able to handle the given authentication is found

    • setAuthentication

      void setAuthentication(List<String> securityProviders, org.mule.runtime.api.security.Authentication authentication) throws org.mule.runtime.api.security.SecurityProviderNotFoundException, org.mule.runtime.api.security.SecurityException, org.mule.runtime.api.security.UnknownAuthenticationTypeException
      Updates the current context with the given Authentication information.
      Parameters:
      securityProviders - the List of security providers that will be added to the SecurityManager
      authentication - the Authentication used for setting up the new security context
      Throws:
      org.mule.runtime.api.security.SecurityProviderNotFoundException - if no security provider able to authenticate the given authentication is found
      org.mule.runtime.api.security.SecurityException - if an error occurs during the update of the security context
      org.mule.runtime.api.security.UnknownAuthenticationTypeException - if no security provider able to handle the given authentication is found

    • getAuthentication

      Optional<org.mule.runtime.api.security.Authentication> getAuthentication()
      Returns:
      the Authentication in the current context

    • createAuthentication

      org.mule.runtime.api.security.Authentication createAuthentication(org.mule.runtime.api.security.Credentials credentials)
      Parameters:
      credentials - the Credentials to be used for this Authentication
      Returns:
      a new instance of a default implementation of Authentication

    • createCredentialsBuilder

      org.mule.runtime.api.security.CredentialsBuilder createCredentialsBuilder()
      Returns:
      a new CredentialsBuilder