de.otto.jsonhome.client

Interface JsonHomeClient

All Known Implementing Classes:

HttpJsonHomeClient, SimpleJsonHomeClient

public interface JsonHomeClient

Client used to retrieve JsonHome documents from different sources. If the json-home document is retrieved using HTTP GET, the implementation should respect the HTTP cache headers returned by the server.

Since:

26.10.12

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.

Method Detail

updateAndGet

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.

Parameters:

uri - the URI uniquely identifying the JsonHome instance.

Returns:

JsonHome

Throws:

NotFoundException - if the requested JsonHome was not found.

JsonHomeClientException - different kind of runtime exceptions, depending on the reason why processing of the request failed. Most notably: HttpStatusCodeException indication a HTTP client or server error in HTTP based implementations of the JsonHomeClient, or IllegalArgumentException in case of an invalid json-home document.

get

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.

Parameters:

uri - the URI of the JsonHome document.

Returns:

JsonHome

Throws:

NotFoundException - if the requested JsonHome was not found.

JsonHomeClientException - different kind of runtime exceptions, depending on the reason why processing of the request failed. Most notably: HttpStatusCodeException indication a HTTP client or server error in HTTP based implementations of the JsonHomeClient, or IllegalArgumentException in case of an invalid json-home document.

shutdown

void shutdown()

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