com.veeva.vault.vapil.api.client

Class VaultClientId

java.lang.Object

com.veeva.vault.vapil.api.client.VaultClientId

public class VaultClientId
extends Object

Construct a Vault Client Id, which is required by VAPIL for all integration calls.

The Vault Client Id appears in the API Usage Logs for tracking and logging purposes. It is in the form:
{company}-{organization}-{component/team}-{server | client}-{program}

For example, an integration developed by Verteo Biotech, Inc could be:
verteobiotech-vault-quality-client-myapp

The Vault Client Id can be set via the following approaches.

Set in the constructor:

 VaultClientId clientId = new VaultClientId("verteobiotech","vault","quality",true,"myapp");

Set via setters after instantiating. This example sets it using builder pattern setters.

 VaultClientId clientId = new VaultClientId()
                .setCompany("verteobiotech")
                .setOrganization("vault")
                .setComponentTeam("quality")
                .setIsClient(true)
                .setProgramName("myapp");

See Also:

https://developer.veevavault.com/docs/#client-id

Constructor Summary

Constructors

Constructor and Description
VaultClientId() Instantiate the Vault Client Id and later set the parameters, such as using the builder pattern setters.
VaultClientId(String company, String organization, String componentTeam, Boolean isClient, String programName) Instantiate the Vault Client Id by passing in all parameters

Method Summary

Modifier and Type	Method and Description
String	getClientId() Retrieve the Vault Client Id in the form {company}-{organization}-{component/team}-{server | client}-{program}
String	getCompany()
String	getComponentTeam()
Boolean	getIsClient()
String	getOrganization()
String	getProgramName()
Boolean	isValid() Determine if all Vault Client Id parameters are populated, as determined by not null and not empty properties
VaultClientId	setCompany(String company)
VaultClientId	setComponentTeam(String componentTeam)
VaultClientId	setIsClient(Boolean isClient)
VaultClientId	setOrganization(String organization)
VaultClientId	setProgramName(String programName)

Methods inherited from class java.lang.Object

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

Constructor Detail

VaultClientId

public VaultClientId()

Instantiate the Vault Client Id and later set the parameters, such as using the builder pattern setters.

Example

 VaultClientId clientId = new VaultClientId()
                .setCompany("veeva")
                .setOrganization("vault")
                .setComponentTeam("devsupport")
                .setIsClient(true)
                .setProgramName("vapiltest");
 

VaultClientId

public VaultClientId(String company,
                     String organization,
                     String componentTeam,
                     Boolean isClient,
                     String programName)

Instantiate the Vault Client Id by passing in all parameters

Parameters:

company - The customer

organization - The customer organization

componentTeam - The development team

isClient - True if a client

programName - Interface name

Method Detail

getClientId

public String getClientId()

Retrieve the Vault Client Id in the form {company}-{organization}-{component/team}-{server | client}-{program}

Example: verteobiotech-vault-quality-client-myapp

Returns:

Fully formed Vault Client Id string

isValid

public Boolean isValid()

Determine if all Vault Client Id parameters are populated, as determined by not null and not empty properties

Returns:

True for valid

getCompany

public String getCompany()

setCompany

public VaultClientId setCompany(String company)

getOrganization

public String getOrganization()

setOrganization

public VaultClientId setOrganization(String organization)

getComponentTeam

public String getComponentTeam()

setComponentTeam

public VaultClientId setComponentTeam(String componentTeam)

getIsClient

public Boolean getIsClient()

setIsClient

public VaultClientId setIsClient(Boolean isClient)

getProgramName

public String getProgramName()

setProgramName

public VaultClientId setProgramName(String programName)