Decouple HttpResponseDecoder from SwaggerMethodParser, Making Jackson…

… encoders package private, Java-doc updates (Azure#547)

* Moving protocol/SerializerAdapter, HttpResponseDecoder to serializer package.

* Making all runtime jackson codec types to package private

* Improving HttpRrsponseDecoder so that client can easily create one with specific decoding settings, java-doc updates.

azure-client-authentication/src/main/java/com/microsoft/azure/v3/credentials/AuthFile.java

@@ -11,8 +11,8 @@
 import com.microsoft.azure.v3.AzureEnvironment;
 import com.microsoft.azure.v3.AzureEnvironment.Endpoint;
 import com.microsoft.rest.v3.annotations.Beta;
-import com.microsoft.rest.v3.protocol.SerializerEncoding;
-import com.microsoft.rest.v3.serializer.JacksonAdapter;
+import com.microsoft.rest.v3.serializer.SerializerEncoding;
+import com.microsoft.rest.v3.serializer.jackson.JacksonAdapter;
 
 import java.io.File;
 import java.io.IOException;

azure-client-authentication/src/main/java/com/microsoft/azure/v3/credentials/AzureCliCredentials.java

@@ -10,7 +10,7 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.microsoft.azure.v3.AzureEnvironment;
 import com.microsoft.rest.v3.annotations.Beta;
-import com.microsoft.rest.v3.serializer.JacksonAdapter;
+import com.microsoft.rest.v3.serializer.jackson.JacksonAdapter;
 import reactor.core.Exceptions;
 import reactor.core.publisher.Mono;
 import reactor.core.scheduler.Schedulers;

azure-client-authentication/src/main/java/com/microsoft/azure/v3/credentials/MSICredentials.java

@@ -8,7 +8,7 @@
 
 import com.microsoft.azure.v3.serializer.AzureJacksonAdapter;
 import com.microsoft.rest.v3.annotations.Beta;
-import com.microsoft.rest.v3.protocol.SerializerEncoding;
+import com.microsoft.rest.v3.serializer.SerializerEncoding;
 import reactor.core.publisher.Mono;
 
 import java.io.BufferedReader;

azure-client-authentication/src/test/java/com/microsoft/azure/v3/credentials/http/MockHttpResponse.java

@@ -8,9 +8,9 @@
 
 import com.microsoft.rest.v3.http.HttpHeaders;
 import com.microsoft.rest.v3.http.HttpResponse;
-import com.microsoft.rest.v3.protocol.SerializerAdapter;
-import com.microsoft.rest.v3.protocol.SerializerEncoding;
-import com.microsoft.rest.v3.serializer.JacksonAdapter;
+import com.microsoft.rest.v3.serializer.SerializerAdapter;
+import com.microsoft.rest.v3.serializer.SerializerEncoding;
+import com.microsoft.rest.v3.serializer.jackson.JacksonAdapter;
 import io.netty.buffer.ByteBuf;
 import io.netty.buffer.Unpooled;
 import reactor.core.publisher.Flux;

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

@@ -26,8 +26,8 @@
 import com.microsoft.rest.v3.http.policy.DecodingPolicy;
 import com.microsoft.rest.v3.http.policy.RetryPolicy;
 import com.microsoft.rest.v3.http.policy.UserAgentPolicy;
-import com.microsoft.rest.v3.protocol.SerializerAdapter;
-import com.microsoft.rest.v3.protocol.SerializerEncoding;
+import com.microsoft.rest.v3.serializer.SerializerAdapter;
+import com.microsoft.rest.v3.serializer.SerializerEncoding;
 import com.microsoft.rest.v3.util.TypeUtil;
 import reactor.core.Exceptions;
 import reactor.core.publisher.Flux;

azure-client-runtime/src/main/java/com/microsoft/azure/v3/AzureServiceClient.java

@@ -8,7 +8,7 @@
 
 import com.microsoft.rest.v3.ServiceClient;
 import com.microsoft.rest.v3.http.HttpPipeline;
-import com.microsoft.rest.v3.protocol.SerializerAdapter;
+import com.microsoft.rest.v3.serializer.SerializerAdapter;
 
 /**
  * The base class for generated Azure service clients.

azure-client-runtime/src/main/java/com/microsoft/azure/v3/PollStrategy.java

@@ -12,8 +12,8 @@
 import com.microsoft.rest.v3.http.ContextData;
 import com.microsoft.rest.v3.http.HttpRequest;
 import com.microsoft.rest.v3.http.HttpResponse;
-import com.microsoft.rest.v3.protocol.HttpResponseDecoder;
-import com.microsoft.rest.v3.protocol.SerializerEncoding;
+import com.microsoft.rest.v3.serializer.HttpResponseDecoder;
+import com.microsoft.rest.v3.serializer.SerializerEncoding;
 import reactor.core.publisher.Flux;
 import reactor.core.publisher.Mono;
 

azure-client-runtime/src/main/java/com/microsoft/azure/v3/serializer/AzureJacksonAdapter.java

@@ -6,8 +6,8 @@
 
 package com.microsoft.azure.v3.serializer;
 
-import com.microsoft.rest.v3.protocol.SerializerAdapter;
-import com.microsoft.rest.v3.serializer.JacksonAdapter;
+import com.microsoft.rest.v3.serializer.SerializerAdapter;
+import com.microsoft.rest.v3.serializer.jackson.JacksonAdapter;
 
 /**
  * A serialization helper class overriding {@link JacksonAdapter} with extra

azure-client-runtime/src/test/java/com/microsoft/azure/v3/AzureProxyTests.java

@@ -13,8 +13,8 @@
 import com.microsoft.rest.v3.http.HttpResponse;
 import com.microsoft.rest.v3.http.policy.DecodingPolicy;
 import com.microsoft.rest.v3.http.HttpPipelineOptions;
-import com.microsoft.rest.v3.protocol.SerializerAdapter;
-import com.microsoft.rest.v3.serializer.JacksonAdapter;
+import com.microsoft.rest.v3.serializer.SerializerAdapter;
+import com.microsoft.rest.v3.serializer.jackson.JacksonAdapter;
 import com.microsoft.rest.v3.InvalidReturnTypeException;
 import com.microsoft.rest.v3.annotations.DELETE;
 import com.microsoft.rest.v3.annotations.ExpectedResponses;

azure-client-runtime/src/test/java/com/microsoft/azure/v3/AzureProxyToRestProxyTests.java

@@ -7,8 +7,8 @@
 import com.microsoft.rest.v3.http.HttpPipeline;
 import com.microsoft.rest.v3.http.policy.DecodingPolicy;
 import com.microsoft.rest.v3.http.HttpPipelineOptions;
-import com.microsoft.rest.v3.protocol.SerializerAdapter;
-import com.microsoft.rest.v3.serializer.JacksonAdapter;
+import com.microsoft.rest.v3.serializer.SerializerAdapter;
+import com.microsoft.rest.v3.serializer.jackson.JacksonAdapter;
 import com.microsoft.rest.v3.annotations.BodyParam;
 import com.microsoft.rest.v3.annotations.DELETE;
 import com.microsoft.rest.v3.annotations.ExpectedResponses;

azure-client-runtime/src/test/java/com/microsoft/azure/v3/http/MockAzureHttpResponse.java

@@ -8,9 +8,9 @@
 
 import com.microsoft.rest.v3.http.HttpHeaders;
 import com.microsoft.rest.v3.http.HttpResponse;
-import com.microsoft.rest.v3.protocol.SerializerAdapter;
-import com.microsoft.rest.v3.protocol.SerializerEncoding;
-import com.microsoft.rest.v3.serializer.JacksonAdapter;
+import com.microsoft.rest.v3.serializer.SerializerAdapter;
+import com.microsoft.rest.v3.serializer.SerializerEncoding;
+import com.microsoft.rest.v3.serializer.jackson.JacksonAdapter;
 import io.netty.buffer.ByteBuf;
 import io.netty.buffer.Unpooled;
 import reactor.core.publisher.Flux;

client-runtime/src/main/java/com/microsoft/rest/v3/RestContentResponse.java

@@ -13,7 +13,7 @@
 /**
  * REST response with a strongly-typed content specified.
  *
- * @param <TBody> The deserialized type of the response body.
+ * @param <TBody> The deserialized type of the response content.
  */
 public final class RestContentResponse<TBody> extends RestResponse<Void, TBody> {
     /**

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

@@ -24,10 +24,10 @@
 import com.microsoft.rest.v3.http.HttpPipelineOptions;
 import com.microsoft.rest.v3.http.policy.RetryPolicy;
 import com.microsoft.rest.v3.http.policy.UserAgentPolicy;
-import com.microsoft.rest.v3.protocol.HttpResponseDecoder;
-import com.microsoft.rest.v3.protocol.SerializerAdapter;
-import com.microsoft.rest.v3.protocol.SerializerEncoding;
-import com.microsoft.rest.v3.serializer.JacksonAdapter;
+import com.microsoft.rest.v3.serializer.HttpResponseDecoder;
+import com.microsoft.rest.v3.serializer.SerializerAdapter;
+import com.microsoft.rest.v3.serializer.SerializerEncoding;
+import com.microsoft.rest.v3.serializer.jackson.JacksonAdapter;
 import com.microsoft.rest.v3.util.FluxUtil;
 import com.microsoft.rest.v3.util.TypeUtil;
 import io.netty.buffer.ByteBuf;

client-runtime/src/main/java/com/microsoft/rest/v3/ServiceClient.java

@@ -7,7 +7,7 @@
 package com.microsoft.rest.v3;
 
 import com.microsoft.rest.v3.http.HttpPipeline;
-import com.microsoft.rest.v3.protocol.SerializerAdapter;
+import com.microsoft.rest.v3.serializer.SerializerAdapter;
 
 /**
  * The base class for REST service clients.

client-runtime/src/main/java/com/microsoft/rest/v3/SwaggerInterfaceParser.java

@@ -7,7 +7,7 @@
 package com.microsoft.rest.v3;
 
 import com.microsoft.rest.v3.annotations.Host;
-import com.microsoft.rest.v3.protocol.SerializerAdapter;
+import com.microsoft.rest.v3.serializer.SerializerAdapter;
 
 import java.lang.reflect.Method;
 import java.util.HashMap;

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

@@ -25,7 +25,8 @@
 import com.microsoft.rest.v3.http.HttpHeader;
 import com.microsoft.rest.v3.http.HttpHeaders;
 import com.microsoft.rest.v3.http.HttpMethod;
-import com.microsoft.rest.v3.protocol.SerializerAdapter;
+import com.microsoft.rest.v3.serializer.HttpResponseDecodeData;
+import com.microsoft.rest.v3.serializer.SerializerAdapter;
 import com.microsoft.rest.v3.util.TypeUtil;
 import com.microsoft.rest.v3.util.escapers.PercentEscaper;
 import com.microsoft.rest.v3.util.escapers.UrlEscapers;
@@ -44,7 +45,7 @@
  * The type to parse details of a specific Swagger REST API call from a provided Swagger interface
  * method.
  */
-public class SwaggerMethodParser {
+public class SwaggerMethodParser implements HttpResponseDecodeData {
     private final SerializerAdapter serializer;
     private final String rawHost;
     private final String fullyQualifiedMethodName;
@@ -207,6 +208,7 @@ public String fullyQualifiedMethodName() {
      *
      * @return the HTTP method that will be used to complete the Swagger method's request
      */
+    @Override
     public HttpMethod httpMethod() {
         return httpMethod;
     }
@@ -219,6 +221,7 @@ public HttpMethod httpMethod() {
      * @return the expected HTTP response status codes for this Swagger method or null if all status
      * codes less than 400 are allowed.
      */
+    @Override
     public int[] expectedStatusCodes() {
         return expectedStatusCodes;
     }
@@ -405,6 +408,7 @@ public Class<? extends RestException> exceptionType() {
      * @return the type of body Object that a thrown RestException will contain if the HTTP
      * response's status code is not one of the expected status codes
      */
+    @Override
     public Class<?> exceptionBodyType() {
         return exceptionBodyType;
     }
@@ -442,6 +446,7 @@ public String bodyContentType() {
      *
      * @return the return type for the method that this object describes.
      */
+    @Override
     public Type returnType() {
         return returnType;
     }
@@ -463,6 +468,7 @@ public Type bodyJavaType() {
      *
      * @return the type that the raw HTTP response body will be sent as
      */
+    @Override
     public Type returnValueWireType() {
         return returnValueWireType;
     }

client-runtime/src/main/java/com/microsoft/rest/v3/annotations/BodyParam.java

@@ -13,7 +13,7 @@
 import static java.lang.annotation.RetentionPolicy.RUNTIME;
 
 /**
- * Annotation for the parameter to be sent as the HTTP Request content.
+ * Annotation to annotate a parameter to send to a REST endpoint as HTTP Request content.
  *
  * If the parameter type extends InputStream, this payload is streamed to server through
  * "application/octet-stream". Otherwise, the body is serialized first and sent as

client-runtime/src/main/java/com/microsoft/rest/v3/annotations/DELETE.java

@@ -12,7 +12,7 @@
 import java.lang.annotation.Target;
 
 /**
- * HTTP DELETE method annotation describing the parametrized relative path to an endpoint for resource deletion.
+ * HTTP DELETE method annotation describing the parametrized relative path to a REST endpoint for resource deletion.
  *
  * The required value can be either a relative path or an absolute path. When it's
  * an absolute path, it must start with a protocol or a parametrized segment.

client-runtime/src/main/java/com/microsoft/rest/v3/annotations/ExpectedResponses.java

@@ -13,7 +13,7 @@
 import static java.lang.annotation.RetentionPolicy.RUNTIME;
 
 /**
- * Annotation to list the HTTP status codes that are expected for a REST API.
+ * Annotation to annotate list of HTTP status codes that are expected in response from a REST endpoint.
  *
  * Example:
  *   {@literal @}ExpectedResponses({200, 201})

client-runtime/src/main/java/com/microsoft/rest/v3/annotations/GET.java

@@ -12,7 +12,7 @@
 import java.lang.annotation.Target;
 
 /**
- * HTTP GET method annotation describing the parametrized relative path to an endpoint for resource retrieval.
+ * HTTP GET method annotation describing the parametrized relative path to a REST endpoint for resource retrieval.
  *
  * The required value can be either a relative path or an absolute path. When it's
  * an absolute path, it must start with a protocol or a parametrized segment.

client-runtime/src/main/java/com/microsoft/rest/v3/annotations/HEAD.java

@@ -12,7 +12,7 @@
 import java.lang.annotation.Target;
 
 /**
- * HTTP HEAD method annotation describing the parametrized relative path to an endpoint.
+ * HTTP HEAD method annotation describing the parametrized relative path to a REST endpoint.
  *
  * The required value can be either a relative path or an absolute path. When it's
  * an absolute path, it must start with a protocol or a parametrized segment.

client-runtime/src/main/java/com/microsoft/rest/v3/annotations/Headers.java

@@ -13,7 +13,7 @@
 import static java.lang.annotation.RetentionPolicy.RUNTIME;
 
 /**
- * List of static headers sent to the REST endpoint.
+ * Annotation to annotate list of static headers sent to a REST endpoint.
  *
  * Headers are comma separated strings, with each in the format of
  * "header name: header value1,header value2".

client-runtime/src/main/java/com/microsoft/rest/v3/annotations/Host.java

@@ -13,7 +13,7 @@
 import static java.lang.annotation.ElementType.TYPE;
 
 /**
- * Annotation for parametrized host name.
+ * Annotation for parametrized host name targeting a REST service.
  *
  * This is the 'host' field or 'x-ms-parameterized-host.hostTemplate' field in
  * a Swagger document. parameters are enclosed in {}s, e.g. {accountName}. An

client-runtime/src/main/java/com/microsoft/rest/v3/annotations/HostParam.java

@@ -13,7 +13,7 @@
 import static java.lang.annotation.RetentionPolicy.RUNTIME;
 
 /**
- * A host parameter annotation for replacing parametrized segments in a dynamic {@link Host}.
+ * Annotation to annotate replacement of parametrized segments in a dynamic {@link Host}.
  *
  * You provide the value, which should be the same (case sensitive) with
  * the parametrized segments in '{}' in the host, unless there's only one

client-runtime/src/main/java/com/microsoft/rest/v3/annotations/PATCH.java

@@ -12,7 +12,7 @@
 import java.lang.annotation.Target;
 
 /**
- * HTTP PATCH method annotation describing the parametrized relative path to an endpoint for resource patch (update).
+ * HTTP PATCH method annotation describing the parametrized relative path to a REST endpoint for resource update.
  *
  * The required value can be either a relative path or an absolute path. When it's
  * an absolute path, it must start with a protocol or a parametrized segment.

client-runtime/src/main/java/com/microsoft/rest/v3/annotations/POST.java

@@ -12,7 +12,7 @@
 import java.lang.annotation.Target;
 
 /**
- * HTTP POST method annotation describing the parametrized relative path to an endpoint for an action.
+ * HTTP POST method annotation describing the parametrized relative path to a REST endpoint for an action.
  *
  * The required value can be either a relative path or an absolute path. When it's
  * an absolute path, it must start with a protocol or a parametrized segment.

client-runtime/src/main/java/com/microsoft/rest/v3/annotations/PUT.java

@@ -12,7 +12,7 @@
 import java.lang.annotation.Target;
 
 /**
- * HTTP PUT method annotation describing the parametrized relative path to an endpoint for resource creation or update.
+ * HTTP PUT method annotation describing the parametrized relative path to a REST endpoint for resource creation or update.
  *
  * The required value can be either a relative path or an absolute path. When it's
  * an absolute path, it must start with a protocol or a parametrized segment.

client-runtime/src/main/java/com/microsoft/rest/v3/annotations/PathParam.java

@@ -13,7 +13,7 @@
 import static java.lang.annotation.RetentionPolicy.RUNTIME;
 
 /**
- * Annotation for named replacement in a REST API URL path segment.
+ * Annotation to annotate replacement for a named path segment in REST endpoint URL.
  *
  * A parameter that is annotated with PathParam will be ignored if the "uri template"
  * does not contain a path segment variable with name {@link PathParam#value()}.

client-runtime/src/main/java/com/microsoft/rest/v3/annotations/QueryParam.java

@@ -13,7 +13,7 @@
 import static java.lang.annotation.RetentionPolicy.RUNTIME;
 
 /**
- * Annotation for query parameters to be appended to REST API Request URI.
+ * Annotation for query parameters to be appended to a REST API Request URI.
  *
  * Example#1:
  *

client-runtime/src/main/java/com/microsoft/rest/v3/annotations/ReturnValueWireType.java

@@ -13,8 +13,7 @@
 import static java.lang.annotation.RetentionPolicy.RUNTIME;
 
 /**
- * Annotation for the type that will be used to deserialize the return value of a service interface
- * method from a network response.
+ * Annotation for the type that will be used to deserialize the return value of a REST API response.
  */
 @Retention(RUNTIME)
 @Target(METHOD)

client-runtime/src/main/java/com/microsoft/rest/v3/annotations/package-info.java

@@ -1,4 +1,4 @@
 /**
- * Package containing annotation for client side methods that maps to REST APIs.
+ * Package containing annotations for client side methods that maps to REST APIs.
  */
 package com.microsoft.rest.v3.annotations;

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

@@ -6,7 +6,7 @@
 
 package com.microsoft.rest.v3.http;
 
-import com.microsoft.rest.v3.protocol.HttpResponseDecoder;
+import com.microsoft.rest.v3.serializer.HttpResponseDecoder;
 import io.netty.buffer.ByteBuf;
 import io.netty.buffer.Unpooled;
 import reactor.core.publisher.Flux;

client-runtime/src/main/java/com/microsoft/rest/v3/http/policy/DecodingPolicy.java

@@ -9,7 +9,7 @@
 import com.microsoft.rest.v3.http.HttpPipelineCallContext;
 import com.microsoft.rest.v3.http.HttpResponse;
 import com.microsoft.rest.v3.http.NextPolicy;
-import com.microsoft.rest.v3.protocol.HttpResponseDecoder;
+import com.microsoft.rest.v3.serializer.HttpResponseDecoder;
 import reactor.core.publisher.Mono;
 
 /**

client-runtime/src/main/java/com/microsoft/rest/v3/http/policy/package-info.java

@@ -1,5 +1,5 @@
 /**
- * Package containing HttpPipeline policies.
+ * Package containing HttpPipelinePolicy interface and it's implementations.
  */
 package com.microsoft.rest.v3.http.policy;