Package org.springframework.vault.authentication

Class LoginTokenAdapter

java.lang.Object

org.springframework.vault.authentication.LoginTokenAdapter

All Implemented Interfaces:

ClientAuthentication

public class LoginTokenAdapter
extends Object
implements ClientAuthentication

Adapts tokens created by a ClientAuthentication to a LoginToken. Allows decoration of a ClientAuthentication object to perform a self-lookup after token retrieval to obtain the remaining TTL, renewability, accessor and token type.

Using this adapter decrements the usage counter for the created token.

Since:

1.1

Author:

Mark Paluch

See Also:

• LoginToken

Constructor Summary

Constructors

Constructor	Description
LoginTokenAdapter(ClientAuthentication delegate, VaultClient client)	Create a new LoginTokenAdapter given ClientAuthentication to decorate and ClientAdapter.
LoginTokenAdapter(ClientAuthentication delegate, RestOperations restOperations)	Deprecated. since 4.1, use LoginTokenAdapter(ClientAuthentication, VaultClient) instead.

Method Summary

Modifier and Type	Method	Description
LoginToken	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

LoginTokenAdapter

@Deprecated(since="4.1")
public LoginTokenAdapter(ClientAuthentication delegate,
 RestOperations restOperations)

Deprecated.

since 4.1, use LoginTokenAdapter(ClientAuthentication, VaultClient) instead.

Create a new LoginTokenAdapter given ClientAuthentication to decorate and RestOperations.

Parameters:

delegate - must not be null.

restOperations - must not be null.

LoginTokenAdapter

public LoginTokenAdapter(ClientAuthentication delegate,
 VaultClient client)

Create a new LoginTokenAdapter given ClientAuthentication to decorate and ClientAdapter.

Parameters:

delegate - must not be null.

client - must not be null.

Since:

4.1

Method Details

login

public LoginToken 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