org.wildfly.security.auth.server

Class HttpAuthenticationFactory

java.lang.Object

org.wildfly.security.auth.server.HttpAuthenticationFactory

All Implemented Interfaces:

MechanismAuthenticationFactory<HttpServerAuthenticationMechanism,HttpServerAuthenticationMechanismFactory,HttpAuthenticationException>

public final class HttpAuthenticationFactory
extends Object

A HTTP authentication mechanism configuration, the configuration is associated with the SecurityDomain and HttpServerAuthenticationMechanismFactory for obtaining configured mechanisms.

Author:

Darran Lofthouse

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpAuthenticationFactory.Builder A builder for SASL server factory configurations.

Method Summary

Modifier and Type	Method and Description
static HttpAuthenticationFactory.Builder	builder() Obtain a new HttpAuthenticationFactory.Builder capable of building a HttpAuthenticationFactory.
M	createMechanism(String name, UnaryOperator<F> factoryTransformation) Create the mechanism instance.
F	getFactory() Get the actual factory used for instantiation.
Collection<String>	getMechanismNames() Get the collection of mechanism names may be supported by this factory.
SecurityDomain	getSecurityDomain() Get the underlying SecurityDomain that mechanisms created by this factory will be using for authentication.

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.auth.server.MechanismAuthenticationFactory

createMechanism

Method Detail

builder

public static HttpAuthenticationFactory.Builder builder()

Obtain a new HttpAuthenticationFactory.Builder capable of building a HttpAuthenticationFactory.

Returns:

a new HttpAuthenticationFactory.Builder capable of building a HttpAuthenticationFactory.

getSecurityDomain

public SecurityDomain getSecurityDomain()

Description copied from interface: MechanismAuthenticationFactory

Get the underlying SecurityDomain that mechanisms created by this factory will be using for authentication.

Specified by:

getSecurityDomain in interface MechanismAuthenticationFactory<M,F,E extends Exception>

Returns:

the underlying SecurityDomain that mechanisms created by this factory will be using for authentication.

getFactory

public F getFactory()

Description copied from interface: MechanismAuthenticationFactory

Get the actual factory used for instantiation.

Specified by:

getFactory in interface MechanismAuthenticationFactory<M,F,E extends Exception>

Returns:

the actual factory (not null)

createMechanism

public M createMechanism(String name,
                         UnaryOperator<F> factoryTransformation)
                  throws E extends Exception

Description copied from interface: MechanismAuthenticationFactory

Create the mechanism instance.

Specified by:

createMechanism in interface MechanismAuthenticationFactory<M,F,E extends Exception>

Parameters:

name - the mechanism name (must not be null)

factoryTransformation - the transformation to apply to the factory (must not be null)

Returns:

the mechanism, or null if the mechanism with the given name is not supported

Throws:

E - if the mechanism instantiation failed

E extends Exception

getMechanismNames

public Collection<String> getMechanismNames()

Description copied from interface: MechanismAuthenticationFactory

Get the collection of mechanism names may be supported by this factory. The actual set of available mechanisms depends on run-time factors but will generally not be greater than this collection.

Specified by:

getMechanismNames in interface MechanismAuthenticationFactory<M,F,E extends Exception>

Returns:

the mechanism names (not null)