Merge pull request #459 from cap-java/errorMessages

Separate UI and Backend Error Keys for Localization

Author: deepikaSingh2711

.github/workflows/cfdeploy.yml

@@ -114,7 +114,7 @@ jobs:
           wget -q -O - https://packages.cloudfoundry.org/debian/cli.cloudfoundry.org.key | sudo tee /etc/apt/trusted.gpg.d/cloudfoundry.asc
           echo "deb https://packages.cloudfoundry.org/debian stable main" | sudo tee /etc/apt/sources.list.d/cloudfoundry-cli.list
           sudo apt update
-          sudo apt install cf-cli
+          sudo apt install cf8-cli
 
           cf install-plugin multiapps -f
 
@@ -249,7 +249,7 @@ jobs:
           wget -q -O - https://packages.cloudfoundry.org/debian/cli.cloudfoundry.org.key | sudo tee /etc/apt/trusted.gpg.d/cloudfoundry.asc
           echo "deb https://packages.cloudfoundry.org/debian stable main" | sudo tee /etc/apt/sources.list.d/cloudfoundry-cli.list
           sudo apt update
-          sudo apt install cf-cli
+          sudo apt install cf8-cli
 
           cf install-plugin multiapps -f
 

.github/workflows/multiTenancyDeployLocal.yml

@@ -105,7 +105,7 @@ jobs:
             wget -q -O - https://packages.cloudfoundry.org/debian/cli.cloudfoundry.org.key | sudo tee /etc/apt/trusted.gpg.d/cloudfoundry.asc
             echo "deb https://packages.cloudfoundry.org/debian stable main" | sudo tee /etc/apt/sources.list.d/cloudfoundry-cli.list
             sudo apt update
-            sudo apt install cf-cli
+            sudo apt install cf8-cli
             
             cf install-plugin multiapps -f
             echo "✅ Cloud Foundry CLI setup complete!"

.github/workflows/multiTenant_deploy_and_Integration_test.yml

@@ -81,7 +81,7 @@ jobs:
             wget -q -O - https://packages.cloudfoundry.org/debian/cli.cloudfoundry.org.key | sudo tee /etc/apt/trusted.gpg.d/cloudfoundry.asc
             echo "deb https://packages.cloudfoundry.org/debian stable main" | sudo tee /etc/apt/sources.list.d/cloudfoundry-cli.list
             sudo apt update
-            sudo apt install cf-cli
+            sudo apt install cf8-cli
             
             cf install-plugin multiapps -f
             echo "✅ Cloud Foundry CLI setup complete!"

.github/workflows/multiTenant_deploy_and_Integration_test_LatestVersion.yml

@@ -129,7 +129,7 @@ jobs:
             wget -q -O - https://packages.cloudfoundry.org/debian/cli.cloudfoundry.org.key | sudo tee /etc/apt/trusted.gpg.d/cloudfoundry.asc
             echo "deb https://packages.cloudfoundry.org/debian stable main" | sudo tee /etc/apt/sources.list.d/cloudfoundry-cli.list
             sudo apt update
-            sudo apt install cf-cli
+            sudo apt install cf8-cli
             
             cf install-plugin multiapps -f
             echo "✅ Cloud Foundry CLI setup complete!"

.github/workflows/singleTenant_deploy_and_Integration_test.yml

@@ -98,7 +98,7 @@ jobs:
           echo "deb https://packages.cloudfoundry.org/debian stable main" \
           | sudo tee /etc/apt/sources.list.d/cloudfoundry-cli.list
           sudo apt update
-          sudo apt install cf-cli
+          sudo apt install cf8-cli
           
           # Install cf CLI plugin
           cf install-plugin multiapps -f

.github/workflows/singleTenant_deploy_and_Integration_test_LatestVersion.yml

