Package org.apache.juneau.bean.hal

package org.apache.juneau.bean.hal

Juneau @Marshalled types for the HAL (Hypertext Application Language) hypermedia format, also covered by draft-kelly-json-hal-08.

Overview

HAL is a JSON-based hypermedia format used by RESTful APIs to express links and embedded resources alongside the payload itself. This module provides typed Juneau beans modeling the HAL wire format — no marshaller is needed; the existing JsonSerializer / JsonParser already produce and consume application/hal+json. The matching ContentType constant is org.apache.juneau.http.header.ContentType#APPLICATION_HAL_JSON (in juneau-rest-common).

Bean Classes

• HalResource - Top-level HAL resource. Carries _links, _embedded, and arbitrary payload fields.
• HalLink - HAL Link Object with the 8 spec fields.
• HalLinkArray - LinkedList<HalLink> used as the multi-link branch inside an _links map.
• HalResourceArray - LinkedList<HalResource> used as the multi-resource branch inside an _embedded map.
• HalLinkOrArraySwap - ObjectSwap that materializes each _links value as either a single HalLink (JSON object) or a HalLinkArray (JSON array) per spec.
• HalResourceOrArraySwap - The _embedded analogue.

Example

// Build a HAL resource with a self link, a curies array, and embedded items. HalResource order = new HalResource() .addLink("self", new HalLink().setHref("/orders/123")) .addLinks("curies", new HalLink().setName("acme").setHref("https://acme.example/{rel}").setTemplated(true)) .set("total", 99.50); String json = JsonSerializer.DEFAULT.write(order); HalResource back = JsonParser.DEFAULT.read(json, HalResource.class);

See Also:

• HAL Specification
• draft-kelly-json-hal-08
• juneau-bean-hal

Related Packages

Package	Description
org.apache.juneau.bean	Data Transfer Objects

Classes

Class	Description
HalLink	Represents a HAL Link Object as defined by draft-kelly-json-hal-08 § 5.
HalLinkArray	Represents a list of HalLink objects.
HalLinkOrArraySwap	Per-property ObjectSwap applied to HAL _links maps so that each map entry round-trips as either a single HalLink (JSON object) or a HalLinkArray (JSON array) per the spec.
HalResource	Represents a HAL Resource Object as defined by draft-kelly-json-hal-08 § 4.
HalResourceArray	Represents a list of HalResource objects.
HalResourceOrArraySwap	Per-property ObjectSwap applied to HAL _embedded maps so that each map entry round-trips as either a single HalResource (JSON object) or a HalResourceArray (JSON array) per the spec.