Module io.helidon.security.providers.httpauth

Package io.helidon.security.providers.httpauth

Class HttpBasicAuthProvider.Builder

java.lang.Object

io.helidon.security.providers.httpauth.HttpBasicAuthProvider.Builder

All Implemented Interfaces:

Builder<HttpBasicAuthProvider>, Supplier<HttpBasicAuthProvider>

Enclosing class:

HttpBasicAuthProvider

public static final class HttpBasicAuthProvider.Builder
extends Object
implements Builder<HttpBasicAuthProvider>

HttpBasicAuthProvider fluent API builder.

Method Summary

Modifier and Type	Method	Description
HttpBasicAuthProvider.Builder	addOutboundTarget(OutboundTarget target)	Add a new outbound target to configure identity propagation or explicit username/password.
HttpBasicAuthProvider.Builder	addUserStore(SecureUserStore store)	Add a user store to the list of stores used by this provider.
HttpBasicAuthProvider	build()	Build the instance from this builder.
HttpBasicAuthProvider.Builder	config(Config config)	Update this builder from configuration.
HttpBasicAuthProvider.Builder	optional(boolean optional)	Whether authentication is required.
HttpBasicAuthProvider.Builder	realm(String realm)	Set the realm to use when challenging users.
HttpBasicAuthProvider.Builder	subjectType(SubjectType subjectType)	Principal type this provider extracts (and also propagates).
HttpBasicAuthProvider.Builder	userStore(SecureUserStore store)	Set user store to validate users.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.common.Builder

get

Method Detail

config

public HttpBasicAuthProvider.Builder config(Config config)

Update this builder from configuration.

Parameters:

config - configuration to read, located on the node of the http basic authentication provider

Returns:

updated builder instance

build

public HttpBasicAuthProvider build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<HttpBasicAuthProvider>

Returns:

instance of the built type

subjectType

public HttpBasicAuthProvider.Builder subjectType(SubjectType subjectType)

Principal type this provider extracts (and also propagates).

Parameters:

subjectType - type of principal

Returns:

updated builder instance

addUserStore

public HttpBasicAuthProvider.Builder addUserStore(SecureUserStore store)

Add a user store to the list of stores used by this provider.

Parameters:

store - user store to add

Returns:

updated builder instance

userStore

public HttpBasicAuthProvider.Builder userStore(SecureUserStore store)

Set user store to validate users. Removes any other stores added through addUserStore(SecureUserStore).

Parameters:

store - User store to use

Returns:

updated builder instance

realm

public HttpBasicAuthProvider.Builder realm(String realm)

Set the realm to use when challenging users.

Parameters:

realm - security realm name to send to browser (or any other client) when unauthenticated

Returns:

updated builder instance

optional

public HttpBasicAuthProvider.Builder optional(boolean optional)

Whether authentication is required. By default, request will fail if the authentication cannot be verified. If set to false, request will process and this provider will abstain.

Parameters:

optional - whether authentication is optional (true) or required (false)

Returns:

updated builder instance

addOutboundTarget

public HttpBasicAuthProvider.Builder addOutboundTarget(OutboundTarget target)

Add a new outbound target to configure identity propagation or explicit username/password.

Parameters:

target - outbound target

Returns:

updated builder instance