Package com.vonage.client

Class HttpWrapper

java.lang.Object

com.vonage.client.HttpWrapper

public class HttpWrapper
extends Object

Internal class that holds available authentication methods and a shared HttpClient.

Constructor Summary

Constructors

Constructor	Description
HttpWrapper(AuthCollection authCollection)
HttpWrapper(AuthMethod... authMethods)
HttpWrapper(HttpConfig httpConfig, AuthCollection authCollection)
HttpWrapper(HttpConfig httpConfig, AuthMethod... authMethods)

Method Summary

Modifier and Type	Method	Description
protected org.apache.http.impl.client.CloseableHttpClient	createHttpClient()
String	getApiKey()	Returns the API key if it was set when creating the client.
UUID	getApplicationId()	Returns the application ID if it was set when creating the client.
AuthCollection	getAuthCollection()	Gets the authentication settings used by the client.
String	getClientVersion()	Gets the SDK version.
org.apache.http.impl.client.CloseableHttpClient	getHttpClient()	Gets the underlying HttpClient instance used by the SDK.
HttpConfig	getHttpConfig()	Gets the HTTP configuration settings for the client.
String	getUserAgent()	Gets the User-Agent header to be used in HTTP requests.
void	setAuthCollection(AuthCollection authCollection)	Deprecated.
void	setHttpClient(org.apache.http.client.HttpClient httpClient)	Deprecated.
void	setHttpConfig(HttpConfig httpConfig)	Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Details

HttpWrapper

public HttpWrapper(HttpConfig httpConfig,
 AuthCollection authCollection)

HttpWrapper

public HttpWrapper(AuthCollection authCollection)

HttpWrapper

public HttpWrapper(AuthMethod... authMethods)

HttpWrapper

public HttpWrapper(HttpConfig httpConfig,
 AuthMethod... authMethods)

Method Details

getHttpClient

public org.apache.http.impl.client.CloseableHttpClient getHttpClient()

Gets the underlying HttpClient instance used by the SDK.

Returns:

The Apache HTTP client instance.

getApplicationId

public UUID getApplicationId()

Returns the application ID if it was set when creating the client.

Returns:

The application ID, or null if unavailable.

Since:

8.9.0

getApiKey

public String getApiKey()

Returns the API key if it was set when creating the client.

Returns:

The API key, or null if unavailable.

Since:

8.9.0

setHttpClient

@Deprecated
public void setHttpClient(org.apache.http.client.HttpClient httpClient)

Deprecated.

setHttpConfig

@Deprecated
public void setHttpConfig(HttpConfig httpConfig)

Deprecated.

getAuthCollection

public AuthCollection getAuthCollection()

Gets the authentication settings used by the client.

Returns:

The available authentication methods object.

setAuthCollection

@Deprecated
public void setAuthCollection(AuthCollection authCollection)

Deprecated.

createHttpClient

protected org.apache.http.impl.client.CloseableHttpClient createHttpClient()

getHttpConfig

public HttpConfig getHttpConfig()

Gets the HTTP configuration settings for the client.

Returns:

The request configuration settings object.

getUserAgent

public String getUserAgent()

Gets the User-Agent header to be used in HTTP requests. This includes the Java runtime and SDK version, as well as the custom user agent string, if present.

Returns:

The user agent string.

getClientVersion

public String getClientVersion()

Gets the SDK version.

Returns:

The SDK version as a string.

Since:

8.11.0