hal

Type Members

1. case class Curie(name: String, href: String, templated: Boolean = true) extends Product with Serializable

   

   Curie support class

   Curie support class

   name

   Name of the curie.

   href

   URI for curie.

   templated

   Hint that curie is a Template URI. Default is true.

2. case class ForwardedBuilder(req: HttpRequest) extends Product with Serializable

   

   Builder to construct URI from X-Forwarded headers

   Builder to construct URI from X-Forwarded headers

   req

   The current HTTP Request

3. trait HalBrowserService extends AnyRef

   

   akka-http Route to expose a HAL Browser Mix in this trait with ~ halBrowserRoutes to expose a HAL Browser at /halbrowser

4. class HalException extends Exception

   

   HAL specific exception

5. trait HalProtocol extends DefaultJsonProtocol

   

   Spray JSON support for serializing Link and Curie instances.

6. case class Link(href: String, templated: Option[Boolean] = None, type: Option[String] = None, deprecation: Option[Boolean] = None, name: Option[String] = None, profile: Option[String] = None, title: Option[String] = None, hreflang: Option[String] = None) extends LinkT with Product with Serializable

   

   HAL Link

   HAL Link

   href

   URI to referenced resource.

   templated

   Hint that the href is a Template URI.

   type

   Hint for the media type of the referenced resource.

   deprecation

   Hints that the Resource is deprecated. Value is a URI to more information on the deprecation.

   name

   A secondary key for the resource.

   profile

   URI to a profile of the resource conforming to https://tools.ietf.org/html/rfc6906.

   title

   A string intended for labeling the resource.

   hreflang

   A string representing the language of the resource.

   See also

   https://tools.ietf.org/html/draft-kelly-json-hal-08#section-5

7. trait LinkT extends AnyRef

   

   Base trait for Link or a Collection of related Links

8. case class Links(links: Seq[Link]) extends LinkT with Product with Serializable

   

   Links collection for nesting links.

   Links collection for nesting links.

   links

   Seq of Links to use in builder.

9. case class ResourceBuilder(withCuries: Option[Seq[Curie]] = None, withData: Option[JsValue] = None, withLinks: Option[Map[String, LinkT]] = None, withEmbedded: Option[Map[String, Seq[JsValue]]] = None, withRequest: Option[HttpRequest] = None) extends HalProtocol with Product with Serializable

   

   ResourceBuilder for constructing HAL resources

   ResourceBuilder for constructing HAL resources

   withCuries

   Adds curies specific to this resource

   withData

   Adds the primary JSON properties and values

   withLinks

   Adds Links to _links property

   withEmbedded

   Adds Embedded resources to _embedded

   withRequest

   Enables X-Forwarded headers support for proxied requests

10. case class UrlBuilder(req: HttpRequest) extends Product with Serializable

    

    Builder to construct URI from HTTP Request URI parts

    Builder to construct URI from HTTP Request URI parts

    req

    The current HTTP Request