[Notification Template API] Add notification template management functions

components/org.wso2.carbon.identity.governance/src/main/java/org/wso2/carbon/identity/governance/service/notification/NotificationTemplateManager.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
+ * Copyright (c) 2019-2024, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,6 +25,137 @@
  */
 public interface NotificationTemplateManager {
 
+
+    /**
+     * Add new notification template type to the system.
+     *
+     * @param notificationChannel Notification channel (Eg: SMS, EMAIL).
+     * @param displayName         Notification template display name
+     * @param tenantDomain        Tenant domain
+     * @throws NotificationTemplateManagerException If an error occurred while adding the template to the registry
+     */
+    default void addNotificationTemplateType(String notificationChannel, String displayName, String tenantDomain)
+            throws NotificationTemplateManagerException {
+
+    }
+
+    /**
+     * Add new notification template type to the system.
+     *
+     * @param notificationChannel Notification channel (Eg: SMS, EMAIL).
+     * @param displayName         Notification template display name.
+     * @param tenantDomain        Tenant domain.
+     * @param applicationUuid     Application UUID.
+     * @throws NotificationTemplateManagerException If an error occurred while adding the template to the registry.
+     */
+    default void addNotificationTemplateType(String notificationChannel, String displayName,
+                                             String tenantDomain, String applicationUuid)
+            throws NotificationTemplateManagerException {
+
+    }
+
+    /**
+     * Get all available notification template types for the tenant.
+     *
+     * @param notificationChannel Notification channel (Eg: SMS, EMAIL).
+     * @param tenantDomain        Tenant domain.
+     * @return List of notification template types.
+     * @throws NotificationTemplateManagerException If an error occurred while getting the notification template types.
+     */
+    default List<String> getAllNotificationTemplateTypes(String notificationChannel, String tenantDomain)
+            throws NotificationTemplateManagerException {
+
+        return null;
+    }
+
+    /**
+     * Delete a notification template type from the tenant registry.
+     *
+     * @param notificationChannel Notification channel (Eg: SMS, EMAIL).
+     * @param templateDisplayName Display name of the template type.
+     * @param tenantDomain        Tenant domain.
+     * @throws NotificationTemplateManagerException If an error occurred while deleting the notification template type.
+     */
+    default void deleteNotificationTemplateType(String notificationChannel, String templateDisplayName,
+                                                String tenantDomain)
+            throws NotificationTemplateManagerException {
+
+    }
+
+    /**
+     * Check whether the given notification template type exists in the system.
+     *
+     * @param notificationChannel     Notification channel (Eg: SMS, EMAIL).
+     * @param templateTypeDisplayName Display name of the template type.
+     * @param tenantDomain            Tenant Domain.
+     * @throws NotificationTemplateManagerException If an error occurred while checking if template type exists.
+     */
+    default boolean isNotificationTemplateTypeExists(String notificationChannel, String templateTypeDisplayName,
+                                                     String tenantDomain)
+            throws NotificationTemplateManagerException {
+
+        return false;
+    }
+
+    /**
+     * Resets the template type in the database by deleting of all it's user defined templates.
+     *
+     * @param notificationChannel Notification channel (Eg: SMS, EMAIL).
+     * @param templateType        Display name of the template.
+     * @param tenantDomain        Tenant domain.
+     * @throws NotificationTemplateManagerException If an error occurred while resetting the notification template type.
+     */
+    default void resetNotificationTemplateType(String notificationChannel, String templateType, String tenantDomain)
+            throws NotificationTemplateManagerException {
+
+    }
+
+    /**
+     * Get all available notification template types in the tenant for a given notification channel.
+     *
+     * @param notificationChannel Notification channel (Eg: SMS, EMAIL).
+     * @param tenantDomain        Tenant domain.
+     * @throws NotificationTemplateManagerException If an error occurred while getting the notification template types.
+     */
+    default List<NotificationTemplate> getAllNotificationTemplates(String notificationChannel, String tenantDomain)
+            throws NotificationTemplateManagerException {
+
+        return null;
+    }
+
+    /**
+     * Get all notification templates of the given type.
+     *
+     * @param notificationChannel Notification channel (Eg: SMS, EMAIL).
+     * @param templateDisplayName Display name of the template.
+     * @param tenantDomain        Tenant domain.
+     * @return List of notification templates.
+     * @throws NotificationTemplateManagerException If an error occurred while getting the notification templates.
+     */
+    default List<NotificationTemplate> getNotificationTemplatesOfType(String notificationChannel,
+                                                                      String templateDisplayName, String tenantDomain)
+            throws NotificationTemplateManagerException {
+
+        return null;
+    }
+
+    /**
+     * Get all notification templates of the given type.
+     *
+     * @param notificationChannel Notification channel (Eg: SMS, EMAIL).
+     * @param templateDisplayName Display name of the template.
+     * @param tenantDomain        Tenant domain.
+     * @param applicationUuid     Application UUID.
+     * @return List of notification templates.
+     * @throws NotificationTemplateManagerException If an error occurred while getting the notification templates.
+     */
+    default List<NotificationTemplate> getNotificationTemplatesOfType(String notificationChannel,
+                                              String templateDisplayName, String tenantDomain, String applicationUuid)
+            throws NotificationTemplateManagerException {
+
+        return null;
+    }
+
     /**
      * Return the notification template from the tenant registry which matches the given channel and template name.
      *
@@ -61,7 +192,7 @@
     }
 
     /**
-     * Add the notification template to the registry.
+     * Add the notification template.
      *
      * @param notificationTemplate Notification template
      *                             {@link org.wso2.carbon.identity.governance.model.NotificationTemplate}
@@ -74,7 +205,7 @@
     }
 
     /**
-     * Add the notification template to the registry.
+     * Add the notification template.
      *
      * @param notificationTemplate  Notification template.
      * @param tenantDomain          Tenant domain.
@@ -87,14 +218,59 @@
     }
 
     /**
-     * Add a new notification template to the registry to the corresponding notification channel root directory.
+     * Update notification template.
      *
-     * @param displayName         Notification template display name
-     * @param notificationChannel Notification channel
-     * @param tenantDomain        Tenant domain
-     * @throws NotificationTemplateManagerException If an error occurred while adding the template to the registry
+     * @param notificationTemplate Notification template
+     *                             {@link org.wso2.carbon.identity.governance.model.NotificationTemplate}
+     * @param tenantDomain         Tenant domain
+     * @throws NotificationTemplateManagerException If an error occurred while updating the notification template
+     */
+    default void updateNotificationTemplate(NotificationTemplate notificationTemplate, String tenantDomain)
+            throws NotificationTemplateManagerException {
+
+    }
+
+    /**
+     * Update notification template of application.
+     *
+     * @param notificationTemplate  Notification template.
+     * @param tenantDomain          Tenant domain.
+     * @param applicationUuid       Application UUID.
+     * @throws NotificationTemplateManagerException If an error occurred while updating the notification template.
+     */
+    default void updateNotificationTemplate(NotificationTemplate notificationTemplate, String tenantDomain,
+                                         String applicationUuid) throws NotificationTemplateManagerException {
+
+    }
+
+    /**
+     * Delete a notification template from the system.
+     *
+     * @param notificationChannel Notification channel (Eg: SMS, EMAIL).
+     * @param templateDisplayName Display name of the template.
+     * @param locale              Locale of the template.
+     * @param tenantDomain        Tenant domain.
+     * @throws NotificationTemplateManagerException If an error occurred while deleting the notification template.
+     */
+    default void deleteNotificationTemplate(String notificationChannel, String templateDisplayName, String locale,
+                                            String tenantDomain)
+            throws NotificationTemplateManagerException {
+
+    }
+
+
+    /**
+     * Delete an application notification template from the system.
+     *
+     * @param notificationChannel Notification channel (Eg: SMS, EMAIL).
+     * @param templateDisplayName Display name of the template.
+     * @param locale              Locale of the template.
+     * @param tenantDomain        Tenant domain.
+     * @param applicationUuid     Application UUID.
+     * @throws NotificationTemplateManagerException If an error occurred while deleting the notification template.
      */
-    default void addNotificationTemplateType(String displayName, String notificationChannel, String tenantDomain)
+    default void deleteNotificationTemplate(String notificationChannel, String templateDisplayName, String locale,
+                                            String tenantDomain, String applicationUuid)
             throws NotificationTemplateManagerException {
 
     }
@@ -125,17 +301,62 @@
     }
 
     /**
-     * Add a new notification template to the registry to the corresponding notification channel root directory.
+     * Check whether the given notification template exists in the system.
+     *
+     * @param notificationChannel   Notification channel.
+     * @param templateDisplayName   Display name of the template.
+     * @param tenantDomain          Tenant Domain.
+     * @throws NotificationTemplateManagerException If an error occurred while checking if template type exists.
+     */
+    default boolean isNotificationTemplateExists(String notificationChannel, String templateDisplayName, String locale,
+                                                 String tenantDomain)
+            throws NotificationTemplateManagerException {
+
+        return false;
+    }
+
+    /**
+     * Check whether the given notification template exists in the system.
+     *
+     * @param notificationChannel     Notification channel.
+     * @param templateDisplayName     Display name of the template.
+     * @param tenantDomain            Tenant Domain.
+     * @param applicationUuid         Application UUID.
+     * @return True if the template exists, false otherwise.
+     * @throws NotificationTemplateManagerException If an error occurred while checking if template type exists.
+     */
+    default boolean isNotificationTemplateExists(String notificationChannel, String templateDisplayName, String locale,
+                                                 String tenantDomain, String applicationUuid)
+            throws NotificationTemplateManagerException {
+
+        return false;
+    }
+
+    /**
+     * Get all available system notification templates of given type.
      *
-     * @param displayName         Notification template display name.
      * @param notificationChannel Notification channel (Eg: SMS, EMAIL).
-     * @param tenantDomain        Tenant domain.
-     * @param applicationUuid     Application UUID.
-     * @throws NotificationTemplateManagerException If an error occurred while adding the template to the registry.
+     * @return List of system notification templates.
      */
-    default void addNotificationTemplateType(String displayName, String notificationChannel,
-                                             String tenantDomain, String applicationUuid)
+    default List<NotificationTemplate> getAllSystemNotificationTemplatesOfType(String notificationChannel,
+                                                                               String templateDisplayName) throws NotificationTemplateManagerException {
+
+        return null;
+    }
+
+    /**
+     * Return the default system notification template which matches the given channel and template name.
+     *
+     * @param notificationChannel Notification Channel Name (Eg: SMS or EMAIL)
+     * @param templateType        Display name of the template
+     * @param locale              Locale
+     * @return Return {@link org.wso2.carbon.identity.governance.model.NotificationTemplate} object
+     * @throws NotificationTemplateManagerException If an error occurred while getting the notification template
+     */
+    default NotificationTemplate getSystemNotificationTemplate(String notificationChannel, String templateType,
+                                                               String locale)
             throws NotificationTemplateManagerException {
 
+        return null;
     }
 }