Add ErrorOptions to RequestOptions (Azure#25130)

Add ErrorOptions to RequestOptions

Author: alzimmermsft

sdk/core/azure-core/src/main/java/com/azure/core/http/rest/ErrorOptions.java

@@ -0,0 +1,19 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.azure.core.http.rest;
+
+/**
+ * Determines how errors are handled by requests using {@link RequestOptions}.
+ */
+public enum ErrorOptions {
+    /**
+     * Throw exceptions when an HTTP response with a status code indicating an error (400 or above) is received.
+     */
+    THROW,
+
+    /**
+     * Do not throw exceptions when an HTTP response with a status code indicating an error (400 or above) is received.
+     */
+    NO_THROW
+}

sdk/core/azure-core/src/main/java/com/azure/core/http/rest/RequestOptions.java

@@ -8,23 +8,26 @@
 import com.azure.core.http.HttpRequest;
 import com.azure.core.util.BinaryData;
 import com.azure.core.util.Context;
+import com.azure.core.util.logging.ClientLogger;
 
+import java.util.EnumSet;
+import java.util.Objects;
 import java.util.function.Consumer;
 
 /**
- * This class contains the options to customize an HTTP request. {@link RequestOptions} can be
- * used to configure the request headers, query params, the request body, or add a callback
- * to modify all aspects of the HTTP request.
+ * This class contains the options to customize an HTTP request. {@link RequestOptions} can be used to configure the
+ * request headers, query params, the request body, or add a callback to modify all aspects of the HTTP request.
  *
  * <p>
- * An instance of fully configured {@link RequestOptions} can be passed to a service method that
- * preconfigures known components of the request like URL, path params etc, further modifying both
- * un-configured, or preconfigured components.
+ * An instance of fully configured {@link RequestOptions} can be passed to a service method that preconfigures known
+ * components of the request like URL, path params etc, further modifying both un-configured, or preconfigured
+ * components.
  * </p>
  *
  * <p>
  * To demonstrate how this class can be used to construct a request, let's use a Pet Store service as an example. The
- * list of APIs available on this service are <a href="https://petstore.swagger.io/#/pet">documented in the swagger definition.</a>
+ * list of APIs available on this service are <a href="https://petstore.swagger.io/#/pet">documented in the swagger
+ * definition.</a>
  * </p>
  *
  * <p><strong>Creating an instance of RequestOptions</strong></p>
@@ -37,8 +40,8 @@
  * <!-- end com.azure.core.http.rest.requestoptions.instantiation -->
  *
  * <p><strong>Configuring the request with JSON body and making a HTTP POST request</strong></p>
- * To <a href="https://petstore.swagger.io/#/pet/addPet">add a new pet to the pet store</a>, an HTTP POST call should
- * be made to the service with the details of the pet that is to be added. The details of the pet are included as the
+ * To <a href="https://petstore.swagger.io/#/pet/addPet">add a new pet to the pet store</a>, an HTTP POST call should be
+ * made to the service with the details of the pet that is to be added. The details of the pet are included as the
  * request body in JSON format.
  *
  * The JSON structure for the request is defined as follows:
@@ -112,26 +115,34 @@
  * <!-- end com.azure.core.http.rest.requestoptions.postrequest -->
  */
 public final class RequestOptions {
-    private Consumer<HttpRequest> requestCallback = request -> { };
-    private boolean throwOnError = true;
+    private static final ClientLogger LOGGER = new ClientLogger(RequestOptions.class);
+
+    private static final EnumSet<ErrorOptions> DEFAULT = EnumSet.of(ErrorOptions.THROW);
+
+    private Consumer<HttpRequest> requestCallback = request -> {
+    };
+    private EnumSet<ErrorOptions> errorOptions = DEFAULT;
     private Context context;
 
     /**
      * Gets the request callback, applying all the configurations set on this RequestOptions.
+     *
      * @return the request callback
      */
     Consumer<HttpRequest> getRequestCallback() {
         return this.requestCallback;
     }
 
     /**
-     * Gets whether an exception is thrown when an HTTP response with a status code indicating an error
-     * (400 or above) is received.
+     * Gets the {@link ErrorOptions} that determines how error responses (400 or above) are handled.
+     * <p>
+     * Default is to throw.
      *
-     * @return true if to throw on status codes of 400 or above, false if not. Default is true.
+     * @return The {@link ErrorOptions} that determines how error responses (400 or above) are handled. Default is to
+     * throw.
      */
-    boolean isThrowOnError() {
-        return this.throwOnError;
+    EnumSet<ErrorOptions> getErrorOptions() {
+        return this.errorOptions;
     }
 
     /**
@@ -145,9 +156,9 @@ Context getContext() {
 
     /**
      * Adds a header to the HTTP request.
+     *
      * @param header the header key
      * @param value the header value
-     *
      * @return the modified RequestOptions object
      */
     public RequestOptions addHeader(String header, String value) {
@@ -163,8 +174,8 @@ public RequestOptions addHeader(String header, String value) {
     }
 
     /**
-     * Adds a query parameter to the request URL. The parameter name and value will be URL encoded.
-     * To use an already encoded parameter name and value, call {@code addQueryParam("name", "value", true)}.
+     * Adds a query parameter to the request URL. The parameter name and value will be URL encoded. To use an already
+     * encoded parameter name and value, call {@code addQueryParam("name", "value", true)}.
      *
      * @param parameterName the name of the query parameter
      * @param value the value of the query parameter
@@ -175,9 +186,9 @@ public RequestOptions addQueryParam(String parameterName, String value) {
     }
 
     /**
-     * Adds a query parameter to the request URL, specifying whether the parameter is already encoded.
-     * A value true for this argument indicates that value of {@link QueryParam#value()} is already encoded
-     * hence engine should not encode it, by default value will be encoded.
+     * Adds a query parameter to the request URL, specifying whether the parameter is already encoded. A value true for
+     * this argument indicates that value of {@link QueryParam#value()} is already encoded hence engine should not
+     * encode it, by default value will be encoded.
      *
      * @param parameterName the name of the query parameter
      * @param value the value of the query parameter
@@ -195,38 +206,55 @@ public RequestOptions addQueryParam(String parameterName, String value, boolean
     }
 
     /**
-     * Adds a custom request callback to modify the HTTP request before it's sent by the HttpClient.
-     * The modifications made on a RequestOptions object is applied in order on the request.
+     * Adds a custom request callback to modify the HTTP request before it's sent by the HttpClient. The modifications
+     * made on a RequestOptions object is applied in order on the request.
      *
      * @param requestCallback the request callback
      * @return the modified RequestOptions object
+     * @throws NullPointerException If {@code requestCallback} is null.
      */
     public RequestOptions addRequestCallback(Consumer<HttpRequest> requestCallback) {
+        Objects.requireNonNull(requestCallback, "'requestCallback' cannot be null.");
         this.requestCallback = this.requestCallback.andThen(requestCallback);
         return this;
     }
 
     /**
      * Sets the body to send as part of the HTTP request.
+     *
      * @param requestBody the request body data
      * @return the modified RequestOptions object
+     * @throws NullPointerException If {@code requestBody} is null.
      */
     public RequestOptions setBody(BinaryData requestBody) {
-        this.requestCallback = this.requestCallback.andThen(request -> {
-            request.setBody(requestBody.toBytes());
-        });
+        Objects.requireNonNull(requestBody, "'requestBody' cannot be null.");
+        this.requestCallback = this.requestCallback.andThen(request -> request.setBody(requestBody.toBytes()));
         return this;
     }
 
     /**
-     * Sets whether exception is thrown when an HTTP response with a status code indicating an error
-     * (400 or above) is received. By default, an exception will be thrown when an error response is received.
+     * Sets the {@link ErrorOptions} that determines how error responses (400 or above) are handled.
+     * <p>
+     * Default is to throw.
+     * <p>
+     * If both {@link ErrorOptions#THROW} and {@link ErrorOptions#NO_THROW} are included in {@code errorOptions}
+     * an exception will be thrown as they aren't compatible with each other.
      *
-     * @param throwOnError true if to throw on status codes of 400 or above, false if not. Default is true.
+     * @param errorOptions The {@link ErrorOptions} that determines how error responses (400 or above) are handled.
      * @return the modified RequestOptions object
+     * @throws NullPointerException If {@code errorOptions} is null.
+     * @throws IllegalArgumentException If both {@link ErrorOptions#THROW} and {@link ErrorOptions#NO_THROW} are
+     * included in {@code errorOptions}.
      */
-    public RequestOptions setThrowOnError(boolean throwOnError) {
-        this.throwOnError = throwOnError;
+    public RequestOptions setErrorOptions(EnumSet<ErrorOptions> errorOptions) {
+        Objects.requireNonNull(errorOptions, "'errorOptions' cannot be null.");
+
+        if (errorOptions.contains(ErrorOptions.THROW) && errorOptions.contains(ErrorOptions.NO_THROW)) {
+            throw LOGGER.logExceptionAsError(new IllegalArgumentException(
+                "'errorOptions' cannot contain both 'ErrorOptions.THROW' and 'ErrorOptions.NO_THROW'."));
+        }
+
+        this.errorOptions = errorOptions;
         return this;
     }
 

sdk/core/azure-core/src/main/java/com/azure/core/http/rest/RestProxy.java

@@ -420,7 +420,7 @@ private Mono<HttpDecodedResponse> ensureExpectedStatus(final HttpDecodedResponse
         // If the response was success or configured to not return an error status when the request fails, return the
         // decoded response.
         if (methodParser.isExpectedResponseStatusCode(responseStatusCode)
-            || (options != null && !options.isThrowOnError())) {
+            || (options != null && options.getErrorOptions().contains(ErrorOptions.NO_THROW))) {
             return Mono.just(decodedResponse);
         }
 

sdk/core/azure-core/src/test/java/com/azure/core/http/rest/SwaggerMethodParserTests.java

@@ -43,6 +43,7 @@
 import java.time.ZoneOffset;
 import java.util.Arrays;
 import java.util.Collections;
+import java.util.EnumSet;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -522,8 +523,7 @@ private static Stream<Arguments> setRequestOptionsSupplier() throws NoSuchMethod
         RequestOptions urlOptions = new RequestOptions()
             .addRequestCallback(httpRequest -> httpRequest.setUrl("https://foo.host.com"));
 
-        RequestOptions statusOptionOptions = new RequestOptions()
-            .setThrowOnError(false);
+        RequestOptions statusOptionOptions = new RequestOptions().setErrorOptions(EnumSet.of(ErrorOptions.NO_THROW));
 
         return Stream.of(
             Arguments.of(swaggerMethodParser, null, null),

sdk/webpubsub/azure-messaging-webpubsub/pom.xml

@@ -46,7 +46,7 @@
     <dependency>
       <groupId>com.azure</groupId>
       <artifactId>azure-core</artifactId>
-      <version>1.22.0-beta.1</version> <!-- {x-version-update;beta_com.azure:azure-core;dependency} -->
+      <version>1.22.0-beta.2</version> <!-- {x-version-update;unreleased_com.azure:azure-core;dependency} -->
     </dependency>
     <dependency>
       <groupId>com.azure</groupId>

sdk/webpubsub/azure-messaging-webpubsub/src/test/java/com/azure/messaging/webpubsub/WebPubSubServiceClientTests.java

@@ -6,6 +6,7 @@
 import com.azure.core.http.HttpClient;
 import com.azure.core.http.policy.HttpLogDetailLevel;
 import com.azure.core.http.policy.HttpLogOptions;
+import com.azure.core.http.rest.ErrorOptions;
 import com.azure.core.http.rest.RequestOptions;
 import com.azure.core.http.rest.Response;
 import com.azure.core.test.TestBase;
@@ -27,6 +28,7 @@
 
 import java.nio.charset.StandardCharsets;
 import java.text.ParseException;
+import java.util.EnumSet;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
@@ -243,7 +245,7 @@ public void testAadCredential() {
     public void testCheckPermission() {
         RequestOptions requestOptions = new RequestOptions()
             .addQueryParam("targetName", "group_name")
-            .setThrowOnError(false);
+            .setErrorOptions(EnumSet.of(ErrorOptions.NO_THROW));
         boolean permission = client.checkPermissionWithResponse(WebPubSubPermission.JOIN_LEAVE_GROUP, "connection_id",
             requestOptions).getValue();
         Assertions.assertFalse(permission);