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

SPR-5973: UriComponents now encapsulates uri template variables

Browse Source
This commit is contained in:
Arjen Poutsma
2011-09-14 14:36:49 +00:00
parent 3f2ea7f50e
commit 38f05678c1
1 changed files with 73 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files

163
org.springframework.web/src/main/java/org/springframework/web/util/UriComponents.java
View File

@@ -316,9 +316,26 @@ public final class UriComponents {
* @param uriVariables the map of URI variables
* @return the expanded uri components
*/
public UriComponents expand(Map<String, ?> uriVariables) {
Assert.notNull(uriVariables, "'uriVariables' must not be null");
public UriComponents expand(Map<String, ?> map) {
Assert.notNull(map, "'uriVariables' must not be null");
return expandInternal(new MapTemplateVariables(map));
}
/**
* Replaces all URI template variables with the values from a given array. The array represent variable values.
* The order of variables is significant.
* @param uriVariableValues URI variable values
* @return the expanded uri components
*/
public UriComponents expand(Object... uriVariableValues) {
Assert.notNull(uriVariableValues, "'uriVariableValues' must not be null");
return expandInternal(new VarArgsTemplateVariables(uriVariableValues));
}
private UriComponents expandInternal(UriTemplateVariables uriVariables) {
String expandedScheme = expandUriComponent(this.scheme, uriVariables);
String expandedUserInfo = expandUriComponent(this.userInfo, uriVariables);
String expandedHost = expandUriComponent(this.host, uriVariables);
@@ -340,7 +357,7 @@ public final class UriComponents {
expandedQueryParams, expandedFragment, false);
}
private static String expandUriComponent(String source, Map<String, ?> uriVariables) {
private static String expandUriComponent(String source, UriTemplateVariables uriVariables) {
if (source == null) {
return null;
}
@@ -352,71 +369,15 @@ public final class UriComponents {
while (matcher.find()) {
String match = matcher.group(1);
String variableName = getVariableName(match);
Object variableValue = uriVariables.get(variableName);
String uriVariableValueString = getVariableValueAsString(variableValue);
String replacement = Matcher.quoteReplacement(uriVariableValueString);
Object variableValue = uriVariables.getValue(variableName);
String variableValueString = getVariableValueAsString(variableValue);
String replacement = Matcher.quoteReplacement(variableValueString);
matcher.appendReplacement(sb, replacement);
}
matcher.appendTail(sb);
return sb.toString();
}
/**
* Replaces all URI template variables with the values from a given array. The array represent variable values.
* The order of variables is significant.
* @param uriVariableValues URI variable values
* @return the expanded uri components
*/
public UriComponents expand(Object... uriVariableValues) {
Assert.notNull(uriVariableValues, "'uriVariableValues' must not be null");
Iterator<Object> valueIterator = Arrays.asList(uriVariableValues).iterator();
String expandedScheme = expandUriComponent(this.scheme, valueIterator);
String expandedUserInfo = expandUriComponent(this.userInfo, valueIterator);
String expandedHost = expandUriComponent(this.host, valueIterator);
PathComponent expandedPath = path.expand(valueIterator);
MultiValueMap<String, String> expandedQueryParams =
new LinkedMultiValueMap<String, String>(this.queryParams.size());
for (Map.Entry<String, List<String>> entry : this.queryParams.entrySet()) {
String expandedName = expandUriComponent(entry.getKey(), valueIterator);
List<String> expandedValues = new ArrayList<String>(entry.getValue().size());
for (String value : entry.getValue()) {
String expandedValue = expandUriComponent(value, valueIterator);
expandedValues.add(expandedValue);
}
expandedQueryParams.put(expandedName, expandedValues);
}
String expandedFragment = expandUriComponent(this.fragment, valueIterator);
return new UriComponents(expandedScheme, expandedUserInfo, expandedHost, this.port, expandedPath,
expandedQueryParams, expandedFragment, false);
}
private static String expandUriComponent(String source, Iterator<Object> valueIterator) {
if (source == null) {
return null;
}
if (source.indexOf('{') == -1) {
return source;
}
Matcher matcher = NAMES_PATTERN.matcher(source);
StringBuffer sb = new StringBuffer();
while (matcher.find()) {
if (!valueIterator.hasNext()) {
throw new IllegalArgumentException("Not enough variable values available to expand [" + source + "]");
}
Object variableValue = valueIterator.next();
String uriVariableValueString = getVariableValueAsString(variableValue);
String replacement = Matcher.quoteReplacement(uriVariableValueString);
matcher.appendReplacement(sb, replacement);
}
matcher.appendTail(sb);
return sb.toString();
}
private static String getVariableName(String match) {
int colonIdx = match.indexOf(':');
return colonIdx == -1 ? match : match.substring(0, colonIdx);
@@ -426,10 +387,6 @@ public final class UriComponents {
return variableValue != null ? variableValue.toString() : "";
}
// other functionality
/**
@@ -722,9 +679,8 @@ public final class UriComponents {
PathComponent encode(String encoding) throws UnsupportedEncodingException;
PathComponent expand(Map<String, ?> uriVariables);
PathComponent expand(UriTemplateVariables uriVariables);
PathComponent expand(Iterator<Object> valueIterator);
}
/**
@@ -753,16 +709,11 @@ public final class UriComponents {
return new FullPathComponent(encodedPath);
}
public PathComponent expand(Map<String, ?> uriVariables) {
public PathComponent expand(UriTemplateVariables uriVariables) {
String expandedPath = expandUriComponent(getPath(), uriVariables);
return new FullPathComponent(expandedPath);
}
public PathComponent expand(Iterator<Object> valueIterator) {
String expandedPath = expandUriComponent(getPath(), valueIterator);
return new FullPathComponent(expandedPath);
}
@Override
public boolean equals(Object o) {
if (this == o) {
@@ -818,7 +769,7 @@ public final class UriComponents {
return new PathSegmentComponent(encodedPathSegments);
}
public PathComponent expand(Map<String, ?> uriVariables) {
public PathComponent expand(UriTemplateVariables uriVariables) {
List<String> pathSegments = getPathSegments();
List<String> expandedPathSegments = new ArrayList<String>(pathSegments.size());
for (String pathSegment : pathSegments) {
@@ -828,16 +779,6 @@ public final class UriComponents {
return new PathSegmentComponent(expandedPathSegments);
}
public PathComponent expand(Iterator<Object> valueIterator) {
List<String> pathSegments = getPathSegments();
List<String> expandedPathSegments = new ArrayList<String>(pathSegments.size());
for (String pathSegment : pathSegments) {
String expandedPathSegment = expandUriComponent(pathSegment, valueIterator);
expandedPathSegments.add(expandedPathSegment);
}
return new PathSegmentComponent(expandedPathSegments);
}
@Override
public boolean equals(Object o) {
if (this == o) {
@@ -873,11 +814,7 @@ public final class UriComponents {
return this;
}
public PathComponent expand(Map<String, ?> uriVariables) {
return this;
}
public PathComponent expand(Iterator<Object> valueIterator) {
public PathComponent expand(UriTemplateVariables uriVariables) {
return this;
}
@@ -893,4 +830,50 @@ public final class UriComponents {
};
/**
* Defines the contract for URI Template variables
*
* @see UriComponents#expand
*/
private interface UriTemplateVariables {
Object getValue(String name);
}
/**
* URI template variables backed by a map.
*/
private static class MapTemplateVariables implements UriTemplateVariables {
private final Map<String, ?> uriVariables;
public MapTemplateVariables(Map<String, ?> uriVariables) {
this.uriVariables = uriVariables;
}
public Object getValue(String name) {
return this.uriVariables.get(name);
}
}
/**
* URI template variables backed by a variable argument array.
*/
private static class VarArgsTemplateVariables implements UriTemplateVariables {
private final Iterator<Object> valueIterator;
public VarArgsTemplateVariables(Object... uriVariableValues) {
this.valueIterator = Arrays.asList(uriVariableValues).iterator();
}
public Object getValue(String name) {
if (!valueIterator.hasNext()) {
throw new IllegalArgumentException("Not enough variable values available to expand [" + name + "]");
}
return valueIterator.next();
}
}
}