Package org.wildfly.security.http.basic

Class BasicMechanismFactory

java.lang.Object

org.wildfly.security.http.basic.BasicMechanismFactory

All Implemented Interfaces:

HttpServerAuthenticationMechanismFactory

@MetaInfServices(HttpServerAuthenticationMechanismFactory.class)
public class BasicMechanismFactory
extends Object
implements HttpServerAuthenticationMechanismFactory

A HttpServerAuthenticationMechanismFactory implementation for the Basic HTTP authentication mechanism.

Author:

Darran Lofthouse

Constructor Summary

Constructors

Constructor	Description
BasicMechanismFactory()
BasicMechanismFactory(Provider provider)
BasicMechanismFactory(Provider... providers)

Method Summary

Modifier and Type	Method	Description
HttpServerAuthenticationMechanism	createAuthenticationMechanism(String mechanismName, Map<String,?> properties, CallbackHandler callbackHandler)	Obtain an instance of the authentication mechanism requested provided this is allowed by any policy specified within the supplied properties.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.wildfly.security.http.HttpServerAuthenticationMechanismFactory

shutdown

Constructor Detail

BasicMechanismFactory

public BasicMechanismFactory()

BasicMechanismFactory

public BasicMechanismFactory(Provider provider)

BasicMechanismFactory

public BasicMechanismFactory(Provider... providers)

Method Detail

getMechanismNames

public String[] getMechanismNames(Map<String,?> properties)

Description copied from interface: HttpServerAuthenticationMechanismFactory

Get the names of the HTTP authentication mechanisms that can be supplied by this factory filtered by the supplied properties.

Specified by:

getMechanismNames in interface HttpServerAuthenticationMechanismFactory

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.

See Also:

HttpServerAuthenticationMechanismFactory.getMechanismNames(java.util.Map)

createAuthenticationMechanism

public HttpServerAuthenticationMechanism createAuthenticationMechanism(String mechanismName,
                                                                       Map<String,?> properties,
                                                                       CallbackHandler callbackHandler)
                                                                throws HttpAuthenticationException

Description copied from interface: HttpServerAuthenticationMechanismFactory

Obtain an instance of the authentication mechanism requested provided this is allowed by any policy specified within the supplied properties.

Specified by:

createAuthenticationMechanism in interface HttpServerAuthenticationMechanismFactory

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.