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

#819 - Polishing.

Browse Source 
Original pull request: #820.
This commit is contained in:
Oliver Drotbohm
2019-02-15 10:53:20 +01:00
parent 14f0012aef
commit 38b98af786
5 changed files with 69 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
src/main/java/org/springframework/hateoas/client/Traverson.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2013-2018 the original author or authors.
* Copyright 2013-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -59,7 +59,7 @@ import com.jayway.jsonpath.JsonPath;
/**
* Component to ease traversing hypermedia APIs by following links with relation types. Highly inspired by the equally
* named JavaScript library.
*
*
* @see https://github.com/basti1302/traverson
* @author Oliver Gierke
* @author Dietrich Schulten
@@ -74,7 +74,7 @@ public class Traverson {
static {
LinkDiscoverer discoverer = new HalLinkDiscoverer();
DEFAULT_LINK_DISCOVERERS = new LinkDiscoverers(OrderAwarePluginRegistry.of(Arrays.asList(discoverer)));
DEFAULT_LINK_DISCOVERERS = new LinkDiscoverers(OrderAwarePluginRegistry.of(discoverer));
}
private final URI baseUri;
@@ -86,7 +86,7 @@ public class Traverson {
/**
* Creates a new {@link Traverson} interacting with the given base URI and using the given {@link MediaType}s to
* interact with the service.
*
*
* @param baseUri must not be {@literal null}.
* @param mediaTypes must not be {@literal null} or empty.
*/
@@ -97,7 +97,7 @@ public class Traverson {
/**
* Creates a new {@link Traverson} interacting with the given base URI and using the given {@link MediaType}s to
* interact with the service.
*
*
* @param baseUri must not be {@literal null}.
* @param mediaTypes must not be {@literal null} or empty.
*/
@@ -115,7 +115,7 @@ public class Traverson {
/**
* Returns all {@link HttpMessageConverter}s that will be registered for the given {@link MediaType}s by default.
*
*
* @param mediaTypes must not be {@literal null}.
* @return
*/
@@ -125,7 +125,7 @@ public class Traverson {
/**
* Returns all {@link HttpMessageConverter}s that will be registered for the given {@link MediaType}s by default.
*
*
* @param mediaTypes must not be {@literal null}.
* @return
*/
@@ -147,7 +147,7 @@ public class Traverson {
/**
* Returns all HAL JSON compatible media types from the given list.
*
*
* @param mediaTypes must not be {@literal null}.
* @return
*/
@@ -168,7 +168,7 @@ public class Traverson {
/**
* Creates a new {@link HttpMessageConverter} to support HAL.
*
*
* @return
*/
private static final HttpMessageConverter<?> getHalConverter(List<MediaType> halFlavours) {
@@ -188,7 +188,7 @@ public class Traverson {
/**
* Configures the {@link RestOperations} to use. If {@literal null} is provided a default {@link RestTemplate} will be
* used.
*
*
* @param operations
* @return
*/
@@ -201,7 +201,7 @@ public class Traverson {
/**
* Sets the {@link LinkDiscoverers} to use. By default a single {@link HalLinkDiscoverer} is registered. If
* {@literal null} is provided the default is reapplied.
*
*
* @param discoverer can be {@literal null}.
* @return
*/
@@ -215,7 +215,7 @@ public class Traverson {
/**
* Sets up a {@link TraversalBuilder} to follow the given rels.
*
*
* @param rels must not be {@literal null} or empty.
* @return
* @see TraversalBuilder
@@ -248,7 +248,7 @@ public class Traverson {
/**
* Builder API to customize traversals.
*
*
* @author Oliver Gierke
*/
public class TraversalBuilder {
@@ -262,7 +262,7 @@ public class Traverson {
/**
* Follows the given rels one by one, which means a request per rel to discover the next resource with the rel in
* line.
*
*
* @param rels must not be {@literal null}.
* @return
*/
@@ -297,7 +297,7 @@ public class Traverson {
/**
* Adds the given operations parameters to the traversal. If a link discovered by the traversal is templated, the
* given parameters will be used to expand the operations into a resolvable URI.
*
*
* @param parameters can be {@literal null}.
* @return
*/
@@ -311,7 +311,7 @@ public class Traverson {
/**
* The {@link HttpHeaders} that shall be used for the requests of the traversal.
*
*
* @param headers can be {@literal null}.
* @return
*/
@@ -325,7 +325,7 @@ public class Traverson {
/**
* Executes the traversal and marshals the final response into an object of the given type.
*
*
* @param type must not be {@literal null}.
* @return
*/
@@ -342,7 +342,7 @@ public class Traverson {
/**
* Executes the traversal and marshals the final response into an object of the given
* {@link ParameterizedTypeReference}.
*
*
* @param type must not be {@literal null}.
* @return
*/
@@ -359,7 +359,7 @@ public class Traverson {
/**
* Executes the traversal and returns the result of the given JSON Path expression evaluated against the final
* representation.
*
*
* @param jsonPath must not be {@literal null} or empty.
* @return
*/
@@ -376,7 +376,7 @@ public class Traverson {
/**
* Returns the raw {@link ResponseEntity} with the representation unmarshalled into an instance of the given type.
*
*
* @param type must not be {@literal null}.
* @return
*/
@@ -393,7 +393,7 @@ public class Traverson {
/**
* Returns the {@link Link} found for the last rel in the rels configured to follow. Will expand the final
* {@link Link} using the
*
*
* @return
* @see #withTemplateParameters(Map)
* @since 0.15
@@ -404,7 +404,7 @@ public class Traverson {
/**
* Returns the templated {@link Link} found for the last rel in the rels configured to follow.
*
*
* @return
* @since 0.17
*/
@@ -420,19 +420,23 @@ public class Traverson {
UriStringAndHeaders finalUriAndHeaders = traverseToFinalUrl();
return new Link(expandFinalUrl ? expandedFinalUriAndHeaders.getUri().toString() : finalUriAndHeaders.getUri(),
this.rels.get(this.rels.size() - 1).getRel());
this.rels.get(this.rels.size() - 1).getRel());
}
private UriStringAndHeaders traverseToFinalUrl() {
UriStringAndHeaders uriAndHeaders = getAndFindLinkWithRel(baseUri.toString(), this.rels.iterator(), HttpHeaders.EMPTY);
return new UriStringAndHeaders(new UriTemplate(uriAndHeaders.getUri()).toString(), uriAndHeaders.getHttpHeaders());
UriStringAndHeaders uriAndHeaders = getAndFindLinkWithRel(baseUri.toString(), this.rels.iterator(),
HttpHeaders.EMPTY);
return new UriStringAndHeaders(new UriTemplate(uriAndHeaders.getUri()).toString(),
uriAndHeaders.getHttpHeaders());
}
private URIAndHeaders traverseToExpandedFinalUrl() {
UriStringAndHeaders uriAndHeaders = getAndFindLinkWithRel(baseUri.toString(), this.rels.iterator(), HttpHeaders.EMPTY);
return new URIAndHeaders(new UriTemplate(uriAndHeaders.getUri()).expand(this.templateParameters), uriAndHeaders.getHttpHeaders());
UriStringAndHeaders uriAndHeaders = getAndFindLinkWithRel(baseUri.toString(), this.rels.iterator(),
HttpHeaders.EMPTY);
return new URIAndHeaders(new UriTemplate(uriAndHeaders.getUri()).expand(this.templateParameters),
uriAndHeaders.getHttpHeaders());
}
private UriStringAndHeaders getAndFindLinkWithRel(String uri, Iterator<Hop> rels, HttpHeaders extraHeaders) {
@@ -464,13 +468,14 @@ public class Traverson {
if (!thisHop.hasParameters()) {
return getAndFindLinkWithRel(link.getHref(), rels, thisHop.getHeaders());
} else {
return getAndFindLinkWithRel(link.expand(thisHop.getMergedParameters(this.templateParameters)).getHref(), rels, thisHop.getHeaders());
return getAndFindLinkWithRel(link.expand(thisHop.getMergedParameters(this.templateParameters)).getHref(), rels,
thisHop.getHeaders());
}
}
/**
* Combine two sets of {@link HttpHeaders} into one.
*
*
* @param headersA
* @param headersB
* @return

61
src/main/java/org/springframework/hateoas/mvc/ControllerLinkBuilder.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2018 the original author or authors.
* Copyright 2012-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -23,15 +23,12 @@ import lombok.experimental.Delegate;
import java.lang.reflect.Method;
import java.net.URI;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import javax.servlet.http.HttpServletRequest;
import org.springframework.context.ApplicationContext;
import org.springframework.core.io.support.SpringFactoriesLoader;
import org.springframework.hateoas.Affordance;
import org.springframework.hateoas.AffordanceModelFactory;
import org.springframework.hateoas.Link;
import org.springframework.hateoas.TemplateVariables;
import org.springframework.hateoas.core.AnnotationMappingDiscoverer;
@@ -39,9 +36,6 @@ import org.springframework.hateoas.core.DummyInvocationUtils;
import org.springframework.hateoas.core.DummyInvocationUtils.MethodInvocation;
import org.springframework.hateoas.core.LinkBuilderSupport;
import org.springframework.hateoas.core.MappingDiscoverer;
import org.springframework.http.MediaType;
import org.springframework.plugin.core.OrderAwarePluginRegistry;
import org.springframework.plugin.core.PluginRegistry;
import org.springframework.util.Assert;
import org.springframework.util.ConcurrentReferenceHashMap;
import org.springframework.web.bind.annotation.RequestMapping;
@@ -56,7 +50,7 @@ import org.springframework.web.util.UriTemplate;
/**
* Builder to ease building {@link Link} instances pointing to Spring MVC controllers.
*
*
* @author Oliver Gierke
* @author Kamill Sokol
* @author Greg Turnquist
@@ -73,20 +67,11 @@ public class ControllerLinkBuilder extends LinkBuilderSupport<ControllerLinkBuil
private static final ControllerLinkBuilderFactory FACTORY = new ControllerLinkBuilderFactory();
private static final CustomUriTemplateHandler HANDLER = new CustomUriTemplateHandler();
static {
List<AffordanceModelFactory> factories = SpringFactoriesLoader.loadFactories(AffordanceModelFactory.class,
ControllerLinkBuilder.class.getClassLoader());
PluginRegistry<? extends AffordanceModelFactory, MediaType> MODEL_FACTORIES = OrderAwarePluginRegistry
.of(factories);
}
private final TemplateVariables variables;
/**
* Creates a new {@link ControllerLinkBuilder} using the given {@link UriComponentsBuilder}.
*
*
* @param builder must not be {@literal null}.
*/
ControllerLinkBuilder(UriComponentsBuilder builder) {
@@ -115,7 +100,7 @@ public class ControllerLinkBuilder extends LinkBuilderSupport<ControllerLinkBuil
/**
* Creates a new {@link ControllerLinkBuilder} with a base of the mapping annotated to the given controller class.
*
*
* @param controller the class to discover the annotation on, must not be {@literal null}.
* @return
*/
@@ -126,7 +111,7 @@ public class ControllerLinkBuilder extends LinkBuilderSupport<ControllerLinkBuil
/**
* Creates a new {@link ControllerLinkBuilder} with a base of the mapping annotated to the given controller class. The
* additional parameters are used to fill up potentially available path variables in the class scop request mapping.
*
*
* @param controller the class to discover the annotation on, must not be {@literal null}.
* @param parameters additional parameters to bind to the URI template declared in the annotation, must not be
* {@literal null}.
@@ -191,22 +176,22 @@ public class ControllerLinkBuilder extends LinkBuilderSupport<ControllerLinkBuil
/**
* Creates a {@link ControllerLinkBuilder} pointing to a controller method. Hand in a dummy method invocation result
* you can create via {@link #methodOn(Class, Object...)} or {@link DummyInvocationUtils#methodOn(Class, Object...)}.
*
*
* <pre>
* &#64;RequestMapping("/customers")
* class CustomerController {
*
*
* &#64;RequestMapping("/{id}/addresses")
* HttpEntity&lt;Addresses&gt; showAddresses(@PathVariable Long id) { … }
* HttpEntity&lt;Addresses&gt; showAddresses(@PathVariable Long id) { … }
* }
*
*
* Link link = linkTo(methodOn(CustomerController.class).showAddresses(2L)).withRel("addresses");
* </pre>
*
*
* The resulting {@link Link} instance will point to {@code /customers/2/addresses} and have a rel of
* {@code addresses}. For more details on the method invocation constraints, see
* {@link DummyInvocationUtils#methodOn(Class, Object...)}.
*
*
* @param invocationValue
* @return
*/
@@ -224,7 +209,7 @@ public class ControllerLinkBuilder extends LinkBuilderSupport<ControllerLinkBuil
* </pre>
*
* This takes a link and adds an {@link Affordance} based on another Spring MVC handler method.
*
*
* @param invocationValue
* @return
*/
@@ -240,7 +225,7 @@ public class ControllerLinkBuilder extends LinkBuilderSupport<ControllerLinkBuil
/**
* Wrapper for {@link DummyInvocationUtils#methodOn(Class, Object...)} to be available in case you work with static
* imports of {@link ControllerLinkBuilder}.
*
*
* @param controller must not be {@literal null}.
* @param parameters parameters to extend template variables in the type level mapping.
* @return
@@ -249,7 +234,7 @@ public class ControllerLinkBuilder extends LinkBuilderSupport<ControllerLinkBuil
return DummyInvocationUtils.methodOn(controller, parameters);
}
/*
/*
* (non-Javadoc)
* @see org.springframework.hateoas.UriComponentsLinkBuilder#getThis()
*/
@@ -258,7 +243,7 @@ public class ControllerLinkBuilder extends LinkBuilderSupport<ControllerLinkBuil
return this;
}
/*
/*
* (non-Javadoc)
* @see org.springframework.hateoas.UriComponentsLinkBuilder#createNewInstance(org.springframework.web.util.UriComponentsBuilder)
*/
@@ -269,14 +254,14 @@ public class ControllerLinkBuilder extends LinkBuilderSupport<ControllerLinkBuil
/**
* Returns a {@link UriComponentsBuilder} to continue to build the already built URI in a more fine grained way.
*
*
* @return
*/
public UriComponentsBuilder toUriComponentsBuilder() {
return UriComponentsBuilder.fromUri(toUri());
}
/*
/*
* (non-Javadoc)
* @see org.springframework.hateoas.core.LinkBuilderSupport#toString()
*/
@@ -302,7 +287,7 @@ public class ControllerLinkBuilder extends LinkBuilderSupport<ControllerLinkBuil
* request contains an {@code X-Forwarded-Ssl} header, which is not (yet) supported by the underlying
* {@link UriComponentsBuilder}. If no {@link RequestContextHolder} exists (you're outside a Spring Web call), fall
* back to relative URIs.
*
*
* @return
*/
public static UriComponentsBuilder getBuilder() {
@@ -324,7 +309,7 @@ public class ControllerLinkBuilder extends LinkBuilderSupport<ControllerLinkBuil
/**
* Check if the current version of Spring Framework is 5.1 or higher.
*
*
* @return
*/
private static boolean isSpringAtLeast5_1() {
@@ -335,12 +320,12 @@ public class ControllerLinkBuilder extends LinkBuilderSupport<ControllerLinkBuil
int majorVersion = Integer.parseInt(parts[0]);
int minorVersion = Integer.parseInt(parts[1]);
return (majorVersion >= 5 && minorVersion >= 1) || (majorVersion > 5);
return majorVersion >= 5 && minorVersion >= 1 || majorVersion > 5;
}
/**
* Copy of {@link ServletUriComponentsBuilder#getCurrentRequest()} until SPR-10110 gets fixed.
*
*
* @return
*/
@SuppressWarnings("null")
@@ -384,7 +369,7 @@ public class ControllerLinkBuilder extends LinkBuilderSupport<ControllerLinkBuil
setStrictEncoding(true);
}
/*
/*
* (non-Javadoc)
* @see org.springframework.web.util.DefaultUriTemplateHandler#expandAndEncode(org.springframework.web.util.UriComponentsBuilder, java.util.Map)
*/
@@ -393,7 +378,7 @@ public class ControllerLinkBuilder extends LinkBuilderSupport<ControllerLinkBuil
return super.expandAndEncode(builder, uriVariables);
}
/*
/*
* (non-Javadoc)
* @see org.springframework.web.util.DefaultUriTemplateHandler#expandAndEncode(org.springframework.web.util.UriComponentsBuilder, java.lang.Object[])
*/