Class JwtAuthenticationOptions.JwtAuthenticationOptionsBuilder

java.lang.Object

org.springframework.vault.authentication.JwtAuthenticationOptions.JwtAuthenticationOptionsBuilder

Enclosing class:

JwtAuthenticationOptions

public static class JwtAuthenticationOptions.JwtAuthenticationOptionsBuilder
extends Object

Builder for JwtAuthenticationOptions.

Since:

3.1

Author:

Nanne Baars, Mark Paluch

Constructor Summary

Constructors

Constructor	Description
JwtAuthenticationOptionsBuilder()

Method Summary

Modifier and Type	Method	Description
JwtAuthenticationOptions	build()	Build a new JwtAuthenticationOptions instance.
JwtAuthenticationOptions.JwtAuthenticationOptionsBuilder	jwt(String jwt)	Configure the JWT authentication token.
JwtAuthenticationOptions.JwtAuthenticationOptionsBuilder	jwtSupplier(Supplier<String> jwtSupplier)	Configure the Supplier to obtain a JWT authentication token.
JwtAuthenticationOptions.JwtAuthenticationOptionsBuilder	path(String path)	Configure the mount path.
JwtAuthenticationOptions.JwtAuthenticationOptionsBuilder	role(String role)	Configure the role.

Methods inherited from class Object

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

Constructor Details

JwtAuthenticationOptionsBuilder

public JwtAuthenticationOptionsBuilder()

Method Details

path

public JwtAuthenticationOptions.JwtAuthenticationOptionsBuilder path(String path)

Configure the mount path.

Parameters:

path - must not be null or empty.

Returns:

this JwtAuthenticationOptions.JwtAuthenticationOptionsBuilder.

role

public JwtAuthenticationOptions.JwtAuthenticationOptionsBuilder role(String role)

Configure the role.

Parameters:

role - name of the role against which the login is being attempted, must not be null or empty.

Returns:

this JwtAuthenticationOptions.JwtAuthenticationOptionsBuilder.

jwt

public JwtAuthenticationOptions.JwtAuthenticationOptionsBuilder jwt(String jwt)

Configure the JWT authentication token. Vault authentication will use this token as singleton. If you want to provide a dynamic token that can change over time, see jwtSupplier(Supplier).

Parameters:

jwt - must not be null.

Returns:

this JwtAuthenticationOptions.JwtAuthenticationOptionsBuilder.

jwtSupplier

public JwtAuthenticationOptions.JwtAuthenticationOptionsBuilder jwtSupplier(Supplier<String> jwtSupplier)

Configure the Supplier to obtain a JWT authentication token.

Parameters:

jwtSupplier - must not be null.

Returns:

this JwtAuthenticationOptions.JwtAuthenticationOptionsBuilder.

build

public JwtAuthenticationOptions build()

Build a new JwtAuthenticationOptions instance.

Returns:

a new JwtAuthenticationOptions.