org.springframework.hateoas.client

Class JsonPathLinkDiscoverer

java.lang.Object

org.springframework.hateoas.client.JsonPathLinkDiscoverer

All Implemented Interfaces:

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

Direct Known Subclasses:

AlpsLinkDiscoverer, CollectionJsonLinkDiscoverer, HalLinkDiscoverer

public class JsonPathLinkDiscoverer
extends Object
implements LinkDiscoverer

LinkDiscoverer that uses JsonPath to find links inside a representation.

Author:

Oliver Gierke, Greg Turnquist

Constructor Summary

Constructors

Constructor and Description
JsonPathLinkDiscoverer(String pathTemplate, MediaType... mediaTypes) Creates a new JsonPathLinkDiscoverer using the given path template supporting the given MediaType.

Method Summary

Modifier and Type	Method and Description
protected Link	extractLink(Object element, LinkRelation rel) Callback for each LinkDiscoverer to extract relevant attributes and generate a Link.
Links	findLinksWithRel(LinkRelation relation, InputStream representation) Returns all links with the given LinkRelation found in the given InputStream representation.
Links	findLinksWithRel(LinkRelation relation, String representation) Returns all links with the given LinkRelation found in the given String representation.
Optional<Link>	findLinkWithRel(LinkRelation relation, InputStream representation) Finds a single link with the given LinkRelation in the given InputStream representation.
Optional<Link>	findLinkWithRel(LinkRelation relation, String representation) Finds a single link with the given LinkRelation in the given String representation.
boolean	supports(MediaType delimiter)

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 Detail

JsonPathLinkDiscoverer

public JsonPathLinkDiscoverer(String pathTemplate,
                              MediaType... mediaTypes)

Creates a new JsonPathLinkDiscoverer using the given path template supporting the given MediaType. The template has to contain a single %s placeholder which will be replaced by the relation type.

Parameters:

pathTemplate - must not be null or empty and contain a single placeholder.

mediaTypes - the MediaTypes to support.

Method Detail

findLinkWithRel

public Optional<Link> findLinkWithRel(LinkRelation relation,
                                      String representation)

Description copied from interface: LinkDiscoverer

Finds a single link with the given LinkRelation in the given String representation.

Specified by:

findLinkWithRel in interface LinkDiscoverer

Parameters:

relation - must not be null.

representation - must not be null.

Returns:

the first link with the given relation type found, or Optional.empty() if none was found.

findLinkWithRel

public Optional<Link> findLinkWithRel(LinkRelation relation,
                                      InputStream representation)

Description copied from interface: LinkDiscoverer

Finds a single link with the given LinkRelation in the given InputStream representation.

Specified by:

findLinkWithRel in interface LinkDiscoverer

Parameters:

relation - must not be null.

representation - must not be null.

Returns:

the first Link with the given LinkRelation found, or Optional.empty() if none was found.

findLinksWithRel

public Links findLinksWithRel(LinkRelation relation,
                              String representation)

Description copied from interface: LinkDiscoverer

Returns all links with the given LinkRelation found in the given String representation.

Specified by:

findLinksWithRel in interface LinkDiscoverer

Parameters:

relation - must not be null.

representation - must not be null.

Returns:

will never be null.

findLinksWithRel

public Links findLinksWithRel(LinkRelation relation,
                              InputStream representation)

Description copied from interface: LinkDiscoverer

Returns all links with the given LinkRelation found in the given InputStream representation.

Specified by:

findLinksWithRel in interface LinkDiscoverer

Parameters:

relation - must not be null.

representation - must not be null.

Returns:

will never be null.

supports

public boolean supports(@NonNull
                        MediaType delimiter)

Specified by:

supports in interface org.springframework.plugin.core.Plugin<MediaType>

extractLink

protected Link extractLink(Object element,
                           LinkRelation rel)

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

Parameters:

element -

rel -

Returns:

link