org.springframework.vault.authentication

Class AppIdAuthentication

java.lang.Object

org.springframework.vault.authentication.AppIdAuthentication

All Implemented Interfaces:

AuthenticationStepsFactory, ClientAuthentication

public class AppIdAuthentication
extends Object
implements ClientAuthentication, AuthenticationStepsFactory

AppId implementation of ClientAuthentication. AppIdAuthentication uses a configured AppIdUserIdMechanism to obtain or calculate a UserId. AppId and UserId are sent in the login request to Vault to obtain a VaultToken.

Author:

Mark Paluch

See Also:

AppIdAuthenticationOptions, RestOperations, Auth Backend: App ID

Constructor Summary

Constructors

Constructor and Description
AppIdAuthentication(AppIdAuthenticationOptions options, RestOperations restOperations) Create a AppIdAuthentication using AppIdAuthenticationOptions and RestOperations.

Method Summary

Modifier and Type	Method and Description
static AuthenticationSteps	createAuthenticationSteps(AppIdAuthenticationOptions options) Creates a AuthenticationSteps for AppId authentication given AppIdAuthenticationOptions.
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 Detail

AppIdAuthentication

public AppIdAuthentication(AppIdAuthenticationOptions options,
                           RestOperations restOperations)

Create a AppIdAuthentication using AppIdAuthenticationOptions and RestOperations.

Parameters:

options - must not be null.

restOperations - must not be null.

Method Detail

createAuthenticationSteps

public static AuthenticationSteps createAuthenticationSteps(AppIdAuthenticationOptions options)

Creates a AuthenticationSteps for AppId authentication given AppIdAuthenticationOptions.

Parameters:

options - must not be null.

Returns:

AuthenticationSteps for AppId 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.