Package org.flowable.common.engine.impl.logging

Class LoggingSessionCommandContextCloseListener

java.lang.Object

org.flowable.common.engine.impl.logging.LoggingSessionCommandContextCloseListener

All Implemented Interfaces:

CommandContextCloseListener

public class LoggingSessionCommandContextCloseListener
extends Object
implements CommandContextCloseListener

Field Summary

Fields

Modifier and Type	Field	Description
protected String	engineType
protected LoggingListener	loggingListener
protected LoggingSession	loggingSession
protected com.fasterxml.jackson.databind.ObjectMapper	objectMapper

Constructor Summary

Constructors

Constructor	Description
LoggingSessionCommandContextCloseListener()
LoggingSessionCommandContextCloseListener(LoggingSession loggingSession, LoggingListener loggingListener, com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Summary

Modifier and Type	Method	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.
String	getEngineType()
LoggingListener	getLoggingListener()
LoggingSession	getLoggingSession()
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	setEngineType(String engineType)
void	setLoggingListener(LoggingListener loggingListener)
void	setLoggingSession(LoggingSession loggingSession)

Methods inherited from class java.lang.Object

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

Field Detail

loggingSession

protected LoggingSession loggingSession

loggingListener

protected LoggingListener loggingListener

objectMapper

protected com.fasterxml.jackson.databind.ObjectMapper objectMapper

engineType

protected String engineType

Constructor Detail

LoggingSessionCommandContextCloseListener

public LoggingSessionCommandContextCloseListener()

LoggingSessionCommandContextCloseListener

public LoggingSessionCommandContextCloseListener(LoggingSession loggingSession,
                                                 LoggingListener loggingListener,
                                                 com.fasterxml.jackson.databind.ObjectMapper objectMapper)

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

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

getLoggingSession

public LoggingSession getLoggingSession()

setLoggingSession

public void setLoggingSession(LoggingSession loggingSession)

getLoggingListener

public LoggingListener getLoggingListener()

setLoggingListener

public void setLoggingListener(LoggingListener loggingListener)

getEngineType

public String getEngineType()

setEngineType

public void setEngineType(String engineType)