Package step.engine.plugins

Class AbstractExecutionEnginePlugin

java.lang.Object

step.core.plugins.AbstractPlugin

step.engine.plugins.AbstractExecutionEnginePlugin

All Implemented Interfaces:

ExecutionCallbacks, step.core.plugins.OptionalPlugin, ExecutionEnginePlugin

Direct Known Subclasses:

BaseArtefactPlugin, BasePlugin, CompositeFunctionTypePlugin, FunctionPlugin, GeneralScriptFunctionPlugin, LocalCompositeFunctionPlugin, LocalFunctionPlugin, LocalRepositoryPlugin, MeasurementPlugin, ParameterManagerPlugin, QuotaManagerPlugin, ThreadManagerPlugin, ThreadPoolPlugin, TimeSeriesExecutionPlugin, ViewPlugin

public abstract class AbstractExecutionEnginePlugin
extends step.core.plugins.AbstractPlugin
implements ExecutionEnginePlugin

Constructor Summary

Constructors

Constructor	Description
AbstractExecutionEnginePlugin()

Method Summary

Modifier and Type	Method	Description
void	afterExecutionEnd(ExecutionContext context)
void	afterFunctionExecution(ExecutionContext context, ReportNode node, Function function, step.functions.io.Output<jakarta.json.JsonObject> output)	This hook is called immediately after a Function is executed in CallFunctionHandler.
void	afterReportNodeExecution(ReportNode node)	Deprecated.
void	afterReportNodeExecution(ExecutionContext context, ReportNode node)
void	afterReportNodeSkeletonCreation(ReportNode node)	Deprecated.
void	afterReportNodeSkeletonCreation(ExecutionContext context, ReportNode node)
void	associateThread(ExecutionContext context, Thread thread)
void	associateThread(ExecutionContext context, Thread thread, long parentThreadId)
void	beforeExecutionEnd(ExecutionContext context)
void	beforeFunctionExecution(ExecutionContext context, ReportNode node, Function function)	This hook is called before a Function is executed in CallFunctionHandler just after the Function has been resolved The hook is also called in simulation mode
void	beforePlanImport(ExecutionContext context)
void	beforeReportNodeExecution(ReportNode node)	Deprecated.
void	beforeReportNodeExecution(ExecutionContext context, ReportNode node)
void	executionStart(ExecutionContext context)
void	initializeExecutionContext(ExecutionEngineContext executionEngineContext, ExecutionContext executionContext)
void	initializeExecutionEngineContext(AbstractExecutionEngineContext parentContext, ExecutionEngineContext executionEngineContext)
void	onErrorContributionRemoval(ExecutionContext context, ReportNode node)
void	onReportNodeRemoval(ExecutionContext context, ReportNode node)
void	unassociateThread(ExecutionContext context, Thread thread)

Methods inherited from class step.core.plugins.AbstractPlugin

toString, validate

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractExecutionEnginePlugin

public AbstractExecutionEnginePlugin()

Method Details

initializeExecutionEngineContext

public void initializeExecutionEngineContext(AbstractExecutionEngineContext parentContext,
 ExecutionEngineContext executionEngineContext)

Specified by:

initializeExecutionEngineContext in interface ExecutionEnginePlugin

initializeExecutionContext

public void initializeExecutionContext(ExecutionEngineContext executionEngineContext,
 ExecutionContext executionContext)

Specified by:

initializeExecutionContext in interface ExecutionEnginePlugin

executionStart

public void executionStart(ExecutionContext context)

Specified by:

executionStart in interface ExecutionCallbacks

beforeExecutionEnd

public void beforeExecutionEnd(ExecutionContext context)

Specified by:

beforeExecutionEnd in interface ExecutionCallbacks

afterExecutionEnd

public void afterExecutionEnd(ExecutionContext context)

Specified by:

afterExecutionEnd in interface ExecutionCallbacks

afterReportNodeSkeletonCreation

@Deprecated
public void afterReportNodeSkeletonCreation(ReportNode node)

Deprecated.

beforeReportNodeExecution

@Deprecated
public void beforeReportNodeExecution(ReportNode node)

Deprecated.

afterReportNodeExecution

@Deprecated
public void afterReportNodeExecution(ReportNode node)

Deprecated.

afterReportNodeSkeletonCreation

public void afterReportNodeSkeletonCreation(ExecutionContext context,
 ReportNode node)

Specified by:

afterReportNodeSkeletonCreation in interface ExecutionCallbacks

beforeReportNodeExecution

public void beforeReportNodeExecution(ExecutionContext context,
 ReportNode node)

Specified by:

beforeReportNodeExecution in interface ExecutionCallbacks

afterReportNodeExecution

public void afterReportNodeExecution(ExecutionContext context,
 ReportNode node)

Specified by:

afterReportNodeExecution in interface ExecutionCallbacks

onReportNodeRemoval

public void onReportNodeRemoval(ExecutionContext context,
 ReportNode node)

Specified by:

onReportNodeRemoval in interface ExecutionCallbacks

onErrorContributionRemoval

public void onErrorContributionRemoval(ExecutionContext context,
 ReportNode node)

Specified by:

onErrorContributionRemoval in interface ExecutionCallbacks

associateThread

public void associateThread(ExecutionContext context,
 Thread thread)

Specified by:

associateThread in interface ExecutionCallbacks

associateThread

public void associateThread(ExecutionContext context,
 Thread thread,
 long parentThreadId)

Specified by:

associateThread in interface ExecutionCallbacks

unassociateThread

public void unassociateThread(ExecutionContext context,
 Thread thread)

Specified by:

unassociateThread in interface ExecutionCallbacks

beforePlanImport

public void beforePlanImport(ExecutionContext context)

Specified by:

beforePlanImport in interface ExecutionCallbacks

beforeFunctionExecution

public void beforeFunctionExecution(ExecutionContext context,
 ReportNode node,
 Function function)

Description copied from interface: ExecutionCallbacks

This hook is called before a Function is executed in CallFunctionHandler just after the Function has been resolved The hook is also called in simulation mode

Specified by:

beforeFunctionExecution in interface ExecutionCallbacks

Parameters:

context - the ExecutionContext

function - the resolved Function that will be executed

afterFunctionExecution

public void afterFunctionExecution(ExecutionContext context,
 ReportNode node,
 Function function,
 step.functions.io.Output<jakarta.json.JsonObject> output)

Description copied from interface: ExecutionCallbacks

This hook is called immediately after a Function is executed in CallFunctionHandler. The ReportNode provided as argument is therefore not reflecting the final status. If you need the final status after CallFunction execution use the hook ExecutionCallbacks.afterReportNodeExecution(ExecutionContext, ReportNode) instead. The hook is also called in simulation mode.

Specified by:

afterFunctionExecution in interface ExecutionCallbacks

Parameters:

context - the ExecutionContext

function - the Function that has been executed

output - the result Output of the execution