Package org.wildfly.security.http

Interface HttpServerAuthenticationMechanismFactory

All Known Implementing Classes:
AggregateServerMechanismFactory, BasicMechanismFactory, BearerMechanismFactory, ClientCertMechanismFactory, DigestMechanismFactory, ExternalMechanismFactory, FilterServerMechanismFactory, FormMechanismFactory, PrivilegedServerMechanismFactory, PropertiesServerMechanismFactory, SecurityProviderServerMechanismFactory, ServiceLoaderServerMechanismFactory, SetMechanismInformationMechanismFactory, SetRequestInformationCallbackMechanismFactory, SingleSignOnServerMechanismFactory, SocketAddressCallbackServerMechanismFactory, SortedServerMechanismFactory, SpnegoMechanismFactory
public interface HttpServerAuthenticationMechanismFactory
Factory to create authentication mechanisms.
Author:
Darran Lofthouse

  • Method Details

    • getMechanismNames

      String[] getMechanismNames(Map<String,?> properties)
      Get the names of the HTTP authentication mechanisms that can be supplied by this factory filtered by the supplied properties.
      Parameters:
      properties - the non-null set of properties to pass configuration to the mechanisms that may be evaluated for mechanism availability.
      Returns:
      A non-null array of the names of the supported HTTP authentication mechanisms.

    • createAuthenticationMechanism

      HttpServerAuthenticationMechanism createAuthenticationMechanism(String mechanismName, Map<String,?> properties, CallbackHandler callbackHandler) throws HttpAuthenticationException
      Obtain an instance of the authentication mechanism requested provided this is allowed by any policy specified within the supplied properties.
      Parameters:
      mechanismName - The non-null name of the mechanism to create.
      properties - The non-null set of properties to select and configure the mechanism that may be evaluated for mechanism availability.
      callbackHandler - The non-null CallbackHandler for use by the mechanism during authentication.
      Returns:
      the configured HttpServerAuthenticationMechanism or null if no mechanism could be resolved for the given mechanism name.
      Throws:
      HttpAuthenticationException - if there is an error creating the mechanism.

    • shutdown

      default void shutdown()
      Can be used for clean up