com.veeva.vault.vapil.api.client

Class VaultClient

java.lang.Object

com.veeva.vault.vapil.api.client.VaultClient

public class VaultClient
extends Object

Base class for all Vault integration calls where a Vault session is established via:
1. Basic authentication using Vault user name and password
2. Existing Vault session, such as a session passed from Vault Web Action/Tab or Vault Job Scheduler
3. OAuth

New API requests are created via the "newRequest" method, passing in the request class to instantiate.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VaultClient.AuthenticationType Type of Authentication with the Vault API

Field Summary

Fields

Modifier and Type	Field and Description
static String	VAULT_API_VERSION The current Vault API Version "v21.1".

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VaultClient()

Method Summary

Modifier and Type	Method and Description
String	getAPIEndpoint(boolean includeVersion) Get the fully formed root API URL consisting of the Vault DNS
String	getAPIEndpoint(String endpoint) Get a fully formed API URL consisting of the Vault DNS, API version, and the API endpoint.
String	getAPIEndpoint(String endpoint, boolean includeVersion) Get a fully formed API URL consisting of the Vault DNS, API version, and the API endpoint.
AuthenticationResponse	getAuthenticationResponse()
String	getLoginEndpoint(String endpoint) Get a fully formed API URL consisting of the Vault login URL and the API endpoint.
String	getPassword()
String	getSessionId()
String	getUserId()
String	getUsername()
VaultClientId	getVaultClientId()
String	getVaultDNS()
String	getVaultUrl()
boolean	hasSessionId()
Boolean	isLogApiErrorsEnabled() Indicates whether or not to log api errors.
<T> T	newRequest(Class<T> requestClass) Instantiate a new request to the Vault API endpoint.
protected void	setAuthenticationResponse(AuthenticationResponse authenticationResponse)
VaultClient	setLogApiErrors(boolean logApiErrors) Sets whether or not to log api errors.
void	setPassword(String password)
void	setUsername(String username)
protected void	setVaultClientId(VaultClientId vaultClientId) Set the client id for Vault API requests VaultClientId
void	setVaultDNS(String vaultDNS)
boolean	validateSession() Validate the current sessionId.

Methods inherited from class java.lang.Object

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

Field Detail

VAULT_API_VERSION

public static final String VAULT_API_VERSION

The current Vault API Version "v21.1". This variable drives the version used in all API calls.

See Also:

Constant Field Values

Constructor Detail

VaultClient

protected VaultClient()

Method Detail

newRequest

public <T> T newRequest(Class<T> requestClass)

Instantiate a new request to the Vault API endpoint.

The Vault Client Id is required for all new requests. An error is thrown if no client id is set.

Type Parameters:

T - The request class to instantiate

Parameters:

requestClass - The request class to instantiate

Returns:

Object of the instantiated class

getVaultDNS

public String getVaultDNS()

Returns:

Vault DNS in format "myvault.veevavault.com"

setVaultDNS

public void setVaultDNS(String vaultDNS)

Parameters:

vaultDNS - Vault DNS in format "myvault.veevavault.com"

getVaultUrl

public String getVaultUrl()

Returns:

Vault URL in format "https://myvault.veevavault.com"

getUsername

public String getUsername()

Returns:

Vault user name

getPassword

public String getPassword()

Returns:

Vault user password

setPassword

public void setPassword(String password)

Parameters:

password - to set

setUsername

public void setUsername(String username)

Parameters:

username - to set

getVaultClientId

public VaultClientId getVaultClientId()

Returns:

The client_id class for Vault API calls

setVaultClientId

protected void setVaultClientId(VaultClientId vaultClientId)

Set the client id for Vault API requests VaultClientId

Parameters:

vaultClientId - Vault Client Id

getAPIEndpoint

public String getAPIEndpoint(boolean includeVersion)

Get the fully formed root API URL consisting of the Vault DNS

Parameters:

includeVersion - include version

Returns:

URL for the API endpoint in form https://myvault.com/api/{version}

getAPIEndpoint

public String getAPIEndpoint(String endpoint)

Get a fully formed API URL consisting of the Vault DNS, API version, and the API endpoint.

Parameters:

endpoint - API endpoint in form "/objects/documents"

Returns:

URL for the API endpoint in form https://myvault.com/api/{version}/objects/documents

getAPIEndpoint

public String getAPIEndpoint(String endpoint,
                             boolean includeVersion)

Get a fully formed API URL consisting of the Vault DNS, API version, and the API endpoint.

Parameters:

endpoint - API endpoint in form "/objects/documents"

includeVersion - include version in final endpoint

Returns:

URL for the API endpoint in form: includeVersion(true) - https://myvault.com/api/{version}/objects/documents includeVersion(false) - https://myvault.com/api/mdl/components

getLoginEndpoint

public String getLoginEndpoint(String endpoint)

Get a fully formed API URL consisting of the Vault login URL and the API endpoint.

Parameters:

endpoint - API endpoint in form "/objects/documents"

Returns:

URL for the API endpoint in form https://login.veevavault.com/auth/discovery

getAuthenticationResponse

public AuthenticationResponse getAuthenticationResponse()

Returns:

The response from an authentication request, which includes the Vault session id and the vaults that the user has access to. Note that only the session id is set if VaultConnection was instantiated with an existing Vault session (since an authentication call was not performed).

getSessionId

public String getSessionId()

Returns:

The Vault session id from an Authentication Response

hasSessionId

public boolean hasSessionId()

Returns:

True if the session id has been set

getUserId

public String getUserId()

Returns:

The user id for the authenticated user. Note that this will return null if VaultConnection was instantiated with an existing Vault session (since an authentication call was not performed).

setLogApiErrors

public VaultClient setLogApiErrors(boolean logApiErrors)

Sets whether or not to log api errors. Default=true

Parameters:

logApiErrors - true/false

Returns:

VaultClient

isLogApiErrorsEnabled

public Boolean isLogApiErrorsEnabled()

Indicates whether or not to log api errors. Default=true

Returns:

true/false

setAuthenticationResponse

protected void setAuthenticationResponse(AuthenticationResponse authenticationResponse)

validateSession

public boolean validateSession()

Validate the current sessionId. The session must be active and the vaultDNS from the request and the response must equal. If the session or vaultDNS is not valid, the current sessionId will be cleared and an error logged.

Returns:

true/false