org.seedstack.seed.rest.hal

Class HalRepresentation

java.lang.Object

org.seedstack.seed.rest.hal.HalRepresentation

Direct Known Subclasses:

HalDefaultRepresentation

public class HalRepresentation
extends Object

An HAL resource representation as defined in the RFC specification.

It's a resource object with two reserved properties:

• "_links": links to other resources
• "_embedded": embedded resources

For instance:

 GET /orders/523 HTTP/1.1
 Host: example.org
 Accept: application/hal+json

 HTTP/1.1 200 OK
 Content-Type: application/hal+json

 {
   "_links": {
     "self": { "href": "/orders/523" },
     "warehouse": { "href": "/warehouse/56" },
     "invoice": { "href": "/invoices/873" }
   },
   "currency": "USD",
   "status": "shipped",
   "total": 10.20
 }
 

Constructor Summary

Constructors

Constructor and Description
HalRepresentation() Default constructor required by Jackson.

Method Summary

Modifier and Type	Method and Description
HalRepresentation	embedded(String rel, Object embedded) Adds an embedded resource or array of resources.
Map<String,Object>	getEmbedded() Returns the embedded resources.
Object	getLink(String rel) Returns the resource's links.
Map<String,Object>	getLinks() Returns the resource's links.
HalRepresentation	link(String rel, Link link) Adds a link with the specified rel and link representation.
HalRepresentation	link(String rel, String href) Adds a link with the specified rel and href.
HalRepresentation	self(Link link) Adds the self link.
HalRepresentation	self(String href) Adds the self link.

Methods inherited from class java.lang.Object

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

Constructor Detail

HalRepresentation

public HalRepresentation()

Default constructor required by Jackson.

Method Detail

self

public HalRepresentation self(String href)

Adds the self link.

Parameters:

href - the resource href

Returns:

itself

self

public HalRepresentation self(Link link)

Adds the self link.

Parameters:

link - the link

Returns:

itself

link

public HalRepresentation link(String rel,
                              String href)

Adds a link with the specified rel and href.

Parameters:

rel - the rel

href - the href

Returns:

itself

link

public HalRepresentation link(String rel,
                              Link link)

Adds a link with the specified rel and link representation.

Parameters:

rel - the rel

link - the link representation

Returns:

itself

getLink

public Object getLink(String rel)

Returns the resource's links.

Returns:

map of links

getLinks

public Map<String,Object> getLinks()

Returns the resource's links.

Returns:

map of links

embedded

public HalRepresentation embedded(String rel,
                                  Object embedded)

Adds an embedded resource or array of resources.

Parameters:

rel - the relation type

embedded - the resource (can be an array of resources)

Returns:

itself

getEmbedded

public Map<String,Object> getEmbedded()

Returns the embedded resources.

Returns:

the map of embedded resources