org.springframework.hateoas.core

Class JsonPathLinkDiscoverer

java.lang.Object

org.springframework.hateoas.core.JsonPathLinkDiscoverer

All Implemented Interfaces:

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

Direct Known Subclasses:

AlpsLinkDiscoverer, HalLinkDiscoverer

public class JsonPathLinkDiscoverer
extends Object
implements LinkDiscoverer

LinkDiscoverer that uses JsonPath to find links inside a representation.

Author:

Oliver Gierke

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<Link>	findLinksWithRel(String rel, InputStream representation) Returns all links with the given relation type found in the given InputStream representation.
List<Link>	findLinksWithRel(String rel, String representation) Returns all links with the given relation type found in the given String representation.
Link	findLinkWithRel(String rel, InputStream representation) Finds a single link with the given relation type in the given InputStream representation.
Link	findLinkWithRel(String rel, String representation) Finds a single link with the given relation type 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

Constructor Detail

JsonPathLinkDiscoverer

public JsonPathLinkDiscoverer(String pathTemplate,
                              MediaType mediaType,
                              MediaType... others)

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.

mediaType - the primary MediaTypes to support.

additional - MediaTypes to support.

Method Detail

findLinkWithRel

public Link findLinkWithRel(String rel,
                            String representation)

Description copied from interface: LinkDiscoverer

Finds a single link with the given relation type in the given String representation.

Specified by:

findLinkWithRel in interface LinkDiscoverer

Parameters:

rel - must not be null or empty.

representation - must not be null or empty.

Returns:

the first link with the given relation type found, or null if none was found.

findLinkWithRel

public Link findLinkWithRel(String rel,
                            InputStream representation)

Description copied from interface: LinkDiscoverer

Finds a single link with the given relation type in the given InputStream representation.

Specified by:

findLinkWithRel in interface LinkDiscoverer

Parameters:

rel - must not be null or empty.

representation - must not be null or empty.

Returns:

the first link with the given relation type found, or null if none was found.

findLinksWithRel

public List<Link> findLinksWithRel(String rel,
                                   String representation)

Description copied from interface: LinkDiscoverer

Returns all links with the given relation type found in the given String representation.

Specified by:

findLinksWithRel in interface LinkDiscoverer

Parameters:

rel - must not be null or empty.

representation - must not be null or empty.

Returns:

findLinksWithRel

public List<Link> findLinksWithRel(String rel,
                                   InputStream representation)

Description copied from interface: LinkDiscoverer

Returns all links with the given relation type found in the given InputStream representation.

Specified by:

findLinksWithRel in interface LinkDiscoverer

Parameters:

rel - must not be null or empty.

representation - must not be null or empty.

Returns:

supports

public boolean supports(MediaType delimiter)

Specified by:

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