Package com.polarion.psvn.core.notifications

Interface INotificationRenderer

public interface INotificationRenderer
The renderer of notification events, contributed per event-id into the NotificationEventHandler via the configuration point com.polarion.psvn.core.notifications.renderers.

The instances are used from the single thread, so they don't have to be thread-safe. The processing starts after the IDataService is initialized, never before.

This class was formerly known as IAnnounceCreator.

Author:
dobisekm

  • Method Details

    • createAnnouncement

      Announcement createAnnouncement(INotificationEvent notifEvent) throws Exception
      Parameters:
      notifEvent - The event to render, never null
      Returns:
      The announcement, never null. The sender and receivers fields are modified before sending, therefore they don't have to be filled in.
      Throws:
      Exception - If something goes wrong. The exception gets logged.

    • createAnnouncement

      Announcement createAnnouncement(INotificationEvent notifEvent, String targetUserId) throws Exception
      Parameters:
      notifEvent - The event to render, never null
      targetUserId - the ID of user or single email
      Returns:
      The announcement, never null. The sender and receivers fields are modified before sending, therefore they don't have to be filled in.
      Throws:
      Exception - If something goes wrong. The exception gets logged.