com.sap.cloud.sdk.cloudplatform.connectivity

Class HttpClientCache

java.lang.Object

com.sap.cloud.sdk.cloudplatform.connectivity.HttpClientCache

Direct Known Subclasses:

RequestScopedHttpClientCache, TimeScopedHttpClientCache

public abstract class HttpClientCache
extends Object

Provides caching functionality to the HttpClientAccessor.

Constructor Summary

Constructors

Constructor and Description
HttpClientCache()

Method Summary

Modifier and Type	Method and Description
protected abstract Optional<com.google.common.cache.Cache<CacheKey,org.apache.http.client.HttpClient>>	getCache() Getter for the cache to be used.
protected abstract CacheKey	getCacheKey() Method called in the #getClient(HttpClientFactory) method to create a CacheKey for no specific Destination.
protected abstract CacheKey	getCacheKey(Destination destination) Method called in the #getClient(Destination, HttpClientFactory) method to create a CacheKey for the given Destination.
protected org.apache.http.client.HttpClient	getHttpClient(Destination destination, HttpClientFactory httpClientFactory) Gets the HttpClient for the given Destination from this cache.
protected org.apache.http.client.HttpClient	getHttpClient(HttpClientFactory httpClientFactory) Gets the non-destination-specific HttpClient from this cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpClientCache

public HttpClientCache()

Method Detail

getHttpClient

@Nonnull
protected org.apache.http.client.HttpClient getHttpClient(@Nonnull
                                                                   Destination destination,
                                                                   @Nonnull
                                                                   HttpClientFactory httpClientFactory)
                                                            throws HttpClientInstantiationException

Gets the HttpClient for the given Destination from this cache.

If there is no HttpClient for destination it is created by using the HttpClientFactory.

Parameters:

destination - The Destination to get the HttpClient for.

httpClientFactory - The HttpClientFactory used to create a new HttpClient if no cached one can be found.

Returns:

The cached HttpClient for the given Destination.

Throws:

HttpClientInstantiationException - If there is an issue while retrieving the HttpClient.

getHttpClient

@Nonnull
protected org.apache.http.client.HttpClient getHttpClient(@Nonnull
                                                                   HttpClientFactory httpClientFactory)
                                                            throws HttpClientInstantiationException

Gets the non-destination-specific HttpClient from this cache.

If there is no generic HttpClient it is created by using the HttpClientFactory.

Parameters:

httpClientFactory - The HttpClientFactory used to create a new HttpClient if no cached one can be found.

Returns:

The cached HttpClient.

Throws:

HttpClientInstantiationException - If there is an issue while retrieving the HttpClient.

getCache

@Nonnull
protected abstract Optional<com.google.common.cache.Cache<CacheKey,org.apache.http.client.HttpClient>> getCache()
                                                                                                                  throws HttpClientInstantiationException

Getter for the cache to be used.

If the optional is empty a new HttpClient will be created and not cached.

Returns:

An Optional that may contain the cache to be used by the getHttpClient(Destination, HttpClientFactory) method.

Throws:

HttpClientInstantiationException - If there is an issue while accessing the cache.

getCacheKey

@Nonnull
protected abstract CacheKey getCacheKey(@Nonnull
                                                 Destination destination)
                                          throws HttpClientInstantiationException

Method called in the #getClient(Destination, HttpClientFactory) method to create a CacheKey for the given Destination.

Parameters:

destination - The destination to create a CacheKey for.

Returns:

The CacheKey for destination.

Throws:

HttpClientInstantiationException - If there is an issue while accessing the cache key.

getCacheKey

@Nonnull
protected abstract CacheKey getCacheKey()
                                          throws HttpClientInstantiationException

Method called in the #getClient(HttpClientFactory) method to create a CacheKey for no specific Destination.

Returns:

The CacheKey for a generic http client.

Throws:

HttpClientInstantiationException - If there is an issue while accessing the cache key.