jsonhomeclient

Type Members

1. case class DirectLinkRelationType(name: String) extends LinkRelationType with Product with Serializable

   

   For a direct link there is exactly one resource of that relation type associated with the API (e.g.

   For a direct link there is exactly one resource of that relation type associated with the API (e.g. "/widgets/").

   name

   the name of the link relation type (e.g. "http://example.org/rel/widgets")

2. class JsonHomeCache extends AnyRef

   

   A cache that regularly reloads a json-home document, so that queries on the json-home document are performed in memory and do not cause any I/O.

3. class JsonHomeClient extends PlayJsonSupport

   

   The client to load a json-home document and extract relevant information.

   The client to load a json-home document and extract relevant information. A client is responsible for a specific json-home host.

4. case class JsonHomeHost(uri: URI, jsonHomeUri: URI, rels: Seq[LinkRelationType]) extends Product with Serializable

   

   This class represents a system that provides a REST API and a json home document to describe its published resources.

   This class represents a system that provides a REST API and a json home document to describe its published resources.

   uri

   the URI to the host.

   jsonHomeUri

   the URI to the json home document

   rels

   the link relations provided by this host.

5. case class JsonHomeService(cachesByHost: Map[JsonHomeHost, JsonHomeCache]) extends Product with Serializable

   

   The json-home service allows to resolve urls (href/href-template) for a given json-home host and a given link releation type.

6. sealed abstract class LinkRelationType extends AnyRef

   

   Represents link relation types (as defined by [RFC5988]).

7. case class TemplateLinkRelationType(name: String) extends LinkRelationType with Product with Serializable

   

   For a template link there are zero to many such resources (e.g.

   For a template link there are zero to many such resources (e.g. "/widgets/{widget_id}"), see also RFC6570.

   name

   the name of the link relation type (e.g. "http://example.org/rel/widget")