refactor: Move OAuth error messages to constants and clean up imports

reeshika-h · reeshika-h · commit 10383cd1d2e4 · 2025-09-03T16:56:03.000+05:30
diff --git a/src/main/java/com/contentstack/cms/Contentstack.java b/src/main/java/com/contentstack/cms/Contentstack.java
@@ -5,7 +5,6 @@
 import java.time.Duration;
 import java.util.HashMap;
 import java.util.Map;
-import java.util.Objects;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.TimeUnit;
 import java.util.logging.Logger;
@@ -17,8 +16,6 @@
 import static com.contentstack.cms.core.Util.API_KEY;
 import static com.contentstack.cms.core.Util.AUTHORIZATION;
 import static com.contentstack.cms.core.Util.BRANCH;
-import static com.contentstack.cms.core.Util.ILLEGAL_USER;
-import static com.contentstack.cms.core.Util.PLEASE_LOGIN;
 import com.contentstack.cms.models.Error;
 import com.contentstack.cms.models.LoginDetails;
 import com.contentstack.cms.models.OAuthConfig;
@@ -99,7 +96,7 @@ public class Contentstack {
      */
     public User user() {
         if (!isOAuthConfigured() && this.authtoken == null) {
-            throw new IllegalStateException("Please login or configure OAuth to access user");
+            throw new IllegalStateException(Util.OAUTH_LOGIN_REQUIRED + " user");
         }
         user = new User(this.instance);
         return user;
@@ -293,7 +290,7 @@ Response<ResponseBody> logoutWithAuthtoken(String authtoken) throws IOException
      */
     public Organization organization() {
         if (!isOAuthConfigured() && this.authtoken == null) {
-            throw new IllegalStateException("Please login or configure OAuth to access organization");
+            throw new IllegalStateException(Util.OAUTH_LOGIN_REQUIRED + " organization");
         }
         
         // If using OAuth, get organization from tokens
@@ -328,10 +325,10 @@ public Organization organization() {
      */
     public Organization organization(@NotNull String organizationUid) {
         if (!isOAuthConfigured() && this.authtoken == null) {
-            throw new IllegalStateException("Please login or configure OAuth to access organization");
+            throw new IllegalStateException(Util.OAUTH_LOGIN_REQUIRED + " organization");
         }
         if (organizationUid.isEmpty()) {
-            throw new IllegalStateException("organizationUid can not be empty");
+            throw new IllegalStateException(Util.OAUTH_ORG_EMPTY);
         }
         return new Organization(this.instance, organizationUid);
     }
@@ -355,7 +352,7 @@ public Organization organization(@NotNull String organizationUid) {
      */
     public Stack stack() {
         if (!isOAuthConfigured() && this.authtoken == null) {
-            throw new IllegalStateException("Please login or configure OAuth to access stack");
+            throw new IllegalStateException(Util.OAUTH_LOGIN_REQUIRED + " stack");
         }
         return new Stack(this.instance);
     }
@@ -380,7 +377,7 @@ public Stack stack() {
      */
     public Stack stack(@NotNull Map<String, Object> header) {
         if (!isOAuthConfigured() && this.authtoken == null && !header.containsKey(AUTHORIZATION)) {
-            throw new IllegalStateException("Please login or configure OAuth to access stack");
+            throw new IllegalStateException(Util.OAUTH_LOGIN_REQUIRED + " stack");
         }
         return new Stack(this.instance, header);
     }
@@ -476,7 +473,7 @@ public Stack stack(@NotNull String apiKey, @NotNull String managementToken, @Not
      */
     public String getOAuthAuthorizationUrl() {
         if (!isOAuthConfigured()) {
-            throw new IllegalStateException("OAuth is not configured. Use Builder.setOAuth() or Builder.setOAuthWithPKCE()");
+            throw new IllegalStateException(Util.OAUTH_CONFIG_MISSING);
         }
         return oauthHandler.authorize();
     }
@@ -489,7 +486,7 @@ public String getOAuthAuthorizationUrl() {
      */
     public CompletableFuture<OAuthTokens> exchangeOAuthCode(String code) {
         if (!isOAuthConfigured()) {
-            throw new IllegalStateException("OAuth is not configured. Use Builder.setOAuth() or Builder.setOAuthWithPKCE()");
+            throw new IllegalStateException(Util.OAUTH_CONFIG_MISSING);
         }
         return oauthHandler.exchangeCodeForToken(code);
     }
@@ -501,7 +498,7 @@ public CompletableFuture<OAuthTokens> exchangeOAuthCode(String code) {
      */
     public CompletableFuture<OAuthTokens> refreshOAuthToken() {
         if (!isOAuthConfigured()) {
-            throw new IllegalStateException("OAuth is not configured. Use Builder.setOAuth() or Builder.setOAuthWithPKCE()");
+            throw new IllegalStateException(Util.OAUTH_CONFIG_MISSING);
         }
         return oauthHandler.refreshAccessToken();
     }
@@ -545,7 +542,7 @@ public OAuthHandler getOAuthHandler() {
      */
     public CompletableFuture<Void> oauthLogout(boolean revokeAuthorization) {
         if (!isOAuthConfigured()) {
-            throw new IllegalStateException("OAuth is not configured. Use Builder.setOAuth() or Builder.setOAuthWithPKCE()");
+            throw new IllegalStateException(Util.OAUTH_CONFIG_MISSING);
         }
         return oauthHandler.logout(revokeAuthorization);
     }
diff --git a/src/main/java/com/contentstack/cms/core/Util.java b/src/main/java/com/contentstack/cms/core/Util.java
@@ -51,6 +51,23 @@ public class Util {
     public static final String ERROR_INSTALLATION = "installation uid is required";
     public static final String MISSING_ORG_ID = "organization uid is required";
 
+    // OAuth Constants
+    public static final String OAUTH_APP_HOST = "app.contentstack.com";
+    public static final String OAUTH_API_HOST = "developerhub-api.contentstack.com";
+    public static final String OAUTH_TOKEN_ENDPOINT = "/token";
+    public static final String OAUTH_AUTHORIZE_ENDPOINT = "/#!/apps/%s/authorize";
+    
+    // OAuth Error Messages
+    public static final String OAUTH_NO_TOKENS = "No OAuth tokens available. Please authenticate first.";
+    public static final String OAUTH_NO_REFRESH_TOKEN = "No refresh token available";
+    public static final String OAUTH_EMPTY_CODE = "Authorization code cannot be null or empty";
+    public static final String OAUTH_CONFIG_MISSING = "OAuth is not configured. Use Builder.setOAuth() or Builder.setOAuthWithPKCE()";
+    public static final String OAUTH_REFRESH_FAILED = "Failed to refresh access token";
+    public static final String OAUTH_REVOKE_FAILED = "Failed to revoke authorization";
+    public static final String OAUTH_STATUS_FAILED = "Failed to get authorization status";
+    public static final String OAUTH_LOGIN_REQUIRED = "Please login or configure OAuth to access";
+    public static final String OAUTH_ORG_EMPTY = "organizationUid can not be empty";
+
     // The code `Util() throws IllegalAccessException` is a constructor for the
     // `Util` class that throws an
     // `IllegalAccessException` when called. This constructor is marked as private,
diff --git a/src/main/java/com/contentstack/cms/models/OAuthConfig.java b/src/main/java/com/contentstack/cms/models/OAuthConfig.java
@@ -8,6 +8,8 @@
 import java.util.Arrays;
 import java.util.List;
 
+import com.contentstack.cms.core.Util;
+
 /**
  * Configuration class for OAuth 2.0 authentication
  */
@@ -67,7 +69,7 @@ public String getFormattedAuthorizationEndpoint() {
             return authEndpoint;
         }
 
-        String hostname = "app.contentstack.com";
+        String hostname = Util.OAUTH_APP_HOST;
 
         // Transform hostname if needed
         if (hostname.contains("contentstack")) {
@@ -76,7 +78,7 @@ public String getFormattedAuthorizationEndpoint() {
                     .replaceAll("\\.io$", ".com");  // *.io -> *.com
         }
 
-        return "https://" + hostname + "/#!/apps/" + appId + "/authorize";
+        return "https://" + hostname + String.format(Util.OAUTH_AUTHORIZE_ENDPOINT, appId);
     }
 
     /**
@@ -89,7 +91,7 @@ public String getTokenEndpoint() {
             return tokenEndpoint;
         }
 
-        String hostname = "developerhub-api.contentstack.com";
+        String hostname = Util.OAUTH_API_HOST;
 
         // Transform hostname if needed
         if (hostname.contains("contentstack")) {
@@ -98,7 +100,7 @@ public String getTokenEndpoint() {
                     .replaceAll("\\.io$", ".com");      // *.io -> *.com
         }
 
-        return "https://" + hostname + "/token";
+        return "https://" + hostname + Util.OAUTH_TOKEN_ENDPOINT;
     }
 
     /**
diff --git a/src/main/java/com/contentstack/cms/oauth/OAuthHandler.java b/src/main/java/com/contentstack/cms/oauth/OAuthHandler.java
@@ -10,6 +10,7 @@
 import java.util.Date;
 import java.util.concurrent.CompletableFuture;
 
+import com.contentstack.cms.core.Util;
 import com.contentstack.cms.models.OAuthConfig;
 import com.contentstack.cms.models.OAuthTokens;
 import com.google.gson.Gson;
@@ -154,7 +155,7 @@ public String authorize() {
      */
     public CompletableFuture<OAuthTokens> exchangeCodeForToken(String code) {
         if (code == null || code.trim().isEmpty()) {
-            return CompletableFuture.failedFuture(new IllegalArgumentException("Authorization code cannot be null or empty"));
+            return CompletableFuture.failedFuture(new IllegalArgumentException(Util.OAUTH_EMPTY_CODE));
         }
         return CompletableFuture.supplyAsync(() -> {
             try {
@@ -210,11 +211,11 @@ public CompletableFuture<OAuthTokens> refreshAccessToken() {
         // Check if we have tokens and refresh token
         if (tokens == null) {
             return CompletableFuture.failedFuture(
-                    new IllegalStateException("No tokens available"));
+                    new IllegalStateException(Util.OAUTH_NO_TOKENS));
         }
         if (!tokens.hasRefreshToken()) {
             return CompletableFuture.failedFuture(
-                    new IllegalStateException("No refresh token available"));
+                    new IllegalStateException(Util.OAUTH_NO_REFRESH_TOKEN));
         }
 
         // Check if token is actually expired
@@ -249,7 +250,7 @@ public CompletableFuture<OAuthTokens> refreshAccessToken() {
                 return newTokens;
             } catch (IOException | RuntimeException e) {
 
-                throw new RuntimeException("Failed to refresh tokens", e);
+                throw new RuntimeException(Util.OAUTH_REFRESH_FAILED, e);
             }
         });
     }
@@ -343,7 +344,7 @@ public CompletableFuture<OAuthTokens> getOauthAppAuthorization() {
 
                     if (!response.isSuccessful()) {
                         String error = responseBody != null ? responseBody.string() : "Unknown error";
-                        throw new RuntimeException("Failed to get authorization status: " + error);
+                        throw new RuntimeException(Util.OAUTH_STATUS_FAILED + ": " + error);
                     }
 
                     String body = responseBody != null ? responseBody.string() : "{}";
@@ -386,7 +387,7 @@ public CompletableFuture<Void> revokeOauthAppAuthorization() {
 
                     if (!response.isSuccessful()) {
                         String error = responseBody != null ? responseBody.string() : "Unknown error";
-                        throw new RuntimeException("Failed to revoke authorization: " + error);
+                        throw new RuntimeException(Util.OAUTH_REVOKE_FAILED + ": " + error);
                     }
                 } finally {
                     if (responseBody != null) {
diff --git a/src/main/java/com/contentstack/cms/oauth/OAuthInterceptor.java b/src/main/java/com/contentstack/cms/oauth/OAuthInterceptor.java
@@ -64,7 +64,7 @@ private Response executeRequest(Chain chain, Request request, int retryCount) th
 
         // Ensure we have tokens
         if (oauthHandler == null || oauthHandler.getTokens() == null) {
-            throw new IOException("No OAuth tokens available. Please authenticate first.");
+            throw new IOException(Util.OAUTH_NO_TOKENS);
         }
 
         // Check if we need to refresh the token before making the request
@@ -81,7 +81,7 @@ private Response executeRequest(Chain chain, Request request, int retryCount) th
                             .build();
                 } catch (InterruptedException | ExecutionException | TimeoutException e) {
 
-                    throw new IOException("Failed to refresh access token", e);
+                    throw new IOException(Util.OAUTH_REFRESH_FAILED, e);
                 }
             }
         }
@@ -110,7 +110,7 @@ private Response executeRequest(Chain chain, Request request, int retryCount) th
 
                         return executeRequest(chain, request, retryCount + 1);
                     } catch (InterruptedException | ExecutionException | TimeoutException e) {
-                        throw new IOException("Failed to refresh access token after 401", e);
+                        throw new IOException(Util.OAUTH_REFRESH_FAILED + " after 401", e);
                     }
                 }
             }

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,8 @@`
`8`	`8`	`import java.util.Arrays;`
`9`	`9`	`import java.util.List;`
`10`	`10`
	`11`	`+import com.contentstack.cms.core.Util;`
	`12`	`+`
`11`	`13`	`/**`
`12`	`14`	`* Configuration class for OAuth 2.0 authentication`
`13`	`15`	`*/`
`@@ -67,7 +69,7 @@ public String getFormattedAuthorizationEndpoint() {`
`67`	`69`	`return authEndpoint;`
`68`	`70`	`}`
`69`	`71`
`70`		`- String hostname = "app.contentstack.com";`
	`72`	`+ String hostname = Util.OAUTH_APP_HOST;`
`71`	`73`
`72`	`74`	`// Transform hostname if needed`
`73`	`75`	`if (hostname.contains("contentstack")) {`
`@@ -76,7 +78,7 @@ public String getFormattedAuthorizationEndpoint() {`
`76`	`78`	`.replaceAll("\\.io$", ".com"); // .io -> .com`
`77`	`79`	`}`
`78`	`80`
`79`		`- return "https://" + hostname + "/#!/apps/" + appId + "/authorize";`
	`81`	`+ return "https://" + hostname + String.format(Util.OAUTH_AUTHORIZE_ENDPOINT, appId);`
`80`	`82`	`}`
`81`	`83`
`82`	`84`	`/**`
`@@ -89,7 +91,7 @@ public String getTokenEndpoint() {`
`89`	`91`	`return tokenEndpoint;`
`90`	`92`	`}`
`91`	`93`
`92`		`- String hostname = "developerhub-api.contentstack.com";`
	`94`	`+ String hostname = Util.OAUTH_API_HOST;`
`93`	`95`
`94`	`96`	`// Transform hostname if needed`
`95`	`97`	`if (hostname.contains("contentstack")) {`
`@@ -98,7 +100,7 @@ public String getTokenEndpoint() {`
`98`	`100`	`.replaceAll("\\.io$", ".com"); // .io -> .com`
`99`	`101`	`}`
`100`	`102`
`101`		`- return "https://" + hostname + "/token";`
	`103`	`+ return "https://" + hostname + Util.OAUTH_TOKEN_ENDPOINT;`
`102`	`104`	`}`
`103`	`105`
`104`	`106`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ private Response executeRequest(Chain chain, Request request, int retryCount) th`
`64`	`64`
`65`	`65`	`// Ensure we have tokens`
`66`	`66`	`if (oauthHandler == null \|\| oauthHandler.getTokens() == null) {`
`67`		`- throw new IOException("No OAuth tokens available. Please authenticate first.");`
	`67`	`+ throw new IOException(Util.OAUTH_NO_TOKENS);`
`68`	`68`	`}`
`69`	`69`
`70`	`70`	`// Check if we need to refresh the token before making the request`
`@@ -81,7 +81,7 @@ private Response executeRequest(Chain chain, Request request, int retryCount) th`
`81`	`81`	`.build();`
`82`	`82`	`} catch (InterruptedException \| ExecutionException \| TimeoutException e) {`
`83`	`83`
`84`		`- throw new IOException("Failed to refresh access token", e);`
	`84`	`+ throw new IOException(Util.OAUTH_REFRESH_FAILED, e);`
`85`	`85`	`}`
`86`	`86`	`}`
`87`	`87`	`}`
`@@ -110,7 +110,7 @@ private Response executeRequest(Chain chain, Request request, int retryCount) th`
`110`	`110`
`111`	`111`	`return executeRequest(chain, request, retryCount + 1);`
`112`	`112`	`} catch (InterruptedException \| ExecutionException \| TimeoutException e) {`
`113`		`- throw new IOException("Failed to refresh access token after 401", e);`
	`113`	`+ throw new IOException(Util.OAUTH_REFRESH_FAILED + " after 401", e);`
`114`	`114`	`}`
`115`	`115`	`}`
`116`	`116`	`}`