Package com.veeva.vault.vapil.api.client

Class VaultClient.Builder

java.lang.Object
com.veeva.vault.vapil.api.model.VaultModel
com.veeva.vault.vapil.api.client.VaultClient.Builder
Enclosing class:
VaultClient
public static class VaultClient.Builder extends VaultModel

  • Constructor Details

  • Method Details

    • 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 VaultClient.Builder withApiErrorLogging(boolean enabled)
      Log errors from the Vault API responses
      Parameters:
      enabled - Enable api error logging. default = true
      Returns:
      VaultClient.Builder

    • withHttpTimeout

      public VaultClient.Builder 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 VaultClient.Builder withIdpOauthAccessToken(String idpOauthAccessToken)
      Initialize with an Idp Oauth Access Token.

       

      Required for OAuth with Token
      Parameters:
      idpOauthAccessToken - Idp Oauth Access Token
      Returns:
      VaultClient.Builder

    • withIdpOauthScope

      public VaultClient.Builder withIdpOauthScope(String idpOauthScope)
      Initialize with an Idp Oauth Access Token.

       

      Optional for OAuth with Token. Default = "openid"
      Parameters:
      idpOauthScope - Idp Oauth Scope
      Returns:
      VaultClient.Builder

    • withIdpPassword

      public VaultClient.Builder withIdpPassword(String idpPassword)
      Initialize with a user's Idp Oauth Password.

       

      Required for OAuth with Discovery
      Parameters:
      idpPassword - Idp Oauth Password
      Returns:
      VaultClient.Builder

    • withIdpUsername

      public VaultClient.Builder 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:
      VaultClient.Builder

    • withValidation

      public VaultClient.Builder withValidation(boolean enabled)
      Validate sessionId and vaultClientSettings.getVaultDNS() after authentication
      Parameters:
      enabled - Enable session and vaultClientSettings.getVaultDNS() validation. default = true
      Returns:
      VaultClient.Builder

    • withVaultClientId

      public VaultClient.Builder withVaultClientId(String vaultClientId)
      Initialize with a Vault Client Id.

       

      s Always Required
      Parameters:
      vaultClientId - Vault Client Id (ex. verteobiotech-vault-quality-server-myapp)
      Returns:
      VaultClient.Builder

    • withVaultDNS

      public VaultClient.Builder withVaultDNS(String vaultDNS)
      Initialize with a specific Vault DNS.

       

      Always Required
      Parameters:
      vaultDNS - Vault DNS
      Returns:
      VaultClient.Builder

    • withVaultOauthClientId

      public VaultClient.Builder withVaultOauthClientId(String vaultOauthClientId)
      Initialize with the OAuth Client Id configured in Vault OAuth Profiles.

       

      Required for OAuth
      Parameters:
      vaultOauthClientId - Vault Oauth Client Id
      Returns:
      VaultClient.Builder

    • withVaultOauthProfileId

      public VaultClient.Builder withVaultOauthProfileId(String vaultOauthProfileId)
      Initialize with the OAuth Profile Id configured in Vault OAuth Profiles.

       

      Required for OAuth
      Parameters:
      vaultOauthProfileId - Vault Oauth Profile Id
      Returns:
      VaultClient.Builder

    • withVaultPassword

      public VaultClient.Builder withVaultPassword(String vaultPassword)
      Initialize with a user's Vault password.

       

      Required for Basic Auth
      Parameters:
      vaultPassword - Vault password
      Returns:
      VaultClient.Builder

    • withVaultSessionId

      public VaultClient.Builder withVaultSessionId(String sessionId)
      Initialize with an existing Vault sessionId
      Parameters:
      sessionId - Vault session ID
      Returns:
      VaultClient.Builder

    • withVaultUsername

      public VaultClient.Builder withVaultUsername(String vaultUsername)
      Initialize with a user's Vault user name.

       

      Required for Basic Auth
      Parameters:
      vaultUsername - Vault user name
      Returns:
      VaultClient.Builder

    • withAllowAllCertificates

      public VaultClient.Builder withAllowAllCertificates(boolean allowAllCertificates)
      Allow Vault Client to trust all certificates
      Parameters:
      allowAllCertificates - true/false
      Returns:
      VaultClient.Builder