org.springframework.vault.authentication

Class PcfAuthentication

java.lang.Object

org.springframework.vault.authentication.PcfAuthentication

All Implemented Interfaces:

AuthenticationStepsFactory, ClientAuthentication

public class PcfAuthentication
extends Object
implements ClientAuthentication, AuthenticationStepsFactory

PCF implementation of ClientAuthentication. PcfAuthentication uses a PCF instance certificate and key to login into Vault.

Requires BouncyCastle to generate a RSA PSS signature.

Since:

2.2

Author:

Mark Paluch

See Also:

PcfAuthenticationOptions, RestOperations, Auth Backend: PCF

Constructor Summary

Constructors

Constructor and Description
PcfAuthentication(PcfAuthenticationOptions options, RestOperations restOperations) Create a PcfAuthentication using PcfAuthenticationOptions and RestOperations.

Method Summary

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

PcfAuthentication

public PcfAuthentication(PcfAuthenticationOptions options,
                         RestOperations restOperations)

Create a PcfAuthentication using PcfAuthenticationOptions and RestOperations.

Parameters:

options - must not be null.

restOperations - must not be null.

Method Detail

createAuthenticationSteps

public static AuthenticationSteps createAuthenticationSteps(PcfAuthenticationOptions options)

Creates a AuthenticationSteps for pcf authentication given PcfAuthenticationOptions.

Parameters:

options - must not be null.

Returns:

AuthenticationSteps for pcf authentication.

login

public VaultToken login()
                 throws VaultException

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.

Throws:

VaultException

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.