Added support for get requests in the ConnectionUtils

Author: intisy

src/main/java/io/github/intisy/utils/core/ConnectionUtils.java

@@ -21,18 +21,22 @@
 @SuppressWarnings("unused")
 public class ConnectionUtils {
     /**
-     * Generates a curl command based on the provided HTTP connection, token, and payload.
+     * Generates a curl command based on the provided HTTP connection, token, and
+     * payload.
      *
      * @param connection The HTTP connection to be used.
-     * @param token      The authorization token to be included in the curl command. If null, no token will be included.
+     * @param token      The authorization token to be included in the curl command.
+     *                   If null, no token will be included.
      * @param payload    The payload to be sent in the curl command.
      * @return A curl command as a string.
      */
     public static String curl(HttpURLConnection connection, String token, String payload) {
         StringBuilder curl = new StringBuilder();
         if (token != null)
-            curl.append("curl -X ").append(connection.getRequestMethod()).append(" -H \"Authorization: Bearer ").append(token).append("\"");
-        connection.getRequestProperties().forEach((key, value) -> curl.append(" -H \"").append(key).append(": ").append(value.get(0)).append("\""));
+            curl.append("curl -X ").append(connection.getRequestMethod()).append(" -H \"Authorization: Bearer ")
+                    .append(token).append("\"");
+        connection.getRequestProperties().forEach(
+                (key, value) -> curl.append(" -H \"").append(key).append(": ").append(value.get(0)).append("\""));
         curl.append(" -d '").append(payload).append("' ").append(connection.getURL());
         System.out.println(connection.getRequestProperties());
         return curl.toString();
@@ -43,7 +47,8 @@ public static String curl(HttpURLConnection connection, String token, String pay
      *
      * @param connection The HTTP connection to be used.
      * @return The output from the error stream as a string.
-     * @throws IOException If an I/O error occurs while reading from the error stream.
+     * @throws IOException If an I/O error occurs while reading from the error
+     *                     stream.
      */
     public static String getOutput(HttpURLConnection connection) throws IOException {
         BufferedReader br = new BufferedReader(new InputStreamReader(connection.getErrorStream()));
@@ -60,18 +65,21 @@ public static String getOutput(HttpURLConnection connection) throws IOException
      * Prints the output from the error stream of the provided HTTP connection.
      *
      * @param connection The HTTP connection to be used.
-     * @throws IOException If an I/O error occurs while reading from the error stream.
+     * @throws IOException If an I/O error occurs while reading from the error
+     *                     stream.
      */
     public static void printOutput(HttpURLConnection connection) throws IOException {
         System.out.println(getOutput(connection));
     }
 
     /**
-     * Sends a JSON payload through the output stream of the specified HTTP connection.
+     * Sends a JSON payload through the output stream of the specified HTTP
+     * connection.
      *
      * @param jsonPayload The JSON object to be sent as the request payload.
      * @param connection  The HTTP connection to which the payload will be written.
-     * @throws IOException If an I/O error occurs while writing to the output stream.
+     * @throws IOException If an I/O error occurs while writing to the output
+     *                     stream.
      */
     public static void connectionPayload(JsonObject jsonPayload, HttpURLConnection connection) throws IOException {
         try (OutputStream os = connection.getOutputStream()) {
@@ -81,15 +89,31 @@ public static void connectionPayload(JsonObject jsonPayload, HttpURLConnection c
     }
 
     /**
-     * Sends an authorized POST request to the specified API URL with the provided authorization key and processes the response.
+     * Sends an authorized POST request to the specified API URL with the provided
+     * authorization key and processes the response.
      *
      * @param apiUrl The URL of the API to which the request will be sent.
      * @param key    The authorization key to be included in the request header.
-     * @return A JsonObject representing the server's response. Contains an additional "code" property indicating the HTTP response code.
+     * @return A JsonObject representing the server's response. Contains an
+     *         additional "code" property indicating the HTTP response code.
      */
     public static JsonObject authorizedRequest(String apiUrl, String key) {
+        return authorizedRequest(apiUrl, key, RequestMethod.POST);
+    }
+
+    /**
+     * Sends an authorized request to the specified API URL with the provided
+     * authorization key and method, and processes the response.
+     *
+     * @param apiUrl The URL of the API to which the request will be sent.
+     * @param key    The authorization key to be included in the request header.
+     * @param method The HTTP method to use (e.g., GET, POST).
+     * @return A JsonObject representing the server's response. Contains an
+     *         additional "code" property indicating the HTTP response code.
+     */
+    public static JsonObject authorizedRequest(String apiUrl, String key, RequestMethod method) {
         try {
-            HttpURLConnection connection = post(apiUrl);
+            HttpURLConnection connection = connection(apiUrl, method);
             connection.setRequestProperty("Authorization", key);
             return handleResponse(connection);
         } catch (IOException e) {
@@ -100,10 +124,12 @@ public static JsonObject authorizedRequest(String apiUrl, String key) {
     /**
      * Handles an exception and returns a JSON object containing error details.
      *
-     * @param e The exception to be handled. Provides details about the error that occurred.
+     * @param e The exception to be handled. Provides details about the error that
+     *          occurred.
      * @return A JsonObject containing two properties:
      *         - "message": A descriptive message about the error.
-     *         - "type": A fixed string "error" indicating the nature of the response.
+     *         - "type": A fixed string "error" indicating the nature of the
+     *         response.
      */
     public static JsonObject handleException(Exception e) {
         JsonObject jsonObject = new JsonObject();
@@ -113,77 +139,159 @@ public static JsonObject handleException(Exception e) {
     }
 
     /**
-     * Sends an authorized HTTP request to the specified API URL with the given authorization key
+     * Sends an authorized HTTP POST request to the specified API URL with the given
+     * authorization key
      * and JSON payload, and processes the server's response.
      *
      * @param apiUrl      The URL of the API to which the request will be sent.
-     * @param key         The authorization key to be included in the request header.
+     * @param key         The authorization key to be included in the request
+     *                    header.
      * @param jsonPayload The JSON object to be sent as the request payload.
-     * @return A JsonObject representing the server's response. Contains an additional "code" property
+     * @return A JsonObject representing the server's response. Contains an
+     *         additional "code" property
      *         indicating the HTTP response code.
      */
     public static JsonObject authorizedRequest(String apiUrl, String key, JsonObject jsonPayload) {
+        return authorizedRequest(apiUrl, key, jsonPayload, RequestMethod.POST);
+    }
+
+    /**
+     * Sends an authorized HTTP request to the specified API URL with the given
+     * authorization key,
+     * JSON payload, and method, and processes the server's response.
+     *
+     * @param apiUrl      The URL of the API to which the request will be sent.
+     * @param key         The authorization key to be included in the request
+     *                    header.
+     * @param jsonPayload The JSON object to be sent as the request payload.
+     * @param method      The HTTP method to use (e.g., GET, POST).
+     * @return A JsonObject representing the server's response. Contains an
+     *         additional "code" property
+     *         indicating the HTTP response code.
+     */
+    public static JsonObject authorizedRequest(String apiUrl, String key, JsonObject jsonPayload,
+            RequestMethod method) {
         Map<String, String> headers = new HashMap<>();
         headers.put("Authorization", key);
-        return headerRequest(apiUrl, headers, jsonPayload);
+        return headerRequest(apiUrl, headers, jsonPayload, method);
     }
 
     /**
-     * Sends a POST request to the specified API URL with given headers and JSON payload,
+     * Sends a POST request to the specified API URL with given headers and JSON
+     * payload,
      * and returns the server's response as a JSON object.
-     * If an error occurs during the request, it handles the exception and returns
-     * an error JSON object.
      *
      * @param apiUrl      The URL of the API to which the request will be sent.
-     * @param headers     A map containing key-value pairs representing the request headers.
+     * @param headers     A map containing key-value pairs representing the request
+     *                    headers.
      * @param jsonPayload The JSON object to be sent as the request payload.
-     * @return A JsonObject representing the server's response. If an exception occurs,
+     * @return A JsonObject representing the server's response. If an exception
+     *         occurs,
      *         returns a JSON object containing error details.
      */
     public static JsonObject headerRequest(String apiUrl, Map<String, String> headers, JsonObject jsonPayload) {
+        return headerRequest(apiUrl, headers, jsonPayload, RequestMethod.POST);
+    }
+
+    /**
+     * Sends a request to the specified API URL with given headers, JSON payload,
+     * and method,
+     * and returns the server's response as a JSON object.
+     *
+     * @param apiUrl      The URL of the API to which the request will be sent.
+     * @param headers     A map containing key-value pairs representing the request
+     *                    headers.
+     * @param jsonPayload The JSON object to be sent as the request payload.
+     * @param method      The HTTP method to use (e.g., GET, POST).
+     * @return A JsonObject representing the server's response. If an exception
+     *         occurs,
+     *         returns a JSON object containing error details.
+     */
+    public static JsonObject headerRequest(String apiUrl, Map<String, String> headers, JsonObject jsonPayload,
+            RequestMethod method) {
         try {
-            HttpURLConnection connection = post(apiUrl);
+            HttpURLConnection connection = connection(apiUrl, method);
             headers.forEach(connection::setRequestProperty);
-            connectionPayload(jsonPayload, connection);
+            if (jsonPayload != null && method == RequestMethod.POST) {
+                connectionPayload(jsonPayload, connection);
+            }
             return handleResponse(connection);
         } catch (IOException e) {
             return handleException(e);
         }
     }
 
     /**
-     * Sends a JSON payload as a POST request to the specified API URL, processes the
+     * Sends a JSON payload as a POST request to the specified API URL, processes
+     * the
      * server's response, and handles potential exceptions.
      *
      * @param apiUrl      The URL of the API to which the request will be sent.
      * @param jsonPayload The JSON object to be sent as the request payload.
-     * @return A JsonObject representing the server's response. Contains an additional
+     * @return A JsonObject representing the server's response. Contains an
+     *         additional
      *         "code" property for the HTTP response code. If an exception occurs,
      *         returns a JsonObject with error details.
      */
     public static JsonObject request(String apiUrl, JsonObject jsonPayload) {
+        return request(apiUrl, jsonPayload, RequestMethod.POST);
+    }
+
+    /**
+     * Sends a JSON payload as a request to the specified API URL with the specified
+     * method,
+     * processes the server's response, and handles potential exceptions.
+     *
+     * @param apiUrl      The URL of the API to which the request will be sent.
+     * @param jsonPayload The JSON object to be sent as the request payload.
+     * @param method      The HTTP method to use (e.g., GET, POST).
+     * @return A JsonObject representing the server's response. Contains an
+     *         additional
+     *         "code" property for the HTTP response code. If an exception occurs,
+     *         returns a JsonObject with error details.
+     */
+    public static JsonObject request(String apiUrl, JsonObject jsonPayload, RequestMethod method) {
         try {
-            HttpURLConnection connection = post(apiUrl);
-            connectionPayload(jsonPayload, connection);
+            HttpURLConnection connection = connection(apiUrl, method);
+            if (jsonPayload != null && method == RequestMethod.POST) {
+                connectionPayload(jsonPayload, connection);
+            }
             return handleResponse(connection);
         } catch (IOException e) {
             return handleException(e);
         }
     }
 
     /**
-     * Sends a POST request to the specified API URL, processes the server's response,
+     * Sends a POST request to the specified API URL, processes the server's
+     * response,
      * and handles any potential I/O exceptions that may occur during the request.
      *
      * @param apiUrl The URL of the API to which the POST request will be sent.
      * @return A JsonObject representing the server's response. If the request is
-     *         successful, the response includes a "code" property indicating the HTTP
-     *         response code and the parsed JSON payload. If an exception occurs, returns
+     *         successful, the response includes a "code" property indicating the
+     *         HTTP
+     *         response code and the parsed JSON payload. If an exception occurs,
+     *         returns
      *         a JsonObject with error details, including a "message" and a "type".
      */
     public static JsonObject request(String apiUrl) {
+        return request(apiUrl, RequestMethod.POST);
+    }
+
+    /**
+     * Sends a request to the specified API URL with the specified method, processes
+     * the
+     * server's response, and handles any potential I/O exceptions that may occur
+     * during the request.
+     *
+     * @param apiUrl The URL of the API to which the request will be sent.
+     * @param method The HTTP method to use (e.g., GET, POST).
+     * @return A JsonObject representing the server's response.
+     */
+    public static JsonObject request(String apiUrl, RequestMethod method) {
         try {
-            HttpURLConnection connection = post(apiUrl);
+            HttpURLConnection connection = connection(apiUrl, method);
             return handleResponse(connection);
         } catch (IOException e) {
             return handleException(e);
@@ -192,19 +300,34 @@ public static JsonObject request(String apiUrl) {
 
     /**
      * Sends a POST request to the specified API URL and returns the configured
-     * HttpURLConnection object. This method sets the request method to POST,
-     * the content type to "application/json", and enables output for the connection.
+     * HttpURLConnection object.
      *
      * @param apiUrl The URL of the API to which the POST request will be sent.
      * @return An HttpURLConnection object configured for the POST request.
      * @throws IOException If an I/O error occurs during the connection setup.
      */
     public static HttpURLConnection post(String apiUrl) throws IOException {
+        return connection(apiUrl, RequestMethod.POST);
+    }
+
+    /**
+     * Sends a GET request to the specified API URL and returns the configured
+     * HttpURLConnection object.
+     *
+     * @param apiUrl The URL of the API to which the GET request will be sent.
+     * @return An HttpURLConnection object configured for the GET request.
+     * @throws IOException If an I/O error occurs during the connection setup.
+     */
+    public static HttpURLConnection get(String apiUrl) throws IOException {
+        return connection(apiUrl, RequestMethod.GET);
+    }
+
+    private static HttpURLConnection connection(String apiUrl, RequestMethod method) throws IOException {
         URL url = new URL(apiUrl);
         HttpURLConnection connection = (HttpURLConnection) url.openConnection();
-        connection.setRequestMethod("POST");
+        connection.setRequestMethod(method.name());
         connection.setRequestProperty("Content-Type", "application/json");
-        connection.setDoOutput(true);
+        connection.setDoOutput(method == RequestMethod.POST);
         return connection;
     }
 
@@ -214,10 +337,14 @@ public static HttpURLConnection post(String apiUrl) throws IOException {
      * the returned JSON object. If the response code is not 200 (HTTP OK), logs the
      * error details.
      *
-     * @param connection The {@code HttpURLConnection} from which to read the response.
-     *                   Must not be null and should already be configured and connected.
-     * @return A {@code JsonObject} representing the response. Includes a "code" property
-     *         with the HTTP response code. If the response is in error, the response body
+     * @param connection The {@code HttpURLConnection} from which to read the
+     *                   response.
+     *                   Must not be null and should already be configured and
+     *                   connected.
+     * @return A {@code JsonObject} representing the response. Includes a "code"
+     *         property
+     *         with the HTTP response code. If the response is in error, the
+     *         response body
      *         is also included in the returned JSON object.
      * @throws IOException If an I/O error occurs while reading the response or
      *                     if the response cannot be parsed as a valid JSON object.
@@ -245,11 +372,15 @@ public static JsonObject handleResponse(HttpURLConnection connection) throws IOE
     }
 
     /**
-     * Reads all lines from the provided BufferedReader and returns them as a single string.
+     * Reads all lines from the provided BufferedReader and returns them as a single
+     * string.
      *
-     * @param br The BufferedReader instance from which to read the lines. Must not be null.
-     * @return A string containing the concatenated lines read from the BufferedReader.
-     * @throws IOException If an I/O error occurs while reading from the BufferedReader.
+     * @param br The BufferedReader instance from which to read the lines. Must not
+     *           be null.
+     * @return A string containing the concatenated lines read from the
+     *         BufferedReader.
+     * @throws IOException If an I/O error occurs while reading from the
+     *                     BufferedReader.
      */
     public static String read(BufferedReader br) throws IOException {
         StringBuilder response = new StringBuilder();

src/main/java/io/github/intisy/utils/core/RequestMethod.java

@@ -0,0 +1,5 @@
+package io.github.intisy.utils.core;
+
+public enum RequestMethod {
+    GET, POST, PUT, DELETE
+}