org.zimowski.bambi.editor.plugins.api

Interface Plugin

All Known Subinterfaces:

ImageExporter, ImagePlugin, TextEncrypter

All Known Implementing Classes:

AbstractImageExporter, AbstractImagePlugin, AbstractPlugin, AbstractPluginAdapter, ClearTextProxy, FilesystemImageExporter, FtpImageUploader, MD5Digest, MultipartFormPostImageUploader, RsaCipher, SHA1Digest, SHA256Digest

public interface Plugin

Common plugin operations.

Author:

Adam Zimowski (mrazjava)

Method Summary

Methods

Modifier and Type	Method and Description
void	initialize(Properties configuration) Typically called immediately after instantiation to allow the plugin proper initialization and certainly before its invocation.

Method Detail

initialize

void initialize(Properties configuration)

Typically called immediately after instantiation to allow the plugin proper initialization and certainly before its invocation. Since plugin configuration is custom defined (cannot be known at compile time), it must follow specific naming convention in order to be properly loaded. Plugin setting must begin with the name of the plugin setting itself, followed by a separator. For example, the ConfigParameters.IMAGE_EXPORT_PLUGIN is used to define the image upload strategy by specifying plugin's full class path. Configuration settings for that plugin can be named freely but must be prefixed with the plugin setting itself followed by ConfigLoader.PARAM_SEPARATOR. Another example: say fooPlug is the setting for com.foo.Plug. Configuration setting bar for fooPlug would would be defined as fooPlug.bar if dot is ConfigLoader.PARAM_SEPARATOR.

Parameters:

configuration - plugin settings defined in the configuration file