public interface

IEnginesPlugin

implements IPlugin
com.pnfsoftware.jeb.core.IEnginesPlugin
Known Indirect Subclasses

Class Overview

Interface for standard engines plugin. Engines plugins run within an engines context in JEB back-end, in a separate thread of execution. They can register for events and act on those events. Engines plugins, unlike unit plugins, are not meant to identify and process input artifacts. They are meant to perform background task to enhance an analysis context. Unit plugins must have a public no-argument constructor.

Summary

Public Methods
abstract void execute(IEnginesContext context)
abstract void execute(IEnginesContext context, Map<String, String> executionOptions)
Execute the plugin code within a given engines context.
abstract List<? extends IOptionDefinition> getExecutionOptionDefinitions()
Retrieve a list of option definitions.
abstract void load(IEnginesContext context)
Load the plugin.
[Expand]
Inherited Methods
From interface com.pnfsoftware.jeb.core.IPlugin

Public Methods

public abstract void execute (IEnginesContext context)

Parameters
context the context in which this plugin executes (never null)

public abstract void execute (IEnginesContext context, Map<String, String> executionOptions)

Execute the plugin code within a given engines context. Plugin writers should consider this as the execution entry-point.

This method is optional and serves to execute on-demand calls, usually triggered by a client via the software front-end. Plugins may decide to start their workload in load(IEnginesContext).

Parameters
context the context in which this plugin executes (never null)
executionOptions optional execution options provided by the caller; the list of options that could be provided is specified by getExecutionOptionDefinitions()

public abstract List<? extends IOptionDefinition> getExecutionOptionDefinitions ()

Retrieve a list of option definitions.

Returns
  • optional list of option definitions

public abstract void load (IEnginesContext context)

Load the plugin. This method is called by the owner context exactly once, just after the engines plugin instantiation.

Parameters
context the context in which this plugin executes (never null)