Package io.helidon.security.provider.header

Class HeaderAtnProvider.Builder

java.lang.Object

io.helidon.security.provider.header.HeaderAtnProvider.Builder

All Implemented Interfaces:

io.helidon.common.Builder<HeaderAtnProvider>

Enclosing class:

HeaderAtnProvider

public static class HeaderAtnProvider.Builder
extends java.lang.Object
implements io.helidon.common.Builder<HeaderAtnProvider>

A fluent api Builder for HeaderAtnProvider.

Method Summary

Modifier and Type	Method	Description
HeaderAtnProvider.Builder	atnTokenHandler(io.helidon.security.util.TokenHandler tokenHandler)	Token handler to extract username from request.
HeaderAtnProvider.Builder	authenticate(boolean authenticate)	Whether to authenticate requests.
HeaderAtnProvider	build()
HeaderAtnProvider.Builder	fromConfig(io.helidon.config.Config config)	Load this builder from a configuration.
HeaderAtnProvider.Builder	optional(boolean optional)	Whether authentication is required.
HeaderAtnProvider.Builder	outboundTokenHandler(io.helidon.security.util.TokenHandler tokenHandler)	Token handler to create outbound headers to propagate identity.
HeaderAtnProvider.Builder	propagate(boolean propagate)	Whether to propagate identity.
HeaderAtnProvider.Builder	subjectType(io.helidon.security.SubjectType subjectType)	Principal type this provider extracts (and also propagates).

Methods inherited from class java.lang.Object

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

Method Detail

build

public HeaderAtnProvider build()

Specified by:

build in interface io.helidon.common.Builder<HeaderAtnProvider>

fromConfig

public HeaderAtnProvider.Builder fromConfig(io.helidon.config.Config config)

Load this builder from a configuration.

Parameters:

config - configuration to load from

Returns:

updated builder instance

subjectType

public HeaderAtnProvider.Builder subjectType(io.helidon.security.SubjectType subjectType)

Principal type this provider extracts (and also propagates).

Parameters:

subjectType - type of principal

Returns:

updated builder instance

propagate

public HeaderAtnProvider.Builder propagate(boolean propagate)

Whether to propagate identity.

Parameters:

propagate - whether to propagate identity (true) or not (false)

Returns:

updated builder instance

authenticate

public HeaderAtnProvider.Builder authenticate(boolean authenticate)

Whether to authenticate requests.

Parameters:

authenticate - whether to authenticate (true) or not (false)

Returns:

updated builder instance

atnTokenHandler

public HeaderAtnProvider.Builder atnTokenHandler(io.helidon.security.util.TokenHandler tokenHandler)

Token handler to extract username from request.

Parameters:

tokenHandler - token handler instance

Returns:

updated builder instance

outboundTokenHandler

public HeaderAtnProvider.Builder outboundTokenHandler(io.helidon.security.util.TokenHandler tokenHandler)

Token handler to create outbound headers to propagate identity. If not defined, atnTokenHandler will be used.

Parameters:

tokenHandler - token handler instance

Returns:

updated builder instance

optional

public HeaderAtnProvider.Builder optional(boolean optional)

Whether authentication is required. By default, request will fail if the username cannot be extracted. 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