AbstractEnginesPlugin

Class Overview

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.

Summary

[Expand] Inherited Methods
From class com.pnfsoftware.jeb.core.AbstractPlugin void dispose() The default implementation does nothing. Object getData(Object key) Retrieve a piece of transient plugin data. void setData(Object key, Object value) Store a piece of transient plugin data.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()
From interface com.pnfsoftware.jeb.core.IEnginesPlugin abstract void execute(IEnginesContext engctx) Same as execute(context, null). abstract void execute(IEnginesContext engctx, 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 List<? extends IOptionDefinition> getExecutionOptionDefinitions(IEnginesContext engctx) Retrieve a list of option definitions. abstract void load(IEnginesContext engctx) This method is called by the owner context exactly once, just after the engines plugin instantiation.
From interface com.pnfsoftware.jeb.core.IPlugin abstract void dispose() Dispose of resources used by this plugin. abstract Object getData(Object key) Retrieve a piece of transient plugin data. abstract IPluginInformation getPluginInformation() Retrieve basic information about the plugin, such as name, version, author, and organization. abstract void setData(Object key, Object value) Store a piece of transient plugin data.