Package com.almworks.jira.structure.api.event

Interface IssueEventBridge

public interface IssueEventBridge

IssueEventBridge is a simple hub that allows to listen to issue changes and report issue changes.

The bridge subscribes to the JIRA notification system to get the standard notifications about the issue changes. Additionally, it allows components to report issue changes.

Only the IDs of the issues that have changed are reported, not the changes themselves. The bridge is also allowed to delay reporting changes a bit to accumulate a bigger change set.

Author:
Igor Sereda

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addListener(IssueListener listener)
    Add an IssueListener that will get notifications of the subsequent changes.
    void
    removeListener(IssueListener listener)
    Removes the listener from the component
    void
    reportChanges(LongList issueIds, JiraChangeType eventType)
    This method is used to notify the bridge that the listed issues have changed or that the listeners must receive the notification anyway, probably to recount something.
    void
    reportEvent(JiraChangeEvent event)
    This method is used to notify the bridge about a specifically constructed event object, which gets rebroadcast to the listeners.

  • Method Details

    • addListener

      void addListener(@Nullable IssueListener listener)
      Add an IssueListener that will get notifications of the subsequent changes.
      Parameters:
      listener - the listener

    • removeListener

      void removeListener(@Nullable IssueListener listener)
      Removes the listener from the component
      Parameters:
      listener - the listener

    • reportChanges

      void reportChanges(@Nullable LongList issueIds, JiraChangeType eventType)
      This method is used to notify the bridge that the listed issues have changed or that the listeners must receive the notification anyway, probably to recount something.
      Parameters:
      issueIds - the list of changed issues
      eventType - the event type

    • reportEvent

      void reportEvent(@Nullable JiraChangeEvent event)
      This method is used to notify the bridge about a specifically constructed event object, which gets rebroadcast to the listeners.
      Parameters:
      event - the event describing a change