Package com.vonage.client

Class VonageClient.Builder

java.lang.Object

com.vonage.client.VonageClient.Builder

Enclosing class:

VonageClient

public static class VonageClient.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
VonageClient.Builder	apiKey(java.lang.String apiKey)	When setting an apiKey, it is also expected that apiSecret(String) and/or signatureSecret(String) will also be set.
VonageClient.Builder	apiSecret(java.lang.String apiSecret)	When setting an apiSecret, it is also expected that apiKey(String) will also be set.
VonageClient.Builder	applicationId(java.lang.String applicationId)	When setting an applicationId, it is also expected that the privateKeyContents will also be set.
VonageClient	build()
VonageClient.Builder	httpClient(org.apache.http.client.HttpClient httpClient)
VonageClient.Builder	httpConfig(HttpConfig httpConfig)
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(java.lang.String privateKeyContents)	When setting the contents of your private key, it is also expected that applicationId(String) will also be set.
VonageClient.Builder	privateKeyPath(java.lang.String privateKeyPath)	When setting the path of your private key, it is also expected that applicationId(String) will also be set.
VonageClient.Builder	privateKeyPath(java.nio.file.Path privateKeyPath)	When setting the path of your private key, it is also expected that applicationId(String) will also be set.
VonageClient.Builder	signatureSecret(java.lang.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)

Parameters:

httpConfig - Configuration options for the HttpWrapper

Returns:

The VonageClient.Builder to keep building.

httpClient

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

Parameters:

httpClient - Custom implementation of HttpClient.

Returns:

The VonageClient.Builder to keep building.

applicationId

public VonageClient.Builder applicationId(java.lang.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:

The VonageClient.Builder to keep building.

apiKey

public VonageClient.Builder apiKey(java.lang.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:

The VonageClient.Builder to keep building.

apiSecret

public VonageClient.Builder apiSecret(java.lang.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:

The VonageClient.Builder to keep building.

signatureSecret

public VonageClient.Builder signatureSecret(java.lang.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:

The VonageClient.Builder to keep building.

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:

The VonageClient.Builder to keep building.

privateKeyContents

public VonageClient.Builder privateKeyContents(java.lang.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:

The VonageClient.Builder to keep building.

privateKeyPath

public VonageClient.Builder privateKeyPath(java.nio.file.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:

The VonageClient.Builder to keep building.

Throws:

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

privateKeyPath

public VonageClient.Builder privateKeyPath(java.lang.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:

The VonageClient.Builder to keep building.

Throws:

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

build

public VonageClient build()

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.