Package org.springframework.hateoas.mediatype.hal

Class HalLinkDiscoverer

java.lang.Object

org.springframework.hateoas.client.JsonPathLinkDiscoverer

org.springframework.hateoas.mediatype.hal.HalLinkDiscoverer

All Implemented Interfaces:

LinkDiscoverer, org.springframework.plugin.core.Plugin<org.springframework.http.MediaType>

Direct Known Subclasses:

HalFormsLinkDiscoverer

public class HalLinkDiscoverer
extends JsonPathLinkDiscoverer

LinkDiscoverer implementation based on HAL link structure.

Author:

Oliver Gierke, Greg Turnquist

Field Summary

Fields inherited from class org.springframework.hateoas.client.JsonPathLinkDiscoverer

mediaTypes

Constructor Summary

Constructors

Modifier	Constructor	Description
	HalLinkDiscoverer()	Constructor for MediaTypes.HAL_JSON.
protected	HalLinkDiscoverer(org.springframework.http.MediaType... mediaTypes)

Method Summary

Modifier and Type	Method	Description
protected Link	extractLink(Object element, LinkRelation rel)	Callback for each LinkDiscoverer to extract relevant attributes and generate a Link.
LinkDiscoverer	inspectEmbeddeds()	Creates a new LinkDiscoverer that looks up HAL links in the document recursively.

Methods inherited from class org.springframework.hateoas.client.JsonPathLinkDiscoverer

findLinksWithRel, findLinksWithRel, findLinkWithRel, findLinkWithRel, supports

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.hateoas.client.LinkDiscoverer

findLinksWithRel, findLinksWithRel, findLinkWithRel, findLinkWithRel, findRequiredLinkWithRel, findRequiredLinkWithRel

Constructor Details

HalLinkDiscoverer

public HalLinkDiscoverer()

Constructor for MediaTypes.HAL_JSON.

HalLinkDiscoverer

protected HalLinkDiscoverer(org.springframework.http.MediaType... mediaTypes)

Method Details

inspectEmbeddeds

public LinkDiscoverer inspectEmbeddeds()

Creates a new LinkDiscoverer that looks up HAL links in the document recursively. In other words, it also finds ones contained in the _embedded clause.

Returns:

will never be null.

Since:

3.0

extractLink

protected Link extractLink(Object element,
 LinkRelation rel)

Description copied from class: JsonPathLinkDiscoverer

Callback for each LinkDiscoverer to extract relevant attributes and generate a Link.

Overrides:

extractLink in class JsonPathLinkDiscoverer

Returns:

link