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

Polish UriTemplateHandler related classes

Browse Source
This commit is contained in:
Rossen Stoyanchev
2016-03-03 13:33:04 -05:00
parent 44c32128dc
commit e98738d8ba
5 changed files with 51 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
spring-web/src/main/java/org/springframework/web/client/AsyncRestTemplate.java
View File

@@ -152,8 +152,9 @@ public class AsyncRestTemplate extends InterceptingAsyncHttpAccessor implements
}
/**
* Set a custom {@link UriTemplateHandler} for expanding URI templates.
* <p>By default, RestTemplate uses {@link DefaultUriTemplateHandler}.
* This property has the same purpose as the corresponding property on the
* {@code RestTemplate}. For more details see
* {@link RestTemplate#setUriTemplateHandler}.
* @param handler the URI template handler to use
*/
public void setUriTemplateHandler(UriTemplateHandler handler) {

8
spring-web/src/main/java/org/springframework/web/client/RestTemplate.java
View File

@@ -237,8 +237,12 @@ public class RestTemplate extends InterceptingHttpAccessor implements RestOperat
}
/**
* Set a custom {@link UriTemplateHandler} for expanding URI templates.
* <p>By default, RestTemplate uses {@link DefaultUriTemplateHandler}.
* Configure the {@link UriTemplateHandler} to use to expand URI templates.
* By default the {@link DefaultUriTemplateHandler} is used which relies on
* Spring's URI template support and exposes several useful properties that
* customize its behavior for encoding and for prepending a common base URL.
* An alternative implementation may be used to plug an external URI
* template library.
* @param handler the URI template handler to use
*/
public void setUriTemplateHandler(UriTemplateHandler handler) {

35
spring-web/src/main/java/org/springframework/web/util/DefaultUriTemplateHandler.java
View File

@@ -24,8 +24,8 @@ import java.util.Map;
import org.springframework.util.Assert;
/**
* Default implementation of {@link UriTemplateHandler} that relies on
* {@link UriComponentsBuilder} internally.
* Default implementation of {@link UriTemplateHandler} that uses
* {@link UriComponentsBuilder} to expand and encode variables.
*
* @author Rossen Stoyanchev
* @since 4.2
@@ -38,14 +38,10 @@ public class DefaultUriTemplateHandler implements UriTemplateHandler {
/**
* Configure a base URL to prepend URI templates with. The base URL should
* have a scheme and host but may also contain a port and a partial path.
* Individual URI templates then may provide the remaining part of the URL
* including additional path, query and fragment.
* <p><strong>Note: </strong>Individual URI templates are expanded and
* encoded before being appended to the base URL. Therefore the base URL is
* expected to be fully expanded and encoded, which can be done with the help
* of {@link UriComponentsBuilder}.
* Configure a base URL to prepend URI templates with. The base URL must
* have a scheme and host but may optionally contain a port and a path.
* The base URL must be fully expanded and encoded which can be done via
* {@link UriComponentsBuilder}.
* @param baseUrl the base URL.
*/
public void setBaseUrl(String baseUrl) {
@@ -68,10 +64,10 @@ public class DefaultUriTemplateHandler implements UriTemplateHandler {
/**
* Whether to parse the path of a URI template string into path segments.
* <p>If set to {@code true} the path of parsed URI templates is decomposed
* into path segments so that URI variables expanded into the path are
* treated according to path segment encoding rules. In effect that means the
* "/" character is percent encoded.
* <p>If set to {@code true} the URI template path is immediately decomposed
* into path segments any URI variables expanded into it are then subject to
* path segment encoding rules. In effect URI variables in the path have any
* "/" characters percent encoded.
* <p>By default this is set to {@code false} in which case the path is kept
* as a full path and expanded URI variables will preserve "/" characters.
* @param parsePath whether to parse the path into path segments
@@ -102,6 +98,11 @@ public class DefaultUriTemplateHandler implements UriTemplateHandler {
return insertBaseUrl(url);
}
/**
* Create a {@code UriComponentsBuilder} from the UriTemplate string. The
* default implementation also parses the path into path segments if
* {@link #setParsePath parsePath} is enabled.
*/
protected UriComponentsBuilder initUriComponentsBuilder(String uriTemplate) {
UriComponentsBuilder builder = UriComponentsBuilder.fromUriString(uriTemplate);
if (shouldParsePath()) {
@@ -114,6 +115,12 @@ public class DefaultUriTemplateHandler implements UriTemplateHandler {
return builder;
}
/**
* Invoked after the URI template has been expanded and encoded to prepend
* the configured {@link #setBaseUrl(String) baseUrl} if any.
* @param uriComponents the expanded and encoded URI
* @return the final URI
*/
protected URI insertBaseUrl(UriComponents uriComponents) {
if (getBaseUrl() == null || uriComponents.getHost() != null) {
return uriComponents.toUri();

20
spring-web/src/main/java/org/springframework/web/util/UriTemplateHandler.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2015 the original author or authors.
* Copyright 2002-2016 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.
@@ -20,15 +20,23 @@ import java.net.URI;
import java.util.Map;
/**
* A strategy for expanding a URI template with URI variables into a {@link URI}.
* Strategy for expanding a URI template with full control over the URI template
* syntax and the encoding of variables. Also a convenient central point for
* pre-processing all URI templates for example to insert a common base path.
*
* <p>Supported as a property on the {@code RestTemplate} as well as the
* {@code AsyncRestTemplate}. The {@link DefaultUriTemplateHandler} is built
* on Spring's URI template support via {@link UriComponentsBuilder}. An
* alternative implementation may be used to plug external URI template libraries.
*
* @author Rossen Stoyanchev
* @since 4.2
* @see org.springframework.web.client.RestTemplate#setUriTemplateHandler
*/
public interface UriTemplateHandler {
/**
* Expand the give URI template with a map of URI variables.
* Expand the given URI template from a map of URI variables.
* @param uriTemplate the URI template string
* @param uriVariables the URI variables
* @return the resulting URI
@@ -36,11 +44,11 @@ public interface UriTemplateHandler {
URI expand(String uriTemplate, Map<String, ?> uriVariables);
/**
* Expand the give URI template with an array of URI variable values.
* Expand the given URI template from an array of URI variables.
* @param uriTemplate the URI template string
* @param uriVariableValues the URI variable values
* @param uriVariables the URI variable values
* @return the resulting URI
*/
URI expand(String uriTemplate, Object... uriVariableValues);
URI expand(String uriTemplate, Object... uriVariables);
}