Package io.helidon.microprofile.jwt.auth

Class JwtAuthProvider.Builder

java.lang.Object

io.helidon.microprofile.jwt.auth.JwtAuthProvider.Builder

All Implemented Interfaces:

Builder<JwtAuthProvider>, Supplier<JwtAuthProvider>

Enclosing class:

JwtAuthProvider

public static class JwtAuthProvider.Builder
extends Object
implements Builder<JwtAuthProvider>

Fluent API builder for JwtAuthProvider.

Method Summary

Modifier and Type	Method	Description
JwtAuthProvider.Builder	allowImpersonation(boolean allowImpersonation)	Whether to allow impersonation by explicitly overriding username from outbound requests using JwtAuthProvider.EP_PROPERTY_OUTBOUND_USER property.
JwtAuthProvider.Builder	atnTokenHandler(TokenHandler tokenHandler)	Token handler to extract username from request.
JwtAuthProvider.Builder	authenticate(boolean authenticate)	Whether to authenticate requests.
JwtAuthProvider	build()	Build the instance from this builder.
JwtAuthProvider.Builder	config(Config config)	Load this builder from a configuration.
JwtAuthProvider.Builder	defaultJwk(Jwk defaultJwk)	Default JWK which should be used.
JwtAuthProvider.Builder	defaultKeyId(String defaultKeyId)	Default JWT key ID which should be used.
JwtAuthProvider.Builder	expectedAudience(String audience)	Audience expected in inbound JWTs.
JwtAuthProvider.Builder	expectedIssuer(String issuer)	Expected issuer in incoming requests.
JwtAuthProvider.Builder	issuer(String issuer)	Issuer used to create new JWTs.
JwtAuthProvider.Builder	optional(boolean optional)	Whether authentication is required.
JwtAuthProvider.Builder	outboundConfig(OutboundConfig config)	Configuration of outbound rules.
JwtAuthProvider.Builder	propagate(boolean propagate)	Whether to propagate identity.
JwtAuthProvider.Builder	publicKey(String publicKey)	String representation of the public key.
JwtAuthProvider.Builder	publicKeyPath(String publicKeyPath)	Path to public key.
JwtAuthProvider.Builder	signJwk(Resource signJwkResource)	JWK resource used to sign JWTs created by us.
JwtAuthProvider.Builder	subjectType(SubjectType subjectType)	Principal type this provider extracts (and also propagates).
JwtAuthProvider.Builder	verifyJwk(Resource verifyJwkResource)	JWK resource used to verify JWTs created by other parties.

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

build

public JwtAuthProvider build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<JwtAuthProvider>

Returns:

instance of the built type

propagate

public JwtAuthProvider.Builder propagate(boolean propagate)

Whether to propagate identity.

Parameters:

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

Returns:

updated builder instance

authenticate

public JwtAuthProvider.Builder authenticate(boolean authenticate)

Whether to authenticate requests.

Parameters:

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

Returns:

updated builder instance

allowImpersonation

public JwtAuthProvider.Builder allowImpersonation(boolean allowImpersonation)

Whether to allow impersonation by explicitly overriding username from outbound requests using JwtAuthProvider.EP_PROPERTY_OUTBOUND_USER property. By default this is not allowed and identity can only be propagated.

Parameters:

allowImpersonation - set to true to allow impersonation

Returns:

updated builder instance

subjectType

public JwtAuthProvider.Builder subjectType(SubjectType subjectType)

Principal type this provider extracts (and also propagates).

Parameters:

subjectType - type of principal

Returns:

updated builder instance

atnTokenHandler

public JwtAuthProvider.Builder atnTokenHandler(TokenHandler tokenHandler)

Token handler to extract username from request.

Parameters:

tokenHandler - token handler instance

Returns:

updated builder instance

optional

public JwtAuthProvider.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

outboundConfig

public JwtAuthProvider.Builder outboundConfig(OutboundConfig config)

Configuration of outbound rules.

Parameters:

config - outbound configuration, each target may contain custom object JwtAuthProvider.JwtOutboundTarget to add our configuration.

Returns:

updated builder instance

signJwk

public JwtAuthProvider.Builder signJwk(Resource signJwkResource)

JWK resource used to sign JWTs created by us.

Parameters:

signJwkResource - resource pointing to a JSON with keys

Returns:

updated builder instance

verifyJwk

public JwtAuthProvider.Builder verifyJwk(Resource verifyJwkResource)

JWK resource used to verify JWTs created by other parties.

Parameters:

verifyJwkResource - resource pointing to a JSON with keys

Returns:

updated builder instance

issuer

public JwtAuthProvider.Builder issuer(String issuer)

Issuer used to create new JWTs.

Parameters:

issuer - issuer to add to the issuer claim

Returns:

updated builder instance

publicKey

public JwtAuthProvider.Builder publicKey(String publicKey)

String representation of the public key.

Parameters:

publicKey - String representation

Returns:

updated builder instance

publicKeyPath

public JwtAuthProvider.Builder publicKeyPath(String publicKeyPath)

Path to public key.

Parameters:

publicKeyPath - Public key path

Returns:

updated builder instance

defaultJwk

public JwtAuthProvider.Builder defaultJwk(Jwk defaultJwk)

Default JWK which should be used.

Parameters:

defaultJwk - Default JWK

Returns:

updated builder instance

defaultKeyId

public JwtAuthProvider.Builder defaultKeyId(String defaultKeyId)

Default JWT key ID which should be used.

Parameters:

defaultKeyId - Default JWT key ID

Returns:

updated builder instance

config

public JwtAuthProvider.Builder config(Config config)

Load this builder from a configuration.

Parameters:

config - configuration to load from

Returns:

updated builder instance

expectedIssuer

public JwtAuthProvider.Builder expectedIssuer(String issuer)

Expected issuer in incoming requests.

Parameters:

issuer - name of issuer

Returns:

updated builder instance

expectedAudience

public JwtAuthProvider.Builder expectedAudience(String audience)

Audience expected in inbound JWTs.

Parameters:

audience - audience string

Returns:

updated builder instance