org.springframework.restdocs.hypermedia

Interface LinkExtractor

public interface LinkExtractor

A LinkExtractor is used to extract links from a JSON response. The expected format of the links in the response is determined by the implementation.

Author:

Andy Wilkinson

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.util.List<Link>>	extractLinks(OperationResponse response) Extract the links from the given response, returning a Map of links where the keys are the link rels.

Method Detail

extractLinks

java.util.Map<java.lang.String,java.util.List<Link>> extractLinks(OperationResponse response)
                                                           throws java.io.IOException

Extract the links from the given response, returning a Map of links where the keys are the link rels.

Parameters:

response - The response from which the links are to be extracted

Returns:

The extracted links, keyed by rel

Throws:

java.io.IOException - if link extraction fails