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.

Constructor Summary

Constructors

Constructor and Description
HttpClientAccessor()

Method Summary

Modifier and Type	Method and Description
static org.apache.http.client.HttpClient	getHttpClient()
static org.apache.http.client.HttpClient	getHttpClient(Destination destination)
static org.apache.http.client.HttpClient	getHttpClient(String destinationName)
static HttpClientCache	getHttpClientCache() Configures the HttpClientCache that is used by the #getHttpClient(String) and #getHttpClient(Destination) methods.
static HttpClientFactory	getHttpClientProvider() Configures 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	setHttpClientProvider(HttpClientFactory httpClientProvider) Configures the HttpClientFactory that is used when creating instances of HttpClient within the HttpClientAccessor.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpClientAccessor

public HttpClientAccessor()

Method Detail

getHttpClient

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

Returns:

An HttpClient independent of any destination.

Throws:

HttpClientInstantiationException - If there is an issue creating the HttpClient.

getHttpClient

@Nonnull
public static org.apache.http.client.HttpClient getHttpClient(@Nonnull
                                                                        String destinationName)
                                                                 throws DestinationNotFoundException,
                                                                        DestinationAccessException,
                                                                        HttpClientInstantiationException

Parameters:

destinationName - The name of the destination to get the HttpClient for.

Returns:

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

Throws:

DestinationNotFoundException - If no Destination can be found for the given name.

DestinationAccessException - If there is an issue accessing the Destination.

HttpClientInstantiationException - If there is an issue creating the HttpClient.

getHttpClient

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

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.

getHttpClientProvider

@Nonnull
public static HttpClientFactory getHttpClientProvider()

Configures 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.

setHttpClientProvider

public static void setHttpClientProvider(@Nonnull
                                         HttpClientFactory httpClientProvider)

Configures 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.

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.