Package io.helidon.security.provider.httpsign

Class SignedHeadersConfig.HeadersConfig

java.lang.Object

io.helidon.security.provider.httpsign.SignedHeadersConfig.HeadersConfig

Enclosing class:

SignedHeadersConfig

public static class SignedHeadersConfig.HeadersConfig
extends java.lang.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(java.util.List<java.lang.String> requiredHeaders)	Create a config with required headers only (e.g.
static SignedHeadersConfig.HeadersConfig	create(java.util.List<java.lang.String> requiredHeaders, java.util.List<java.lang.String> ifPresentHeaders)	Create a new instance with both required headers and headers that are signed only if present in request.
static SignedHeadersConfig.HeadersConfig	fromConfig(io.helidon.config.Config config)	Create a new instance from configuration.

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(java.util.List<java.lang.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(java.util.List<java.lang.String> requiredHeaders,
                                                       java.util.List<java.lang.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

fromConfig

public static SignedHeadersConfig.HeadersConfig fromConfig(io.helidon.config.Config config)

Create a new instance from configuration.

Parameters:

config - configuration located at header config

Returns:

instance configured from config