Package org.springframework.hateoas.client

Class Traverson

java.lang.Object

org.springframework.hateoas.client.Traverson

public class Traverson
extends Object

Component to ease traversing hypermedia APIs by following links with relation types. Highly inspired by the equally named JavaScript library.

Since:

0.11

Author:

Oliver Gierke, Dietrich Schulten, Greg Turnquist, Tom Bunting, Manish Misra, Michael Wirth

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	Traverson.TraversalBuilder	Builder API to customize traversals.

Constructor Summary

Constructors

Constructor	Description
Traverson(URI baseUri, List<MediaType> mediaTypes)	Creates a new Traverson interacting with the given base URI and using the given MediaTypes to interact with the service.
Traverson(URI baseUri, MediaType... mediaTypes)	Creates a new Traverson interacting with the given base URI and using the given MediaTypes to interact with the service.

Method Summary

Modifier and Type	Method	Description
Traverson.TraversalBuilder	follow(String... rels)	Sets up a Traverson.TraversalBuilder to follow the given rels.
Traverson.TraversalBuilder	follow(Hop hop)	Sets up a Traverson.TraversalBuilder for a single rel with customized details.
static List<HttpMessageConverter<?>>	getDefaultMessageConverters(MediaType... mediaTypes)	Returns all HttpMessageConverters that will be registered for the given MediaTypes by default.
Traverson	setLinkDiscoverers(List<? extends LinkDiscoverer> discoverer)	Sets the LinkDiscoverers to use.
Traverson	setRestOperations(RestOperations operations)	Configures the RestOperations to use.

Methods inherited from class java.lang.Object

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

Constructor Details

Traverson

public Traverson(URI baseUri,
 MediaType... mediaTypes)

Creates a new Traverson interacting with the given base URI and using the given MediaTypes to interact with the service.

Parameters:

baseUri - must not be null.

mediaTypes - must not be null or empty.

Traverson

public Traverson(URI baseUri,
 List<MediaType> mediaTypes)

Creates a new Traverson interacting with the given base URI and using the given MediaTypes to interact with the service.

Parameters:

baseUri - must not be null.

mediaTypes - must not be null or empty.

Method Details

getDefaultMessageConverters

public static List<HttpMessageConverter<?>> getDefaultMessageConverters(MediaType... mediaTypes)

Returns all HttpMessageConverters that will be registered for the given MediaTypes by default.

Parameters:

mediaTypes - must not be null.

Returns:

setRestOperations

public Traverson setRestOperations(@Nullable
 RestOperations operations)

Configures the RestOperations to use. If null is provided a default RestTemplate will be used.

Parameters:

operations -

Returns:

setLinkDiscoverers

public Traverson setLinkDiscoverers(@Nullable
 List<? extends LinkDiscoverer> discoverer)

Sets the LinkDiscoverers to use. By default a single HalLinkDiscoverer is registered. If null is provided the default is reapplied.

Parameters:

discoverer - can be null.

Returns:

follow

public Traverson.TraversalBuilder follow(String... rels)

Sets up a Traverson.TraversalBuilder to follow the given rels.

Parameters:

rels - must not be null or empty.

Returns:

See Also:

• Traverson.TraversalBuilder

follow

public Traverson.TraversalBuilder follow(Hop hop)

Sets up a Traverson.TraversalBuilder for a single rel with customized details.

Parameters:

hop - must not be null

Returns: