Package com.bandwidth

Class BandwidthClient

java.lang.Object

com.bandwidth.BandwidthClient

All Implemented Interfaces:

Configuration

public final class BandwidthClient
extends Object
implements Configuration

Gateway class for the library. This class acts as a factory for Controllers. It holds the state of the SDK.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BandwidthClient.Builder	Class to build instances of BandwidthClient.

Method Summary

Modifier and Type	Method	Description
Map<String,AuthManager>	getAuthManagers()	The list of auth managers.
String	getBaseUri()	Get base URI by current environment.
String	getBaseUri(Server server)	Get base URI by current environment.
String	getBaseUrl()	baseUrl value.
Environment	getEnvironment()	Current API environment.
HttpClient	getHttpClient()	The HTTP Client instance to use for making HTTP requests.
ReadonlyHttpClientConfiguration	getHttpClientConfig()	Http Client Configuration instance.
MessagingBasicAuthCredentials	getMessagingBasicAuthCredentials()	The credentials to use with MessagingBasicAuth.
MessagingClient	getMessagingClient()	Provides access to messagingClient Client.
MultiFactorAuthBasicAuthCredentials	getMultiFactorAuthBasicAuthCredentials()	The credentials to use with MultiFactorAuthBasicAuth.
MultiFactorAuthClient	getMultiFactorAuthClient()	Provides access to multiFactorAuthClient Client.
PhoneNumberLookupBasicAuthCredentials	getPhoneNumberLookupBasicAuthCredentials()	The credentials to use with PhoneNumberLookupBasicAuth.
PhoneNumberLookupClient	getPhoneNumberLookupClient()	Provides access to phoneNumberLookupClient Client.
VoiceBasicAuthCredentials	getVoiceBasicAuthCredentials()	The credentials to use with VoiceBasicAuth.
VoiceClient	getVoiceClient()	Provides access to voiceClient Client.
WebRtcBasicAuthCredentials	getWebRtcBasicAuthCredentials()	The credentials to use with WebRtcBasicAuth.
WebRtcClient	getWebRtcClient()	Provides access to webRtcClient Client.
BandwidthClient.Builder	newBuilder()	Builds a new BandwidthClient.Builder object.
static void	shutdown()	Shutdown the underlying HttpClient instance.
long	timeout()	Deprecated. This method will be removed in a future version.
String	toString()	Converts this BandwidthClient into string format.

Methods inherited from class java.lang.Object

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

Method Detail

shutdown

public static void shutdown()

Shutdown the underlying HttpClient instance.

getMessagingClient

public MessagingClient getMessagingClient()

Provides access to messagingClient Client.

Returns:

Returns the MessagingClient instance

getMultiFactorAuthClient

public MultiFactorAuthClient getMultiFactorAuthClient()

Provides access to multiFactorAuthClient Client.

Returns:

Returns the MultiFactorAuthClient instance

getPhoneNumberLookupClient

public PhoneNumberLookupClient getPhoneNumberLookupClient()

Provides access to phoneNumberLookupClient Client.

Returns:

Returns the PhoneNumberLookupClient instance

getVoiceClient

public VoiceClient getVoiceClient()

Provides access to voiceClient Client.

Returns:

Returns the VoiceClient instance

getWebRtcClient

public WebRtcClient getWebRtcClient()

Provides access to webRtcClient Client.

Returns:

Returns the WebRtcClient instance

getEnvironment

public Environment getEnvironment()

Current API environment.

Specified by:

getEnvironment in interface Configuration

Returns:

environment

getBaseUrl

public String getBaseUrl()

baseUrl value.

Specified by:

getBaseUrl in interface Configuration

Returns:

baseUrl

getHttpClient

public HttpClient getHttpClient()

The HTTP Client instance to use for making HTTP requests.

Returns:

httpClient

getHttpClientConfig

public ReadonlyHttpClientConfiguration getHttpClientConfig()

Http Client Configuration instance.

Specified by:

getHttpClientConfig in interface Configuration

Returns:

httpClientConfig

getMessagingBasicAuthCredentials

public MessagingBasicAuthCredentials getMessagingBasicAuthCredentials()

The credentials to use with MessagingBasicAuth.

Specified by:

getMessagingBasicAuthCredentials in interface Configuration

Returns:

messagingBasicAuthCredentials

getMultiFactorAuthBasicAuthCredentials

public MultiFactorAuthBasicAuthCredentials getMultiFactorAuthBasicAuthCredentials()

The credentials to use with MultiFactorAuthBasicAuth.

Specified by:

getMultiFactorAuthBasicAuthCredentials in interface Configuration

Returns:

multiFactorAuthBasicAuthCredentials

getPhoneNumberLookupBasicAuthCredentials

public PhoneNumberLookupBasicAuthCredentials getPhoneNumberLookupBasicAuthCredentials()

The credentials to use with PhoneNumberLookupBasicAuth.

Specified by:

getPhoneNumberLookupBasicAuthCredentials in interface Configuration

Returns:

phoneNumberLookupBasicAuthCredentials

getVoiceBasicAuthCredentials

public VoiceBasicAuthCredentials getVoiceBasicAuthCredentials()

The credentials to use with VoiceBasicAuth.

Specified by:

getVoiceBasicAuthCredentials in interface Configuration

Returns:

voiceBasicAuthCredentials

getWebRtcBasicAuthCredentials

public WebRtcBasicAuthCredentials getWebRtcBasicAuthCredentials()

The credentials to use with WebRtcBasicAuth.

Specified by:

getWebRtcBasicAuthCredentials in interface Configuration

Returns:

webRtcBasicAuthCredentials

getAuthManagers

public Map<String,AuthManager> getAuthManagers()

The list of auth managers.

Returns:

authManagers

timeout

@Deprecated
public long timeout()

Deprecated.

This method will be removed in a future version. Use getHttpClientConfig() instead.

The timeout to use for making HTTP requests.

Specified by:

timeout in interface Configuration

Returns:

timeout

getBaseUri

public String getBaseUri(Server server)

Get base URI by current environment.

Specified by:

getBaseUri in interface Configuration

Parameters:

server - Server for which to get the base URI

Returns:

Processed base URI

getBaseUri

public String getBaseUri()

Get base URI by current environment.

Specified by:

getBaseUri in interface Configuration

Returns:

Processed base URI

toString

public String toString()

Converts this BandwidthClient into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

newBuilder

public BandwidthClient.Builder newBuilder()

Builds a new BandwidthClient.Builder object. Creates the instance with the state of the current client.

Returns:

a new BandwidthClient.Builder object