From baac007c09debb3766cbd07c3c5dc5f2818615cd Mon Sep 17 00:00:00 2001
From: Darin Kelkhoff <darin.kelkhoff@gmail.com>
Date: Mon, 13 May 2024 08:41:38 -0500
Subject: [PATCH] CE-1180 Add QBadHttpResponseStatusException, to make easier
 for implementations to see what status code there was in a failure

---
 .../module/api/actions/BaseAPIActionUtil.java |  3 +-
 .../QBadHttpResponseStatusException.java      | 78 +++++++++++++++++++
 2 files changed, 80 insertions(+), 1 deletion(-)
 create mode 100644 qqq-backend-module-api/src/main/java/com/kingsrook/qqq/backend/module/api/exceptions/QBadHttpResponseStatusException.java

diff --git a/qqq-backend-module-api/src/main/java/com/kingsrook/qqq/backend/module/api/actions/BaseAPIActionUtil.java b/qqq-backend-module-api/src/main/java/com/kingsrook/qqq/backend/module/api/actions/BaseAPIActionUtil.java
index 5be4635d..700664c9 100644
--- a/qqq-backend-module-api/src/main/java/com/kingsrook/qqq/backend/module/api/actions/BaseAPIActionUtil.java
+++ b/qqq-backend-module-api/src/main/java/com/kingsrook/qqq/backend/module/api/actions/BaseAPIActionUtil.java
@@ -69,6 +69,7 @@ import com.kingsrook.qqq.backend.core.utils.StringUtils;
 import com.kingsrook.qqq.backend.core.utils.ValueUtils;
 import com.kingsrook.qqq.backend.module.api.exceptions.OAuthCredentialsException;
 import com.kingsrook.qqq.backend.module.api.exceptions.OAuthExpiredTokenException;
+import com.kingsrook.qqq.backend.module.api.exceptions.QBadHttpResponseStatusException;
 import com.kingsrook.qqq.backend.module.api.exceptions.RateLimitException;
 import com.kingsrook.qqq.backend.module.api.exceptions.RetryableServerErrorException;
 import com.kingsrook.qqq.backend.module.api.model.AuthorizationType;
@@ -593,7 +594,7 @@ public class BaseAPIActionUtil
       }
 
       String warningMessage = "HTTP " + request.getMethod() + " for table [" + table.getName() + "] failed with status " + statusCode + ": " + resultString;
-      throw (new QException(warningMessage));
+      throw (new QBadHttpResponseStatusException(warningMessage, statusCode));
    }
 
 
diff --git a/qqq-backend-module-api/src/main/java/com/kingsrook/qqq/backend/module/api/exceptions/QBadHttpResponseStatusException.java b/qqq-backend-module-api/src/main/java/com/kingsrook/qqq/backend/module/api/exceptions/QBadHttpResponseStatusException.java
new file mode 100644
index 00000000..35ddd0cd
--- /dev/null
+++ b/qqq-backend-module-api/src/main/java/com/kingsrook/qqq/backend/module/api/exceptions/QBadHttpResponseStatusException.java
@@ -0,0 +1,78 @@
+/*
+ * QQQ - Low-code Application Framework for Engineers.
+ * Copyright (C) 2021-2024.  Kingsrook, LLC
+ * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
+ * contact@kingsrook.com
+ * https://github.com/Kingsrook/
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package com.kingsrook.qqq.backend.module.api.exceptions;
+
+
+import com.kingsrook.qqq.backend.core.exceptions.QException;
+
+
+/*******************************************************************************
+ ** Exception thrown when an API HTTP request failed due to a bad status code.
+ ** This exception includes the status code as a field
+ *******************************************************************************/
+public class QBadHttpResponseStatusException extends QException
+{
+   private int statusCode;
+
+
+
+   /*******************************************************************************
+    **
+    *******************************************************************************/
+   public QBadHttpResponseStatusException(String message, int statusCode)
+   {
+      super(message);
+      this.statusCode = statusCode;
+   }
+
+
+
+   /*******************************************************************************
+    ** Getter for statusCode
+    *******************************************************************************/
+   public int getStatusCode()
+   {
+      return (this.statusCode);
+   }
+
+
+
+   /*******************************************************************************
+    ** Setter for statusCode
+    *******************************************************************************/
+   public void setStatusCode(int statusCode)
+   {
+      this.statusCode = statusCode;
+   }
+
+
+
+   /*******************************************************************************
+    ** Fluent setter for statusCode
+    *******************************************************************************/
+   public QBadHttpResponseStatusException withStatusCode(int statusCode)
+   {
+      this.statusCode = statusCode;
+      return (this);
+   }
+
+}