Merge pull request #250 from RushanNanayakkara/ft_notification_templa…

…te_api

components/email-mgt/org.wso2.carbon.email.mgt/src/main/java/org/wso2/carbon/email/mgt/constants/I18nMgtConstants.java

@@ -65,6 +65,10 @@ private I18nMgtConstants() {}
     public static final String NOTIFICATION_TEMPLATES_STORAGE_CONFIG = "DataStorageType.NotificationTemplates";
     public static final String NOTIFICATION_TEMPLATES_LEGACY_TENANTS = "NotificationTemplates.LegacyTenants.Tenant";
 
+    public static final String SERVICE_PROPERTY_KEY_SERVICE_NAME = "service.name";
+    public static final String SERVICE_PROPERTY_VAL_EMAIL_TEMPLATE_MANAGER = "EmailTemplateManager";
+    public static final String SERVICE_PROPERTY_VAL_NOTIFICATION_TEMPLATE_MANAGER = "NotificationTemplateManager";
+
     public static class ErrorMsg {
         private ErrorMsg() {
 

components/email-mgt/org.wso2.carbon.email.mgt/src/main/java/org/wso2/carbon/email/mgt/constants/SQLConstants.java

@@ -97,4 +97,7 @@ public class SQLConstants {
     public static final String DELETE_APP_NOTIFICATION_TEMPLATES_BY_TYPE_SQL =
             "DELETE FROM IDN_NOTIFICATION_APP_TEMPLATE WHERE TYPE_ID = (" + GET_NOTIFICATION_TYPE_ID_SQL +
                     ") AND APP_ID = :APP_ID; AND TENANT_ID = :TENANT_ID;";
+    public static final String DELETE_ALL_APP_NOTIFICATION_TEMPLATES_BY_TYPE_SQL =
+            "DELETE FROM IDN_NOTIFICATION_APP_TEMPLATE WHERE TYPE_ID = (" + GET_NOTIFICATION_TYPE_ID_SQL +
+                    ") AND TENANT_ID = :TENANT_ID;";
 }

components/email-mgt/org.wso2.carbon.email.mgt/src/main/java/org/wso2/carbon/email/mgt/constants/TemplateMgtConstants.java

@@ -0,0 +1,113 @@
+/*
+ * Copyright (c) 2023-2024, WSO2 LLC. (http://www.wso2.com).
+ *
+ * WSO2 LLC. licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.wso2.carbon.email.mgt.constants;
+
+public class TemplateMgtConstants {
+
+    private TemplateMgtConstants() {}
+
+    public static final String DEFAULT_EMAIL_NOTIFICATION_LOCALE = "en_US";
+    public static final String DEFAULT_SMS_NOTIFICATION_LOCALE = "en_US";
+
+    /**
+     * Class which contains the error scenarios.
+     */
+    public static class ErrorScenarios {
+
+        // NTM - NOTIFICATION TEMPLATE MANAGER
+        public static final String NOTIFICATION_TEMPLATE_MANAGER = "NTM";
+    }
+
+    /**
+     * Class which contains the error codes for template management.
+     */
+    public static class ErrorCodes {
+
+        public static final String TEMPLATE_TYPE_ALREADY_EXISTS = "65001";
+        public static final String TEMPLATE_TYPE_NOT_FOUND = "65002";
+        public static final String TEMPLATE_ALREADY_EXISTS = "65003";
+        public static final String TEMPLATE_NOT_FOUND = "65004";
+        public static final String ERROR_ADDING_TEMPLATE = "65005";
+        public static final String ERROR_UPDATING_TEMPLATE = "65006";
+        public static final String ERROR_SYSTEM_RESOURCE_DELETION_NOT_ALLOWED = "65007";
+        public static final String ERROR_RESOLVING_MAIN_APPLICATION = "65008";
+    }
+
+    /**
+     * Enum which contains error codes and corresponding error messages.
+     */
+    public enum ErrorMessages {
+
+        ERROR_CODE_EMPTY_TEMPLATE_NAME("60001", "Notification template name cannot be empty."),
+        ERROR_CODE_EMPTY_LOCALE("60002", "Locale code cannot be empty"),
+        ERROR_CODE_INVALID_LOCALE("60003", "Locale code is invalid."),
+        ERROR_CODE_EMPTY_TEMPLATE_CHANNEL("60004", "Notification template channel cannot be empty"),
+        ERROR_CODE_INVALID_SMS_TEMPLATE("60005", "Body of a SMS template cannot be empty."),
+        ERROR_CODE_INVALID_SMS_TEMPLATE_CONTENT("60006", "SMS template cannot have a subject or footer"),
+        ERROR_CODE_INVALID_EMAIL_TEMPLATE("60007", "Subject/Body/Footer sections of an email template " +
+                "cannot be empty."),
+        ERROR_CODE_INVALID_TEMPLATE_DISPLAY_NAME("60008", "Invalid template display name."),
+        ERROR_CODE_NULL_TEMPLATE_OBJECT("60009", "Notification template is not provided."),
+        ERROR_CODE_TEMPLATE_TYPE_ALREADY_EXISTS(ErrorCodes.TEMPLATE_TYPE_ALREADY_EXISTS,
+                "Notification template type : %s already exists in tenant : %s"),
+        ERROR_CODE_TEMPLATE_TYPE_NOT_FOUND(ErrorCodes.TEMPLATE_TYPE_NOT_FOUND, "Notification template type :" +
+                " %s doesn't exist in tenant : %s"),
+        ERROR_CODE_TEMPLATE_ALREADY_EXISTS(ErrorCodes.TEMPLATE_ALREADY_EXISTS, "Notification template : %s" +
+                " already exists in tenant : %s"),
+        ERROR_CODE_TEMPLATE_NOT_FOUND(ErrorCodes.TEMPLATE_NOT_FOUND, "Notification template : %s " +
+                "doesn't exist in tenant : %s"),
+        ERROR_CODE_SYSTEM_TEMPLATE_TYPE_NOT_FOUND(ErrorCodes.TEMPLATE_TYPE_NOT_FOUND,
+                "System notification template type : %s doesn't exist."),
+        ERROR_CODE_SYSTEM_TEMPLATE_NOT_FOUND(ErrorCodes.TEMPLATE_NOT_FOUND, "System notification " +
+                "template : %s doesn't exist"),
+        ERROR_CODE_ERROR_ADDING_TEMPLATE(ErrorCodes.ERROR_ADDING_TEMPLATE, "Error when adding template : %s" +
+                " to tenant : %s"),
+        ERROR_CODE_ERROR_UPDATING_TEMPLATE(ErrorCodes.ERROR_UPDATING_TEMPLATE, "Error when updating " +
+                "template : %s on tenant : %s"),
+        ERROR_CODE_SYSTEM_RESOURCE_DELETION_NOT_ALLOWED(ErrorCodes.ERROR_SYSTEM_RESOURCE_DELETION_NOT_ALLOWED,
+                "System resource deletion not allowed. %S"),
+        ERROR_CODE_ERROR_RESOLVING_MAIN_APPLICATION(ErrorCodes.ERROR_RESOLVING_MAIN_APPLICATION,
+                "Error when resolving main application : %s");
+
+        private final String code;
+        private final String message;
+
+        ErrorMessages(String code, String message) {
+
+            this.code = code;
+            this.message = message;
+        }
+
+        public String getCode() {
+
+            return code;
+        }
+
+        public String getMessage() {
+
+            return message;
+        }
+
+        @Override
+        public String toString() {
+
+            return code + " - " + message;
+        }
+    }
+}

components/email-mgt/org.wso2.carbon.email.mgt/src/main/java/org/wso2/carbon/email/mgt/internal/I18nMgtServiceComponent.java

@@ -28,6 +28,7 @@
 import org.wso2.carbon.context.PrivilegedCarbonContext;
 import org.wso2.carbon.email.mgt.EmailTemplateManager;
 import org.wso2.carbon.email.mgt.EmailTemplateManagerImpl;
+import org.wso2.carbon.email.mgt.NotificationTemplateManagerImpl;
 import org.wso2.carbon.email.mgt.SMSProviderPayloadTemplateManager;
 import org.wso2.carbon.email.mgt.SMSProviderPayloadTemplateManagerImpl;
 import org.wso2.carbon.email.mgt.constants.I18nMgtConstants;
@@ -61,6 +62,7 @@
 import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.HashMap;
+import java.util.Hashtable;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
@@ -71,6 +73,9 @@
 import javax.xml.stream.XMLStreamReader;
 
 import static org.wso2.carbon.email.mgt.constants.I18nMgtConstants.NOTIFICATION_TEMPLATES_LEGACY_TENANTS;
+import static org.wso2.carbon.email.mgt.constants.I18nMgtConstants.SERVICE_PROPERTY_KEY_SERVICE_NAME;
+import static org.wso2.carbon.email.mgt.constants.I18nMgtConstants.SERVICE_PROPERTY_VAL_EMAIL_TEMPLATE_MANAGER;
+import static org.wso2.carbon.email.mgt.constants.I18nMgtConstants.SERVICE_PROPERTY_VAL_NOTIFICATION_TEMPLATE_MANAGER;
 import static org.wso2.carbon.email.mgt.constants.I18nMgtConstants.SMS_PROVIDER;
 import static org.wso2.carbon.email.mgt.constants.I18nMgtConstants.SMS_PROVIDER_POST_BODY_TEMPLATES_DIR_PATH;
 import static org.wso2.carbon.email.mgt.constants.I18nMgtConstants.TEMPLATE_BODY;
@@ -111,12 +116,28 @@ protected void activate(ComponentContext context) {
             }
 
             // Register EmailTemplateManagerImpl.
+            Hashtable<String, String> emailTemplateManagerServiceProperties = new Hashtable<>();
+            emailTemplateManagerServiceProperties.put(SERVICE_PROPERTY_KEY_SERVICE_NAME,
+                    SERVICE_PROPERTY_VAL_EMAIL_TEMPLATE_MANAGER);
             ServiceRegistration notificationManagerSR = bundleCtx
-                    .registerService(NotificationTemplateManager.class.getName(), emailTemplateManager, null);
+                    .registerService(NotificationTemplateManager.class.getName(), emailTemplateManager,
+                            emailTemplateManagerServiceProperties);
             if (notificationManagerSR != null) {
-                if (log.isDebugEnabled()) {
-                    log.debug("Notification Template Mgt Service registered.");
-                }
+                log.debug("Notification Template Mgt Service registered.");
+            } else {
+                log.error("Error registering Notification Template Mgt Service.");
+            }
+
+            // Register Notification Template Mgt Service as an OSGi service.
+            NotificationTemplateManagerImpl notificationTemplateManager = new NotificationTemplateManagerImpl();
+            Hashtable<String, String> notificationTemplateManagerServiceProperties = new Hashtable<>();
+            notificationTemplateManagerServiceProperties.put(SERVICE_PROPERTY_KEY_SERVICE_NAME,
+                    SERVICE_PROPERTY_VAL_NOTIFICATION_TEMPLATE_MANAGER);
+            ServiceRegistration notificationTemplateSR = bundleCtx
+                    .registerService(NotificationTemplateManager.class.getName(), notificationTemplateManager,
+                            notificationTemplateManagerServiceProperties);
+            if (notificationTemplateSR != null) {
+                log.debug("Notification Template Mgt Service registered.");
             } else {
                 log.error("Error registering Notification Template Mgt Service.");
             }

components/email-mgt/org.wso2.carbon.email.mgt/src/main/java/org/wso2/carbon/email/mgt/store/DBBasedTemplateManager.java

@@ -328,6 +328,25 @@ public void deleteNotificationTemplates(String displayName, String notificationC
         }
     }
 
