Package com.vonage.client

Class HttpConfig

java.lang.Object

com.vonage.client.HttpConfig

public class HttpConfig
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpConfig.Builder	Builder for configuring the base URI and timeout of the client.

Method Summary

Modifier and Type	Method	Description
static HttpConfig.Builder	builder()	Entrypoint for creating a custom HttpConfig.
static HttpConfig	defaultConfig()	Creates a standard HttpConfig.
String	getApiBaseUri()
String	getApiEuBaseUri()
String	getCustomUserAgent()	Returns the custom user agent string that will be appended to the default one, if set.
URI	getProxy()	Returns the proxy URL to use for the underlying HTTP client configuration.
URI	getRegionalBaseUri(ApiRegion region)	Returns the base URI for the specified region.
String	getRestBaseUri()
int	getTimeoutMillis()	Gets the timeout setting for the underlying HTTP client configuration.
String	getVersionedApiBaseUri(String version)	Deprecated.
String	getVersionedApiEuBaseUri(String version)	Deprecated.
String	getVersionedRestBaseUri(String version)	Deprecated.
String	getVersionedVideoBaseUri(String version)	Deprecated.
String	getVideoBaseUri()
boolean	isDefaultApiBaseUri()	Deprecated.
boolean	isDefaultApiEuBaseUri()	Deprecated.
boolean	isDefaultRestBaseUri()	Deprecated.
boolean	isDefaultVideoBaseUri()	Deprecated.

Methods inherited from class java.lang.Object

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

Method Details

getTimeoutMillis

public int getTimeoutMillis()

Gets the timeout setting for the underlying HTTP client configuration.

Returns:

The request timeout in milliseconds.

Since:

7.8.0

getApiBaseUri

public String getApiBaseUri()

getRestBaseUri

public String getRestBaseUri()

getVideoBaseUri

public String getVideoBaseUri()

getApiEuBaseUri

public String getApiEuBaseUri()

getRegionalBaseUri

public URI getRegionalBaseUri(ApiRegion region)

Returns the base URI for the specified region.

Parameters:

region - The region as an enum.

Returns:

The base URI for the given region.

Since:

8.11.0

getCustomUserAgent

public String getCustomUserAgent()

Returns the custom user agent string that will be appended to the default one, if set.

Returns:

The custom user agent string to append, or null if not set.

Since:

8.11.0

getProxy

public URI getProxy()

Returns the proxy URL to use for the underlying HTTP client configuration.

Returns:

The proxy URI, or null if not set.

Since:

8.15.0

isDefaultApiBaseUri

@Deprecated
public boolean isDefaultApiBaseUri()

Deprecated.

isDefaultRestBaseUri

@Deprecated
public boolean isDefaultRestBaseUri()

Deprecated.

isDefaultApiEuBaseUri

@Deprecated
public boolean isDefaultApiEuBaseUri()

Deprecated.

isDefaultVideoBaseUri

@Deprecated
public boolean isDefaultVideoBaseUri()

Deprecated.

getVersionedApiBaseUri

@Deprecated
public String getVersionedApiBaseUri(String version)

Deprecated.

getVersionedRestBaseUri

@Deprecated
public String getVersionedRestBaseUri(String version)

Deprecated.

getVersionedApiEuBaseUri

@Deprecated
public String getVersionedApiEuBaseUri(String version)

Deprecated.

getVersionedVideoBaseUri

@Deprecated
public String getVersionedVideoBaseUri(String version)

Deprecated.

defaultConfig

public static HttpConfig defaultConfig()

Creates a standard HttpConfig.

Returns:

an HttpConfig object with sensible defaults.

builder

public static HttpConfig.Builder builder()

Entrypoint for creating a custom HttpConfig.

Returns:

A new Builder.