Package com.atlassian.jira.event.commit

Class OnCommitEventManagerImpl

java.lang.Object

com.atlassian.jira.event.commit.OnCommitEventManagerImpl

All Implemented Interfaces:

OnCommitEventManager

@ParametersAreNonnullByDefault
public class OnCommitEventManagerImpl
extends Object
implements OnCommitEventManager

Constructor Summary

Constructors

Constructor	Description
OnCommitEventManagerImpl(TxnAwareEventFactory txnAwareEventFactory)

Method Summary

Modifier and Type	Method	Description
void	dispatchAsOnCommitEvent(Supplier<Object> eventSupplier)	Will wrap the provided event into a default OnCommitEvent object, for publishing.
<T> void	dispatchOnCommitEvent(Supplier<OnCommitEvent<T>> onCommitEventSupplier)	Will publish the event immediately if not inside a transaction, otherwise will be published once the current transactions has finished.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OnCommitEventManagerImpl

public OnCommitEventManagerImpl(TxnAwareEventFactory txnAwareEventFactory)

Method Details

dispatchAsOnCommitEvent

public void dispatchAsOnCommitEvent(Supplier<Object> eventSupplier)

Description copied from interface: OnCommitEventManager

Will wrap the provided event into a default OnCommitEvent object, for publishing.

The Supplier will be invoked when the event is about to be published.

NB: This is intended for non issue related events that would like to ensure they are fired after any transaction has completed. For issue related OnCommitEvent, use IssueEventManager

Specified by:

dispatchAsOnCommitEvent in interface OnCommitEventManager

Parameters:

eventSupplier - The supplier of the event object to wrap into an OnCommitEvent event

dispatchOnCommitEvent

public <T> void dispatchOnCommitEvent(Supplier<OnCommitEvent<T>> onCommitEventSupplier)

Description copied from interface: OnCommitEventManager

Will publish the event immediately if not inside a transaction, otherwise will be published once the current transactions has finished.

The Supplier will be invoked when the event is about to be published, so any data that should be reloaded can be done inside it. Potentially the OnCommitEvent.getOnCommitEventDataReloadStatus() can be set to OnCommitEvent.OnCommitEventDataReloadStatus.RELOADED_ON_COMMIT for the event.

NB: This is intended for non issue related events that would like to ensure they are fired after any transaction has completed. For issue related OnCommitEvent, use IssueEventManager

Specified by:

dispatchOnCommitEvent in interface OnCommitEventManager

Type Parameters:

T - The wrapped type of the event

Parameters:

onCommitEventSupplier - The supplier of the OnCommitEvent event to send