readme.adoc

Writing Plugins

TODO: Flesh this document out.

1. Create a plugin package: Create a new package folder in this directory for your plugin. This package will be a home for the various types and API implementations that make up your plugin.

See the example plugin package.
2. Create a Plugin implementation: The core of a plugin is the Plugin implementation, this is the type that will be executed to perform the plugin’s tasks/job(s).

For convenience an abstract plugin implementation has been provided which should be extended by specific plugin implementations.

See the example plugin implementation.
3. Create a Plugin Provider implementation: The PluginProvider is a simple type that enables the construction of new Plugin instances asynchronously at job execution time. (TODO: Define job stages).

Additionally, PluginProvider extends the Plugin Info Container which provides base information about a plugin, such as the plugin’s name, url segment, description, and input request type.

See the example plugin provider implementation.
4. Register the new plugin with the Plugin Registry: The PluginRegistry class is the root location that tells the service about the existence of the plugins contained within it.