From bf8578366880f076332dd551c253fc36ffc41930 Mon Sep 17 00:00:00 2001 From: Umut Ay Bora Date: Fri, 11 Jul 2025 13:24:39 +0200 Subject: [PATCH] Renamed logging switch --- src/main/java/wasapi/Caller.java | 35 +++++++++++++++++--------- src/main/java/wasapi/WasapiClient.java | 26 +++++++++---------- src/test/java/FoodPlanner.java | 4 +-- 3 files changed, 38 insertions(+), 27 deletions(-) diff --git a/src/main/java/wasapi/Caller.java b/src/main/java/wasapi/Caller.java index f5ef8ab..a46c89a 100644 --- a/src/main/java/wasapi/Caller.java +++ b/src/main/java/wasapi/Caller.java @@ -35,7 +35,7 @@ public abstract class Caller { /** * A static boolean variable that determines whether logs should be kept for API calls. */ - public static boolean keepLogs; + public static boolean logResponseBody; /** * A Printer object for logging. @@ -46,7 +46,7 @@ public abstract class Caller { * Constructs a wasapi.Caller object and initializes the ObjectMapper object and the keepLogs variable. */ public Caller(){ - keepLogs = Boolean.parseBoolean(PropertyUtilities.getProperty("keep-api-logs", "true")); + logResponseBody = Boolean.parseBoolean(PropertyUtilities.getProperty("keep-api-logs", "true")); } /** @@ -91,10 +91,21 @@ protected static ReturnType perform( protected static ReturnType perform( Call call, Class... errorModels){ - Response response = call(call, false, false, getPreviousMethodName()); + Response response = call(call, false, logResponseBody, getPreviousMethodName()); return response.isSuccessful() ? (ReturnType) response.body() : getErrorBody(response, errorModels); } + /** + * Gets the response from an API call and logs the results. + * + * @param call the Call object representing the API call + * @return the Response object representing the API response + * @throws FailedCallException if the call is strict and the response is not successful + */ + protected static Response getResponse(Call call){ + return call(call, false, logResponseBody, getPreviousMethodName()); + } + /** * Gets the response from an API call and logs the results. * @@ -104,7 +115,7 @@ protected static ReturnType perform( * @return the Response object representing the API response * @throws FailedCallException if the call is strict and the response is not successful */ - protected static Response getResponse(Call call, Boolean strict, Boolean printBody){ + protected static Response getResponse(Call call, boolean strict, boolean printBody){ return call(call, strict, printBody, getPreviousMethodName()); } @@ -117,7 +128,7 @@ protected static Response getResponse(Call call, Boolean s * @return the Response object representing the API response * @throws FailedCallException if the call is strict and the response is not successful */ - protected static Response getResponse(String serviceName, Call call, Boolean strict, Boolean printBody){ + protected static Response getResponse(String serviceName, Call call, boolean strict, boolean printBody){ return call(call, strict, printBody, serviceName); } @@ -140,8 +151,8 @@ protected static Response getResponse(String serviceName, Call ResponsePair, ErrorModel> getResponse( Call call, - Boolean strict, - Boolean printBody, + boolean strict, + boolean printBody, Class... errorModels ){ Response response = call(call, strict, printBody, getPreviousMethodName()); @@ -164,8 +175,8 @@ private static Response getResponse(Call call, boolean printBody) thro String contentType = response.headers().get("content-type"); boolean printableResponse = contentType != null && contentType.contains("application/json"); T body = response.body(); - if (keepLogs) log.success("The response code is: " + response.code()); - if (keepLogs && !response.message().isEmpty()) log.info(response.message()); + if (logResponseBody) log.success("The response code is: " + response.code()); + if (logResponseBody && !response.message().isEmpty()) log.info(response.message()); if (printBody && printableResponse) log.info("The response body is: \n" + getJsonString(body)); return Response.success(body, response.raw()); } @@ -224,7 +235,7 @@ private static ErrorModel getErrorObject(Response response, Clas * @param serviceName The name of the service being called. */ private static void printCallSpecifications(Call call, String serviceName){ - if (keepLogs) + if (logResponseBody) log.info("Performing " + StringUtilities.markup(PALE, call.request().method()) + " call for '" + @@ -299,7 +310,7 @@ private static ErrorModel getErrorBody(Response response, Class< * @return a boolean indicating whether logs are being kept for API calls */ public static boolean keepsLogs() { - return keepLogs; + return logResponseBody; } /** @@ -308,6 +319,6 @@ public static boolean keepsLogs() { * @param keepLogs a boolean indicating whether logs should be kept for API calls */ public static void keepLogs(boolean keepLogs) { - Caller.keepLogs = keepLogs; + Caller.logResponseBody = keepLogs; } } \ No newline at end of file diff --git a/src/main/java/wasapi/WasapiClient.java b/src/main/java/wasapi/WasapiClient.java index 38df8bc..7c392df 100644 --- a/src/main/java/wasapi/WasapiClient.java +++ b/src/main/java/wasapi/WasapiClient.java @@ -74,7 +74,7 @@ public class WasapiClient { /** * A boolean indicating whether to log the headers in the requests. */ - boolean printHeaders = Boolean.parseBoolean(ContextStore.get("log-headers", "true")); + boolean logHeaders = Boolean.parseBoolean(ContextStore.get("log-headers", "true")); /** * A boolean indicating whether to log detailed information in the requests. @@ -87,9 +87,9 @@ public class WasapiClient { boolean hostnameVerification = Boolean.parseBoolean(ContextStore.get("verify-hostname", "true")); /** - * A boolean indicating whether to print request body in the outgoing requests. + * A boolean indicating whether to log request body in the outgoing requests. */ - boolean printRequestBody = Boolean.parseBoolean(ContextStore.get("print-request-body", "false")); + boolean logRequestBody = Boolean.parseBoolean(ContextStore.get("log-request-body", "false")); /** * Connection timeout in seconds. @@ -174,7 +174,7 @@ private S generate(Class serviceClass) { *
  • A network interceptor for modifying requests before execution.
    • * * The interceptor ensures headers are set, logs the request body if enabled, - * and prints headers when required. + * and logs headers when required. * * @return a configured OkHttpClient instance */ @@ -211,7 +211,7 @@ private OkHttpClient getDefaultHttpClient(){ String.valueOf(Objects.requireNonNull(request.body()).contentType())) .build(); - if (printRequestBody) { + if (logRequestBody) { Request cloneRequest = request.newBuilder().build(); if (cloneRequest.body()!= null){ Buffer buffer = new Buffer(); @@ -229,7 +229,7 @@ private OkHttpClient getDefaultHttpClient(){ else log.warning("Request body is null!"); } } - if (printHeaders) + if (logHeaders) log.info(("Headers(" + request.headers().size() + "): \n" + request.headers()).trim()); return chain.proceed(request); }).build(); @@ -276,10 +276,10 @@ public static class Builder { */ public Builder() { generator = new WasapiClient(); - generator.printHeaders = Boolean.parseBoolean(ContextStore.get("log-headers", "true")); + generator.logHeaders = Boolean.parseBoolean(ContextStore.get("log-headers", "true")); generator.detailedLogging = Boolean.parseBoolean(ContextStore.get("detailed-logging", "false")); generator.hostnameVerification = Boolean.parseBoolean(ContextStore.get("verify-hostname", "true")); - generator.printRequestBody = Boolean.parseBoolean(ContextStore.get("print-request-body", "false")); + generator.logRequestBody = Boolean.parseBoolean(ContextStore.get("log-request-body", "false")); generator.connectionTimeout = Integer.parseInt(ContextStore.get("connection-timeout", "60")); generator.readTimeout = Integer.parseInt(ContextStore.get("connection-read-timeout", "30")); generator.writeTimeout = Integer.parseInt(ContextStore.get("connection-write-timeout", "30")); @@ -306,18 +306,18 @@ public Builder headers(Headers headers) { } /** - * Enables or disables printing of request/response headers. + * Enables or disables logging of request/response headers. */ - public Builder printHeaders(boolean enabled) { - generator.printHeaders = enabled; + public Builder logHeaders(boolean enabled) { + generator.logHeaders = enabled; return this; } /** - * Enables or disables printing of request body. + * Enables or disables logging of request body. */ public Builder logRequestBody(boolean enabled) { - generator.printRequestBody = enabled; + generator.logRequestBody = enabled; return this; } diff --git a/src/test/java/FoodPlanner.java b/src/test/java/FoodPlanner.java index 8b10cce..596470e 100644 --- a/src/test/java/FoodPlanner.java +++ b/src/test/java/FoodPlanner.java @@ -9,7 +9,7 @@ public class FoodPlanner extends WasapiUtilities { FoodPlannerServices petStoreServices = new WasapiClient.Builder() .logRequestBody(true) - .printHeaders(true) + .logHeaders(true) .build(FoodPlannerServices.class); public SimpleMessageResponseModel signUp(UserSignUpModel userSignUpModel){ @@ -35,7 +35,7 @@ public Auth(String authorisationToken){ .build() ) .logRequestBody(true) - .printHeaders(true) + .logHeaders(true) .build(FoodPlannerServices.Authorized.class); }