LogicalDOCPlugin (logicaldoc 8.8.0 API)

java.lang.Object
- org.java.plugin.Plugin
- - com.logicaldoc.util.plugin.LogicalDOCPlugin

Direct Known Subclasses:

AndroidPlugin, CmisPlugin, CorePlugin, DropboxPlugin, 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

Constructors
Constructor Description

LogicalDOCPlugin()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Properties`	`getData()`
`File`	`getDataDirectory()`	Returns the data directory for this plugin, that is {conf.plugindir}/{pluginName}.
`String`	`getPluginPath()`	Retrieves the path where the plugins jar archives are stored
`String`	`getProperty(String name)`
`void`	`install()`	Concrete implementations of this method must insert first installation logic such as database initialization.
`File`	`resolveDataPath(String relativePath)`	Resolves a relative path inside the plugin data folder

Methods inherited from class org.java.plugin.Plugin
getDescriptor, getManager, isActive, toString

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

- Constructor Detail
  - LogicalDOCPlugin
```
public LogicalDOCPlugin()
```
- Method Detail
  - getPluginPath
```
public String getPluginPath()
```
    Retrieves the path where the plugins jar archives are stored
    
    Returns:
    
    the path where the plugins jar archives are stored
  - 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.
    
    Returns:
    
    the folder for the data of the plugin
  - install
```
public void install()
             throws Exception
```
    Concrete implementations of this method must insert first installation logic such as database initialization.
    
    Throws:
    
    Exception - raised if some errors happened during the installation
  - getData
```
public Properties getData()
```
  - getProperty
```
public String getProperty(String name)
```