Package org.springframework.vault.authentication

Class AuthenticationStepsExecutor

java.lang.Object

org.springframework.vault.authentication.AuthenticationStepsExecutor

All Implemented Interfaces:

ClientAuthentication

public class AuthenticationStepsExecutor
extends Object
implements ClientAuthentication

Synchronous executor for AuthenticationSteps using RestOperations to login using authentication flows.

Since:

2.0

Author:

Mark Paluch

See Also:

• AuthenticationSteps

Constructor Summary

Constructors

Constructor	Description
AuthenticationStepsExecutor(AuthenticationSteps steps, VaultClient vaultClient, RestClient restClient)	Create a new AuthenticationStepsExecutor given AuthenticationSteps and VaultClient.
AuthenticationStepsExecutor(AuthenticationSteps steps, RestClient client)	Create a new AuthenticationStepsExecutor given AuthenticationSteps and RestOperations.
AuthenticationStepsExecutor(AuthenticationSteps steps, RestOperations restOperations)	Deprecated. since 4.1, use AuthenticationStepsExecutor(AuthenticationSteps, VaultClient, RestClient) instead.

Method Summary

Modifier and Type	Method	Description
VaultToken	login()	Obtain a VaultToken for authenticated Vault access.

Methods inherited from class java.lang.Object

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

Constructor Details

AuthenticationStepsExecutor

@Deprecated(since="4.1")
public AuthenticationStepsExecutor(AuthenticationSteps steps,
 RestOperations restOperations)

Deprecated.

since 4.1, use AuthenticationStepsExecutor(AuthenticationSteps, VaultClient, RestClient) instead.

Create a new AuthenticationStepsExecutor given AuthenticationSteps and RestOperations.

Parameters:

steps - must not be null.

restOperations - must not be null.

AuthenticationStepsExecutor

public AuthenticationStepsExecutor(AuthenticationSteps steps,
 RestClient client)

Create a new AuthenticationStepsExecutor given AuthenticationSteps and RestOperations.

Parameters:

steps - must not be null.

client - must not be null.

Since:

4.0

AuthenticationStepsExecutor

public AuthenticationStepsExecutor(AuthenticationSteps steps,
 VaultClient vaultClient,
 RestClient restClient)

Create a new AuthenticationStepsExecutor given AuthenticationSteps and VaultClient.

Parameters:

steps - must not be null.

vaultClient - must not be null.

restClient - must not be null.

Since:

4.1

Method Details

login

public VaultToken login()
                 throws VaultException

Description copied from interface: ClientAuthentication

Obtain a VaultToken for authenticated Vault access.

This method may perform an authentication request to Vault or return a cached or pre-configured token.

Specified by:

login in interface ClientAuthentication

Returns:

the Vault token for subsequent authenticated requests

Throws:

VaultLoginException - if authentication fails.

VaultException

See Also:

• LoginToken