Package org.exoplatform.commons.api.notification.channel

Interface ChannelManager

public interface ChannelManager

  • Method Details

    • register

      void register(AbstractChannel channel)
      Register new channel
      Parameters:
      channel -

    • unregister

      void unregister(AbstractChannel channel)
      Unregister the specified channel
      Parameters:
      channel -

    • registerTemplateProvider

      void registerTemplateProvider(TemplateProvider provider)
      Register the Template provider
      Parameters:
      provider -

    • registerOverrideTemplateProvider

      void registerOverrideTemplateProvider(TemplateProvider provider)
      Register and override the Template provider
      Parameters:
      provider -

    • getChannel

      AbstractChannel getChannel(ChannelKey key)
      Gets the channel by the specified key
      Parameters:
      key - the channel key
      Returns:

    • getChannels

      List<AbstractChannel> getChannels()
      Gets list of the channels
      Returns:

    • getDefaultChannels

      default List<AbstractChannel> getDefaultChannels()
      This will use AbstractChannel.isDefaultChannel() to determine whether the channel will be enabled for plugins by default or not
      Returns:
      List of active channels for all plugins by default.

    • getSpecificChannels

      default List<AbstractChannel> getSpecificChannels()
      This will use AbstractChannel.isDefaultChannel() to determine whether the channel is specific for some plugins or not
      Returns:
      List of active channels for specific plugins only.

    • getLifecycle

      AbstractNotificationLifecycle getLifecycle(ChannelKey key)
      Gets the lifecycle by the ChannelKey
      Parameters:
      key -
      Returns:

    • sizeChannels

      int sizeChannels()
      Gets size of channels has been registered
      Returns: