Provide a way to automatically deserialize non-OK JSON response

core/src/main/java/com/linecorp/armeria/client/AggregatedResponseAs.java

@@ -57,10 +57,6 @@ static <T> ResponseAs<AggregatedHttpResponse, ResponseEntity<T>> json(TypeRefere
 
  private static <T> ResponseEntity<T> newJsonResponseEntity(AggregatedHttpResponse response,
  JsonDecoder<T> decoder) {
- if (!response.status().isSuccess()) {
- throw newInvalidHttpResponseException(response);
- }
-
  try {
  return ResponseEntity.of(response.headers(), decoder.decode(response.content().array()),
  response.trailers());
@@ -69,13 +65,6 @@ private static <T> ResponseEntity<T> newJsonResponseEntity(AggregatedHttpRespons
  }
  }
 
- private static InvalidHttpResponseException newInvalidHttpResponseException(
- AggregatedHttpResponse response) {
- return new InvalidHttpResponseException(
- response, "status: " + response.status() +
- " (expect: the success class (2xx). response: " + response, null);
- }
-
  @FunctionalInterface
  private interface JsonDecoder<T> {
  T decode(byte[] bytes) throws IOException;

core/src/main/java/com/linecorp/armeria/client/BlockingConditionalResponseAs.java

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2023 LINE Corporation
+ *
+ * LINE Corporation licenses this file to you under the Apache License,
+ * version 2.0 (the "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at:
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ */
+
 package com.linecorp.armeria.client;
 
 import java.util.function.Predicate;
@@ -9,47 +25,85 @@
 import com.linecorp.armeria.common.HttpResponse;
 import com.linecorp.armeria.common.ResponseEntity;
 
-final class BlockingConditionalResponseAs<V> extends ConditionalResponseAs<HttpResponse, AggregatedHttpResponse, ResponseEntity<V>> {
+public final class BlockingConditionalResponseAs<V>
+ extends ConditionalResponseAs<HttpResponse, AggregatedHttpResponse, ResponseEntity<V>> {
 
  BlockingConditionalResponseAs(ResponseAs<HttpResponse, AggregatedHttpResponse> originalResponseAs,
  ResponseAs<AggregatedHttpResponse, ResponseEntity<V>> responseAs,
  Predicate<AggregatedHttpResponse> predicate) {
  super(originalResponseAs, responseAs, predicate);
  }
 
+ /**
+ * Invokes {@link ConditionalResponseAs#andThen(ResponseAs, Predicate)} to add the mapping of
+ * {@link ResponseAs} and {@link Predicate}
+ */
  public BlockingConditionalResponseAs<V> andThenJson(
  Class<? extends V> clazz, Predicate<AggregatedHttpResponse> predicate) {
  return (BlockingConditionalResponseAs<V>) andThen(AggregatedResponseAs.json(clazz), predicate);
  }
 
+ /**
+ * Invokes {@link ConditionalResponseAs#andThen(ResponseAs, Predicate)} to add the mapping of
+ * {@link ResponseAs} and {@link Predicate}
+ */
  public BlockingConditionalResponseAs<V> andThenJson(
  Class<? extends V> clazz, ObjectMapper objectMapper, Predicate<AggregatedHttpResponse> predicate) {
- return (BlockingConditionalResponseAs<V>) andThen(AggregatedResponseAs.json(clazz, objectMapper), predicate);
+ return (BlockingConditionalResponseAs<V>) andThen(
+ AggregatedResponseAs.json(clazz, objectMapper), predicate);
  }
 
+ /**
+ * Invokes {@link ConditionalResponseAs#andThen(ResponseAs, Predicate)} to add the mapping of
+ * {@link ResponseAs} and {@link Predicate}
+ */
  public BlockingConditionalResponseAs<V> andThenJson(
  TypeReference<? extends V> typeRef, Predicate<AggregatedHttpResponse> predicate) {
  return (BlockingConditionalResponseAs<V>) andThen(AggregatedResponseAs.json(typeRef), predicate);
  }
 
+ /**
+ * Invokes {@link ConditionalResponseAs#andThen(ResponseAs, Predicate)} to add the mapping of
+ * {@link ResponseAs} and {@link Predicate}
+ */
  public BlockingConditionalResponseAs<V> andThenJson(
- TypeReference<? extends V> typeRef, ObjectMapper objectMapper, Predicate<AggregatedHttpResponse> predicate) {
- return (BlockingConditionalResponseAs<V>) andThen(AggregatedResponseAs.json(typeRef, objectMapper), predicate);
+ TypeReference<? extends V> typeRef, ObjectMapper objectMapper,
+ Predicate<AggregatedHttpResponse> predicate) {
+ return (BlockingConditionalResponseAs<V>) andThen(
+ AggregatedResponseAs.json(typeRef, objectMapper), predicate);
  }
 
+ /**
+ * Invokes {@link ConditionalResponseAs#orElse(ResponseAs)} and returns {@link ResponseAs} whose
+ * {@link Predicate} is evaluated as true.
+ */
  public ResponseAs<HttpResponse, ResponseEntity<V>> orElseJson(Class<? extends V> clazz) {
- return super.orElse(AggregatedResponseAs.json(clazz));
+ return orElse(AggregatedResponseAs.json(clazz));
  }
 
- public ResponseAs<HttpResponse, ResponseEntity<V>> orElseJson(Class<? extends V> clazz, ObjectMapper objectMapper) {
- return super.orElse(AggregatedResponseAs.json(clazz, objectMapper));
+ /**
+ * Invokes {@link ConditionalResponseAs#orElse(ResponseAs)} and returns {@link ResponseAs} whose
+ * {@link Predicate} is evaluated as true.
+ */
+ public ResponseAs<HttpResponse, ResponseEntity<V>> orElseJson(
+ Class<? extends V> clazz, ObjectMapper objectMapper) {
+ return orElse(AggregatedResponseAs.json(clazz, objectMapper));
  }
 
+ /**
+ * Invokes {@link ConditionalResponseAs#orElse(ResponseAs)} and returns {@link ResponseAs} whose
+ * {@link Predicate} is evaluated as true.
+ */
  public ResponseAs<HttpResponse, ResponseEntity<V>> orElseJson(TypeReference<? extends V> typeRef) {
- return super.orElse(AggregatedResponseAs.json(typeRef));
+ return orElse(AggregatedResponseAs.json(typeRef));
  }
 
- public ResponseAs<HttpResponse, ResponseEntity<V>> orElseJson(TypeReference<? extends V> typeRef, ObjectMapper objectMapper) {
- return super.orElse(AggregatedResponseAs.json(typeRef, objectMapper));
+ /**
+ * Invokes {@link ConditionalResponseAs#orElse(ResponseAs)} and returns {@link ResponseAs} whose
+ * {@link Predicate} is evaluated as true.
+ */
+ public ResponseAs<HttpResponse, ResponseEntity<V>> orElseJson(
+ TypeReference<? extends V> typeRef, ObjectMapper objectMapper) {
+ return orElse(AggregatedResponseAs.json(typeRef, objectMapper));
  }
 }

core/src/main/java/com/linecorp/armeria/client/BlockingResponseAs.java

@@ -20,6 +20,9 @@
 
 import java.util.function.Predicate;
 
+import com.fasterxml.jackson.core.type.TypeReference;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
 import com.linecorp.armeria.common.AggregatedHttpResponse;
 import com.linecorp.armeria.common.HttpResponse;
 import com.linecorp.armeria.common.util.Exceptions;
@@ -41,7 +44,26 @@ public boolean requiresAggregation() {
  return true;
  }
 
- <V> BlockingConditionalResponseAs<V> andThenJson(Class<? extends V> clazz, Predicate<AggregatedHttpResponse> predicate) {
+ public <V> BlockingConditionalResponseAs<V> andThenJson(
+ Class<? extends V> clazz, Predicate<AggregatedHttpResponse> predicate) {
  return new BlockingConditionalResponseAs<>(this, AggregatedResponseAs.json(clazz), predicate);
  }
+
+ public <V> BlockingConditionalResponseAs<V> andThenJson(
+ Class<? extends V> clazz, ObjectMapper objectMapper, Predicate<AggregatedHttpResponse> predicate) {
+ return new BlockingConditionalResponseAs<>(
+ this, AggregatedResponseAs.json(clazz, objectMapper), predicate);
+ }
+
+ public <V> BlockingConditionalResponseAs<V> andThenJson(
+ TypeReference<? extends V> typeRef, Predicate<AggregatedHttpResponse> predicate) {
+ return new BlockingConditionalResponseAs<>(this, AggregatedResponseAs.json(typeRef), predicate);
+ }
+
+ public <V> BlockingConditionalResponseAs<V> andThenJson(
+ TypeReference<? extends V> typeRef, ObjectMapper objectMapper,
+ Predicate<AggregatedHttpResponse> predicate) {
+ return new BlockingConditionalResponseAs<>(
+ this, AggregatedResponseAs.json(typeRef, objectMapper), predicate);
+ }
 }

core/src/main/java/com/linecorp/armeria/client/ConditionalResponseAs.java

@@ -22,23 +22,38 @@
 import java.util.Map.Entry;
 import java.util.function.Predicate;
 
+/**
+ * Adds the mapping of {@link ResponseAs} and {@link Predicate} in order to return {@link ResponseAs} whose
+ * {@link Predicate} is evaluated as true.
+ */
 public class ConditionalResponseAs<T, R, V> {
 
- private final ResponseAs<T, R> originalResposeAs;
- ConditionalResponseAs (ResponseAs<T, R> originalResposeAs, ResponseAs<R, V> responseAs, Predicate<R> predicate) {
- this.originalResposeAs = originalResposeAs;
- // This is necessary to add predicate into list
+ private final ResponseAs<T, R> originalResponseAs;
+ private final List<Entry<ResponseAs<R, V>, Predicate<R>>> predicateMappingList = new ArrayList<>();
+
+ ConditionalResponseAs(
+ ResponseAs<T, R> originalResponseAs, ResponseAs<R, V> responseAs, Predicate<R> predicate) {
+ this.originalResponseAs = originalResponseAs;
  andThen(responseAs, predicate);
  }
 
- final List<Entry<ResponseAs<R, V>, Predicate<R>>> list = new ArrayList<>();
+ /**
+ * Adds the mapping of {@link ResponseAs} and {@link Predicate} to the List.
+ */
+ public ConditionalResponseAs<T, R, V> andThen(ResponseAs<R, V> responseAs, Predicate<R> predicate) {
+ predicateMappingList.add(new SimpleEntry<>(responseAs, predicate));
+ return this;
+ }
 
+ /**
+ * Returns {@link ResponseAs} whose {@link Predicate} is evaluated as true.
+ */
  public ResponseAs<T, V> orElse(ResponseAs<R, V> responseAs) {
  return new ResponseAs<T, V>() {
  @Override
  public V as(T response) {
- final R r = originalResposeAs.as(response);
- for (Entry<ResponseAs<R, V>, Predicate<R>> entry: list) {
+ final R r = originalResponseAs.as(response);
+ for (Entry<ResponseAs<R, V>, Predicate<R>> entry: predicateMappingList) {
  if (entry.getValue().test(r)) {
  return entry.getKey().as(r);
  }
@@ -47,9 +62,4 @@ public V as(T response) {
  }
  };
  }
-
- public ConditionalResponseAs<T, R, V> andThen(ResponseAs<R, V> responseAs, Predicate<R> predicate) {
- list.add(new SimpleEntry<>(responseAs, predicate));
- return this;
- }
 }

core/src/main/java/com/linecorp/armeria/client/HttpStatusClassPredicates.java

@@ -0,0 +1,77 @@
+/*
+ * Copyright 2023 LINE Corporation
+ *
+ * LINE Corporation licenses this file to you under the Apache License,
+ * version 2.0 (the "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at:
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ */
+
+package com.linecorp.armeria.client;
+
+import static java.util.Objects.requireNonNull;
+
+import java.util.function.Predicate;
+
+import com.linecorp.armeria.common.HttpStatus;
+import com.linecorp.armeria.common.HttpStatusClass;
+
+final class HttpStatusClassPredicates implements Predicate<HttpStatus> {
+
+ private static final HttpStatusClassPredicates INFORMATIONAL_PREDICATE =
+ new HttpStatusClassPredicates(HttpStatusClass.INFORMATIONAL);
+
+ private static final HttpStatusClassPredicates SUCCESS_PREDICATE =
+ new HttpStatusClassPredicates(HttpStatusClass.SUCCESS);
+
+ private static final HttpStatusClassPredicates REDIRECTION_PREDICATE =
+ new HttpStatusClassPredicates(HttpStatusClass.REDIRECTION);
+
+ private static final HttpStatusClassPredicates CLIENT_ERROR_PREDICATE =
+ new HttpStatusClassPredicates(HttpStatusClass.CLIENT_ERROR);
+
+ private static final HttpStatusClassPredicates SERVER_ERROR_PREDICATE =
+ new HttpStatusClassPredicates(HttpStatusClass.SERVER_ERROR);
+
+ private static final HttpStatusClassPredicates UNKNOWN_PREDICATE =
+ new HttpStatusClassPredicates(HttpStatusClass.UNKNOWN);
+
+ static HttpStatusClassPredicates of(HttpStatusClass httpStatusClass) {
+ switch (httpStatusClass) {
+ case INFORMATIONAL:
+ return INFORMATIONAL_PREDICATE;
+ case SUCCESS:
+ return SUCCESS_PREDICATE;
+ case REDIRECTION:
+ return REDIRECTION_PREDICATE;
+ case CLIENT_ERROR:
+ return CLIENT_ERROR_PREDICATE;
+ case SERVER_ERROR:
+ return SERVER_ERROR_PREDICATE;
+ default:
+ return UNKNOWN_PREDICATE;
+ }
+ }
+
+ private final HttpStatusClass httpStatusClass;
+
+ private HttpStatusClassPredicates(HttpStatusClass httpStatusClass) {
+ this.httpStatusClass = requireNonNull(httpStatusClass, "httpStatusClass");
+ }
+
+ @Override
+ public boolean test(HttpStatus status) {
+ return httpStatusClass.contains(status);
+ }
+
+ HttpStatusClass statusClass() {
+ return httpStatusClass;
+ }
+}

core/src/main/java/com/linecorp/armeria/client/HttpStatusPredicate.java

@@ -0,0 +1,63 @@
+/*
+ * Copyright 2023 LINE Corporation
+ *
+ * LINE Corporation licenses this file to you under the Apache License,
+ * version 2.0 (the "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at:
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ */
+
+package com.linecorp.armeria.client;
+
+import static java.util.Objects.requireNonNull;
+
+import java.util.function.Predicate;
+
+import com.google.common.collect.ImmutableMap;
+
+import com.linecorp.armeria.common.HttpStatus;
+
+final class HttpStatusPredicate implements Predicate<HttpStatus> {
+ private static final ImmutableMap<HttpStatus, HttpStatusPredicate> httpStatusPredicateMap;
+
+ static {
+ final ImmutableMap.Builder<HttpStatus, HttpStatusPredicate> builder =
+ ImmutableMap.builderWithExpectedSize(1000);
+ for (int i = 0; i < 1000; i++) {
+ final HttpStatus status = HttpStatus.valueOf(i);
+ builder.put(status, new HttpStatusPredicate(HttpStatus.valueOf(i)));
+ }
+ httpStatusPredicateMap = builder.build();
+ }
+
+ static HttpStatusPredicate of(HttpStatus httpStatus) {
+ if (httpStatus.code() < 0 || httpStatus.code() >= 1000) {
+ return new HttpStatusPredicate(httpStatus);
+ } else {
+ final HttpStatusPredicate httpStatusPredicate = httpStatusPredicateMap.get(httpStatus);
+ return requireNonNull(httpStatusPredicate, "httpStatusPredicate");
+ }
+ }
+
+ private final HttpStatus status;
+
+ private HttpStatusPredicate(HttpStatus status) {
+ this.status = requireNonNull(status, "status");
+ }
+
+ @Override
+ public boolean test(HttpStatus status) {
+ return this.status.equals(status);
+ }
+
+ HttpStatus status() {
+ return status;
+ }
+}