Package com.pnfsoftware.jeb.core

Class AbstractEnginesPlugin

java.lang.Object

com.pnfsoftware.jeb.core.AbstractPlugin

com.pnfsoftware.jeb.core.AbstractEnginesPlugin

All Implemented Interfaces:

IEnginesPlugin, IPlugin

public abstract class AbstractEnginesPlugin
extends AbstractPlugin
implements IEnginesPlugin

Skeleton implementation for engines plugins. It is recommended plugins extend this class or one of the its subclasses instead of implementing IEnginesPlugin. Please refer to IEnginesPlugin for notes and caveats.

Field Summary

Fields

Modifier and Type	Field	Description
static final ILogger	logger

Constructor Summary

Constructors

Constructor	Description
AbstractEnginesPlugin()

Method Summary

Modifier and Type	Method	Description
void	execute(IEnginesContext context)	The default implementation forwards execution to IEnginesPlugin.execute(IEnginesContext, java.util.Map), without providing options.
List<? extends IOptionDefinition>	getExecutionOptionDefinitions()	The default implementation returns null.
void	load(IEnginesContext context)	The default implementation does nothing.

Methods inherited from class com.pnfsoftware.jeb.core.AbstractPlugin

dispose, getData, setData

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.pnfsoftware.jeb.core.IEnginesPlugin

execute, getExecutionOptionDefinitions

Methods inherited from interface com.pnfsoftware.jeb.core.IPlugin

dispose, getData, getPluginInformation, setData

Field Details

logger

public static final ILogger logger

Constructor Details

AbstractEnginesPlugin

public AbstractEnginesPlugin()

Method Details

getExecutionOptionDefinitions

public List<? extends IOptionDefinition> getExecutionOptionDefinitions()

The default implementation returns null.

Specified by:

getExecutionOptionDefinitions in interface IEnginesPlugin

Returns:

optional list of option definitions

load

public void load(IEnginesContext context)

The default implementation does nothing.

Specified by:

load in interface IEnginesPlugin

Parameters:

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

execute

public void execute(IEnginesContext context)

The default implementation forwards execution to IEnginesPlugin.execute(IEnginesContext, java.util.Map), without providing options.

Specified by:

execute in interface IEnginesPlugin

Parameters:

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