de.otto.jsonhome.client

Class HttpJsonHomeClient

java.lang.Object

de.otto.jsonhome.client.HttpJsonHomeClient

All Implemented Interfaces:

JsonHomeClient

public class HttpJsonHomeClient
extends java.lang.Object
implements JsonHomeClient

A JsonHomeClient used to get json-home documents from an URI via HTTP. This implementation is relying on Apache's CachingHttpClient.

Since:

26.10.12

Constructor Summary

Constructors

Constructor and Description
HttpJsonHomeClient() Constructs a default HttpJsonHomeClient build on top of a CachingHttpClient with in-memory storage.
HttpJsonHomeClient(org.apache.http.client.HttpClient httpClient, org.apache.http.impl.client.cache.CacheConfig cacheConfig) Constructs a HttpJsonHomeClient using a HttpClient and a CacheConfig.
HttpJsonHomeClient(org.apache.http.client.HttpClient httpClient, org.apache.http.client.cache.HttpCacheStorage storage, org.apache.http.impl.client.cache.CacheConfig cacheConfig) Constructs a caching HttpJsonHomeClient using a HttpClient, HttpCacheStorage and a CacheConfig.

Method Summary

Modifier and Type	Method and Description
de.otto.jsonhome.model.JsonHome	get(java.net.URI uri) Gets the JsonHome document associated to the specified URI.
void	shutdown() Shutdown the client and dispose all resources.
de.otto.jsonhome.model.JsonHome	updateAndGet(java.net.URI uri) Updates the (possibly cached) JsonHome instance identified by the URI and returns the updated instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpJsonHomeClient

public HttpJsonHomeClient()

Constructs a default HttpJsonHomeClient build on top of a CachingHttpClient with in-memory storage.

HttpJsonHomeClient

public HttpJsonHomeClient(org.apache.http.client.HttpClient httpClient,
                          org.apache.http.impl.client.cache.CacheConfig cacheConfig)

Constructs a HttpJsonHomeClient using a HttpClient and a CacheConfig. Internally, these two are used to build a CachingHttpClient using a BasicHttpCacheStorage.

Parameters:

httpClient - non-caching HttpClient used to get resources.

cacheConfig - configuration of the HttpCacheStorage

HttpJsonHomeClient

public HttpJsonHomeClient(org.apache.http.client.HttpClient httpClient,
                          org.apache.http.client.cache.HttpCacheStorage storage,
                          org.apache.http.impl.client.cache.CacheConfig cacheConfig)

Constructs a caching HttpJsonHomeClient using a HttpClient, HttpCacheStorage and a CacheConfig.

Parameters:

httpClient - non-caching HttpClient used to get resources.

storage - the HttpCacheStorage used to cache HTTP responses.

cacheConfig - configuration of the HttpCacheStorage

Method Detail

updateAndGet

public de.otto.jsonhome.model.JsonHome updateAndGet(java.net.URI uri)

Updates the (possibly cached) JsonHome instance identified by the URI and returns the updated instance.

Specified by:

updateAndGet in interface JsonHomeClient

Parameters:

uri - the URI uniquely identifying the JsonHome instance.

Returns:

JsonHome

get

public de.otto.jsonhome.model.JsonHome get(java.net.URI uri)

Gets the JsonHome document associated to the specified URI. The returned instance may be returned from a cache.

Specified by:

get in interface JsonHomeClient

Parameters:

uri - the URI of the JsonHome document.

Returns:

JsonHome

shutdown

public void shutdown()

Description copied from interface: JsonHomeClient

Shutdown the client and dispose all resources. Should be called when shutting down the client.

Specified by:

shutdown in interface JsonHomeClient