Package org.springframework.vault.authentication

Class TokenAuthentication

java.lang.Object

org.springframework.vault.authentication.TokenAuthentication

All Implemented Interfaces:

AuthenticationStepsFactory, ClientAuthentication

public class TokenAuthentication
extends Object
implements ClientAuthentication, AuthenticationStepsFactory

Static Token-based ClientAuthentication method.

Author:

Mark Paluch

See Also:

• VaultToken
• Auth Backend: Token

Constructor Summary

Constructors

Constructor	Description
TokenAuthentication(String token)	Create a new TokenAuthentication with a static token.
TokenAuthentication(VaultToken token)	Create a new TokenAuthentication with a static token.

Method Summary

Modifier and Type	Method	Description
static AuthenticationSteps	createAuthenticationSteps(VaultToken token, boolean selfLookup)	Creates a AuthenticationSteps for token authentication given VaultToken.
AuthenticationSteps	getAuthenticationSteps()	Get the AuthenticationSteps describing an authentication flow.
VaultToken	login()	Return a VaultToken.

Methods inherited from class java.lang.Object

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

Constructor Details

TokenAuthentication

public TokenAuthentication(String token)

Create a new TokenAuthentication with a static token.

Parameters:

token - the Vault token, must not be empty or null.

TokenAuthentication

public TokenAuthentication(VaultToken token)

Create a new TokenAuthentication with a static token.

Parameters:

token - the Vault token, must not be null.

Method Details

createAuthenticationSteps

public static AuthenticationSteps createAuthenticationSteps(VaultToken token,
 boolean selfLookup)

Creates a AuthenticationSteps for token authentication given VaultToken.

Parameters:

token - must not be null.

selfLookup - true to perform a self-lookup using the given VaultToken. Self-lookup will create a LoginToken and provide renewability and TTL.

Returns:

AuthenticationSteps for token authentication.

Since:

2.0

login

public VaultToken login()

Description copied from interface: ClientAuthentication

Return a VaultToken. This method can optionally log into Vault to obtain a token.

Specified by:

login in interface ClientAuthentication

Returns:

a VaultToken.

getAuthenticationSteps

public AuthenticationSteps getAuthenticationSteps()

Description copied from interface: AuthenticationStepsFactory

Get the AuthenticationSteps describing an authentication flow.

Specified by:

getAuthenticationSteps in interface AuthenticationStepsFactory

Returns:

the AuthenticationSteps describing an authentication flow.