Package com.atlassian.jira.event.issue

Interface IssueEventManager

All Known Implementing Classes:
DefaultIssueEventManager
@PublicApi public interface IssueEventManager
Component responsible for dispatching issue events.
Since:
v4.4

  • Method Details

    • dispatchEvent

      @Deprecated void dispatchEvent(Long eventTypeId, Issue issue, ApplicationUser remoteUser, boolean sendMail)
      Deprecated.
      since v6.4.10, please use dispatchEvent(IssueEventBundle).
      Dispatch event of given type, configuring whether or not a mail notification should be sent (useful e.g. for bulk edit).

      Since v7.4.0 this will also dispatch an OnCommitIssueEvent with the created IssueEvent.

      Parameters:
      eventTypeId - type of event
      issue - affected issue
      remoteUser - user initiating the event
      sendMail - whether or not a mail notification should be sent

    • dispatchEvent

      @Deprecated void dispatchEvent(Long eventTypeId, Issue issue, Map<String,Object> params, ApplicationUser remoteUser, boolean sendMail)
      Deprecated.
      since v6.4.10, please use dispatchEvent(IssueEventBundle).
      Dispatch event of given type with custom parameters.

      Since v7.4.0 this will also dispatch an OnCommitIssueEvent with the created IssueEvent.

      Parameters:
      eventTypeId - type of event
      issue - affected issue
      params - custom event parameters
      remoteUser - user initiating the event
      sendMail - whether or not a mail notification should be sent

    • dispatchRedundantEvent

      @Deprecated void dispatchRedundantEvent(Long eventTypeId, Issue issue, Map<String,Object> params, ApplicationUser remoteUser, boolean sendMail)
      Deprecated.
      since v6.4.10, please use dispatchEvent(IssueEventBundle).
      Dispatch a redundant event of given type with custom parameters.

      Since v7.4.0 this will also dispatch an OnCommitIssueEvent with the created IssueEvent.

      Parameters:
      eventTypeId - type of event
      issue - affected issue
      params - custom event parameters
      remoteUser - user initiating the event
      sendMail - whether or not a mail notification should be sent

    • dispatchEvent

      @Deprecated void dispatchEvent(Long eventTypeId, Issue issue, Map params, ApplicationUser remoteUser)
      Deprecated.
      since v6.4.10, please use dispatchEvent(IssueEventBundle).
      Dispatch event of given type with custom parameters.

      Since v7.4.0 this will also dispatch an OnCommitIssueEvent with the created IssueEvent.

      Parameters:
      eventTypeId - type of event
      issue - affected issue
      params - custom event parameters
      remoteUser - user initiating the event

    • dispatchEvent

      @Deprecated void dispatchEvent(Long eventTypeId, Issue issue, ApplicationUser remoteUser, Comment comment, Worklog worklog, org.ofbiz.core.entity.GenericValue changelog)
      Deprecated.
      since v6.4.10, please use dispatchEvent(IssueEventBundle).
      Dispatch event of given type.

      Since v7.4.0 this will also dispatch an OnCommitIssueEvent with the created IssueEvent.

      Parameters:
      eventTypeId - type of event
      issue - affected issue
      remoteUser - remoteUser user initiating the event
      comment - comment for this event
      worklog - worklog for this event
      changelog - An attached changeGroup for this event

    • dispatchRedundantEvent

      @Deprecated void dispatchRedundantEvent(Long eventTypeId, Issue issue, ApplicationUser remoteUser, Comment comment, Worklog worklog, org.ofbiz.core.entity.GenericValue changelog)
      Deprecated.
      since v6.4.10, please use dispatchEvent(IssueEventBundle).
      Dispatch a redundant event of given type.

      Since v7.4.0 this will also dispatch an OnCommitIssueEvent with the created IssueEvent.

      Parameters:
      eventTypeId - type of event
      issue - affected issue
      remoteUser - remoteUser user initiating the event
      comment - comment for this event
      worklog - worklog for this event
      changelog - An attached changeGroup for this event

    • dispatchEvent

      @Deprecated void dispatchEvent(Long eventTypeId, Issue issue, ApplicationUser remoteUser, Comment comment, Worklog worklog, org.ofbiz.core.entity.GenericValue changelog, boolean sendMail)
      Deprecated.
      since v6.4.10, please use dispatchEvent(IssueEventBundle).
      Dispatch event of given type.

      Since v7.4.0 this will also dispatch an OnCommitIssueEvent with the created IssueEvent.

      Parameters:
      eventTypeId - type of event
      issue - affected issue
      remoteUser - remoteUser user initiating the event
      comment - comment for this event
      worklog - worklog for this event
      changelog - attached changeGroup for this event
      sendMail - whether or not a mail notification should be sent

    • dispatchEvent

      @Deprecated void dispatchEvent(Long eventTypeId, Issue issue, ApplicationUser remoteUser, Comment comment, Worklog worklog, org.ofbiz.core.entity.GenericValue changelog, Map params)
      Deprecated.
      since v6.4.10, please use dispatchEvent(IssueEventBundle).
      Dispatch event of given type with custom parameters.

      Since v7.4.0 this will also dispatch an OnCommitIssueEvent with the created IssueEvent.

      Parameters:
      eventTypeId - type of event
      issue - affected issue
      remoteUser - remoteUser user initiating the event
      comment - comment for this event
      worklog - worklog for this event
      changelog - attached changeGroup for this event
      params - custom event parameters

    • dispatchRedundantEvent

      @Deprecated void dispatchRedundantEvent(Long eventTypeId, Issue issue, ApplicationUser remoteUser, Comment comment, Worklog worklog, org.ofbiz.core.entity.GenericValue changelog, Map params)
      Deprecated.
      since v6.4.10, please use dispatchEvent(IssueEventBundle).
      Dispatch a redundant event of given type with custom parameters.

      Since v7.4.0 this will also dispatch an OnCommitIssueEvent with the created IssueEvent.

      Parameters:
      eventTypeId - type of event
      issue - affected issue
      remoteUser - remoteUser user initiating the event
      comment - comment for this event
      worklog - worklog for this event
      changelog - attached changeGroup for this event
      params - custom event parameters

    • dispatchEvent

      @Deprecated void dispatchEvent(Long eventTypeId, Issue issue, ApplicationUser remoteUser, Comment comment, Worklog worklog, org.ofbiz.core.entity.GenericValue changelog, Map params, boolean sendMail)
      Deprecated.
      since v6.4.10, please use dispatchEvent(IssueEventBundle).
      Dispatch event of given type with custom parameters.

      Since v7.4.0 this will also dispatch an OnCommitIssueEvent with the created IssueEvent.

      Parameters:
      eventTypeId - type of event
      issue - affected issue
      remoteUser - remoteUser user initiating the event
      comment - comment for this event
      worklog - worklog for this event
      changelog - attached changeGroup for this event
      params - custom event parameters
      sendMail - whether or not a mail notification should be sent

    • dispatchRedundantEvent

      @Deprecated void dispatchRedundantEvent(Long eventTypeId, Issue issue, ApplicationUser remoteUser, Comment comment, Worklog worklog, org.ofbiz.core.entity.GenericValue changelog, Map params, boolean sendMail)
      Deprecated.
      since v6.4.10, please use dispatchEvent(IssueEventBundle).
      Dispatch a redundant event of given type with custom parameters.

      Since v7.4.0 this will also dispatch an OnCommitIssueEvent with the created IssueEvent.

      Parameters:
      eventTypeId - type of event
      issue - affected issue
      remoteUser - remoteUser user initiating the event
      comment - comment for this event
      worklog - worklog for this event
      changelog - attached changeGroup for this event
      params - custom event parameters
      sendMail - whether or not a mail notification should be sent

    • dispatchEvent

      @Deprecated void dispatchEvent(Long eventTypeId, Issue issue, ApplicationUser remoteUser, org.ofbiz.core.entity.GenericValue changelog, boolean sendMail, boolean subtasksUpdated)
      Deprecated.
      since v6.4.10, please use dispatchEvent(IssueEventBundle).
      Dispatch event of given type.

      Since v7.4.0 this will also dispatch an OnCommitIssueEvent with the created IssueEvent.

      Parameters:
      eventTypeId - type of event
      issue - affected issue
      remoteUser - remoteUser user initiating the event
      changelog - attached changeGroup for this event
      sendMail - whether or not a mail notification should be sent
      subtasksUpdated - if subtask have been modified.

    • dispatchRedundantEvent

      @Deprecated void dispatchRedundantEvent(Long eventTypeId, Issue issue, ApplicationUser remoteUser, org.ofbiz.core.entity.GenericValue changelog, boolean sendMail, boolean subtasksUpdated)
      Deprecated.
      since v6.4.10, please use dispatchEvent(IssueEventBundle).
      Dispatch a redundant event of given type.

      Since v7.4.0 this will also dispatch an OnCommitIssueEvent with the created IssueEvent.

      Parameters:
      eventTypeId - type of event
      issue - affected issue
      remoteUser - remoteUser user initiating the event
      changelog - attached changeGroup for this event
      sendMail - whether or not a mail notification should be sent
      subtasksUpdated - if subtask have been modified.

    • dispatchEvent

      @Deprecated void dispatchEvent(Long eventTypeId, Issue issue, ApplicationUser remoteUser, Comment comment, Worklog worklog, org.ofbiz.core.entity.GenericValue changelog, Map params, boolean sendMail, boolean subtasksUpdated)
      Deprecated.
      since v6.4.10, please use dispatchEvent(IssueEventBundle).
      Dispatch event of given type with custom parameters.

      Since v7.4.0 this will also dispatch an OnCommitIssueEvent with the created IssueEvent.

      Parameters:
      eventTypeId - type of event
      issue - affected issue
      remoteUser - remoteUser user initiating the event
      comment - comment for this event
      worklog - worklog for this event
      changelog - attached changeGroup for this event
      params - custom event parameters
      sendMail - whether or not a mail notification should be sent
      subtasksUpdated - if subtask have been modified.

    • dispatchRedundantEvent

      @Deprecated void dispatchRedundantEvent(Long eventTypeId, Issue issue, ApplicationUser remoteUser, Comment comment, Worklog worklog, org.ofbiz.core.entity.GenericValue changelog, Map params, boolean sendMail, boolean subtasksUpdated)
      Deprecated.
      since v6.4.10, please use dispatchEvent(IssueEventBundle).
      Dispatch a redundant event of given type with custom parameters.
      Parameters:
      eventTypeId - type of event
      issue - affected issue
      remoteUser - remoteUser user initiating the event
      comment - comment for this event
      worklog - worklog for this event
      changelog - attached changeGroup for this event
      params - custom event parameters
      sendMail - whether or not a mail notification should be sent
      subtasksUpdated - if subtask have been modified.

    • dispatchEvent

      default void dispatchEvent(IssueEventBundle issueEventBundle)
      Dispatches a bundle of issue events. This method will dispatch one event for the bundle itself, and one per event contained in the bundle.

      Since v7.4.0 this will also dispatch an OnCommitIssueEventBundle with the provided IssueEventBundle. This is the equivalent of calling dispatchIssueEventBundle(IssueEventBundle, boolean) (IssueEventBundle, boolean)} with true as the parameter. To suppress this call dispatchIssueEventBundle(IssueEventBundle, boolean) directly, with false as parameter.

      Parameters:
      issueEventBundle - The bundle with all the issue events.
      Since:
      6.3.8
      See Also:

    • dispatchIssueEventBundle

      @ExperimentalApi void dispatchIssueEventBundle(IssueEventBundle issueEventBundle, boolean shouldAlsoDispatchOnCommit)
      Dispatches a bundle of issue events.

      This method will dispatch one event for the bundle itself, and one per event contained in the bundle.

      If true is passed as the parameter, it will also invoke dispatchIssueEventBundleOnCommit(Supplier) and send this IssueEventBundle inside a OnCommitIssueEventBundle after the transaction has completed, which may be now if no transaction.

      In addition this will also send all JiraIssueEvent as OnCommitJiraIssueEvent if parameter is true.

      Parameters:
      issueEventBundle - The bundle with all the issue events.
      shouldAlsoDispatchOnCommit - If true will also invoke dispatchIssueEventBundleOnCommit(Supplier)
      Since:
      7.4.0
      See Also:

    • dispatchIssueEventBundleOnCommit

      @ExperimentalApi void dispatchIssueEventBundleOnCommit(Supplier<OnCommitIssueEventBundle> onCommitIssueEventBundleSupplier)
      Dispatches a bundle of issue events.

      This method will dispatch one event for the bundle itself, and one per event contained in the bundle.

      In addition this will also send all JiraIssueEvent as OnCommitJiraIssueEvent.

      Parameters:
      onCommitIssueEventBundleSupplier - The supplier to build the bundle on commit with all the issue events.
      Since:
      7.4.0
      See Also:

    • dispatchIssueEventOnCommit

      @ExperimentalApi void dispatchIssueEventOnCommit(Supplier<OnCommitIssueEvent> onCommitIssueEventSupplier)
      Dispatches an issue event that will be sent after any existing transaction has been commited. If there is no transaction it will send immediately.
      Parameters:
      onCommitIssueEventSupplier - The supplier to build the event on commit.
      Since:
      7.4.0
      See Also: