pt.ua.dicoogle.plugins.webui

Class WebUIPluginManager

java.lang.Object

pt.ua.dicoogle.plugins.webui.WebUIPluginManager

public class WebUIPluginManager
extends java.lang.Object

A class type for managing web UI plugins.

Constructor Summary

Constructors

Constructor and Description
WebUIPluginManager()

Method Summary

Modifier and Type	Method and Description
WebUIPlugin	get(java.lang.String name) Get the descriptor of a web UI plugin.
WebUIPlugin	load(java.io.File directory)
void	loadAll(java.io.File directory)
void	loadAllFromZip(java.util.zip.ZipFile pluginZip) Load all web plugins from a zip or jar file.
void	loadSettings(java.io.File settingsFolder)
java.util.Collection<WebUIPlugin>	pluginSet()
JSONObject	retrieveJSON(java.lang.String name) Retrieve and return the original JSON object of the plugin.
java.lang.String	retrieveModuleJS(java.lang.String name)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebUIPluginManager

public WebUIPluginManager()

Method Detail

loadAll

public void loadAll(java.io.File directory)

load

public WebUIPlugin load(java.io.File directory)
                 throws java.io.IOException,
                        PluginFormatException

Throws:

java.io.IOException

PluginFormatException

loadAllFromZip

public void loadAllFromZip(java.util.zip.ZipFile pluginZip)
                    throws java.io.IOException

Load all web plugins from a zip or jar file.

Parameters:

pluginZip - the zip file containing the plugins

Throws:

java.io.IOException - if the zip file can not be read

get

public WebUIPlugin get(java.lang.String name)

Get the descriptor of a web UI plugin.

Parameters:

name - the name of the plugin

Returns:

a copy of the installed web UI plugin

retrieveJSON

public JSONObject retrieveJSON(java.lang.String name)
                        throws java.io.IOException

Retrieve and return the original JSON object of the plugin.

Parameters:

name - the name of the plugin

Returns:

a JSON object of the original "package.json"

Throws:

java.io.IOException - on error reading "package.json"

retrieveModuleJS

public java.lang.String retrieveModuleJS(java.lang.String name)
                                  throws java.io.IOException

Throws:

java.io.IOException

pluginSet

public java.util.Collection<WebUIPlugin> pluginSet()

loadSettings

public void loadSettings(java.io.File settingsFolder)