pt.ua.dicoogle.sdk

Interface PluginSet

All Known Implementing Classes:

DefaultFileStoragePlugin, PluginBase

public interface PluginSet

This is the class responsible for creating a Dicoolge plugin. The developer may use this interface in order to manage and expose the implemented plugins. One instance of each installed plugin set is created by injecting it as a PluginImplementation. All instances are expected to be thread safe. It is highly recommended that provided collections are immutable, and that no modifications are performed in getter methods.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<GraphicalInterface>	getGraphicalPlugins() Deprecated. the Swing-based remote user interface is deprecated
java.util.Collection<IndexerInterface>	getIndexPlugins() Gets the indexer plugins enclosed in this plugin set.
java.util.Collection<JettyPluginInterface>	getJettyPlugins() Obtains a collection of Jetty plugins, so as to implement web services via Dicoogle.
java.lang.String	getName() Gets the plugin's name.
java.util.Collection<QueryInterface>	getQueryPlugins() Gets the query plugins enclosed in this plugin set.
java.util.Collection<ServerResource>	getRestPlugins() Obtains a collection of access to the RESTful resources.
ConfigurationHolder	getSettings() Retrieves the plugin's settings.
java.util.Collection<StorageInterface>	getStoragePlugins() Gets the storage plugins enclosed in this plugin set.
void	setSettings(ConfigurationHolder xmlSettings) Defines the plugin's settings.
void	shutdown() Signals a plugin to stop.

Method Detail

getIndexPlugins

java.util.Collection<IndexerInterface> getIndexPlugins()

Gets the indexer plugins enclosed in this plugin set. This collection must be immutable.

Returns:

IndexPluginInterface returns a list of active index plugins

See Also:

IndexerInterface

getGraphicalPlugins

java.util.Collection<GraphicalInterface> getGraphicalPlugins()

Deprecated. the Swing-based remote user interface is deprecated

Gets the graphical plugins enclosed in this plugin set. This collection must be immutable.

Returns:

getQueryPlugins

java.util.Collection<QueryInterface> getQueryPlugins()

Gets the query plugins enclosed in this plugin set. This collection must be immutable.

Returns:

a collection of query plugins

See Also:

QueryInterface

getStoragePlugins

java.util.Collection<StorageInterface> getStoragePlugins()

Gets the storage plugins enclosed in this plugin set. This collection must be immutable.

Returns:

Collection holding the StoragePlugins of this PluginSet

getRestPlugins

java.util.Collection<ServerResource> getRestPlugins()

Obtains a collection of access to the RESTful resources. These plugins will be installed to the web service hierarchy according to a name defined by the object's toString() method. This collection must be immutable.

Returns:

a collection of Restlet-based server resources, implementing toString() to provide the resource name

getJettyPlugins

java.util.Collection<JettyPluginInterface> getJettyPlugins()

Obtains a collection of Jetty plugins, so as to implement web services via Dicoogle. This collection must be immutable.

Returns:

a collection of Jetty plugins to the core application

See Also:

JettyPluginInterface

getName

java.lang.String getName()

Gets the plugin's name. This name will be used for identifying index/query/storage providers, and should be unique among the total plugin sets installed.

Returns:

the name of the plugin, never changes

setSettings

void setSettings(ConfigurationHolder xmlSettings)

Defines the plugin's settings. This method will be called once after the plugin set was instantiated with plugin-scoped settings. Dicoogle users can modify these settings by accessing the XML file with the same name in the "Settings" folder. Developers may define such settings programmatically from the plugin itself.

Parameters:

xmlSettings - an XML-based configuration holder

getSettings

ConfigurationHolder getSettings()

Retrieves the plugin's settings.

Returns:

an XML-based configuration holder

shutdown

void shutdown()

Signals a plugin to stop. Upon an invocation of this method, the plugin may clean allocated resources and save state if required.