Package org.springframework.vault.authentication

Class AuthenticationSteps.Node<T>

java.lang.Object

org.springframework.vault.authentication.AuthenticationSteps.Node<T>

Type Parameters:

T - authentication state object type produced by this node.

Enclosing class:

AuthenticationSteps

public static class AuthenticationSteps.Node<T>
extends Object

Intermediate authentication step with authentication flow operators represented as node.

Constructor Summary

Constructors

Constructor	Description
Node()

Method Summary

Modifier and Type	Method	Description
AuthenticationSteps	login(String uriTemplate, String... uriVariables)	Terminal operation requesting a token from Vault by posting the current state to Vaults uriTemplate.
AuthenticationSteps	login(Function<? super T,? extends VaultToken> mappingFunction)	Terminal operation resulting in a token by applying a mapping Function to the current state object.
AuthenticationSteps	login(AuthenticationSteps.HttpRequest<VaultResponse> request)	Terminal operation requesting a token from Vault by issuing a HTTP request with the current state to Vaults uriTemplate.
AuthenticationSteps	loginAt(String authMount)	Terminal operation requesting a token from Vault by posting the current state to Vaults uriTemplate.
<R> AuthenticationSteps.Node<R>	map(Function<? super T,? extends R> mappingFunction)	Transform the state object into a different object.
AuthenticationSteps.Node<T>	onNext(Consumer<? super T> consumerFunction)	Callback with the current state object.
<R> AuthenticationSteps.Node<R>	request(AuthenticationSteps.HttpRequest<R> request)	Request data using a AuthenticationSteps.HttpRequest.
<R> AuthenticationSteps.Node<AuthenticationSteps.Pair<T,R>>	zipWith(AuthenticationSteps.Node<? extends R> other)	Combine the result from this AuthenticationSteps.Node and another into a AuthenticationSteps.Pair.

Methods inherited from class java.lang.Object

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

Constructor Details

Node

public Node()

Method Details

map

public <R> AuthenticationSteps.Node<R> map(Function<? super T,? extends R> mappingFunction)

Transform the state object into a different object.

Type Parameters:

R - resulting object type

Parameters:

mappingFunction - mapping function to be applied to the state object, must not be null.

Returns:

the next AuthenticationSteps.Node.

zipWith

public <R>
AuthenticationSteps.Node<AuthenticationSteps.Pair<T,R>> zipWith(AuthenticationSteps.Node<? extends R> other)

Combine the result from this AuthenticationSteps.Node and another into a AuthenticationSteps.Pair.

Returns:

the next AuthenticationSteps.Node.

Since:

2.1

onNext

public AuthenticationSteps.Node<T> onNext(Consumer<? super T> consumerFunction)

Callback with the current state object.

Parameters:

consumerFunction - consumer function to be called with the state object, must not be null.

Returns:

the next AuthenticationSteps.Node.

request

public <R> AuthenticationSteps.Node<R> request(AuthenticationSteps.HttpRequest<R> request)

Request data using a AuthenticationSteps.HttpRequest.

Parameters:

request - the HTTP request definition, must not be null.

Returns:

the next AuthenticationSteps.Node.

loginAt

public AuthenticationSteps loginAt(String authMount)

Terminal operation requesting a token from Vault by posting the current state to Vaults uriTemplate. Terminal operation requesting a token from Vault by logging into Vault sending the current state to the Vault authMount. The actual request path is derived from authMount using the pattern auth/%s/login. If the request path needs to be customized, use login(String, String...) instead.

Parameters:

authMount - the name of the authentication mount, must not be null or empty.

Returns:

the AuthenticationSteps.

Since:

4.1

login

public AuthenticationSteps login(String uriTemplate,
 String... uriVariables)

Terminal operation requesting a token from Vault by posting the current state to Vaults uriTemplate.

Parameters:

uriTemplate - Vault authentication endpoint, must not be null or empty.

uriVariables - URI variables for URI template expansion.

Returns:

the AuthenticationSteps.

login

public AuthenticationSteps login(AuthenticationSteps.HttpRequest<VaultResponse> request)

Terminal operation requesting a token from Vault by issuing a HTTP request with the current state to Vaults uriTemplate.

Parameters:

request - HTTP request definition.

Returns:

the AuthenticationSteps.

login

public AuthenticationSteps login(Function<? super T,? extends VaultToken> mappingFunction)

Terminal operation resulting in a token by applying a mapping Function to the current state object.

Parameters:

mappingFunction - mapping function to be applied to the state object, must not be null.

Returns:

the AuthenticationSteps.