Package org.wildfly.security.http

Class HttpAuthenticator.Builder

java.lang.Object

org.wildfly.security.http.HttpAuthenticator.Builder

Enclosing class:

HttpAuthenticator

public static class HttpAuthenticator.Builder
extends Object

A Builder to configure and create an instance of HttpAuthenticator.

Method Summary

Modifier and Type	Method	Description
HttpAuthenticator	build()	Build the new HttpAuthenticator instance.
HttpAuthenticator.Builder	registerLogoutHandler(Consumer<Runnable> logoutHandlerConsumer)	A Consumer responsible for registering a Runnable emitted by one of the mechanisms during the evaluation of a request and representing some action to be taken during logout.
HttpAuthenticator.Builder	setHttpExchangeSpi(HttpExchangeSpi httpExchangeSpi)	Set the HttpExchangeSpi instance for the current request to allow integration with the Elytron APIs.
HttpAuthenticator.Builder	setIdentityCacheSupplier(Supplier<org.wildfly.security.cache.IdentityCache> identityCacheSupplier)	Set a Supplier which acts as a factory to return a new IdentityCache instance for the current request, this allows alternative caching strategies to be provided.
HttpAuthenticator.Builder	setIgnoreOptionalFailures(boolean ignoreOptionalFailures)	Where authentication is not required but is still attempted a failure of an authentication mechanism will cause the challenges to be sent and the current request returned to the client, setting this value to true will allow the failure to be ignored.
HttpAuthenticator.Builder	setMechanismSupplier(Supplier<List<HttpServerAuthenticationMechanism>> mechanismSupplier)	Set the supplier to use to obtain list of HttpServerAuthenticationMechanism implementations instances to use, based on the configured policy.
HttpAuthenticator.Builder	setProgrammaticMechanismName(String programmaticMechanismName)	Set the mechanism name that should be used for programmatic authentication if one is not provided at the time of the call.
HttpAuthenticator.Builder	setRequired(boolean required)	Sets if authentication is required for the current request, if not required mechanisms will be called to be given the opportunity to authenticate
HttpAuthenticator.Builder	setSecurityDomain(SecurityDomain securityDomain)	Set the SecurityDomain to use for programmatic authentication.

Methods inherited from class java.lang.Object

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

Method Detail

setMechanismSupplier

public HttpAuthenticator.Builder setMechanismSupplier(Supplier<List<HttpServerAuthenticationMechanism>> mechanismSupplier)

Set the supplier to use to obtain list of HttpServerAuthenticationMechanism implementations instances to use, based on the configured policy.

Parameters:

mechanismSupplier - the Supplier with the configured authentication policy

Returns:

the HttpAuthenticator.Builder to allow method call chaining.

setSecurityDomain

public HttpAuthenticator.Builder setSecurityDomain(SecurityDomain securityDomain)

Set the SecurityDomain to use for programmatic authentication.

Parameters:

securityDomain - the SecurityDomain to use for programmatic authentication.

Returns:

the HttpAuthenticator.Builder to allow method call chaining.

setHttpExchangeSpi

public HttpAuthenticator.Builder setHttpExchangeSpi(HttpExchangeSpi httpExchangeSpi)

Set the HttpExchangeSpi instance for the current request to allow integration with the Elytron APIs.

Parameters:

httpExchangeSpi - the HttpExchangeSpi instance for the current request

Returns:

the HttpAuthenticator.Builder to allow method call chaining.

setRequired

public HttpAuthenticator.Builder setRequired(boolean required)

Sets if authentication is required for the current request, if not required mechanisms will be called to be given the opportunity to authenticate

Parameters:

required - is authentication required for the current request?

Returns:

the HttpAuthenticator.Builder to allow method call chaining.

setIgnoreOptionalFailures

public HttpAuthenticator.Builder setIgnoreOptionalFailures(boolean ignoreOptionalFailures)

Where authentication is not required but is still attempted a failure of an authentication mechanism will cause the challenges to be sent and the current request returned to the client, setting this value to true will allow the failure to be ignored. This setting has no effect when required is set to true, in that case all failures will result in a client

Parameters:

ignoreOptionalFailures - should mechanism failures be ignored if authentication is optional.

Returns:

the HttpAuthenticator.Builder to allow method call chaining.

registerLogoutHandler

public HttpAuthenticator.Builder registerLogoutHandler(Consumer<Runnable> logoutHandlerConsumer)

A Consumer responsible for registering a Runnable emitted by one of the mechanisms during the evaluation of a request and representing some action to be taken during logout.

This method is mainly targeted for programmatic logout where logout requests are send by the application after the authentication. Although, integration code is free to register the logout handler whatever they want in order to support different logout scenarios.

Parameters:

logoutHandlerConsumer - the consumer responsible for registering the logout handler (not null)

Returns:

the HttpAuthenticator.Builder to allow method call chaining.

setProgrammaticMechanismName

public HttpAuthenticator.Builder setProgrammaticMechanismName(String programmaticMechanismName)

Set the mechanism name that should be used for programmatic authentication if one is not provided at the time of the call.

Parameters:

programmaticMechanismName - the name of the mechanism to use for programmatic authentication.

Returns:

the HttpAuthenticator.Builder to allow method call chaining.

setIdentityCacheSupplier

public HttpAuthenticator.Builder setIdentityCacheSupplier(Supplier<org.wildfly.security.cache.IdentityCache> identityCacheSupplier)

Set a Supplier which acts as a factory to return a new IdentityCache instance for the current request, this allows alternative caching strategies to be provided.

Parameters:

identityCacheSupplier - - a factory which returns new IdentityCache instances for the current request.

Returns:

the HttpAuthenticator.Builder to allow method call chaining.

build

public HttpAuthenticator build()

Build the new HttpAuthenticator instance.

Returns:

the new HttpAuthenticator instance.