Package org.springframework.vault.authentication

Class AuthenticationStepsOperator

java.lang.Object

org.springframework.vault.authentication.AuthenticationStepsOperator

All Implemented Interfaces:

VaultTokenSupplier

public class AuthenticationStepsOperator
extends Object
implements VaultTokenSupplier

VaultTokenSupplier using AuthenticationSteps to create an authentication flow emitting VaultToken.

This class uses ReactiveVaultClient for non-blocking and reactive HTTP Vault access. It also uses WebClient for external HTTP access. The authentication flow materializes as reactive sequence postponing execution until subscription.

Supplier instances are inspected for their type. ResourceCredentialSupplier instances are loaded through DataBufferUtils to use non-blocking I/O for file access. Calls to generic supplier types are offloaded to a scheduler to avoid blocking calls on reactive worker/eventloop threads.

Since:

2.0

Author:

Mark Paluch

See Also:

• AuthenticationSteps

Constructor Summary

Constructors

Constructor	Description
AuthenticationStepsOperator(AuthenticationSteps steps, ReactiveVaultClient vaultClient, WebClient webClient)	Create a new AuthenticationStepsOperator given AuthenticationSteps, ReactiveVaultClient, and WebClient.
AuthenticationStepsOperator(AuthenticationSteps steps, WebClient webClient)	Create a new AuthenticationStepsOperator given AuthenticationSteps and WebClient.

Method Summary

Modifier and Type	Method	Description
Mono<VaultToken>	getVaultToken()	Return a VaultToken.

Methods inherited from class java.lang.Object

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

Constructor Details

AuthenticationStepsOperator

public AuthenticationStepsOperator(AuthenticationSteps steps,
 WebClient webClient)

Create a new AuthenticationStepsOperator given AuthenticationSteps and WebClient.

Parameters:

steps - must not be null.

webClient - must not be null.

AuthenticationStepsOperator

public AuthenticationStepsOperator(AuthenticationSteps steps,
 ReactiveVaultClient vaultClient,
 WebClient webClient)

Create a new AuthenticationStepsOperator given AuthenticationSteps, ReactiveVaultClient, and WebClient.

Parameters:

steps - must not be null.

vaultClient - must not be null.

webClient - must not be null.

Since:

4.1

Method Details

getVaultToken

public Mono<VaultToken> getVaultToken()
                               throws VaultException

Description copied from interface: VaultTokenSupplier

Return a VaultToken. This can declare a Vault login flow to obtain a token.

Specified by:

getVaultToken in interface VaultTokenSupplier

Returns:

a Mono with the VaultToken.

Throws:

VaultException