com.veeva.vault.vapil.api.client

Class VaultClientBuilder

java.lang.Object

com.veeva.vault.vapil.api.client.VaultClientBuilder

public class VaultClientBuilder
extends Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VaultClientBuilder()

Method Summary

Modifier and Type	Method and Description
VaultClient	build() Build a Vault API Client with the configured settings from the builder.
static VaultClientBuilder	newClientBuilder(VaultClient.AuthenticationType authenticationType) Create a new instance of a VaultClientBuilder
VaultClientBuilder	withApiErrorLogging(boolean enabled) Log errors from the Vault API responses
VaultClientBuilder	withHttpTimeout(int minutes) Set the http timeout for the Vault Client.
VaultClientBuilder	withIdpOauthAccessToken(String idpOauthAccessToken) Initialize with an Idp Oauth Access Token.
VaultClientBuilder	withIdpPassword(String idpPassword) Initialize with a user's Idp Oauth Password.
VaultClientBuilder	withIdpUsername(String idpUsername) Initialize with a user's Idp Oauth user name.
VaultClientBuilder	withValidation(boolean enabled) Validate sessionId and vaultDNS after authentication
VaultClientBuilder	withVaultClientId(VaultClientId vaultClientId) Initialize with a Vault Client Id.
VaultClientBuilder	withVaultDNS(String vaultDNS) Initialize with a specific Vault DNS.
VaultClientBuilder	withVaultOauthClientId(String vaultOauthClientId) Initialize with the OAuth Client Id configured in Vault OAuth Profiles.
VaultClientBuilder	withVaultOauthProfileId(String vaultOauthProfileId) Initialize with the OAuth Profile Id configured in Vault OAuth Profiles.
VaultClientBuilder	withVaultPassword(String vaultPassword) Initialize with a user's Vault password.
VaultClientBuilder	withVaultSessionId(String vaultSessionId) Initialize with an existing Vault sessionId
VaultClientBuilder	withVaultUsername(String vaultUsername) Initialize with a user's Vault user name.

Methods inherited from class java.lang.Object

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

Constructor Detail

VaultClientBuilder

protected VaultClientBuilder()

Method Detail

newClientBuilder

public static VaultClientBuilder newClientBuilder(VaultClient.AuthenticationType authenticationType)

Create a new instance of a VaultClientBuilder

Parameters:

authenticationType - VaultClient.AuthenticationType

Returns:

VaultClientBuilder

build

public VaultClient build()
                  throws IllegalArgumentException

Build a Vault API Client with the configured settings from the builder. Throws IllegalArgumentException when required parameters are missing.

Returns:

VaultClient

Throws:

IllegalArgumentException

withApiErrorLogging

public VaultClientBuilder withApiErrorLogging(boolean enabled)

Log errors from the Vault API responses

Parameters:

enabled - Enable api error logging. default = true

Returns:

VaultClientBuilder

withHttpTimeout

public VaultClientBuilder withHttpTimeout(int minutes)

Set the http timeout for the Vault Client. Default = 60 minutes.

Can only be set before any and all HTTP calls are first executed including authentication

Parameters:

minutes - Number of minutes before http timeout occurs

Returns:

VaultClientBuilder

withIdpOauthAccessToken

public VaultClientBuilder withIdpOauthAccessToken(String idpOauthAccessToken)

Initialize with an Idp Oauth Access Token.

Required for OAuth with Token

Parameters:

idpOauthAccessToken - Idp Oauth Access Token

Returns:

VaultClientBuilder

withIdpPassword

public VaultClientBuilder withIdpPassword(String idpPassword)

Initialize with a user's Idp Oauth Password.

Required for OAuth with Discovery

Parameters:

idpPassword - Idp Oauth Password

Returns:

VaultClientBuilder

withIdpUsername

public VaultClientBuilder withIdpUsername(String idpUsername)

Initialize with a user's Idp Oauth user name.

Required for OAuth with Discovery when Vault and Idp user name do not match

Parameters:

idpUsername - Idp Oauth user name

Returns:

VaultClientBuilder

withValidation

public VaultClientBuilder withValidation(boolean enabled)

Validate sessionId and vaultDNS after authentication

Parameters:

enabled - Enable session and vaultDNS validation. default = true

Returns:

VaultClientBuilder

withVaultClientId

public VaultClientBuilder withVaultClientId(VaultClientId vaultClientId)

Initialize with a Vault Client Id.

s Always Required

Parameters:

vaultClientId - Vault Client Id (ex. verteobiotech-vault-quality-server-myapp)

Returns:

VaultClientBuilder

withVaultDNS

public VaultClientBuilder withVaultDNS(String vaultDNS)

Initialize with a specific Vault DNS.

Always Required

Parameters:

vaultDNS - Vault DNS

Returns:

VaultClientBuilder

withVaultOauthClientId

public VaultClientBuilder withVaultOauthClientId(String vaultOauthClientId)

Initialize with the OAuth Client Id configured in Vault OAuth Profiles.

Required for OAuth

Parameters:

vaultOauthClientId - Vault Oauth Client Id

Returns:

VaultClientBuilder

withVaultOauthProfileId

public VaultClientBuilder withVaultOauthProfileId(String vaultOauthProfileId)

Initialize with the OAuth Profile Id configured in Vault OAuth Profiles.

Required for OAuth

Parameters:

vaultOauthProfileId - Vault Oauth Profile Id

Returns:

VaultClientBuilder

withVaultPassword

public VaultClientBuilder withVaultPassword(String vaultPassword)

Initialize with a user's Vault password.

Required for Basic Auth

Parameters:

vaultPassword - Vault password

Returns:

VaultClientBuilder

withVaultSessionId

public VaultClientBuilder withVaultSessionId(String vaultSessionId)

Initialize with an existing Vault sessionId

Parameters:

vaultSessionId - Vault session ID

Returns:

VaultClientBuilder

withVaultUsername

public VaultClientBuilder withVaultUsername(String vaultUsername)

Initialize with a user's Vault user name.

Required for Basic Auth

Parameters:

vaultUsername - Vault user name

Returns:

VaultClientBuilder