pt.ua.dicoogle.sdk

Interface DicooglePlugin

All Known Subinterfaces:

GraphicalInterface, IndexerInterface, JettyPluginInterface, QueryInterface, StorageInterface

All Known Implementing Classes:

DefaultFileStoragePlugin

public interface DicooglePlugin

Class interface representing a generic plugin.

These plugins can have an initialization process, and can be enabled or disabled by the system. Furthermore, every plugin must have a name, so that Dicoogle can address it and control it. No further assumptions are made here regarding functionality. Any other more specific functionality must be defined as a class inheriting from this one.

Method Summary

Modifier and Type	Method and Description
boolean	disable() Issues the plugin to become disabled.
boolean	enable() Issues the plugin to become enabled.
java.lang.String	getName() Obtains the unique name of plugin.
ConfigurationHolder	getSettings() Obtains access to the settings of the plugin.
boolean	isEnabled() Verifies if the plugin is enabled.
void	setSettings(ConfigurationHolder settings) Sets the settings of this plugin.

Method Detail

getName

java.lang.String getName()

Obtains the unique name of plugin. A plugin must have a name to serve as an ID, and this is the method from where it is retrieved. This name must never change.

Returns:

the name of the plugin

enable

boolean enable()

Issues the plugin to become enabled. It is expected that an enabled plugin, once configured, is ready to perform its main tasks.

Returns:

whether the plugin was successfully enabled

disable

boolean disable()

Issues the plugin to become disabled. When called, the plugin is responsible for stopping all services that the plugin is running.

Returns:

whether the plugin was successfully disabled

isEnabled

boolean isEnabled()

Verifies if the plugin is enabled.

Returns:

whether the plugin is enabled

setSettings

void setSettings(ConfigurationHolder settings)

Sets the settings of this plugin. This method lets the plugin receive its settings from the core Dicoogle system.

Parameters:

settings - the parameters that will be used by the plugin

getSettings

ConfigurationHolder getSettings()

Obtains access to the settings of the plugin.

Returns:

the plugin's settings