+    @Override
+    public void deleteAllNotificationTemplates(String displayName, String notificationChannel, String tenantDomain)
+            throws NotificationTemplateManagerServerException {
+
+        String templateTypeKey = displayName.toLowerCase();
+        int tenantId = getTenantId(tenantDomain);
+
+        orgNotificationTemplateDAO.removeNotificationTemplates(templateTypeKey, notificationChannel, tenantId);
+        if (log.isDebugEnabled()) {
+            log.debug(String.format("Org %s templates for type: %s for tenant: %s successfully deleted.",
+                    notificationChannel, displayName, tenantDomain));
+        }
+        appNotificationTemplateDAO.removeAllNotificationTemplates(templateTypeKey, notificationChannel, tenantId);
+        if (log.isDebugEnabled()) {
+            log.debug(String.format("App %s templates for type: %s for all applications for tenant: %s " +
+                            "successfully deleted.", notificationChannel, displayName, tenantDomain));
+        }
+    }
+
     /**
      * Get the tenant id of the given tenant domain.
      * @param tenantDomain

components/email-mgt/org.wso2.carbon.email.mgt/src/main/java/org/wso2/carbon/email/mgt/store/HybridTemplateManager.java

@@ -102,6 +102,20 @@ public void deleteNotificationTemplateType(String displayName, String notificati
         }
     }
 
+    @Override
+    public void deleteAllNotificationTemplates(String displayName, String notificationChannel, String tenantDomain)
+            throws NotificationTemplateManagerServerException {
+
+        if (dbBasedTemplateManager.isNotificationTemplateTypeExists(displayName, notificationChannel, tenantDomain)) {
+            dbBasedTemplateManager.deleteAllNotificationTemplates(displayName, notificationChannel, tenantDomain);
+        }
+
+        if (registryBasedTemplateManager.isNotificationTemplateTypeExists(displayName, notificationChannel,
+                tenantDomain)) {
+            registryBasedTemplateManager.deleteAllNotificationTemplates(displayName, notificationChannel, tenantDomain);
+        }
+    }
+
     @Override
     public void addOrUpdateNotificationTemplate(NotificationTemplate notificationTemplate, String applicationUuid,
                                                 String tenantDomain) throws NotificationTemplateManagerServerException {

components/email-mgt/org.wso2.carbon.email.mgt/src/main/java/org/wso2/carbon/email/mgt/store/RegistryBasedTemplateManager.java

@@ -297,6 +297,23 @@ public void deleteNotificationTemplates(String displayName, String notificationC
         }
     }
 
+    @Override
+    public void deleteAllNotificationTemplates(String displayName, String notificationChannel, String tenantDomain)
+            throws NotificationTemplateManagerServerException {
+
+        String path = buildTemplateRootDirectoryPath(I18nEmailUtil.getNormalizedName(displayName),
+                notificationChannel, null);
+
+        try {
+            Collection templates = (Collection) resourceMgtService.getIdentityResource(path, tenantDomain);
+            for (String subPath : templates.getChildren()) {
+                resourceMgtService.deleteIdentityResource(subPath, tenantDomain);
+            }
+        } catch (IdentityRuntimeException | RegistryException e) {
+            throw new NotificationTemplateManagerServerException("Error while deleting notification templates.", e);
+        }
+    }
+
     /**
      * Get the notification template from resource.
      *

components/email-mgt/org.wso2.carbon.email.mgt/src/main/java/org/wso2/carbon/email/mgt/store/SystemDefaultTemplateManager.java

@@ -112,6 +112,13 @@ public void deleteNotificationTemplateType(String displayName, String notificati
         throw new UnsupportedOperationException();
     }
 
+    @Override
+    public void deleteAllNotificationTemplates(String displayName, String notificationChannel, String tenantDomain)
+            throws NotificationTemplateManagerServerException {
+
+        throw new UnsupportedOperationException();
+    }
+
     @Override
     public void addOrUpdateNotificationTemplate(NotificationTemplate notificationTemplate, String applicationUuid,
                                                 String tenantDomain) throws NotificationTemplateManagerServerException {

components/email-mgt/org.wso2.carbon.email.mgt/src/main/java/org/wso2/carbon/email/mgt/store/TemplatePersistenceManager.java

@@ -73,6 +73,19 @@ List<String> listNotificationTemplateTypes(String notificationChannel, String te
     void deleteNotificationTemplateType(String displayName, String notificationChannel, String tenantDomain)
             throws NotificationTemplateManagerServerException;
 
+    /**
+     * Delete both organization level and application level notification templates under a notification template type.
+     *
+     * @param displayName           Display Name.
+     * @param notificationChannel   Notification channel.
+     * @param tenantDomain          Tenant domain.
+     * @throws NotificationTemplateManagerServerException If an error occurred while resetting the template type.
+     */
+    default void deleteAllNotificationTemplates(String displayName, String notificationChannel, String tenantDomain)
+            throws NotificationTemplateManagerServerException {
+        // not implemented
+    }
+
     /**
      * Update the notification template if exists or add a new template if not exists.
      *

components/email-mgt/org.wso2.carbon.email.mgt/src/main/java/org/wso2/carbon/email/mgt/store/TemplatePersistenceManagerFactory.java

@@ -33,7 +33,8 @@ public class TemplatePersistenceManagerFactory {
     private static final Log log = LogFactory.getLog(TemplatePersistenceManagerFactory.class);
 
     /**
-     * Returns a {@link TemplatePersistenceManager} implementation based on the configuration.
+     * Returns a {@link TemplatePersistenceManager} implementation based on the configuration that handles both system
+     * templates and user defined templates.
      *
      * If the storage type is configured as database, an instance of {@link DBBasedTemplateManager} will be returned.
      * If the storage type is configured as hybrid, an instance of {@link HybridTemplateManager} will be returned.
@@ -66,4 +67,60 @@ public TemplatePersistenceManager getTemplatePersistenceManager() {
         }
         return new UnifiedTemplateManager(persistenceManager);
     }
+
+    /**
+     * Returns a {@link TemplatePersistenceManager} implementation based on the configuration that handles only user
+     * defined templates.
+     *
+     * If the storage type is configured as database, an instance of {@link DBBasedTemplateManager} will be returned.
+     * If the storage type is configured as hybrid, an instance of {@link HybridTemplateManager} will be returned.
+     * If the storage type is configured as registry, an instance of {@link RegistryBasedTemplateManager} will be returned.
+     * For any other case, an instance of {@link DBBasedTemplateManager} will be returned.
+     *
+     * @return an implementation of {@link TemplatePersistenceManager}.
+     */
+    public TemplatePersistenceManager getUserDefinedTemplatePersistenceManager() {
+
+        String notificationTemplatesStorageType = IdentityUtil.getProperty(NOTIFICATION_TEMPLATES_STORAGE_CONFIG);
+
+        TemplatePersistenceManager persistenceManager = new DBBasedTemplateManager();
+
+        if (StringUtils.isNotBlank(notificationTemplatesStorageType)) {
+            switch (notificationTemplatesStorageType) {
+                case "hybrid":
+                    persistenceManager = new HybridTemplateManager();
+                    log.info("Hybrid template persistent manager initialized.");
+                    break;
+                case "registry":
+                    persistenceManager = new RegistryBasedTemplateManager();
+                    log.warn("Registry based template persistent manager initialized.");
+                    break;
+            }
+        }
+
+        if (log.isDebugEnabled()) {
+            log.debug("Template persistent manager initialized with the type: " + persistenceManager.getClass());
+        }
+        return persistenceManager;
+    }
+
+    /**
+     * Returns a {@link TemplatePersistenceManager} implementation based on the configuration that handles only
+     * system templates.
+     *
+     * If the storage type is configured as database, an instance of {@link DBBasedTemplateManager} will be returned.
+     * If the storage type is configured as hybrid, an instance of {@link HybridTemplateManager} will be returned.
+     * If the storage type is configured as registry, an instance of {@link RegistryBasedTemplateManager} will be returned.
+     * For any other case, an instance of {@link DBBasedTemplateManager} will be returned.
+     *
+     * @return an implementation of {@link TemplatePersistenceManager}.
+     */
+    public TemplatePersistenceManager getSystemTemplatePersistenceManager() {
+
+        SystemDefaultTemplateManager inMemoryTemplateManager = new SystemDefaultTemplateManager();
+        if (log.isDebugEnabled()) {
+            log.debug("Template persistent manager initialized with the type: " + inMemoryTemplateManager.getClass());
+        }
+        return inMemoryTemplateManager;
+    }
 }

components/email-mgt/org.wso2.carbon.email.mgt/src/main/java/org/wso2/carbon/email/mgt/store/UnifiedTemplateManager.java

@@ -82,6 +82,16 @@ public void deleteNotificationTemplateType(String displayName, String notificati
         }
     }
 
+    @Override
+    public void deleteAllNotificationTemplates(String displayName, String notificationChannel, String tenantDomain)
+            throws NotificationTemplateManagerServerException {
+
+        if (templatePersistenceManager.isNotificationTemplateTypeExists(displayName, notificationChannel,
+                tenantDomain)) {
+            templatePersistenceManager.deleteAllNotificationTemplates(displayName, notificationChannel, tenantDomain);
+        }
+    }
+
     @Override
     public void addOrUpdateNotificationTemplate(NotificationTemplate notificationTemplate, String applicationUuid,
                                                 String tenantDomain) throws NotificationTemplateManagerServerException {