Package org.exoplatform.commons.api.notification.service.setting

Interface PluginSettingService

public interface PluginSettingService

  • Method Details

    • registerPluginConfig

      void registerPluginConfig(PluginConfig pluginConfig)
      Registers configuration of a plugin.
      Parameters:
      pluginConfig - The plugin configuration.

    • registerGroupConfig

      void registerGroupConfig(GroupProviderPlugin groupConfig)
      Registers the plugin configuration of a group.
      Parameters:
      groupConfig - The plugin configuration to be registered.

    • getPluginConfig

      PluginConfig getPluginConfig(String pluginId)
      Gets configuration of a plugin from its Id.
      Parameters:
      pluginId - Id of the plugin.
      Returns:
      The plugin configuration.

    • getGroupPlugins

      List<GroupProvider> getGroupPlugins()
      Gets a list of groups containing plugins.
      Returns:
      The list of groups.

    • saveActivePlugin

      void saveActivePlugin(String channelId, String pluginId, boolean isActive)
      Saves a plugin.
      Parameters:
      pluginId - Id of the saved plugin.
      isActive - If "true", the plugin is active. If "false", the plugin is inactive.

    • saveChannelStatus

      void saveChannelStatus(String channelId, boolean enable)
      Saves a status for a given Channel
      Parameters:
      channelId - Channel identifier
      enable - status whether enabled or not

    • saveChannelDefaultValue

      void saveChannelDefaultValue(String channelId, boolean enable)
      Saves a default value for a given Channel
      Parameters:
      channelId - Channel identifier
      enable - status whether enabled or not

    • getDefaultChannelValue

      boolean getDefaultChannelValue(String channelId)
      Get notification channel default value
      Parameters:
      channelId - Channel identifier
      Returns:
      true is active by default else inactive

    • saveEmailSender

      void saveEmailSender(String name, String email)
      Saves email notification sender settings
      Parameters:
      name - Company name
      email - Company email

    • getEmailSenderName

      String getEmailSenderName()
      Returns:
      Mail notification sender name

    • getEmailSenderEmail

      String getEmailSenderEmail()
      Returns:
      Mail notification sender email

    • isActive

      boolean isActive(String channelId, String pluginId)
      Checks if a plugin is active or inactive.
      Parameters:
      channelId - ChannelKey identifier
      pluginId - Id of the plugin.
      Returns:
      The returned value is "true" if the plugin is active or "false" if the plugin is inactive.

    • isChannelActive

      boolean isChannelActive(String channelId)
      Checks if a notification channel is active or inactive.
      Parameters:
      channelId - Channel identifier
      Returns:
      true is active else inactive

    • isAllowed

      boolean isAllowed(String channelId, String pluginId)
      Checks whether the channel is allowed on designated plugin or not
      Parameters:
      channelId - ChannelKey identifier
      pluginId - Id of the plugin.
      Returns:
      true if AbstractChannel is default channel or if the channel is configured to be used in pluginId

    • getActivePluginIds

      List<String> getActivePluginIds(String channelId)
      Gets all Ids of active plugins by channel.
      Returns:
      Ids of the active plugins.

    • getPluginChannels

      default List<String> getPluginChannels(String pluginId)
      Parameters:
      pluginId - PluginConfig type
      Returns:
      List of active channels of Plugin

    • getActivePlugins

      List<PluginInfo> getActivePlugins(String channelId)
      Gets information of all active plugins by channel.
      Returns:
      Information of the active plugins.

    • getAllPlugins

      List<PluginInfo> getAllPlugins()
      Gets information of all plugins.
      Returns:
      Information of the plugins.