public abstract class LogicalDOCPlugin
extends org.java.plugin.Plugin
manager
, registry
) which it was loaded.Modifier and Type | Field and Description |
---|---|
protected static org.slf4j.Logger |
log |
Constructor and Description |
---|
LogicalDOCPlugin() |
Modifier and Type | Method and Description |
---|---|
protected void |
doStart()
This method will be called once during plug-in activation before any
access to any code from this plug-in.
|
protected void |
doStop()
This method will be called once during plug-in deactivation.
|
Properties |
getData() |
File |
getDataDirectory()
Returns the data directory for this plugin, that is
{conf.plugindir}/{pluginName}.
|
protected String |
getPluginName() |
String |
getPluginPath()
Retrieves the path of the plugin jar archive
|
String |
getProperty(String name) |
protected void |
install()
Concrete implementations of this method must insert first installation
logic such as database initialisation.
|
protected boolean |
isInstallNeeded()
Tells is the plug-in need to be installed.
|
protected void |
loadData() |
File |
resolveDataPath(String relativePath)
Resolves a relative path inside the plugin data folder
|
protected void |
saveData() |
protected void |
setRestartRequired() |
protected void |
start()
Concrete implementations of this method must insert startup
initialisations.
|
protected void doStart() throws Exception
install()
method is
calleddoStart
in class org.java.plugin.Plugin
Exception
- if an error has occurred during plug-in start-upPlugin.doStart()
protected boolean isInstallNeeded()
protected void loadData() throws IOException
IOException
protected void saveData() throws IOException
IOException
public String getPluginPath()
public File resolveDataPath(String relativePath)
relativePath
- The relative pathpublic File getDataDirectory()
protected String getPluginName()
protected void install() throws Exception
Exception
protected void start() throws Exception
Exception
protected void setRestartRequired()
protected void doStop() throws Exception
doStart()
method will be called again (but for another instance
of this class).doStop
in class org.java.plugin.Plugin
Exception
- if an error has occurred during plug-in shutdownPlugin.doStop()
public Properties getData()
Copyright © 2008-2014 Logical Objects. All Rights Reserved.