org.rapidcontext.app.plugin

Class Plugin

java.lang.Object

org.rapidcontext.core.storage.StorableObject

org.rapidcontext.app.plugin.Plugin

public class Plugin
extends StorableObject

The base plug-in class. A plug-in may extend this class in order to supervise the loading and unloading process. If a plug-in does not declare an overriding implementation, a default instance of this class is created instead.

Version:

1.0

Author:

Per Cederberg

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_PLATFORM The dictionary key for the optimal platform version.

Fields inherited from class org.rapidcontext.core.storage.StorableObject

dict, KEY_CLASSNAME, KEY_ID, KEY_TYPE

Constructor Summary

Constructors

Constructor and Description
Plugin(Dict dict) Creates a new plug-in instance with the specified plug-in configuration data.

Method Summary

Modifier and Type	Method and Description
void	destroy() Uninitializes the plug-in.
void	init() Initializes the plug-in.

Methods inherited from class org.rapidcontext.core.storage.StorableObject

activate, id, isActive, isModified, passivate, path, serialize, toString, type

Methods inherited from class java.lang.Object

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

Field Detail

KEY_PLATFORM

public static final java.lang.String KEY_PLATFORM

The dictionary key for the optimal platform version.

See Also:

Constant Field Values

Constructor Detail

Plugin

public Plugin(Dict dict)

Creates a new plug-in instance with the specified plug-in configuration data. All subclasses must provide a constructor matching this signature.

Parameters:

dict - the plug-in configuration data

Method Detail

init

public void init()
          throws StorageException

Initializes the plug-in. This method should load or initialize any resources required by the plug-in, such as adding additional handlers to the provided in-memory storage.

Overrides:

init in class StorableObject

Throws:

StorageException - if the initialization failed

destroy

public void destroy()
             throws StorageException

Uninitializes the plug-in. This method should free any resources previously loaded or stored by the plug-in.

Overrides:

destroy in class StorableObject

Throws:

StorageException - if the destruction failed