PluginBase

java.lang.Object
- pt.ua.dicoogle.sdk.PluginBase

All Implemented Interfaces:

PlatformCommunicatorInterface, PluginSet

Direct Known Subclasses:

DefaultFileStoragePlugin
```
public abstract class PluginBase
extends java.lang.Object
implements PluginSet, PlatformCommunicatorInterface
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.List<GraphicalInterface>`	`graphicPlugins`
`protected java.util.List<IndexerInterface>`	`indexPlugins`
`protected java.util.List<JettyPluginInterface>`	`jettyPlugins`
`protected DicooglePlatformInterface`	`platform`
`protected java.util.List<QueryInterface>`	`queryPlugins`
`protected java.util.List<ServerResource>`	`services`
`protected ConfigurationHolder`	`settings`
`protected java.util.List<StorageInterface>`	`storagePlugins`

Constructor Summary

Constructors
Constructor and Description

PluginBase()

Constructors
Constructor and Description
`PluginBase()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.List<GraphicalInterface>`	`getGraphicalPlugins()` Gets the graphical plugins enclosed in this plugin set.
`java.util.List<IndexerInterface>`	`getIndexPlugins()` Gets the indexer plugins enclosed in this plugin set.
`java.util.List<JettyPluginInterface>`	`getJettyPlugins()` Obtains a collection of Jetty plugins, so as to implement web services via Dicoogle.
`abstract java.lang.String`	`getName()` Gets the plugin's name.
`java.util.List<QueryInterface>`	`getQueryPlugins()` Gets the query plugins enclosed in this plugin set.
`java.util.List<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`	`setPlatformProxy(DicooglePlatformInterface core)`
`void`	`setSettings(ConfigurationHolder xmlSettings)` Defines the plugin's settings.
`void`	`shutdown()` Signals a plugin to stop.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - indexPlugins
```
protected java.util.List<IndexerInterface> indexPlugins
```
  - graphicPlugins
```
protected java.util.List<GraphicalInterface> graphicPlugins
```
  - queryPlugins
```
protected java.util.List<QueryInterface> queryPlugins
```
  - jettyPlugins
```
protected java.util.List<JettyPluginInterface> jettyPlugins
```
  - storagePlugins
```
protected java.util.List<StorageInterface> storagePlugins
```
  - services
```
protected java.util.List<ServerResource> services
```
  - settings
```
protected ConfigurationHolder settings
```
  - platform
```
protected DicooglePlatformInterface platform
```
- Constructor Detail
  - PluginBase
```
public PluginBase()
```
- Method Detail
  - getIndexPlugins
```
public java.util.List<IndexerInterface> getIndexPlugins()
```
    Description copied from interface: PluginSet
    
    Gets the indexer plugins enclosed in this plugin set. This collection must be immutable.
    
    Specified by:
    
    getIndexPlugins in interface PluginSet
    
    Returns:
    
    IndexPluginInterface returns a list of active index plugins
    
    See Also:
    
    IndexerInterface
  - getGraphicalPlugins
```
public java.util.List<GraphicalInterface> getGraphicalPlugins()
```
    Description copied from interface: PluginSet
    
    Gets the graphical plugins enclosed in this plugin set. This collection must be immutable.
    
    Specified by:
    
    getGraphicalPlugins in interface PluginSet
    
    Returns:
  - getQueryPlugins
```
public java.util.List<QueryInterface> getQueryPlugins()
```
    Description copied from interface: PluginSet
    
    Gets the query plugins enclosed in this plugin set. This collection must be immutable.
    
    Specified by:
    
    getQueryPlugins in interface PluginSet
    
    Returns:
    
    a collection of query plugins
    
    See Also:
    
    QueryInterface
  - getRestPlugins
```
public java.util.List<ServerResource> getRestPlugins()
```
    Description copied from interface: PluginSet
    
    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.
    
    Specified by:
    
    getRestPlugins in interface PluginSet
    
    Returns:
    
    a collection of Restlet-based server resources, implementing toString() to provide the resource name
  - getJettyPlugins
```
public java.util.List<JettyPluginInterface> getJettyPlugins()
```
    Description copied from interface: PluginSet
    
    Obtains a collection of Jetty plugins, so as to implement web services via Dicoogle. This collection must be immutable.
    
    Specified by:
    
    getJettyPlugins in interface PluginSet
    
    Returns:
    
    a collection of Jetty plugins to the core application
    
    See Also:
    
    JettyPluginInterface
  - getName
```
public abstract java.lang.String getName()
```
    Description copied from interface: PluginSet
    
    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.
    
    Specified by:
    
    getName in interface PluginSet
    
    Returns:
    
    the name of the plugin, never changes
  - getSettings
```
public ConfigurationHolder getSettings()
```
    Description copied from interface: PluginSet
    
    Retrieves the plugin's settings.
    
    Specified by:
    
    getSettings in interface PluginSet
    
    Returns:
    
    an XML-based configuration holder
  - setSettings
```
public void setSettings(ConfigurationHolder xmlSettings)
```
    Description copied from interface: PluginSet
    
    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.
    
    Specified by:
    
    setSettings in interface PluginSet
    
    Parameters:
    
    xmlSettings - an XML-based configuration holder
  - shutdown
```
public void shutdown()
```
    Description copied from interface: PluginSet
    
    Signals a plugin to stop. Upon an invocation of this method, the plugin may clean allocated resources and save state if required.
    
    Specified by:
    
    shutdown in interface PluginSet
  - getStoragePlugins
```
public java.util.Collection<StorageInterface> getStoragePlugins()
```
    Description copied from interface: PluginSet
    
    Gets the storage plugins enclosed in this plugin set. This collection must be immutable.
    
    Specified by:
    
    getStoragePlugins in interface PluginSet
    
    Returns:
    
    Collection holding the StoragePlugins of this PluginSet
  - setPlatformProxy
```
public void setPlatformProxy(DicooglePlatformInterface core)
```
    Specified by:
    
    setPlatformProxy in interface PlatformCommunicatorInterface

Class PluginBase

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

indexPlugins

graphicPlugins

queryPlugins

jettyPlugins

storagePlugins

services

settings

platform

Constructor Detail

PluginBase

Method Detail

getIndexPlugins

getGraphicalPlugins

getQueryPlugins

getRestPlugins

getJettyPlugins

getName

getSettings

setSettings

shutdown

getStoragePlugins

setPlatformProxy