Use HttpMethod instead of String (Azure#342)

* Add HttpMethod class

* Use HttpMethod instead of strings

azure-client-authentication/src/test/java/com/microsoft/azure/v2/credentials/RefreshTokenClientTests.java

@@ -3,6 +3,7 @@
 import com.google.common.base.Charsets;
 import com.google.common.io.CharStreams;
 import com.microsoft.azure.v2.credentials.http.MockHttpClient;
+import com.microsoft.rest.v2.http.HttpMethod;
 import com.microsoft.rest.v2.http.HttpRequest;
 import com.microsoft.rest.v2.util.FlowableUtil;
 import org.junit.Test;
@@ -22,7 +23,7 @@ public void refreshToken() throws IOException {
 
         assertEquals(1, httpClient.requests().size());
         final HttpRequest request = httpClient.requests().get(0);
-        assertEquals("POST", request.httpMethod());
+        assertEquals(HttpMethod.POST, request.httpMethod());
         assertEquals("com.microsoft.azure.v2.credentials.RefreshTokenClient$RefreshTokenService.refreshToken", request.callerMethod());
         assertEquals("http://my.base.url/mockTenant/oauth2/token", request.url());
 

azure-client-runtime/src/main/java/com/microsoft/azure/v2/AzureAsyncOperationPollStrategy.java

@@ -8,6 +8,7 @@
 
 import com.microsoft.rest.v2.RestProxy;
 import com.microsoft.rest.v2.SwaggerMethodParser;
+import com.microsoft.rest.v2.http.HttpMethod;
 import com.microsoft.rest.v2.http.HttpRequest;
 import com.microsoft.rest.v2.http.HttpResponse;
 import io.reactivex.Single;
@@ -61,7 +62,7 @@ else if (pollingSucceeded) {
             throw new IllegalStateException("Polling is completed and did not succeed. Cannot create a polling request.");
         }
 
-        return new HttpRequest(fullyQualifiedMethodName(), "GET", pollUrl);
+        return new HttpRequest(fullyQualifiedMethodName(), HttpMethod.GET, pollUrl);
     }
 
     @Override

azure-client-runtime/src/main/java/com/microsoft/azure/v2/AzureProxy.java

@@ -12,6 +12,7 @@
 import com.microsoft.azure.v2.serializer.AzureJacksonAdapter;
 import com.microsoft.rest.v2.credentials.ServiceClientCredentials;
 import com.microsoft.rest.v2.http.HttpClient;
+import com.microsoft.rest.v2.http.HttpMethod;
 import com.microsoft.rest.v2.http.HttpPipeline;
 import com.microsoft.rest.v2.http.HttpPipelineBuilder;
 import com.microsoft.rest.v2.http.NettyClient;
@@ -286,7 +287,7 @@ public Single<? extends PollStrategy> apply(HttpResponse response) {
                                         final Long parsedDelayInMilliseconds = PollStrategy.delayInMillisecondsFrom(originalHttpResponse);
                                         final long delayInMilliseconds = parsedDelayInMilliseconds != null ? parsedDelayInMilliseconds : AzureProxy.defaultDelayInMilliseconds();
 
-                                        final String originalHttpRequestMethod = originalHttpRequest.httpMethod();
+                                        final HttpMethod originalHttpRequestMethod = originalHttpRequest.httpMethod();
 
                                         PollStrategy pollStrategy = null;
                                         if (httpStatusCode == 200) {
@@ -298,7 +299,7 @@ public Single<? extends PollStrategy> apply(HttpResponse response) {
                                                 result = createProvisioningStateOrCompletedPollStrategy(originalHttpRequest, originalHttpResponse, methodParser, delayInMilliseconds);
                                             }
                                         }
-                                        else if (originalHttpRequestMethod.equalsIgnoreCase("PUT") || originalHttpRequestMethod.equalsIgnoreCase("PATCH")) {
+                                        else if (originalHttpRequestMethod == HttpMethod.PUT || originalHttpRequestMethod == HttpMethod.PATCH) {
                                             if (httpStatusCode == 201) {
                                                 pollStrategy = AzureAsyncOperationPollStrategy.tryToCreate(AzureProxy.this, methodParser, originalHttpRequest, originalHttpResponse, delayInMilliseconds);
                                                 if (pollStrategy == null) {
@@ -341,10 +342,10 @@ else if (originalHttpRequestMethod.equalsIgnoreCase("PUT") || originalHttpReques
     private Single<PollStrategy> createProvisioningStateOrCompletedPollStrategy(final HttpRequest httpRequest, HttpResponse httpResponse, final SwaggerMethodParser methodParser, final long delayInMilliseconds) {
         Single<PollStrategy> result;
 
-        final String httpRequestMethod = httpRequest.httpMethod();
-        if (httpRequestMethod.equalsIgnoreCase("DELETE")
-                || httpRequestMethod.equalsIgnoreCase("GET")
-                || httpRequestMethod.equalsIgnoreCase("HEAD")
+        final HttpMethod httpRequestMethod = httpRequest.httpMethod();
+        if (httpRequestMethod == HttpMethod.DELETE
+                || httpRequestMethod == HttpMethod.GET
+                || httpRequestMethod == HttpMethod.HEAD
                 || !methodParser.expectsResponseBody()) {
             result = Single.<PollStrategy>just(new CompletedPollStrategy(AzureProxy.this, methodParser, httpResponse));
         } else {

azure-client-runtime/src/main/java/com/microsoft/azure/v2/LocationPollStrategy.java

@@ -8,6 +8,7 @@
 
 import com.microsoft.rest.v2.RestProxy;
 import com.microsoft.rest.v2.SwaggerMethodParser;
+import com.microsoft.rest.v2.http.HttpMethod;
 import com.microsoft.rest.v2.http.HttpRequest;
 import com.microsoft.rest.v2.http.HttpResponse;
 import io.reactivex.Single;
@@ -38,7 +39,7 @@ private LocationPollStrategy(RestProxy restProxy, SwaggerMethodParser methodPars
 
     @Override
     public HttpRequest createPollRequest() {
-        return new HttpRequest(fullyQualifiedMethodName(), "GET", locationUrl);
+        return new HttpRequest(fullyQualifiedMethodName(), HttpMethod.GET, locationUrl);
     }
 
     @Override

azure-client-runtime/src/main/java/com/microsoft/azure/v2/ProvisioningStatePollStrategy.java

@@ -8,6 +8,7 @@
 
 import com.microsoft.rest.v2.RestProxy;
 import com.microsoft.rest.v2.SwaggerMethodParser;
+import com.microsoft.rest.v2.http.HttpMethod;
 import com.microsoft.rest.v2.http.HttpRequest;
 import com.microsoft.rest.v2.http.HttpResponse;
 import io.reactivex.Single;
@@ -31,7 +32,7 @@ public class ProvisioningStatePollStrategy extends PollStrategy {
 
     @Override
     HttpRequest createPollRequest() {
-        return new HttpRequest(originalRequest.callerMethod(), "GET", originalRequest.url());
+        return new HttpRequest(originalRequest.callerMethod(), HttpMethod.GET, originalRequest.url());
     }
 
     @Override

azure-client-runtime/src/test/java/com/microsoft/azure/v2/http/MockAzureHttpClient.java

@@ -19,6 +19,7 @@
 import com.microsoft.rest.v2.http.HttpClient;
 import com.microsoft.rest.v2.http.HttpHeader;
 import com.microsoft.rest.v2.http.HttpHeaders;
+import com.microsoft.rest.v2.http.HttpMethod;
 import com.microsoft.rest.v2.http.HttpRequest;
 import com.microsoft.rest.v2.http.HttpResponse;
 import com.microsoft.rest.v2.util.FlowableUtil;
@@ -124,7 +125,7 @@ else if (requestPathLower.startsWith("/status/")) {
                 }
             }
             else if (requestHost.equalsIgnoreCase("mock.azure.com")) {
-                if (request.httpMethod().equalsIgnoreCase("GET")) {
+                if (request.httpMethod() == HttpMethod.GET) {
                     if (requestPathLower.contains("/mockprovider/mockresources/")) {
                         ++getRequests;
                         --pollsRemaining;
@@ -171,7 +172,7 @@ else if (pollType.equalsIgnoreCase(LocationPollStrategy.HEADER_NAME)) {
                         }
                     }
                 }
-                else if (request.httpMethod().equalsIgnoreCase("PUT")) {
+                else if (request.httpMethod() == HttpMethod.PUT) {
                     ++createRequests;
 
                     final Map<String, String> requestQueryMap = queryToMap(requestUrl.getQuery());
@@ -232,7 +233,7 @@ else if (pollType.equalsIgnoreCase(LocationPollStrategy.HEADER_NAME)) {
                         }
                     }
                 }
-                else if (request.httpMethod().equalsIgnoreCase("DELETE")) {
+                else if (request.httpMethod() == HttpMethod.DELETE) {
                     ++deleteRequests;
 
                     final Map<String,String> requestQueryMap = queryToMap(requestUrl.getQuery());

client-runtime/src/main/java/com/microsoft/rest/v2/RestProxy.java

@@ -16,6 +16,7 @@
 import com.microsoft.rest.v2.http.FlowableHttpRequestBody;
 import com.microsoft.rest.v2.http.HttpHeader;
 import com.microsoft.rest.v2.http.HttpHeaders;
+import com.microsoft.rest.v2.http.HttpMethod;
 import com.microsoft.rest.v2.http.HttpPipeline;
 import com.microsoft.rest.v2.http.HttpPipelineBuilder;
 import com.microsoft.rest.v2.http.HttpRequest;
@@ -471,11 +472,11 @@ private boolean isFlowableByteArray(TypeToken entityTypeToken) {
     private Maybe<?> handleBodyReturnTypeAsync(final HttpResponse response, final SwaggerMethodParser methodParser, final Type entityType) {
         final TypeToken entityTypeToken = TypeToken.of(entityType);
         final int responseStatusCode = response.statusCode();
-        final String httpMethod = methodParser.httpMethod();
+        final HttpMethod httpMethod = methodParser.httpMethod();
         final Type returnValueWireType = methodParser.returnValueWireType();
 
         final Maybe<?> asyncResult;
-        if (httpMethod.equalsIgnoreCase("HEAD")
+        if (httpMethod == HttpMethod.HEAD
                 && (entityTypeToken.isSubtypeOf(boolean.class) || entityTypeToken.isSubtypeOf(Boolean.class))) {
             boolean isSuccess = (responseStatusCode / 100) == 2;
             asyncResult = Maybe.just(isSuccess);

client-runtime/src/main/java/com/microsoft/rest/v2/SwaggerMethodParser.java

@@ -26,6 +26,7 @@
 import com.microsoft.rest.v2.annotations.QueryParam;
 import com.microsoft.rest.v2.http.HttpHeader;
 import com.microsoft.rest.v2.http.HttpHeaders;
+import com.microsoft.rest.v2.http.HttpMethod;
 import io.reactivex.Observable;
 import io.reactivex.Single;
 
@@ -43,7 +44,7 @@
 public class SwaggerMethodParser {
     private final String rawHost;
     private final String fullyQualifiedMethodName;
-    private String httpMethod;
+    private HttpMethod httpMethod;
     private String relativePath;
     private final List<Substitution> hostSubstitutions = new ArrayList<>();
     private final List<Substitution> pathSubstitutions = new ArrayList<>();
@@ -73,22 +74,22 @@ public class SwaggerMethodParser {
         fullyQualifiedMethodName = swaggerInterface.getName() + "." + swaggerMethod.getName();
 
         if (swaggerMethod.isAnnotationPresent(GET.class)) {
-            setHttpMethodAndRelativePath("GET", swaggerMethod.getAnnotation(GET.class).value());
+            setHttpMethodAndRelativePath(HttpMethod.GET, swaggerMethod.getAnnotation(GET.class).value());
         }
         else if (swaggerMethod.isAnnotationPresent(PUT.class)) {
-            setHttpMethodAndRelativePath("PUT", swaggerMethod.getAnnotation(PUT.class).value());
+            setHttpMethodAndRelativePath(HttpMethod.PUT, swaggerMethod.getAnnotation(PUT.class).value());
         }
         else if (swaggerMethod.isAnnotationPresent(HEAD.class)) {
-            setHttpMethodAndRelativePath("HEAD", swaggerMethod.getAnnotation(HEAD.class).value());
+            setHttpMethodAndRelativePath(HttpMethod.HEAD, swaggerMethod.getAnnotation(HEAD.class).value());
         }
         else if (swaggerMethod.isAnnotationPresent(DELETE.class)) {
-            setHttpMethodAndRelativePath("DELETE", swaggerMethod.getAnnotation(DELETE.class).value());
+            setHttpMethodAndRelativePath(HttpMethod.DELETE, swaggerMethod.getAnnotation(DELETE.class).value());
         }
         else if (swaggerMethod.isAnnotationPresent(POST.class)) {
-            setHttpMethodAndRelativePath("POST", swaggerMethod.getAnnotation(POST.class).value());
+            setHttpMethodAndRelativePath(HttpMethod.POST, swaggerMethod.getAnnotation(POST.class).value());
         }
         else if (swaggerMethod.isAnnotationPresent(PATCH.class)) {
-            setHttpMethodAndRelativePath("PATCH", swaggerMethod.getAnnotation(PATCH.class).value());
+            setHttpMethodAndRelativePath(HttpMethod.PATCH, swaggerMethod.getAnnotation(PATCH.class).value());
         }
         else {
             final ArrayList<Class<? extends Annotation>> requiredAnnotationOptions = new ArrayList<>();
@@ -197,7 +198,7 @@ public String fullyQualifiedMethodName() {
      * Get the HTTP method that will be used to complete the Swagger method's request.
      * @return The HTTP method that will be used to complete the Swagger method's request.
      */
-    public String httpMethod() {
+    public HttpMethod httpMethod() {
         return httpMethod;
     }
 
@@ -431,7 +432,7 @@ private static boolean restResponseTypeExpectsBody(ParameterizedType restRespons
      * @param relativePath The path in the URL that will be used to complete the Swagger method's
      *                     request.
      */
-    private void setHttpMethodAndRelativePath(String httpMethod, String relativePath) {
+    private void setHttpMethodAndRelativePath(HttpMethod httpMethod, String relativePath) {
         this.httpMethod = httpMethod;
         this.relativePath = relativePath;
     }

client-runtime/src/main/java/com/microsoft/rest/v2/http/HttpMethod.java

@@ -0,0 +1,65 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for
+ * license information.
+ */
+
+package com.microsoft.rest.v2.http;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.microsoft.rest.v2.ExpandableStringEnum;
+
+import java.util.Collection;
+
+/**
+ * The different HTTP methods of a HttpRequest.
+ */
+public class HttpMethod extends ExpandableStringEnum<HttpMethod> {
+    /**
+     * The HTTP GET method.
+     */
+    public static final HttpMethod GET = fromString("GET");
+
+    /**
+     * The HTTP PUT method.
+     */
+    public static final HttpMethod PUT = fromString("PUT");
+
+    /**
+     * The HTTP POST method.
+     */
+    public static final HttpMethod POST = fromString("POST");
+
+    /**
+     * The HTTP PATCH method.
+     */
+    public static final HttpMethod PATCH = fromString("PATCH");
+
+    /**
+     * The HTTP DELETE method.
+     */
+    public static final HttpMethod DELETE = fromString("DELETE");
+
+    /**
+     * The HTTP HEAD method.
+     */
+    public static final HttpMethod HEAD = fromString("HEAD");
+
+    /**
+     * Creates or finds a HttpMethod from its string representation.
+     *
+     * @param name a name to look for.
+     * @return the corresponding HttpMethod.
+     */
+    @JsonCreator
+    public static HttpMethod fromString(String name) {
+        return fromString(name, HttpMethod.class);
+    }
+
+    /**
+     * @return known HttpMethod values.
+     */
+    public static Collection<HttpMethod> values() {
+        return values(HttpMethod.class);
+    }
+}

client-runtime/src/main/java/com/microsoft/rest/v2/http/HttpRequest.java

@@ -16,7 +16,7 @@
  */
 public class HttpRequest {
     private String callerMethod;
-    private String httpMethod;
+    private HttpMethod httpMethod;
     private String url;
     private HttpHeaders headers;
     private HttpRequestBody body;
@@ -28,7 +28,7 @@ public class HttpRequest {
      * @param httpMethod The HTTP method to use with this request.
      * @param url The URL where this HTTP request should be sent to.
      */
-    public HttpRequest(String callerMethod, String httpMethod, String url) {
+    public HttpRequest(String callerMethod, HttpMethod httpMethod, String url) {
         this.callerMethod = callerMethod;
         this.httpMethod = httpMethod;
         this.url = url;
@@ -44,7 +44,7 @@ public HttpRequest(String callerMethod, String httpMethod, String url) {
      * @param headers The HTTP headers to use with this request.
      * @param body The body of this HTTP request.
      */
-    public HttpRequest(String callerMethod, String httpMethod, String url, HttpHeaders headers, HttpRequestBody body) {
+    public HttpRequest(String callerMethod, HttpMethod httpMethod, String url, HttpHeaders headers, HttpRequestBody body) {
         this.callerMethod = callerMethod;
         this.httpMethod = httpMethod;
         this.url = url;
@@ -74,7 +74,7 @@ public HttpRequest withCallerMethod(String callerMethod) {
      * Get the HTTP method that this request will use.
      * @return The HTTP method that this request will use.
      */
-    public String httpMethod() {
+    public HttpMethod httpMethod() {
         return httpMethod;
     }
 
@@ -83,7 +83,7 @@ public String httpMethod() {
      * @param httpMethod The HTTP method to use, e.g. "GET".
      * @return This HttpRequest so that multiple operations can be chained together.
      */
-    public HttpRequest withHttpMethod(String httpMethod) {
+    public HttpRequest withHttpMethod(HttpMethod httpMethod) {
         this.httpMethod = httpMethod;
         return this;
     }

client-runtime/src/main/java/com/microsoft/rest/v2/http/NettyClient.java

@@ -246,7 +246,7 @@ public boolean isDisposed() {
                                 }
                             });
 
-                            if (request.httpMethod().equalsIgnoreCase("HEAD")) {
+                            if (request.httpMethod() == com.microsoft.rest.v2.http.HttpMethod.HEAD) {
                                 // Use HttpClientCodec for HEAD operations
                                 if (channel.pipeline().get("HttpClientCodec") == null) {
                                     channel.pipeline().remove(HttpRequestEncoder.class);
@@ -261,7 +261,7 @@ public boolean isDisposed() {
                             }
 
                             final DefaultHttpRequest raw = new DefaultHttpRequest(HttpVersion.HTTP_1_1,
-                                    HttpMethod.valueOf(request.httpMethod()),
+                                    HttpMethod.valueOf(request.httpMethod().toString()),
                                     request.url());
 
                             for (HttpHeader header : request.headers()) {

client-runtime/src/test/java/com/microsoft/rest/v2/CredentialsTests.java

@@ -9,6 +9,7 @@
 import com.microsoft.rest.v2.credentials.BasicAuthenticationCredentials;
 import com.microsoft.rest.v2.credentials.TokenCredentials;
 
+import com.microsoft.rest.v2.http.HttpMethod;
 import com.microsoft.rest.v2.http.HttpPipeline;
 import com.microsoft.rest.v2.policy.CredentialsPolicy;
 import com.microsoft.rest.v2.http.HttpRequest;
@@ -46,7 +47,7 @@ public Single<HttpResponse> sendAsync(HttpRequest request) {
                 new CredentialsPolicy.Factory(credentials),
                 auditorFactory);
 
-        HttpRequest request = new HttpRequest("basicCredentialsTest", "GET", "http://localhost");
+        HttpRequest request = new HttpRequest("basicCredentialsTest", HttpMethod.GET, "http://localhost");
         pipeline.sendRequestAsync(request).blockingGet();
     }
 
@@ -73,7 +74,7 @@ public Single<HttpResponse> sendAsync(HttpRequest request) {
                 new CredentialsPolicy.Factory(credentials),
                 auditorFactory);
 
-        HttpRequest request = new HttpRequest("basicCredentialsTest", "GET", "http://localhost");
+        HttpRequest request = new HttpRequest("basicCredentialsTest", HttpMethod.GET, "http://localhost");
         pipeline.sendRequestAsync(request).blockingGet();
     }
 }