Module io.helidon.security.providers.httpsign

Package io.helidon.security.providers.httpsign

Class SignedHeadersConfig.HeadersConfig

java.lang.Object

io.helidon.security.providers.httpsign.SignedHeadersConfig.HeadersConfig

Enclosing class:

SignedHeadersConfig

public static final class SignedHeadersConfig.HeadersConfig
extends Object

Configuration of headers to be signed.

Method Summary

Modifier and Type	Method	Description
static SignedHeadersConfig.HeadersConfig	create()	Create a config with no signed headers (e.g.
static SignedHeadersConfig.HeadersConfig	create(Config config)	Create a new instance from configuration.
static SignedHeadersConfig.HeadersConfig	create(List<String> requiredHeaders)	Create a config with required headers only (e.g.
static SignedHeadersConfig.HeadersConfig	create(List<String> requiredHeaders, List<String> ifPresentHeaders)	Create a new instance with both required headers and headers that are signed only if present in request.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static SignedHeadersConfig.HeadersConfig create()

Create a config with no signed headers (e.g. signatures disabled)

Returns:

instance with no required headers

create

public static SignedHeadersConfig.HeadersConfig create(List<String> requiredHeaders)

Create a config with required headers only (e.g. no "if-present" headers).

Parameters:

requiredHeaders - headers that must be signed

Returns:

instance with required headers

create

public static SignedHeadersConfig.HeadersConfig create(List<String> requiredHeaders,
                                                       List<String> ifPresentHeaders)

Create a new instance with both required headers and headers that are signed only if present in request.

Parameters:

requiredHeaders - headers that must be signed (and signature validation or creation should fail if not signed or present)

ifPresentHeaders - headers that must be signed if present in request

Returns:

instance with required and "if-present" headers

create

public static SignedHeadersConfig.HeadersConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - configuration located at header config

Returns:

instance configured from config