Package com.vonage.client

Class VonageClient.Builder

java.lang.Object

com.vonage.client.VonageClient.Builder

Enclosing class:

VonageClient

public static class VonageClient.Builder
extends Object

Builder for specifying the properties of the client.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
VonageClient.Builder	apiKey(String apiKey)	When setting an apiKey, it is also expected that apiSecret(String) and/or signatureSecret(String) will also be set.
VonageClient.Builder	apiSecret(String apiSecret)	When setting an apiSecret, it is also expected that apiKey(String) will also be set.
VonageClient.Builder	applicationId(String applicationId)	When setting an applicationId, it is also expected that the privateKeyContents will also be set.
VonageClient.Builder	applicationId(UUID applicationId)	Set the application ID for this client.
VonageClient	build()	Builds the client with this builder's parameters.
VonageClient.Builder	hashType(HashUtil.HashType hashType)	Sets the hash type to use for signing requests.
VonageClient.Builder	httpClient(org.apache.http.client.HttpClient httpClient)	Deprecated. This method will be removed in the next major release.
VonageClient.Builder	httpConfig(HttpConfig httpConfig)	Configure the HTTP client parameters.
VonageClient.Builder	privateKeyContents(byte[] privateKeyContents)	When setting the contents of your private key, it is also expected that applicationId(String) will also be set.
VonageClient.Builder	privateKeyContents(String privateKeyContents)	When setting the contents of your private key, it is also expected that applicationId(String) will also be set.
VonageClient.Builder	privateKeyPath(String privateKeyPath)	When setting the path of your private key, it is also expected that applicationId(String) will also be set.
VonageClient.Builder	privateKeyPath(Path privateKeyPath)	When setting the path of your private key, it is also expected that applicationId(String) will also be set.
VonageClient.Builder	signatureSecret(String signatureSecret)	When setting a signatureSecret, it is also expected that apiKey(String) will also be set.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

httpConfig

public VonageClient.Builder httpConfig(HttpConfig httpConfig)

Configure the HTTP client parameters.

Parameters:

httpConfig - Configuration options for the HttpWrapper.

Returns:

This builder.

httpClient

@Deprecated
public VonageClient.Builder httpClient(org.apache.http.client.HttpClient httpClient)

Deprecated.

This method will be removed in the next major release.

Set the underlying HTTP client instance.

Parameters:

httpClient - Custom implementation of HttpClient.

Returns:

This builder.

applicationId

public VonageClient.Builder applicationId(UUID applicationId)

Set the application ID for this client. This will be used alongside your private key (se via privateKeyContents) for authenticating requests.

Parameters:

applicationId - The application UUID.

Returns:

This builder.

Since:

7.11.0

applicationId

public VonageClient.Builder applicationId(String applicationId)

When setting an applicationId, it is also expected that the privateKeyContents will also be set.

Parameters:

applicationId - Used to identify each application.

Returns:

This builder.

apiKey

public VonageClient.Builder apiKey(String apiKey)

When setting an apiKey, it is also expected that apiSecret(String) and/or signatureSecret(String) will also be set.

Parameters:

apiKey - The API Key found in the dashboard for your account.

Returns:

This builder.

apiSecret

public VonageClient.Builder apiSecret(String apiSecret)

When setting an apiSecret, it is also expected that apiKey(String) will also be set.

Parameters:

apiSecret - The API Secret found in the dashboard for your account.

Returns:

This builder.

signatureSecret

public VonageClient.Builder signatureSecret(String signatureSecret)

When setting a signatureSecret, it is also expected that apiKey(String) will also be set.

Parameters:

signatureSecret - The Signature Secret found in the dashboard for your account.

Returns:

This builder.

hashType

public VonageClient.Builder hashType(HashUtil.HashType hashType)

Sets the hash type to use for signing requests.

Parameters:

hashType - The hashing strategy for signature keys as an enum.

Returns:

This builder.

privateKeyContents

public VonageClient.Builder privateKeyContents(byte[] privateKeyContents)

When setting the contents of your private key, it is also expected that applicationId(String) will also be set.

Parameters:

privateKeyContents - The contents of your private key used for JWT generation.

Returns:

This builder.

privateKeyContents

public VonageClient.Builder privateKeyContents(String privateKeyContents)

When setting the contents of your private key, it is also expected that applicationId(String) will also be set.

Parameters:

privateKeyContents - The contents of your private key used for JWT generation.

Returns:

This builder.

privateKeyPath

public VonageClient.Builder privateKeyPath(Path privateKeyPath)
                                    throws VonageUnableToReadPrivateKeyException

When setting the path of your private key, it is also expected that applicationId(String) will also be set.

Parameters:

privateKeyPath - The path to your private key used for JWT generation.

Returns:

This builder.

Throws:

VonageUnableToReadPrivateKeyException - if the private key could not be read from the file system.

privateKeyPath

public VonageClient.Builder privateKeyPath(String privateKeyPath)
                                    throws VonageUnableToReadPrivateKeyException

When setting the path of your private key, it is also expected that applicationId(String) will also be set.

Parameters:

privateKeyPath - The path to your private key used for JWT generation.

Returns:

This builder.

Throws:

VonageUnableToReadPrivateKeyException - if the private key could not be read from the file system.

build

public VonageClient build()

Builds the client with this builder's parameters.

Returns:

A new VonageClient from the stored builder options.

Throws:

VonageClientCreationException - if credentials aren't provided in a valid pairing or there were issues generating an JWTAuthMethod with the provided credentials.