com.logicaldoc.util.plugin

Class LogicalDOCPlugin

java.lang.Object

org.java.plugin.Plugin

com.logicaldoc.util.plugin.LogicalDOCPlugin

public abstract class LogicalDOCPlugin
extends org.java.plugin.Plugin

This is the base class for LogicalDOC plugins. The methods of this class are automatically invoked by the manager during plug-in life cycle management (activation and deactivation). In addition, this class makes available methods to manage the plug-in's properties stored in file plugin.properties, and allows access to the plug-in framework (manager, registry) which it was loaded.

Since:

3.0

Author:

Marco Meschieri - Logical Objects

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
LogicalDOCPlugin()

Method Summary

Methods

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.

Methods inherited from class org.java.plugin.Plugin

getDescriptor, getManager, isActive, toString

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.slf4j.Logger log

Constructor Detail

LogicalDOCPlugin

public LogicalDOCPlugin()

Method Detail

doStart

protected void doStart()
                throws Exception

This method will be called once during plug-in activation before any access to any code from this plug-in. If the plug-in needs to be installed(@link #isInstallNeeded())the install() method is called

Specified by:

doStart in class org.java.plugin.Plugin

Throws:

Exception - if an error has occurred during plug-in start-up

See Also:

Plugin.doStart()

isInstallNeeded

protected boolean isInstallNeeded()

Tells is the plug-in need to be installed. This default implementation check if the file 'install' exists o the plug-in's data folder. Concrete implementations are free to re-implement this logic.

Returns:

true if the plug-in need to be reinstalled

loadData

protected void loadData()
                 throws IOException

Throws:

IOException

saveData

protected void saveData()
                 throws IOException

Throws:

IOException

getPluginPath

public String getPluginPath()

Retrieves the path of the plugin jar archive

resolveDataPath

public File resolveDataPath(String relativePath)

Resolves a relative path inside the plugin data folder

Parameters:

relativePath - The relative path

Returns:

The file

getDataDirectory

public File getDataDirectory()

Returns the data directory for this plugin, that is {conf.plugindir}/{pluginName}. It will be created in not existing.

getPluginName

protected String getPluginName()

install

protected void install()
                throws Exception

Concrete implementations of this method must insert first installation logic such as database initialisation.

Throws:

Exception

start

protected void start()
              throws Exception

Concrete implementations of this method must insert startup initialisations.

Throws:

Exception

setRestartRequired

protected void setRestartRequired()

doStop

protected void doStop()
               throws Exception

This method will be called once during plug-in deactivation. After this method call, no other code from this plug-in can be accessed, unless doStart() method will be called again (but for another instance of this class).

Specified by:

doStop in class org.java.plugin.Plugin

Throws:

Exception - if an error has occurred during plug-in shutdown

See Also:

Plugin.doStop()

getData

public Properties getData()

getProperty

public String getProperty(String name)