Package com.logicaldoc.util.plugin
Class LogicalDOCPlugin
java.lang.Object
org.java.plugin.Plugin
com.logicaldoc.util.plugin.LogicalDOCPlugin
- Direct Known Subclasses:
AndroidPlugin
,CmisPlugin
,CorePlugin
,DropboxPlugin
,IOSPlugin
,WebDAVPlugin
,WebserviceDocPlugin
,WebservicePlugin
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 (see org.java.plugin.PluginManager manager), {see
org.java.plugin.registry.PluginRegistry registry) which it was loaded.
- Since:
- 3.0
- Author:
- Marco Meschieri - LogicalDOC
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetData()
Returns the data directory for this plugin, that is {conf.plugindir}/{pluginName}.Retrieves the path where the plugin jar archive is storedgetProperty
(String name) void
install()
Concrete implementations of this method must insert first installation logic such as database initialization.resolveDataPath
(String relativePath) Resolves a relative path inside the plugin data folderMethods inherited from class org.java.plugin.Plugin
getDescriptor, getManager, isActive, toString
-
Constructor Details
-
LogicalDOCPlugin
public LogicalDOCPlugin()
-
-
Method Details
-
getPluginPath
Retrieves the path where the plugin jar archive is stored- Returns:
- the path where the plugin jar archive is stored
-
resolveDataPath
Resolves a relative path inside the plugin data folder- Parameters:
relativePath
- The relative path- Returns:
- The file
-
getDataDirectory
Returns the data directory for this plugin, that is {conf.plugindir}/{pluginName}. It will be created in not existing.- Returns:
- the folder for the data of the plugin
-
install
Concrete implementations of this method must insert first installation logic such as database initialization.- Throws:
PluginException
- raised if some errors happened during the installation
-
getData
-
getProperty
-