com.sap.cloud.sdk.cloudplatform.connectivity

Class HttpClientAccessor

java.lang.Object

com.sap.cloud.sdk.cloudplatform.connectivity.HttpClientAccessor

public final class HttpClientAccessor
extends Object

Accessor for HttpClients.

Method Summary

Modifier and Type	Method and Description
static org.apache.http.client.HttpClient	getHttpClient() Returns an HttpClient independent of any destination.
static org.apache.http.client.HttpClient	getHttpClient(HttpDestinationProperties destination) Returns an HttpClient for the given Destination.
static HttpClientCache	getHttpClientCache() Configures the HttpClientCache that is used by the #getHttpClient(String) and #getHttpClient(Destination) methods.
static HttpClientFactory	getHttpClientFactory() Returns the HttpClientFactory that is used when creating instances of HttpClient within the HttpClientAccessor.
static void	setHttpClientCache(HttpClientCache httpClientCache) Configures the HttpClientCache that is used by the #getHttpClient(String) and #getHttpClient(Destination) methods.
static void	setHttpClientFactory(HttpClientFactory httpClientFactory) Sets the HttpClientFactory that is used when creating instances of HttpClient within the HttpClientAccessor.
static io.vavr.control.Try<org.apache.http.client.HttpClient>	tryGetHttpClient() Returns an HttpClient independent of any destination.
static io.vavr.control.Try<org.apache.http.client.HttpClient>	tryGetHttpClient(HttpDestinationProperties destination) Returns a Try of an HttpClient for the given Destination.

Methods inherited from class java.lang.Object

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

Method Detail

getHttpClientFactory

@Nonnull
public static HttpClientFactory getHttpClientFactory()

Returns the HttpClientFactory that is used when creating instances of HttpClient within the HttpClientAccessor.

Returns:

The HttpClientFactory.

setHttpClientFactory

public static void setHttpClientFactory(@Nullable
                                        HttpClientFactory httpClientFactory)

Sets the HttpClientFactory that is used when creating instances of HttpClient within the HttpClientAccessor.

CAUTION: This factory is accessed concurrently. Therefore, you have to make sure that you do not introduce any concurrency issues when changing the factory. Furthermore, be aware that setting a custom factory will affect all consumers of the HttpClientAccessor within the application.

Parameters:

httpClientFactory - The global HttpClientFactory instance to be used. Use null to reset the factory.

getHttpClient

@Nonnull
public static org.apache.http.client.HttpClient getHttpClient()
                                                                throws HttpClientInstantiationException

Returns an HttpClient independent of any destination.

Returns:

An HttpClient independent of any destination.

Throws:

HttpClientInstantiationException - If there is an issue creating the HttpClient.

tryGetHttpClient

@Nonnull
public static io.vavr.control.Try<org.apache.http.client.HttpClient> tryGetHttpClient()

Returns an HttpClient independent of any destination.

Returns:

An HttpClient independent of any destination.

getHttpClient

@Nonnull
public static org.apache.http.client.HttpClient getHttpClient(@Nonnull
                                                                       HttpDestinationProperties destination)
                                                                throws DestinationAccessException,
                                                                       HttpClientInstantiationException

Returns an HttpClient for the given Destination. The instance may be cached.

Parameters:

destination - The destination to get the HttpClient for.

Returns:

An HttpClient for the given Destination. The instance may be cached.

Throws:

DestinationAccessException - If there is an issue accessing the Destination.

HttpClientInstantiationException - If there is an issue creating the HttpClient.

tryGetHttpClient

@Nonnull
public static io.vavr.control.Try<org.apache.http.client.HttpClient> tryGetHttpClient(@Nonnull
                                                                                               HttpDestinationProperties destination)

Returns a Try of an HttpClient for the given Destination. The instance may be cached.

Parameters:

destination - The destination to get the HttpClient for.

Returns:

A Try of an HttpClient for the given Destination. The instance may be cached.

getHttpClientCache

@Nonnull
public static HttpClientCache getHttpClientCache()

Configures the HttpClientCache that is used by the #getHttpClient(String) and #getHttpClient(Destination) methods.

By default this uses the RequestScopedHttpClientCache implementation, which caches an HttpClient for the life time of the current request.

CAUTION: This factory is accessed concurrently. Therefore, you have to make sure that you do not introduce any concurrency issues when changing the factory. Furthermore, be aware that setting a custom factory will affect all consumers of the HttpClientAccessor within the application.

setHttpClientCache

public static void setHttpClientCache(@Nonnull
                                      HttpClientCache httpClientCache)

Configures the HttpClientCache that is used by the #getHttpClient(String) and #getHttpClient(Destination) methods.

By default this uses the RequestScopedHttpClientCache implementation, which caches an HttpClient for the life time of the current request.

CAUTION: This factory is accessed concurrently. Therefore, you have to make sure that you do not introduce any concurrency issues when changing the factory. Furthermore, be aware that setting a custom factory will affect all consumers of the HttpClientAccessor within the application.