com.fluxtion.api.audit

Interface Auditor

All Superinterfaces:

Lifecycle

public interface Auditor
extends Lifecycle

Auditor for a static event processor. User registers an implementation of this interface with SEPConfig.addAuditor(auditor, String). A registered Auditor receives lifecycle callbacks for registration of nodes and processing of events, see javadoc below for details.
An Auditor can provide various meta functions for the SEP they are registered with, such as:

• Generic event logger
• A performance monitor
• A realtime property tracer
• Commit/rollback functionality
• A profiler

Author:

V12 Technology Limited

Method Summary

Modifier and Type	Method and Description
default boolean	auditInvocations() Indicates whether an auditor is interested in receiving nodeInvoked event callback.
default void	eventReceived(Event event) Callback indicating the Event to be processed by the SEP nodes.
default void	eventReceived(Object event) Callback indicating the Event to be processed by the SEP nodes as an Object.
default void	init() callback received before any events are processed by the Static event processor.
default void	nodeInvoked(Object node, String nodeName, String methodName, Object event) Callback method received by the auditor due to processing an event.
void	nodeRegistered(Object node, String nodeName) Callback for each node registered in the SEP.
default void	processingComplete() Callback to indicate all nodes have processed the Event and the execution path for that event is complete.
default void	tearDown() callback received after all events are processed by the Static event processor, and no more are expected.

Method Detail

nodeRegistered

void nodeRegistered(Object node,
                    String nodeName)

Callback for each node registered in the SEP. This method will be invoked after init, but before any event processing methods are invoked.

Parameters:

node - The node instance in the SEP

nodeName - The unique name of the node in the SEP

eventReceived

default void eventReceived(Event event)

Callback indicating the Event to be processed by the SEP nodes. Will be called before any node has processed the event.

Parameters:

event - the event to be processed

eventReceived

default void eventReceived(Object event)

Callback indicating the Event to be processed by the SEP nodes as an Object. Will be called before any node has processed the event.

Parameters:

event - the event to be processed

processingComplete

default void processingComplete()

Callback to indicate all nodes have processed the Event and the execution path for that event is complete.

init

default void init()

Description copied from interface: Lifecycle

callback received before any events are processed by the Static event processor. Init methods are invoked in topological order.

Specified by:

init in interface Lifecycle

tearDown

default void tearDown()

Description copied from interface: Lifecycle

callback received after all events are processed by the Static event processor, and no more are expected. tearDown methods are invoked in reverse-topological order.

Specified by:

tearDown in interface Lifecycle

nodeInvoked

default void nodeInvoked(Object node,
                         String nodeName,
                         String methodName,
                         Object event)

Callback method received by the auditor due to processing an event. This method is invoked before the node in the execution path receives a notification.

Parameters:

node - The next node to process in the execution path

nodeName - The name of the node, this is the same name as the variable name of the node in the SEP

methodName - The method of the node that is next to be invoked in the execution path.

event - The event that is the root of the of this execution path.

auditInvocations

default boolean auditInvocations()

Indicates whether an auditor is interested in receiving nodeInvoked event callback. Some auditors are not interested in granular monitoring of the execution path and can opt out of node invocation callbacks.

• true - auditor receives all lifecycle callbacks
• false - auditor receives all lifecycle callbacks except: nodeInvoked

Returns:

intention to receive all lifecycle callbacks.