org.springframework.vault.authentication

Class CubbyholeAuthenticationOptions.CubbyholeAuthenticationOptionsBuilder

java.lang.Object

org.springframework.vault.authentication.CubbyholeAuthenticationOptions.CubbyholeAuthenticationOptionsBuilder

Enclosing class:

CubbyholeAuthenticationOptions

public static class CubbyholeAuthenticationOptions.CubbyholeAuthenticationOptionsBuilder
extends Object

Builder for CubbyholeAuthenticationOptions.

Method Summary

Modifier and Type	Method and Description
CubbyholeAuthenticationOptions	build() Build a new CubbyholeAuthenticationOptions instance.
CubbyholeAuthenticationOptions.CubbyholeAuthenticationOptionsBuilder	initialToken(VaultToken initialToken) Configure the initial VaultToken to access Cubbyhole.
CubbyholeAuthenticationOptions.CubbyholeAuthenticationOptionsBuilder	path(String path) Configure the cubbyhole path, such as cubbyhole/token.
CubbyholeAuthenticationOptions.CubbyholeAuthenticationOptionsBuilder	selfLookup(boolean selfLookup) Configure whether to perform a self-lookup after token retrieval.
CubbyholeAuthenticationOptions.CubbyholeAuthenticationOptionsBuilder	unwrappingEndpoints(UnwrappingEndpoints endpoints) Configure the UnwrappingEndpoints to use.
CubbyholeAuthenticationOptions.CubbyholeAuthenticationOptionsBuilder	wrapped() Configure whether to use wrapped token responses.

Methods inherited from class java.lang.Object

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

Method Detail

initialToken

public CubbyholeAuthenticationOptions.CubbyholeAuthenticationOptionsBuilder initialToken(VaultToken initialToken)

Configure the initial VaultToken to access Cubbyhole.

Parameters:

initialToken - must not be null.

Returns:

this CubbyholeAuthenticationOptions.CubbyholeAuthenticationOptionsBuilder.

path

public CubbyholeAuthenticationOptions.CubbyholeAuthenticationOptionsBuilder path(String path)

Configure the cubbyhole path, such as cubbyhole/token. Expects a token in the data response.

Parameters:

path - must not be empty or null.

Returns:

this CubbyholeAuthenticationOptions.CubbyholeAuthenticationOptionsBuilder.

unwrappingEndpoints

public CubbyholeAuthenticationOptions.CubbyholeAuthenticationOptionsBuilder unwrappingEndpoints(UnwrappingEndpoints endpoints)

Configure the UnwrappingEndpoints to use.

Parameters:

endpoints - must not be null.

Returns:

this CubbyholeAuthenticationOptions.CubbyholeAuthenticationOptionsBuilder

Since:

2.2

wrapped

public CubbyholeAuthenticationOptions.CubbyholeAuthenticationOptionsBuilder wrapped()

Configure whether to use wrapped token responses.

Returns:

this CubbyholeAuthenticationOptions.CubbyholeAuthenticationOptionsBuilder.

selfLookup

public CubbyholeAuthenticationOptions.CubbyholeAuthenticationOptionsBuilder selfLookup(boolean selfLookup)

Configure whether to perform a self-lookup after token retrieval. Defaults to true.

Parameters:

selfLookup - true to perform a self-lookup or false to disable it.

Returns:

this CubbyholeAuthenticationOptions.CubbyholeAuthenticationOptionsBuilder.

Since:

1.0.1

build

public CubbyholeAuthenticationOptions build()

Build a new CubbyholeAuthenticationOptions instance. Requires path(String) or wrapped() to be configured.

Returns:

a new CubbyholeAuthenticationOptions.