Package org.springframework.vault.authentication

Class ClientCertificateAuthentication

java.lang.Object

org.springframework.vault.authentication.ClientCertificateAuthentication

All Implemented Interfaces:

AuthenticationStepsFactory, ClientAuthentication

public class ClientCertificateAuthentication
extends Object
implements ClientAuthentication, AuthenticationStepsFactory

TLS Client Certificate ClientAuthentication.

Author:

Mark Paluch, Andy Lintner

See Also:

• VaultClient

Constructor Summary

Constructors

Constructor	Description
ClientCertificateAuthentication(ClientCertificateAuthenticationOptions options, VaultClient client)	Create a ClientCertificateAuthentication using VaultClient.
ClientCertificateAuthentication(ClientCertificateAuthenticationOptions options, RestClient client)	Create a ClientCertificateAuthentication using RestOperations.
ClientCertificateAuthentication(ClientCertificateAuthenticationOptions options, RestOperations restOperations)	Deprecated. since 4.1, use ClientCertificateAuthentication(ClientCertificateAuthenticationOptions, VaultClient) instead.
ClientCertificateAuthentication(VaultClient client)	Create a ClientCertificateAuthentication using VaultClient.
ClientCertificateAuthentication(RestClient client)	Create a ClientCertificateAuthentication using RestClient.
ClientCertificateAuthentication(RestOperations restOperations)	Deprecated. since 4.1, use ClientCertificateAuthentication(VaultClient) instead.

Method Summary

Modifier and Type	Method	Description
static AuthenticationSteps	createAuthenticationSteps()	Create AuthenticationSteps for client certificate authentication.
static AuthenticationSteps	createAuthenticationSteps(ClientCertificateAuthenticationOptions options)	Create AuthenticationSteps for client certificate authentication.
AuthenticationSteps	getAuthenticationSteps()	Get the AuthenticationSteps describing an authentication flow.
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

ClientCertificateAuthentication

@Deprecated(since="4.1")
public ClientCertificateAuthentication(RestOperations restOperations)

Deprecated.

since 4.1, use ClientCertificateAuthentication(VaultClient) instead.

Create a ClientCertificateAuthentication using RestOperations.

Parameters:

restOperations - must not be null.

ClientCertificateAuthentication

@Deprecated(since="4.1")
public ClientCertificateAuthentication(ClientCertificateAuthenticationOptions options,
 RestOperations restOperations)

Deprecated.

since 4.1, use ClientCertificateAuthentication(ClientCertificateAuthenticationOptions, VaultClient) instead.

Create a ClientCertificateAuthentication using RestOperations.

Parameters:

options - must not be null.

restOperations - must not be null.

Since:

2.3

ClientCertificateAuthentication

public ClientCertificateAuthentication(RestClient client)

Create a ClientCertificateAuthentication using RestClient.

Parameters:

client - must not be null.

Since:

4.0

ClientCertificateAuthentication

public ClientCertificateAuthentication(ClientCertificateAuthenticationOptions options,
 RestClient client)

Create a ClientCertificateAuthentication using RestOperations.

Parameters:

options - must not be null.

client - must not be null.

Since:

4.0

ClientCertificateAuthentication

public ClientCertificateAuthentication(VaultClient client)

Create a ClientCertificateAuthentication using VaultClient.

Parameters:

client - must not be null.

Since:

4.1

ClientCertificateAuthentication

public ClientCertificateAuthentication(ClientCertificateAuthenticationOptions options,
 VaultClient client)

Create a ClientCertificateAuthentication using VaultClient.

Parameters:

options - must not be null.

client - must not be null.

Since:

4.1

Method Details

createAuthenticationSteps

public static AuthenticationSteps createAuthenticationSteps()

Create AuthenticationSteps for client certificate authentication.

Returns:

AuthenticationSteps for client certificate authentication.

Since:

2.0

createAuthenticationSteps

public static AuthenticationSteps createAuthenticationSteps(ClientCertificateAuthenticationOptions options)

Create AuthenticationSteps for client certificate authentication.

Parameters:

options - must not be null.

Returns:

AuthenticationSteps for client certificate authentication.

Since:

2.3

login

public VaultToken login()

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

See Also:

• LoginToken

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.