refactor: Update error message handling in Alias, Asset, and AuditLog classes to use centralized error messages for consistency

Author: reeshika-h

src/main/java/com/contentstack/cms/core/ErrorMessages.java

@@ -19,8 +19,8 @@ private ErrorMessages() {
     public static final String OAUTH_ORG_EMPTY = "organizationUid can not be empty";
 
     public static final String PRIVATE_CONSTRUCTOR = "This class cannot be instantiated. Use the static methods to continue.";
-    public static final String PRIVATE_CONSTRUCTOR_DETAILED = "This private constructor cannot be accessed outside the class. Use the public methods instead.";
 
+    public static final String ALIAS_UID_REQUIRED = "Alias UID is required. Provide a valid Alias UID and try again.";
     public static final String ASSET_UID_REQUIRED = "Asset UID is required. Provide a valid Asset UID and try again.";
     public static final String LOG_ITEM_UID_REQUIRED = "Log Item UID is required. Provide a valid Log Item UID and try again.";
     public static final String BRANCH_UID_REQUIRED = "Branch UID is required. Provide a valid Branch UID and try again.";

src/main/java/com/contentstack/cms/core/Util.java

@@ -75,7 +75,7 @@ public class Util {
     // `IllegalAccessException` is to prevent
     // the instantiation of the `Util` class from outside the class itself.
     Util() throws IllegalAccessException {
-        throw new IllegalAccessException(ErrorMessages.PRIVATE_CONSTRUCTOR_DETAILED);
+        throw new IllegalAccessException(ErrorMessages.PRIVATE_CONSTRUCTOR);
     }
 
     /**

src/main/java/com/contentstack/cms/stack/Alias.java

@@ -1,18 +1,19 @@
 package com.contentstack.cms.stack;
 
-import com.contentstack.cms.core.ErrorMessages;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Objects;
 
-import com.contentstack.cms.BaseImplementation;
-import okhttp3.ResponseBody;
 import org.jetbrains.annotations.NotNull;
 import org.json.simple.JSONObject;
+
+import com.contentstack.cms.BaseImplementation;
+import com.contentstack.cms.core.ErrorMessages;
+
+import okhttp3.ResponseBody;
 import retrofit2.Call;
 import retrofit2.Retrofit;
 
-import java.util.HashMap;
-import java.util.Map;
-import java.util.Objects;
-
 /**
  * An alias acts as a pointer to a particular branch. You can specify the alias
  * ID in your frontend code to pull content
@@ -162,7 +163,7 @@ public Call<ResponseBody> find() {
      * @since 2022-10-20
      */
     public Call<ResponseBody> fetch() {
-        Objects.requireNonNull(this.uid, "ErrorMessages.GLOBAL_FIELD_UID_REQUIRED");
+        Objects.requireNonNull(this.uid, ErrorMessages.ALIAS_UID_REQUIRED);
         return this.service.single(this.headers, this.uid);
     }
 
@@ -208,7 +209,7 @@ public Call<ResponseBody> update(@NotNull JSONObject body) {
      * @since 2022-10-20
      */
     public Call<ResponseBody> delete() {
-        Objects.requireNonNull(this.uid, "ErrorMessages.GLOBAL_FIELD_UID_REQUIRED");
+        Objects.requireNonNull(this.uid, ErrorMessages.ALIAS_UID_REQUIRED);
         return this.service.delete(this.headers, this.uid, this.params);
     }
 

src/main/java/com/contentstack/cms/stack/Asset.java

@@ -227,12 +227,12 @@ public Call<AssetListResponse> findAsPojo() {
      * @since 2022-10-20
      */
     public Call<ResponseBody> fetch() {
-        Objects.requireNonNull(this.assetUid, "ErrorMessages.ASSET_UID_REQUIRED");
+        Objects.requireNonNull(this.assetUid, ErrorMessages.ASSET_UID_REQUIRED);
         return this.service.single(this.headers, this.assetUid, this.params);
     }
 
     public Call<AssetResponse> fetchAsPojo() { // New method for POJO conversion
-        Objects.requireNonNull(this.assetUid, "ErrorMessages.ASSET_UID_REQUIRED");
+        Objects.requireNonNull(this.assetUid, ErrorMessages.ASSET_UID_REQUIRED);
         return this.service.singlePojo(this.headers, this.assetUid, this.params);
     }
 
@@ -392,7 +392,7 @@ private MultipartBody createMultipartBody(String filePath, String parentUid, Str
      * @since 2022-10-20
      */
     public Call<ResponseBody> replace(@NotNull String filePath, @NotNull String description) {
-        Objects.requireNonNull(this.assetUid, "ErrorMessages.ASSET_UID_REQUIRED");
+        Objects.requireNonNull(this.assetUid, ErrorMessages.ASSET_UID_REQUIRED);
         MultipartBody.Part assetPath = uploadFile(filePath);
         RequestBody body = RequestBody.create(Objects.requireNonNull(MediaType.parse(String.valueOf(MultipartBody.FORM))), description);
         return this.service.replace(this.headers, this.assetUid, assetPath, body, this.params);
@@ -445,7 +445,7 @@ private MultipartBody.Part uploadFile(@NotNull String filePath) {
      * @since 2022-10-20
      */
     public Call<ResponseBody> generatePermanentUrl(JSONObject body) {
-        Objects.requireNonNull(this.assetUid, "ErrorMessages.ASSET_UID_REQUIRED");
+        Objects.requireNonNull(this.assetUid, ErrorMessages.ASSET_UID_REQUIRED);
         return this.service.generatePermanentUrl(this.headers, this.assetUid, body);
     }
 
@@ -475,7 +475,7 @@ public Call<ResponseBody> generatePermanentUrl(JSONObject body) {
      * @since 2022-10-20
      */
     public Call<ResponseBody> getPermanentUrl(String slugUrl) {
-        Objects.requireNonNull(this.assetUid, "ErrorMessages.ASSET_UID_REQUIRED");
+        Objects.requireNonNull(this.assetUid, ErrorMessages.ASSET_UID_REQUIRED);
         return this.service.downloadPermanentUrl(this.headers, this.assetUid, slugUrl, this.params);
     }
 
@@ -492,7 +492,7 @@ public Call<ResponseBody> getPermanentUrl(String slugUrl) {
      * @since 0.1.0
      */
     public Call<ResponseBody> delete() {
-        Objects.requireNonNull(this.assetUid, "ErrorMessages.ASSET_UID_REQUIRED");
+        Objects.requireNonNull(this.assetUid, ErrorMessages.ASSET_UID_REQUIRED);
         return this.service.delete(this.headers, this.assetUid);
     }
 
@@ -582,7 +582,7 @@ public Call<ResponseBody> setVersionName(int versionNumber,
      * @since 0.1.0
      */
     public Call<ResponseBody> getVersionNameDetails() {
-        Objects.requireNonNull(this.assetUid, "ErrorMessages.ASSET_UID_REQUIRED");
+        Objects.requireNonNull(this.assetUid, ErrorMessages.ASSET_UID_REQUIRED);
         return this.service.getVersionNameDetails(this.headers, this.assetUid, this.params);
     }
 
@@ -603,7 +603,7 @@ public Call<ResponseBody> getVersionNameDetails() {
      * @since 0.1.0
      */
     public Call<ResponseBody> deleteVersionName(int versionNumber) {
-        Objects.requireNonNull(this.assetUid, "ErrorMessages.ASSET_UID_REQUIRED");
+        Objects.requireNonNull(this.assetUid, ErrorMessages.ASSET_UID_REQUIRED);
         return this.service.deleteVersionName(this.headers, this.assetUid, versionNumber);
     }
 
@@ -620,7 +620,7 @@ public Call<ResponseBody> deleteVersionName(int versionNumber) {
      * @since 0.1.0
      */
     public Call<ResponseBody> getReferences() {
-        Objects.requireNonNull(this.assetUid, "ErrorMessages.ASSET_UID_REQUIRED");
+        Objects.requireNonNull(this.assetUid, ErrorMessages.ASSET_UID_REQUIRED);
         return this.service.getReferences(this.headers, this.assetUid);
     }
 
@@ -678,7 +678,7 @@ public Call<ResponseBody> getByType(@NotNull String assetType) {
      * @since 0.1.0
      */
     public Call<ResponseBody> updateDetails(JSONObject requestBody) {
-        Objects.requireNonNull(this.assetUid, "ErrorMessages.ASSET_UID_REQUIRED");
+        Objects.requireNonNull(this.assetUid, ErrorMessages.ASSET_UID_REQUIRED);
         return this.service.updateDetails(this.headers, this.assetUid, this.params, requestBody);
     }
 
@@ -704,7 +704,7 @@ public Call<ResponseBody> updateDetails(JSONObject requestBody) {
      * @since 0.1.0
      */
     public Call<ResponseBody> publish(@NotNull JSONObject requestBody) {
-        Objects.requireNonNull(this.assetUid, "ErrorMessages.ASSET_UID_REQUIRED");
+        Objects.requireNonNull(this.assetUid, ErrorMessages.ASSET_UID_REQUIRED);
         return this.service.publish(this.headers, this.assetUid, requestBody);
     }
 
@@ -730,7 +730,7 @@ public Call<ResponseBody> publish(@NotNull JSONObject requestBody) {
      */
     public Call<ResponseBody> unpublish(
             @NotNull JSONObject requestBody) {
-        Objects.requireNonNull(this.assetUid, "ErrorMessages.ASSET_UID_REQUIRED");
+        Objects.requireNonNull(this.assetUid, ErrorMessages.ASSET_UID_REQUIRED);
         return this.service.unpublish(this.headers, this.assetUid, requestBody);
     }
 

src/main/java/com/contentstack/cms/stack/AuditLog.java

@@ -114,7 +114,7 @@ public Call<ResponseBody> find() {
      * @return Call
      */
     public Call<ResponseBody> fetch() {
-        Objects.requireNonNull(this.logItemUid, "ErrorMessages.LOG_ITEM_UID_REQUIRED");
+        Objects.requireNonNull(this.logItemUid, ErrorMessages.LOG_ITEM_UID_REQUIRED);
         return this.service.fetch(this.headers, this.logItemUid);
     }
 

src/test/java/com/contentstack/cms/core/TestUtils.java

@@ -30,7 +30,7 @@ void testUtilConstructor() {
         try {
             new Util();
         } catch (IllegalAccessException e) {
-            Assertions.assertEquals("private=modifier", e.getMessage());
+            Assertions.assertEquals(PRIVATE_CONSTRUCTOR, e.getMessage());
         }
     }