Consistent and lenient HttpMethod resolution across all web modules

Issue: SPR-13776

Author: jhoeller

spring-test/src/main/java/org/springframework/mock/web/MockMultipartHttpServletRequest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2015 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.
@@ -128,7 +128,7 @@ public String getMultipartContentType(String paramOrFileName) {
 
 	@Override
 	public HttpMethod getRequestMethod() {
-		return HttpMethod.valueOf(getMethod());
+		return HttpMethod.resolve(getMethod());
 	}
 
 	@Override

spring-web/src/main/java/org/springframework/http/HttpHeaders.java

@@ -470,15 +470,18 @@ public void setAccessControlAllowMethods(List<HttpMethod> allowedMethods) {
 	}
 
 	/**
-	 * Returns the value of the {@code Access-Control-Allow-Methods} response header.
+	 * Return the value of the {@code Access-Control-Allow-Methods} response header.
 	 */
 	public List<HttpMethod> getAccessControlAllowMethods() {
 		List<HttpMethod> result = new ArrayList<HttpMethod>();
 		String value = getFirst(ACCESS_CONTROL_ALLOW_METHODS);
 		if (value != null) {
 			String[] tokens = value.split(",\\s*");
 			for (String token : tokens) {
-				result.add(HttpMethod.valueOf(token));
+				HttpMethod resolved = HttpMethod.resolve(token);
+				if (resolved != null) {
+					result.add(resolved);
+				}
 			}
 		}
 		return result;
@@ -492,7 +495,7 @@ public void setAccessControlAllowOrigin(String allowedOrigin) {
 	}
 
 	/**
-	 * Returns the value of the {@code Access-Control-Allow-Origin} response header.
+	 * Return the value of the {@code Access-Control-Allow-Origin} response header.
 	 */
 	public String getAccessControlAllowOrigin() {
 		return getFirst(ACCESS_CONTROL_ALLOW_ORIGIN);
@@ -550,11 +553,10 @@ public void setAccessControlRequestMethod(HttpMethod requestedMethod) {
 	}
 
 	/**
-	 * Returns the value of the {@code Access-Control-Request-Method} request header.
+	 * Return the value of the {@code Access-Control-Request-Method} request header.
 	 */
 	public HttpMethod getAccessControlRequestMethod() {
-		String value = getFirst(ACCESS_CONTROL_REQUEST_METHOD);
-		return (value != null ? HttpMethod.valueOf(value) : null);
+		return HttpMethod.resolve(getFirst(ACCESS_CONTROL_REQUEST_METHOD));
 	}
 
 	/**
@@ -615,12 +617,15 @@ public void setAllow(Set<HttpMethod> allowedMethods) {
 	public Set<HttpMethod> getAllow() {
 		String value = getFirst(ALLOW);
 		if (!StringUtils.isEmpty(value)) {
-			List<HttpMethod> allowedMethod = new ArrayList<HttpMethod>(5);
+			List<HttpMethod> result = new LinkedList<HttpMethod>();
 			String[] tokens = value.split(",\\s*");
 			for (String token : tokens) {
-				allowedMethod.add(HttpMethod.valueOf(token));
+				HttpMethod resolved = HttpMethod.resolve(token);
+				if (resolved != null) {
+					result.add(resolved);
+				}
 			}
-			return EnumSet.copyOf(allowedMethod);
+			return EnumSet.copyOf(result);
 		}
 		else {
 			return EnumSet.noneOf(HttpMethod.class);
@@ -635,7 +640,7 @@ public void setCacheControl(String cacheControl) {
 	}
 
 	/**
-	 * Returns the value of the {@code Cache-Control} header.
+	 * Return the value of the {@code Cache-Control} header.
 	 */
 	public String getCacheControl() {
 		return getFirst(CACHE_CONTROL);
@@ -656,7 +661,7 @@ public void setConnection(List<String> connection) {
 	}
 
 	/**
-	 * Returns the value of the {@code Connection} header.
+	 * Return the value of the {@code Connection} header.
 	 */
 	public List<String> getConnection() {
 		return getFirstValueAsList(CONNECTION);
@@ -920,7 +925,7 @@ public void setRange(List<HttpRange> ranges) {
 	}
 
 	/**
-	 * Returns the value of the {@code Range} header.
+	 * Return the value of the {@code Range} header.
 	 * <p>Returns an empty list when the range is unknown.
 	 */
 	public List<HttpRange> getRange() {
@@ -936,7 +941,7 @@ public void setUpgrade(String upgrade) {
 	}
 
 	/**
-	 * Returns the value of the {@code Upgrade} header.
+	 * Return the value of the {@code Upgrade} header.
 	 */
 	public String getUpgrade() {
 		return getFirst(UPGRADE);

spring-web/src/main/java/org/springframework/http/HttpMethod.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2015 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.
@@ -16,16 +16,52 @@
 
 package org.springframework.http;
 
+import java.util.HashMap;
+import java.util.Map;
+
 /**
  * Java 5 enumeration of HTTP request methods. Intended for use
  * with {@link org.springframework.http.client.ClientHttpRequest}
  * and {@link org.springframework.web.client.RestTemplate}.
  *
  * @author Arjen Poutsma
+ * @author Juergen Hoeller
  * @since 3.0
  */
 public enum HttpMethod {
 
-	GET, POST, HEAD, OPTIONS, PUT, PATCH, DELETE, TRACE
+	GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS, TRACE;
+
+
+	private static final Map<String, HttpMethod> mappings = new HashMap<String, HttpMethod>(8);
+
+	static {
+		for (HttpMethod httpMethod : values()) {
+			mappings.put(httpMethod.name(), httpMethod);
+		}
+	}
+
+
+	/**
+	 * Resolve the given method value to an {@code HttpMethod}.
+	 * @param method the method value as a String
+	 * @return the corresponding {@code HttpMethod}, or {@code null} if not found
+	 * @since 4.2.4
+	 */
+	public static HttpMethod resolve(String method) {
+		return (method != null ? mappings.get(method) : null);
+	}
+
+
+	/**
+	 * Determine whether this {@code HttpMethod} matches the given
+	 * method value.
+	 * @param method the method value as a String
+	 * @return {@code true} if it matches, {@code false} otherwise
+	 * @since 4.2.4
+	 */
+	public boolean matches(String method) {
+		return name().equals(method);
+	}
 
 }

spring-web/src/main/java/org/springframework/http/HttpRequest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2011 the original author or authors.
+ * Copyright 2002-2015 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.
@@ -19,8 +19,8 @@
 import java.net.URI;
 
 /**
- * Represents an HTTP request message, consisting of {@linkplain #getMethod() method}
- * and {@linkplain #getURI() uri}.
+ * Represents an HTTP request message, consisting of
+ * {@linkplain #getMethod() method} and {@linkplain #getURI() uri}.
  *
  * @author Arjen Poutsma
  * @since 3.1
@@ -29,13 +29,14 @@ public interface HttpRequest extends HttpMessage {
 
 	/**
 	 * Return the HTTP method of the request.
-	 * @return the HTTP method as an HttpMethod enum value
+	 * @return the HTTP method as an HttpMethod enum value, or {@code null}
+	 * if not resolvable (e.g. in case of a non-standard HTTP method)
 	 */
 	HttpMethod getMethod();
 
 	/**
 	 * Return the URI of the request.
-	 * @return the URI of the request
+	 * @return the URI of the request (never {@code null})
 	 */
 	URI getURI();
 

spring-web/src/main/java/org/springframework/http/RequestEntity.java

@@ -20,7 +20,6 @@
 import java.nio.charset.Charset;
 import java.util.Arrays;
 
-import org.springframework.util.Assert;
 import org.springframework.util.MultiValueMap;
 import org.springframework.util.ObjectUtils;
 
@@ -104,8 +103,6 @@ public RequestEntity(MultiValueMap<String, String> headers, HttpMethod method, U
 	 */
 	public RequestEntity(T body, MultiValueMap<String, String> headers, HttpMethod method, URI url) {
 		super(body, headers);
-		Assert.notNull(method, "'method' is required");
-		Assert.notNull(url, "'url' is required");
 		this.method = method;
 		this.url = url;
 	}

spring-web/src/main/java/org/springframework/http/client/HttpComponentsAsyncClientHttpRequest.java

@@ -68,7 +68,7 @@ final class HttpComponentsAsyncClientHttpRequest extends AbstractBufferingAsyncC
 
 	@Override
 	public HttpMethod getMethod() {
-		return HttpMethod.valueOf(this.httpRequest.getMethod());
+		return HttpMethod.resolve(this.httpRequest.getMethod());
 	}
 
 	@Override

spring-web/src/main/java/org/springframework/http/client/HttpComponentsClientHttpRequest.java

@@ -66,7 +66,7 @@ final class HttpComponentsClientHttpRequest extends AbstractBufferingClientHttpR
 
 	@Override
 	public HttpMethod getMethod() {
-		return HttpMethod.valueOf(this.httpRequest.getMethod());
+		return HttpMethod.resolve(this.httpRequest.getMethod());
 	}
 
 	@Override

spring-web/src/main/java/org/springframework/http/client/HttpComponentsStreamingClientHttpRequest.java

@@ -65,7 +65,7 @@ final class HttpComponentsStreamingClientHttpRequest extends AbstractClientHttpR
 
 	@Override
 	public HttpMethod getMethod() {
-		return HttpMethod.valueOf(this.httpRequest.getMethod());
+		return HttpMethod.resolve(this.httpRequest.getMethod());
 	}
 
 	@Override

spring-web/src/main/java/org/springframework/http/client/SimpleBufferingAsyncClientHttpRequest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * Copyright 2002-2015 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.
@@ -57,7 +57,7 @@ final class SimpleBufferingAsyncClientHttpRequest extends AbstractBufferingAsync
 
 	@Override
 	public HttpMethod getMethod() {
-		return HttpMethod.valueOf(this.connection.getRequestMethod());
+		return HttpMethod.resolve(this.connection.getRequestMethod());
 	}
 
 	@Override
@@ -78,8 +78,8 @@ protected ListenableFuture<ClientHttpResponse> executeInternal(
 			@Override
 			public ClientHttpResponse call() throws Exception {
 				SimpleBufferingClientHttpRequest.addHeaders(connection, headers);
-				// JDK < 1.8 doesn't support getOutputStream with HTTP DELETE
-				if (HttpMethod.DELETE.equals(getMethod()) && bufferedOutput.length == 0) {
+				// JDK <1.8 doesn't support getOutputStream with HTTP DELETE
+				if (HttpMethod.DELETE == getMethod() && bufferedOutput.length == 0) {
 					connection.setDoOutput(false);
 				}
 				if (connection.getDoOutput() && outputStreaming) {

spring-web/src/main/java/org/springframework/http/client/SimpleBufferingClientHttpRequest.java

@@ -52,7 +52,7 @@ final class SimpleBufferingClientHttpRequest extends AbstractBufferingClientHttp
 
 	@Override
 	public HttpMethod getMethod() {
-		return HttpMethod.valueOf(this.connection.getRequestMethod());
+		return HttpMethod.resolve(this.connection.getRequestMethod());
 	}
 
 	@Override
@@ -69,8 +69,8 @@ public URI getURI() {
 	protected ClientHttpResponse executeInternal(HttpHeaders headers, byte[] bufferedOutput) throws IOException {
 		addHeaders(this.connection, headers);
 
-		// JDK < 1.8 doesn't support getOutputStream with HTTP DELETE
-		if (HttpMethod.DELETE.equals(getMethod()) && bufferedOutput.length == 0) {
+		// JDK <1.8 doesn't support getOutputStream with HTTP DELETE
+		if (HttpMethod.DELETE == getMethod() && bufferedOutput.length == 0) {
 			this.connection.setDoOutput(false);
 		}