Spring/spring-hateoas
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

#840 - LinkDiscoverer now exposes methods to lookup required links.

Browse Source 
Introduced findRequiredLinkWithRel(…) methods on LinkDiscoverer to delegate to existing lookups but resolving the Optional into an IllegalArgumentException.

Fixed JsonPathLinkDiscoverer to return no links at all if a required path segment in the payload cannot be found which would have triggered a PathNotFoundException before.

Polished parameter names and JavaDoc. Moved base test cases into the right packages.
This commit is contained in:
Oliver Drotbohm
2019-02-28 16:52:35 +01:00
parent df4e099458
commit 81af032810
9 changed files with 102 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
src/main/java/org/springframework/hateoas/client/JsonPathLinkDiscoverer.java
View File

@@ -35,6 +35,7 @@ import org.springframework.util.Assert;
import com.jayway.jsonpath.InvalidPathException;
import com.jayway.jsonpath.JsonPath;
import com.jayway.jsonpath.PathNotFoundException;
/**
* {@link LinkDiscoverer} that uses {@link JsonPath} to find links inside a representation.
@@ -108,10 +109,14 @@ public class JsonPathLinkDiscoverer implements LinkDiscoverer {
Assert.notNull(relation, "LinkRelation must not be null!");
try {
Object parseResult = getExpression(relation).read(representation);
return createLinksFrom(parseResult, relation);
} catch (IOException e) {
throw new RuntimeException(e);
} catch (IOException o_O) {
throw new RuntimeException(o_O);
} catch (PathNotFoundException o_O) {
return Links.NONE;
}
}

78
src/main/java/org/springframework/hateoas/client/LinkDiscoverer.java
View File

@@ -31,76 +31,112 @@ import org.springframework.plugin.core.Plugin;
*/
public interface LinkDiscoverer extends Plugin<MediaType> {
/**
* Finds a single link with the given {@link LinkRelation} in the given {@link String} representation.
*
* @param rel must not be {@literal null}.
* @param representation must not be {@literal null}.
* @return the first link with the given relation type found, or {@link Optional#empty()} if none was found.
*/
Optional<Link> findLinkWithRel(LinkRelation rel, String representation);
/**
* Finds a single link with the given relation type in the given {@link String} representation.
*
* @param rel must not be {@literal null} or empty.
* @param representation must not be {@literal null}.
* @return the first link with the given relation type found, or {@literal null} if none was found.
* @return the first {@link Link} with the given link relation found, or {@link Optional#empty()} if none was found.
*/
default Optional<Link> findLinkWithRel(String rel, String representation) {
return findLinkWithRel(LinkRelation.of(rel), representation);
}
Optional<Link> findLinkWithRel(LinkRelation rel, String representation);
/**
* Finds a single link with the given relation type in the given {@link InputStream} representation.
* Finds a single link with the given relation in the given {@link String} representation.
*
* @param rel must not be {@literal null} or empty.
* @param relation must not be {@literal null}.
* @param representation must not be {@literal null}.
* @return the first link with the given relation type found, or {@literal null} if none was found.
* @return the first link with the given relation type found.
* @throws IllegalArgumentException if no {@link Link} for the given {@link LinkRelation} can be found.
*/
default Optional<Link> findLinkWithRel(String rel, InputStream representation) {
return findLinkWithRel(LinkRelation.of(rel), representation);
default Link findRequiredLinkWithRel(LinkRelation relation, String representation) {
return findLinkWithRel(relation, representation).orElseThrow(
() -> new IllegalArgumentException(String.format("Did not find link with relation '%s'!", relation.value())));
}
/**
* Finds a single link with the given {@link LinkRelation} in the given {@link InputStream} representation.
*
* @param rel must not be {@literal null}.
* @param relation must not be {@literal null}.
* @param representation must not be {@literal null}.
* @return the first link with the given relation type found, or {@literal null} if none was found.
* @return the first {@link Link} with the given {@link LinkRelation} found, or {@link Optional#empty()} if none was
* found.
*/
Optional<Link> findLinkWithRel(LinkRelation rel, InputStream representation);
Optional<Link> findLinkWithRel(LinkRelation relation, InputStream representation);
/**
* Finds a single link with the given relation type in the given {@link InputStream} representation.
*
* @param relation must not be {@literal null} or empty.
* @param representation must not be {@literal null}.
* @return the first link with the given relation type found, or {@link Optional#empty()} if none was found.
*/
default Optional<Link> findLinkWithRel(String relation, InputStream representation) {
return findLinkWithRel(LinkRelation.of(relation), representation);
}
/**
* Finds a single link with the given relation type in the given {@link InputStream} representation.
*
* @param relation must not be {@literal null} or empty.
* @param representation must not be {@literal null}.
* @return the first link with the given relation type found.
* @throws IllegalArgumentException if no {@link Link} for the given {@link LinkRelation} can be found.
*/
default Link findRequiredLinkWithRel(LinkRelation relation, InputStream representation) {
return findLinkWithRel(relation, representation).orElseThrow(
() -> new IllegalArgumentException(String.format("Did not find link with relation '%s'!", relation.value())));
}
/**
* Returns all links with the given link relation found in the given {@link String} representation.
*
* @param rel must not be {@literal null} or empty.
* @param relation must not be {@literal null} or empty.
* @param representation must not be {@literal null}.
* @return will never be {@literal null}.
*/
default Links findLinksWithRel(String rel, String representation) {
return findLinksWithRel(LinkRelation.of(rel), representation);
default Links findLinksWithRel(String relation, String representation) {
return findLinksWithRel(LinkRelation.of(relation), representation);
}
/**
* Returns all links with the given {@link LinkRelation} found in the given {@link String} representation.
*
* @param rel must not be {@literal null}.
* @param relation must not be {@literal null}.
* @param representation must not be {@literal null}.
* @return will never be {@literal null}.
*/
Links findLinksWithRel(LinkRelation rel, String representation);
Links findLinksWithRel(LinkRelation relation, String representation);
/**
* Returns all links with the given link relation found in the given {@link InputStream} representation.
*
* @param rel must not be {@literal null} or empty.
* @param relation must not be {@literal null} or empty.
* @param representation must not be {@literal null}.
* @return will never be {@literal null}.
*/
default Links findLinksWithRel(String rel, InputStream representation) {
return findLinksWithRel(LinkRelation.of(rel), representation);
default Links findLinksWithRel(String relation, InputStream representation) {
return findLinksWithRel(LinkRelation.of(relation), representation);
}
/**
* Returns all links with the given {@link LinkRelation} found in the given {@link InputStream} representation.
*
* @param rel must not be {@literal null}.
* @param relation must not be {@literal null}.
* @param representation must not be {@literal null}.
* @return will never be {@literal null}.
*/
Links findLinksWithRel(LinkRelation rel, InputStream representation);
Links findLinksWithRel(LinkRelation relation, InputStream representation);
}

3
src/main/java/org/springframework/hateoas/mediatype/uber/UberLinkDiscoverer.java
View File

@@ -78,7 +78,8 @@ public class UberLinkDiscoverer implements LinkDiscoverer {
@Override
public Links findLinksWithRel(LinkRelation rel, String representation) {
return getLinks(representation).stream().filter(it -> it.hasRel(rel)) //
return getLinks(representation).stream() //
.filter(it -> it.hasRel(rel)) //
.collect(Links.collector());
}