Class SignedHeadersConfig.Builder

java.lang.Object

io.helidon.security.providers.httpsign.SignedHeadersConfig.Builder

All Implemented Interfaces:

Builder<SignedHeadersConfig.Builder, SignedHeadersConfig>, Supplier<SignedHeadersConfig>

Enclosing class:

SignedHeadersConfig

public static final class SignedHeadersConfig.Builder
extends Object
implements Builder<SignedHeadersConfig.Builder, SignedHeadersConfig>

Fluent API builder to create SignedHeadersConfig instances. Call build() to create a new instance.

Method Summary

Modifier and Type	Method	Description
SignedHeadersConfig	build()	Build the instance from this builder.
SignedHeadersConfig.Builder	config(String method, SignedHeadersConfig.HeadersConfig config)	Configuration of a single method (see SecurityEnvironment.method() to set required and "if-present" headers to be signed (or to be expected in inbound signature).
SignedHeadersConfig.Builder	defaultConfig(SignedHeadersConfig.HeadersConfig config)	Default configuration is used by methods that do not have an explicit configuration.

Methods inherited from class Object

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

Methods inherited from interface Builder

get, identity, update

Modifier and Type	Method	Description
default SignedHeadersConfig	get()
default SignedHeadersConfig.Builder	identity()	Instance of this builder as the correct type.
default SignedHeadersConfig.Builder	update(Consumer<SignedHeadersConfig.Builder> consumer)	Update the builder in a fluent API way.

Method Details

build

public SignedHeadersConfig build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<SignedHeadersConfig.Builder, SignedHeadersConfig>

Returns:

instance of the built type

defaultConfig

public SignedHeadersConfig.Builder defaultConfig(SignedHeadersConfig.HeadersConfig config)

Default configuration is used by methods that do not have an explicit configuration.

Configuration is not cumulative - e.g. if you configure default to require "date" and "host" headers and method "GET" to require "(request-target)", GET will NOT require "date" and "host"

Parameters:

config - configuration of method (e.g. headers that must always be signed and headers to be signed when available in request)

Returns:

updated builder instance

config

public SignedHeadersConfig.Builder config(String method,
 SignedHeadersConfig.HeadersConfig config)

Configuration of a single method (see SecurityEnvironment.method() to set required and "if-present" headers to be signed (or to be expected in inbound signature).

Parameters:

method - exact method name

config - configuration of method

Returns:

updated builder instance