org.flowable.job.service.impl.history.async

Class AsyncHistorySessionCommandContextCloseListener

java.lang.Object

org.flowable.job.service.impl.history.async.AsyncHistorySessionCommandContextCloseListener

All Implemented Interfaces:

CommandContextCloseListener

public class AsyncHistorySessionCommandContextCloseListener
extends Object
implements CommandContextCloseListener

A listener for command context lifecycle close events that generates JSON (using Jackson) and corresponding HistoryJobEntity when the CommandContext closes and adds them to the list of entities that will be inserted to the database. The reason why this is done at the very end, is because that way the historical data can be optimized (some events cancel others, can be grouped, etc.)

Author:

Joram Barrez

Field Summary

Fields

Modifier and Type	Field and Description
protected AsyncHistoryListener	asyncHistoryListener
protected AsyncHistorySession	asyncHistorySession
protected String	dataFieldName
protected String	typeFieldName

Constructor Summary

Constructors

Constructor and Description
AsyncHistorySessionCommandContextCloseListener()
AsyncHistorySessionCommandContextCloseListener(AsyncHistorySession asyncHistorySession, AsyncHistoryListener asyncHistoryListener)

Method Summary

Modifier and Type	Method and Description
void	afterSessionsFlush(CommandContext commandContext) Called when the Session have been successfully flushed.
void	closed(CommandContext commandContext) Called when the CommandContext is successfully closed.
void	closeFailure(CommandContext commandContext) Called when the CommandContext has not been successfully closed due to an exception that happened.
void	closing(CommandContext commandContext) Called when the CommandContext is being closed, but no 'close logic' has been executed.
protected void	generateJson(JobServiceConfiguration jobServiceConfiguration, Map<String,List<com.fasterxml.jackson.databind.node.ObjectNode>> jobData, List<com.fasterxml.jackson.databind.node.ObjectNode> objectNodes, String type)
protected com.fasterxml.jackson.databind.node.ObjectNode	generateJson(JobServiceConfiguration jobServiceConfiguration, String type, com.fasterxml.jackson.databind.node.ObjectNode historicData)
AsyncHistoryListener	getAsyncHistoryListener()
AsyncHistorySession	getAsyncHistorySession()
String	getDataFieldName()
String	getTypeFieldName()
boolean	multipleAllowed() Determines if there are multiple occurrences allowed of this close listener
Integer	order() Determines the order in which the close listeners will be executed
void	setAsyncHistoryListener(AsyncHistoryListener asyncHistoryListener)
void	setAsyncHistorySession(AsyncHistorySession asyncHistorySession)
void	setDataFieldName(String dataFieldName)
void	setTypeFieldName(String typeFieldName)

Methods inherited from class java.lang.Object

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

Field Detail

asyncHistorySession

protected AsyncHistorySession asyncHistorySession

asyncHistoryListener

protected AsyncHistoryListener asyncHistoryListener

typeFieldName

protected String typeFieldName

dataFieldName

protected String dataFieldName

Constructor Detail

AsyncHistorySessionCommandContextCloseListener

public AsyncHistorySessionCommandContextCloseListener()

AsyncHistorySessionCommandContextCloseListener

public AsyncHistorySessionCommandContextCloseListener(AsyncHistorySession asyncHistorySession,
                                                      AsyncHistoryListener asyncHistoryListener)

Method Detail

closing

public void closing(CommandContext commandContext)

Description copied from interface: CommandContextCloseListener

Called when the CommandContext is being closed, but no 'close logic' has been executed. At this point, the TransactionContext (if applicable) has not yet been committed/rolledback and none of the Session instances have been flushed. If an exception happens and it is not caught in this method: - The Session instances will *not* be flushed - The TransactionContext will be rolled back (if applicable)

Specified by:

closing in interface CommandContextCloseListener

generateJson

protected void generateJson(JobServiceConfiguration jobServiceConfiguration,
                            Map<String,List<com.fasterxml.jackson.databind.node.ObjectNode>> jobData,
                            List<com.fasterxml.jackson.databind.node.ObjectNode> objectNodes,
                            String type)

generateJson

protected com.fasterxml.jackson.databind.node.ObjectNode generateJson(JobServiceConfiguration jobServiceConfiguration,
                                                                      String type,
                                                                      com.fasterxml.jackson.databind.node.ObjectNode historicData)

closed

public void closed(CommandContext commandContext)

Description copied from interface: CommandContextCloseListener

Called when the CommandContext is successfully closed. At this point, the TransactionContext (if applicable) has been successfully committed and no rollback has happened. All Session instances have been closed. Note that throwing an exception here does *not* affect the transaction. The CommandContext will log the exception though.

Specified by:

closed in interface CommandContextCloseListener

closeFailure

public void closeFailure(CommandContext commandContext)

Description copied from interface: CommandContextCloseListener

Called when the CommandContext has not been successfully closed due to an exception that happened. Note that throwing an exception here does *not* affect the transaction. The CommandContext will log the exception though.

Specified by:

closeFailure in interface CommandContextCloseListener

afterSessionsFlush

public void afterSessionsFlush(CommandContext commandContext)

Description copied from interface: CommandContextCloseListener

Called when the Session have been successfully flushed. When an exception happened during the flushing of the sessions, this method will not be called. If an exception happens and it is not caught in this method: - The Session instances will *not* be flushed - The TransactionContext will be rolled back (if applicable)

Specified by:

afterSessionsFlush in interface CommandContextCloseListener

order

public Integer order()

Description copied from interface: CommandContextCloseListener

Determines the order in which the close listeners will be executed

Specified by:

order in interface CommandContextCloseListener

Returns:

order lowest number will be executed first

multipleAllowed

public boolean multipleAllowed()

Description copied from interface: CommandContextCloseListener

Determines if there are multiple occurrences allowed of this close listener

Specified by:

multipleAllowed in interface CommandContextCloseListener

Returns:

multipleAllowed multiple occurrences allowed

getAsyncHistorySession

public AsyncHistorySession getAsyncHistorySession()

setAsyncHistorySession

public void setAsyncHistorySession(AsyncHistorySession asyncHistorySession)

getAsyncHistoryListener

public AsyncHistoryListener getAsyncHistoryListener()

setAsyncHistoryListener

public void setAsyncHistoryListener(AsyncHistoryListener asyncHistoryListener)

getTypeFieldName

public String getTypeFieldName()

setTypeFieldName

public void setTypeFieldName(String typeFieldName)

getDataFieldName

public String getDataFieldName()

setDataFieldName

public void setDataFieldName(String dataFieldName)