Reduce complexity of exception factory

newtork · newtork · commit c6ab27cd41bf · 2025-08-06T14:22:42.000+02:00
diff --git a/core/src/main/java/com/sap/ai/sdk/core/common/ClientException.java b/core/src/main/java/com/sap/ai/sdk/core/common/ClientException.java
@@ -24,8 +24,9 @@ public class ClientException extends RuntimeException {
    * used to extract more detailed error information.
    */
   @Nullable
-  @Getter(onMethod_ = @Beta, value = AccessLevel.PROTECTED)
-  @Setter(onMethod_ = @Beta, value = AccessLevel.PROTECTED)
+  @Getter(onMethod_ = @Beta, value = AccessLevel.PUBLIC)
+  @Setter(onMethod_ = @Beta, value = AccessLevel.PUBLIC)
+  @Accessors(chain = true)
   ClientError clientError;
 
   /**
diff --git a/core/src/main/java/com/sap/ai/sdk/core/common/ClientExceptionFactory.java b/core/src/main/java/com/sap/ai/sdk/core/common/ClientExceptionFactory.java
@@ -12,6 +12,7 @@
  * @param <R> The subtype of {@link ClientError} payload that can be processed by this factory.
  */
 @Beta
+@FunctionalInterface
 public interface ClientExceptionFactory<E extends ClientException, R extends ClientError> {
 
   /**
@@ -22,7 +23,9 @@ public interface ClientExceptionFactory<E extends ClientException, R extends Cli
    * @return An instance of the specified {@link ClientException} type
    */
   @Nonnull
-  E build(@Nonnull final String message, @Nullable final Throwable cause);
+  default E build(@Nonnull final String message, @Nullable final Throwable cause) {
+    return build(message, null, cause);
+  }
 
   /**
    * Creates an exception with a message and optional cause.
@@ -40,9 +43,10 @@ default E build(@Nonnull final String message) {
    * deserialized into a {@link ClientError} object.
    *
    * @param message A descriptive message for the exception.
-   * @param clientError The structured {@link ClientError} object deserialized from the response.
+   * @param clientError The structured {@link ClientError} object deserialized from the response, null if not exist.
+   * @param cause An optional cause of the exception, can be null if not applicable.
    * @return An instance of the specified {@link ClientException} type
    */
   @Nonnull
-  E buildFromClientError(@Nonnull final String message, @Nonnull final R clientError);
+  E build(@Nonnull final String message, @Nullable final R clientError, @Nullable final Throwable cause);
 }
diff --git a/core/src/main/java/com/sap/ai/sdk/core/common/ClientResponseHandler.java b/core/src/main/java/com/sap/ai/sdk/core/common/ClientResponseHandler.java
@@ -79,7 +79,7 @@ public T handleResponse(@Nonnull final ClassicHttpResponse response) throws E {
   private T parseSuccess(@Nonnull final ClassicHttpResponse response) throws E {
     final HttpEntity responseEntity = response.getEntity();
     if (responseEntity == null) {
-      throw exceptionFactory.build("The HTTP Response is empty", null).setHttpResponse(response);
+      throw exceptionFactory.build("The HTTP Response is empty").setHttpResponse(response);
     }
 
     val content =
@@ -161,7 +161,7 @@ protected void parseErrorResponseAndThrow(
     }
     final R clientError = maybeClientError.get();
     val message = getErrorMessage(httpResponse, clientError.getMessage());
-    throw exceptionFactory.buildFromClientError(message, clientError).setHttpResponse(httpResponse);
+    throw exceptionFactory.build(message, clientError, null).setHttpResponse(httpResponse);
   }
 
   private static String getErrorMessage(
diff --git a/core/src/test/java/com/sap/ai/sdk/core/common/ClientResponseHandlerTest.java b/core/src/test/java/com/sap/ai/sdk/core/common/ClientResponseHandlerTest.java
@@ -17,6 +17,8 @@
 import org.apache.hc.core5.http.HttpEntity;
 import org.apache.hc.core5.http.io.entity.StringEntity;
 import org.apache.hc.core5.http.message.BasicClassicHttpResponse;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 import org.junit.jupiter.api.Test;
 
 class ClientResponseHandlerTest {
@@ -33,18 +35,10 @@ static class MyError implements ClientError {
   static class MyException extends ClientException {}
 
   static class MyExceptionFactory implements ClientExceptionFactory<MyException, MyError> {
-    @Nonnull
+    @NotNull
     @Override
-    public MyException build(@Nonnull String message, Throwable cause) {
-      return new MyException(message, cause);
-    }
-
-    @Nonnull
-    @Override
-    public MyException buildFromClientError(@Nonnull String message, @Nonnull MyError clientError) {
-      var ex = new MyException(message);
-      ex.clientError = clientError;
-      return ex;
+    public MyException build(@NotNull String message, @Nullable MyError clientError, @Nullable Throwable cause) {
+      return (MyException) new MyException(message, cause).setClientError(clientError);
     }
   }
 
diff --git a/core/src/test/java/com/sap/ai/sdk/core/common/IterableStreamConverterTest.java b/core/src/test/java/com/sap/ai/sdk/core/common/IterableStreamConverterTest.java
@@ -23,6 +23,8 @@
 import org.apache.hc.core5.http.ContentType;
 import org.apache.hc.core5.http.io.entity.InputStreamEntity;
 import org.apache.hc.core5.http.message.BasicClassicHttpResponse;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 
@@ -119,19 +121,10 @@ public static class TestClientException extends ClientException {}
   static class TestClientExceptionFactory
       implements ClientExceptionFactory<TestClientException, ClientError> {
 
-    @Nonnull
+    @NotNull
     @Override
-    public TestClientException build(@Nonnull String message, Throwable cause) {
-      return new TestClientException(message, cause);
-    }
-
-    @Nonnull
-    @Override
-    public TestClientException buildFromClientError(
-        @Nonnull String message, @Nonnull ClientError clientError) {
-      TestClientException exception = new TestClientException(message);
-      exception.clientError = clientError;
-      return exception;
+    public TestClientException build(@NotNull String message, @Nullable ClientError clientError, @Nullable Throwable cause) {
+      return (TestClientException) new TestClientException(message, cause).setClientError(clientError);
     }
   }
 }
diff --git a/foundation-models/openai/src/main/java/com/sap/ai/sdk/foundationmodels/openai/OpenAiClientException.java b/foundation-models/openai/src/main/java/com/sap/ai/sdk/foundationmodels/openai/OpenAiClientException.java
@@ -11,9 +11,8 @@
 @StandardException
 public class OpenAiClientException extends ClientException {
 
-  OpenAiClientException(@Nonnull final String message, @Nonnull final OpenAiError clientError) {
-    super(message);
-    setClientError(clientError);
+  OpenAiClientException(@Nonnull final String message, @Nullable final Throwable cause) {
+    super(message, cause);
   }
 
   /**
diff --git a/foundation-models/openai/src/main/java/com/sap/ai/sdk/foundationmodels/openai/OpenAiExceptionFactory.java b/foundation-models/openai/src/main/java/com/sap/ai/sdk/foundationmodels/openai/OpenAiExceptionFactory.java
@@ -5,20 +5,11 @@
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 
-@Beta
 class OpenAiExceptionFactory implements ClientExceptionFactory<OpenAiClientException, OpenAiError> {
 
   @Nonnull
   @Override
-  public OpenAiClientException build(
-      @Nonnull final String message, @Nullable final Throwable cause) {
-    return new OpenAiClientException(message, cause);
-  }
-
-  @Nonnull
-  @Override
-  public OpenAiClientException buildFromClientError(
-      @Nonnull final String message, @Nonnull final OpenAiError openAiError) {
-    return new OpenAiClientException(message, openAiError);
+  public OpenAiClientException build(@Nonnull String message, @Nullable OpenAiError clientError, @Nullable Throwable cause) {
+    return (OpenAiClientException) new OpenAiClientException(message, cause).setClientError(clientError);
   }
 }
diff --git a/orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationChatResponse.java b/orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationChatResponse.java
@@ -44,7 +44,7 @@ public String getContent() throws OrchestrationFilterException.Output {
     if ("content_filter".equals(choice.getFinishReason())) {
       final var filterDetails = Try.of(this::getOutputFilteringChoices).getOrElseGet(e -> Map.of());
       final var message = "Content filter filtered the output.";
-      throw new OrchestrationFilterException.Output(message, filterDetails);
+      throw new OrchestrationFilterException.Output(message).setFilterDetails(filterDetails);
     }
     return choice.getMessage().getContent();
   }
diff --git a/orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationClient.java b/orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationClient.java
@@ -120,7 +120,7 @@ private static void throwOnContentFilter(@Nonnull final OrchestrationChatComplet
       final var filterDetails =
           Try.of(() -> getOutputFilteringChoices(delta)).getOrElseGet(e -> Map.of());
       final var message = "Content filter filtered the output.";
-      throw new OrchestrationFilterException.Output(message, filterDetails);
+      throw new OrchestrationFilterException.Output(message).setFilterDetails(filterDetails);
     }
   }
 
diff --git a/orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationClientException.java b/orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationClientException.java
@@ -12,12 +12,6 @@
 @StandardException
 public class OrchestrationClientException extends ClientException {
 
-  OrchestrationClientException(
-      @Nonnull final String message, @Nonnull final OrchestrationError clientError) {
-    super(message);
-    setClientError(clientError);
-  }
-
   /**
    * Retrieves the {@link ErrorResponse} from the orchestration service, if available.
    *
diff --git a/orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationExceptionFactory.java b/orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationExceptionFactory.java
@@ -11,34 +11,23 @@
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 
-@Beta
 class OrchestrationExceptionFactory
     implements ClientExceptionFactory<OrchestrationClientException, OrchestrationError> {
 
-  @Nonnull
-  public OrchestrationClientException build(
-      @Nonnull final String message, @Nullable final Throwable cause) {
-    return new OrchestrationClientException(message, cause);
-  }
-
   @Nonnull
   @Override
-  public OrchestrationClientException buildFromClientError(
-      @Nonnull final String message, @Nonnull final OrchestrationError clientError) {
-
-    final var inputFilterDetails = extractInputFilterDetails(clientError);
-    if (!inputFilterDetails.isEmpty()) {
-      return new OrchestrationFilterException.Input(message, clientError, inputFilterDetails);
-    }
-
-    return new OrchestrationClientException(message, clientError);
+  public OrchestrationClientException build(@Nonnull String message, @Nullable OrchestrationError clientError, @Nullable Throwable cause) {
+      final var inputFilterDetails = extractInputFilterDetails(clientError);
+      if (!inputFilterDetails.isEmpty()) {
+        return (OrchestrationClientException) new OrchestrationFilterException.Input(message,cause).setFilterDetails(inputFilterDetails).setClientError(clientError);
+      }
+    return (OrchestrationClientException) new OrchestrationClientException(message, cause).setClientError(clientError);
   }
 
   @SuppressWarnings("unchecked")
   @Nonnull
-  private Map<String, Object> extractInputFilterDetails(@Nonnull final OrchestrationError error) {
-
-    return Optional.of(error.getErrorResponse())
+  private Map<String, Object> extractInputFilterDetails(@Nullable final OrchestrationError error) {
+    return Optional.ofNullable(error).map(OrchestrationError::getErrorResponse)
         .map(ErrorResponse::getModuleResults)
         .map(ModuleResults::getInputFiltering)
         .map(GenericModuleResult::getData)
diff --git a/orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationFilterException.java b/orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationFilterException.java
@@ -12,6 +12,8 @@
 import javax.annotation.Nullable;
 import lombok.AccessLevel;
 import lombok.Getter;
+import lombok.Setter;
+import lombok.experimental.Accessors;
 import lombok.experimental.StandardException;
 
 /** Base exception for errors occurring during orchestration filtering. */
@@ -20,6 +22,8 @@
 public class OrchestrationFilterException extends OrchestrationClientException {
 
   /** Details about the filters that caused the exception. */
+  @Accessors(chain = true)
+  @Setter(AccessLevel.PACKAGE)
   @Getter @Nonnull protected Map<String, Object> filterDetails = Map.of();
 
   /**
@@ -37,22 +41,8 @@ public LlamaGuard38b getLlamaGuard38b() {
   }
 
   /** Exception thrown when an error occurs during input filtering. */
+  @StandardException
   public static class Input extends OrchestrationFilterException {
-    /**
-     * Constructs a new OrchestrationInputFilterException.
-     *
-     * @param message The detail message.
-     * @param clientError The specific client error.
-     * @param filterDetails Details about the filter that caused the exception.
-     */
-    Input(
-        @Nonnull final String message,
-        @Nonnull final OrchestrationError clientError,
-        @Nonnull final Map<String, Object> filterDetails) {
-      super(message);
-      setClientError(clientError);
-      this.filterDetails = filterDetails;
-    }
 
     /**
      * Retrieves Azure Content Safety input details from {@code filterDetails}, if present.
@@ -75,17 +65,8 @@ public AzureContentSafetyInput getAzureContentSafetyInput() {
    * Exception thrown when an error occurs during output filtering, specifically when the finish
    * reason is a content filter.
    */
+  @StandardException
   public static class Output extends OrchestrationFilterException {
-    /**
-     * Constructs a new OrchestrationOutputFilterException.
-     *
-     * @param message The detail message.
-     * @param filterDetails Details about the filter that caused the exception.
-     */
-    Output(@Nonnull final String message, @Nonnull final Map<String, Object> filterDetails) {
-      super(message);
-      this.filterDetails = filterDetails;
-    }
 
     /**
      * Retrieves Azure Content Safety output details from {@code filterDetails}, if present.

Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@ public T handleResponse(@Nonnull final ClassicHttpResponse response) throws E {`
`79`	`79`	`private T parseSuccess(@Nonnull final ClassicHttpResponse response) throws E {`
`80`	`80`	`final HttpEntity responseEntity = response.getEntity();`
`81`	`81`	`if (responseEntity == null) {`
`82`		`- throw exceptionFactory.build("The HTTP Response is empty", null).setHttpResponse(response);`
	`82`	`+ throw exceptionFactory.build("The HTTP Response is empty").setHttpResponse(response);`
`83`	`83`	`}`
`84`	`84`
`85`	`85`	`val content =`
`@@ -161,7 +161,7 @@ protected void parseErrorResponseAndThrow(`
`161`	`161`	`}`
`162`	`162`	`final R clientError = maybeClientError.get();`
`163`	`163`	`val message = getErrorMessage(httpResponse, clientError.getMessage());`
`164`		`- throw exceptionFactory.buildFromClientError(message, clientError).setHttpResponse(httpResponse);`
	`164`	`+ throw exceptionFactory.build(message, clientError, null).setHttpResponse(httpResponse);`
`165`	`165`	`}`
`166`	`166`
`167`	`167`	`private static String getErrorMessage(`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ public String getContent() throws OrchestrationFilterException.Output {`
`44`	`44`	`if ("content_filter".equals(choice.getFinishReason())) {`
`45`	`45`	`final var filterDetails = Try.of(this::getOutputFilteringChoices).getOrElseGet(e -> Map.of());`
`46`	`46`	`final var message = "Content filter filtered the output.";`
`47`		`- throw new OrchestrationFilterException.Output(message, filterDetails);`
	`47`	`+ throw new OrchestrationFilterException.Output(message).setFilterDetails(filterDetails);`
`48`	`48`	`}`
`49`	`49`	`return choice.getMessage().getContent();`
`50`	`50`	`}`
Original file line number	Diff line number	Diff line change
`@@ -120,7 +120,7 @@ private static void throwOnContentFilter(@Nonnull final OrchestrationChatComplet`
`120`	`120`	`final var filterDetails =`
`121`	`121`	`Try.of(() -> getOutputFilteringChoices(delta)).getOrElseGet(e -> Map.of());`
`122`	`122`	`final var message = "Content filter filtered the output.";`
`123`		`- throw new OrchestrationFilterException.Output(message, filterDetails);`
	`123`	`+ throw new OrchestrationFilterException.Output(message).setFilterDetails(filterDetails);`
`124`	`124`	`}`
`125`	`125`	`}`
`126`	`126`