@@ -149,7 +149,7 @@ jobs:
           echo "deb https://packages.cloudfoundry.org/debian stable main" \
           | sudo tee /etc/apt/sources.list.d/cloudfoundry-cli.list
           sudo apt update
-          sudo apt install cf-cli
+          sudo apt install cf8-cli
           
           # Install cf CLI plugin
           cf install-plugin multiapps -f

README.md

@@ -1299,9 +1299,12 @@ type=Type
 
 ### Error Messages Localization
 
-The plugin provides error message keys in the `SDMErrorKeys` [class](https://github.com/cap-java/sdm/blob/develop/sdm/src/main/java/com/sap/cds/sdm/constants/SDMErrorKeys.java). You can override these messages by adding translations to `messages_[languagecode].properties` files in your leading application under `srv/src/main/resources`.
+The plugin provides two classes for error keys:
 
-Default messages are present in `SDMErrorMessages` [class](https://github.com/cap-java/sdm/blob/develop/sdm/src/main/java/com/sap/cds/sdm/constants/SDMErrorMessages.java). If the leading application does not provide translations in their language-specific properties files, these default English language messages are shown to the user.
+- `SDMUIErrorKeys` - UI-facing messages that should be translated
+- `SDMErrorKeys` - Backend/internal messages (no translation needed)
+
+To translate UI messages, add entries to `messages_[languagecode].properties` in `srv/src/main/resources/`. If the leading application does not provide translations in their language-specific properties files, these default English language messages are shown to the user.
 
 Example `messages_de.properties` for German language:
 ```properties
@@ -1311,7 +1314,6 @@ SDM.mimetypeInvalidError=Der Dateityp ist nicht zulässig
 SDM.maxCountErrorMessage=Maximale Anzahl von Anhängen erreicht
 ```
 
-
 ## Support for Attachment Upload Status
 
 The attachment upload process displays a status indicator for each file being uploaded.

sdm/src/main/java/com/sap/cds/sdm/constants/SDMErrorKeys.java

@@ -8,48 +8,39 @@
 import java.util.LinkedHashMap;
 import java.util.Map;
 
+// Backend/Internal Error Keys
 public class SDMErrorKeys {
-  private SDMErrorKeys() {
-    // Doesn't do anything
-  }
+  private SDMErrorKeys() {}
 
-  public static final String COULD_NOT_UPDATE_THE_ATTACHMENT_KEY =
-      "SDM.couldNotUpdateTheAttachment";
-  public static final String ATTACHMENT_NOT_FOUND_KEY = "SDM.attachmentNotFound";
-  public static final String GENERIC_ERROR_KEY = "SDM.genericError";
-  public static final String EVENT_UPLOAD_KEY = "SDM.eventUpload";
-  public static final String VERSIONED_REPO_ERROR_KEY = "SDM.Repository.versionedRepoError";
-  public static final String VIRUS_REPO_ERROR_MORE_THAN_400MB_KEY =
-      "SDM.virusRepoErrorMoreThan400MB";
-  public static final String VIRUS_ERROR_KEY = "SDM.virusError";
-  public static final String REPOSITORY_ERROR_KEY = "SDM.repositoryError";
-  public static final String SDM_MISSING_ROLES_EXCEPTION_KEY = "SDM.sdmMissingRolesException";
-  public static final String SDM_SERVER_ERROR_KEY = "SDM.sdmServerError";
   public static final String ENTITY_PROCESSING_ERROR_LINK_KEY = "SDM.entityProcessingErrorLink";
-  public static final String USER_NOT_AUTHORISED_ERROR_KEY = "SDM.userNotAuthorisedError";
-  public static final String MIMETYPE_INVALID_ERROR_KEY = "SDM.mimetypeInvalidError";
-  public static final String USER_NOT_AUTHORISED_ERROR_LINK_KEY = "SDM.userNotAuthorisedErrorLink";
-  public static final String FILE_NOT_FOUND_ERROR_KEY = "SDM.fileNotFoundError";
+  public static final String FAILED_TO_EDIT_LINK_KEY = "SDM.failedToEditLink";
   public static final String ONBOARD_REPO_MESSAGE_KEY = "SDM.onboardRepoMessage";
   public static final String REPOSITORY_ALREADY_EXIST_KEY = "SDM.repositoryAlreadyExist";
   public static final String ONBOARD_REPO_ERROR_MESSAGE_KEY = "SDM.onboardRepoErrorMessage";
-  public static final String UPDATE_ATTACHMENT_ERROR_KEY = "SDM.updateAttachmentError";
+  public static final String FAILED_TO_OFFBOARD_REPOSITORY_KEY = "SDM.failedToOffboardRepository";
+  public static final String ERROR_WHILE_OFFBOARDING_REPOSITORY_KEY =
+      "SDM.errorWhileOffboardingRepository";
+  public static final String UNEXPECTED_ERROR_WHILE_OFFBOARDING_REPOSITORY_KEY =
+      "SDM.unexpectedErrorWhileOffboardingRepository";
   public static final String DRAFT_NOT_FOUND_KEY = "SDM.draftNotFound";
-  public static final String UNSUPPORTED_PROPERTIES_KEY = "SDM.unsupportedProperties";
-  public static final String FAILED_TO_COPY_ATTACHMENT_KEY = "SDM.failedToCopyAttachment";
   public static final String PARENT_ENTITY_NOT_FOUND_ERROR_KEY = "SDM.parentEntityNotFoundError";
   public static final String COMPOSITION_NOT_FOUND_ERROR_KEY = "SDM.compositionNotFoundError";
   public static final String TARGET_ATTACHMENT_ENTITY_NOT_FOUND_ERROR_KEY =
       "SDM.targetAttachmentEntityNotFoundError";
   public static final String INVALID_FACET_FORMAT_ERROR_KEY = "SDM.invalidFacetFormatError";
   public static final String FETCH_ATTACHMENT_COMPOSITION_ERROR_KEY =
       "SDM.fetchAttachmentCompositionError";
-  public static final String FAILED_TO_EDIT_LINK_KEY = "SDM.failedToEditLink";
   public static final String ERROR_IN_SETTING_TIMEOUT_KEY = "SDM.errorInSettingTimeout";
   public static final String SDM_CREDENTIALS_MISSING_OR_INVALID_KEY =
       "SDM.sdmCredentialsMissingOrInvalid";
   public static final String FAILED_TO_RETRIEVE_SDM_CREDENTIALS_KEY =
       "SDM.failedToRetrieveSdmCredentials";
+  public static final String CLIENT_CREDENTIALS_MISSING_OR_INVALID_KEY =
+      "SDM.clientCredentialsMissingOrInvalid";
+  public static final String FAILED_TO_CREATE_CLIENT_CREDENTIALS_KEY =
+      "SDM.failedToCreateClientCredentials";
+  public static final String FAILED_TO_REPLACE_SUBDOMAIN_IN_BASE_TOKEN_URL_KEY =
+      "SDM.failedToReplaceSubdomainInBaseTokenUrl";
   public static final String FAILED_TO_CREATE_HTTP_CLIENT_KEY = "SDM.failedToCreateHttpClient";
   public static final String ERROR_WHILE_CREATING_HTTP_CLIENT_KEY =
       "SDM.errorWhileCreatingHttpClient";
@@ -58,67 +49,17 @@ private SDMErrorKeys() {
   public static final String FAILED_TO_SERIALIZE_REPOSITORY_OBJECT_TO_JSON_KEY =
       "SDM.failedToSerializeRepositoryObjectToJson";
   public static final String FAILED_TO_CREATE_STRING_ENTITY_KEY = "SDM.failedToCreateStringEntity";
-  public static final String CLIENT_CREDENTIALS_MISSING_OR_INVALID_KEY =
-      "SDM.clientCredentialsMissingOrInvalid";
-  public static final String FAILED_TO_CREATE_CLIENT_CREDENTIALS_KEY =
-      "SDM.failedToCreateClientCredentials";
-  public static final String FAILED_TO_REPLACE_SUBDOMAIN_IN_BASE_TOKEN_URL_KEY =
-      "SDM.failedToReplaceSubdomainInBaseTokenUrl";
   public static final String ERROR_WHILE_FETCHING_REPOSITORY_ID_KEY =
-      "SDM.errowWhileFetchingRepositoryId";
+      "SDM.errorWhileFetchingRepositoryId";
   public static final String UNEXPECTED_ERROR_WHILE_FETCHING_REPOSITORY_ID_KEY =
       "SDM.unexpectedErrorWhileFetchingRepositoryId";
-  public static final String FAILED_TO_OFFBOARD_REPOSITORY_KEY = "SDM.failedToOffboardRepository";
-  public static final String ERROR_WHILE_OFFBOARDING_REPOSITORY_KEY =
-      "SDM.errorWhileOffboardingRepository";
-  public static final String UNEXPECTED_ERROR_WHILE_OFFBOARDING_REPOSITORY_KEY =
-      "SDM.unexpectedErrorWhileOffboardingRepository";
   public static final String FAILED_TO_PARSE_REPOSITORY_RESPONSE_KEY =
       "SDM.failedToParseRepositoryResponse";
   public static final String FAILED_TO_CREATE_FOLDER_KEY = "SDM.failedToCreateFolder";
-  public static final String FILENAME_WHITESPACE_ERROR_MESSAGE_KEY =
-      "SDM.filenameWhitespaceErrorMessage";
-  public static final String SINGLE_RESTRICTED_CHARACTER_IN_FILE_KEY =
-      "SDM.singleRestrictedCharacterInFile";
-  public static final String SINGLE_DUPLICATE_FILENAME_KEY = "SDM.singleDuplicateFilename";
-  public static final String VIRUS_DETECTED_FILE_ERROR_KEY = "SDM.virusDetectedFileError";
-  public static final String VIRUS_SCAN_IN_PROGRESS_FILE_ERROR_KEY =
-      "SDM.virusScanInProgressFileError";
-
-  public static final String UPLOAD_IN_PROGRESS_FILE_ERROR_KEY = "SDM.uploadInProgressFileError";
-  public static final String VIRUS_DETECTED_FILES_PREFIX_KEY = "SDM.virusDetectedFilesPrefix";
-  public static final String VIRUS_DETECTED_FILES_SUFFIX_KEY = "SDM.virusDetectedFilesSuffix";
-  public static final String VIRUS_SCAN_IN_PROGRESS_FILES_PREFIX_KEY =
-      "SDM.virusScanInProgressFilesPrefix";
-  public static final String VIRUS_SCAN_IN_PROGRESS_FILES_SUFFIX_KEY =
-      "SDM.virusScanInProgressFilesSuffix";
-  public static final String SCAN_FAILED_FILES_PREFIX_KEY = "SDM.scanFailedFilesPrefix";
-  public static final String SCAN_FAILED_FILES_SUFFIX_KEY = "SDM.scanFailedFilesSuffix";
-  public static final String RESTRICTED_CHARACTERS_IN_MULTIPLE_FILES_KEY =
-      "SDM.restrictedCharactersInMultipleFiles";
-  public static final String MULTIPLE_DUPLICATE_FILENAMES_PREFIX_KEY =
-      "SDM.multipleDuplicateFilenamesPrefix";
-  public static final String MULTIPLE_DUPLICATE_FILENAMES_SUFFIX_KEY =
-      "SDM.multipleDuplicateFilenamesSuffix";
-  public static final String FILE_NOT_FOUND_PREFIX_KEY = "SDM.fileNotFoundPrefix";
-  public static final String FILE_NOT_FOUND_SUFFIX_KEY = "SDM.fileNotFoundSuffix";
-  public static final String BAD_REQUEST_PREFIX_KEY = "SDM.badRequestPrefix";
-  public static final String BAD_REQUEST_SUFFIX_KEY = "SDM.badRequestSuffix";
-  public static final String EVENT_CREATE_KEY = "SDM.eventCreate";
-  public static final String EVENT_UPDATE_KEY = "SDM.eventUpdate";
-  public static final String NO_SDM_ROLES_PREFIX_KEY = "SDM.noSdmRolesPrefix";
   public static final String CONTEXT_INFO_TABLE = "SDM.contextInfoTable";
   public static final String CONTEXT_INFO_PAGE = "SDM.contextInfoPage";
-  public static final String UNSUPPORTED_PROPERTIES_PREFIX_KEY = "SDM.unsupportedPropertiesPrefix";
-  public static final String UNSUPPORTED_PROPERTIES_SUFFIX_KEY = "SDM.unsupportedPropertiesSuffix";
-  public static final String MAX_COUNT_ERROR_MESSAGE_KEY = "SDM.maxCountErrorMessage";
-  public static final String FETCH_CHANGELOG_ERROR_KEY = "SDM.fetchChangelogError";
-  public static final String FAILED_TO_MOVE_ATTACHMENT_KEY = "SDM.failedToMoveAttachment";
-  public static final String INVALID_SECONDARY_PROPERTIES_FOR_MOVE_PREFIX_KEY =
-      "SDM.invalidSecondaryPropertiesForMovePrefix";
-  public static final String INVALID_SECONDARY_PROPERTIES_FOR_MOVE_SUFFIX_KEY =
-      "SDM.invalidSecondaryPropertiesForMoveSuffix";
-  public static final String SDM_MOVE_OPERATION_FAILED_KEY = "SDM.sdmMoveOperationFailed";
+  public static final String EVENT_CREATE_KEY = "SDM.eventCreate";
+  public static final String EVENT_UPDATE_KEY = "SDM.eventUpdate";
   public static final String FAILED_TO_ACCESS_ERROR_KEY_FIELDS_KEY =
       "SDM.failedToAccessErrorKeyFields";
   public static final String FAILED_TO_ACCESS_ERROR_MESSAGES_FIELDS_KEY =

sdm/src/main/java/com/sap/cds/sdm/constants/SDMErrorMessages.java

@@ -19,9 +19,8 @@ private SDMErrorMessages() {
 
   public static final String COULD_NOT_UPDATE_THE_ATTACHMENT = "Could not update the attachment";
   public static final String ATTACHMENT_NOT_FOUND = "Attachment not found";
-  public static final String GENERIC_ERROR = "Could not %s the document.";
-  public static final String EVENT_UPLOAD = "upload";
-  public static final String EVENT_DELETE = "delete";
+  public static final String COULD_NOT_UPLOAD_DOCUMENT = "Could not upload the document.";
+  public static final String COULD_NOT_DELETE_DOCUMENT = "Could not delete the document.";
   public static final String VERSIONED_REPO_ERROR =
       "Upload not supported for versioned repositories.";
   public static final String VIRUS_REPO_ERROR_MORE_THAN_400MB =
@@ -263,8 +262,12 @@ public static String getDuplicateFilesError(String filename) {
     return duplicateFilenameFormat(filenames);
   }
 
-  public static String getGenericError(String event) {
-    return String.format(SDMUtils.getErrorMessage("GENERIC_ERROR"), event);
+  public static String getCouldNotUploadDocument() {
+    return SDMUtils.getErrorMessage("COULD_NOT_UPLOAD_DOCUMENT");
+  }
+
+  public static String getCouldNotDeleteDocument() {
+    return SDMUtils.getErrorMessage("COULD_NOT_DELETE_DOCUMENT");
   }
 
   public static String getVirusFilesError(String filename) {