|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.nutch.plugin.Plugin
public class Plugin
A nutch-plugin is an container for a set of custom logic that provide
extensions to the nutch core functionality or another plugin that provides an
API for extending. A plugin can provide one or a set of extensions.
Extensions are components that can be dynamically installed as a kind of
listener to extension points. Extension points are a kind of publisher that
provide a API and invoke one or a set of installed extensions.
Each plugin may extend the base Plugin
. Plugin
instances are used as the point of life cycle managemet of plugin related
functionality.
The Plugin
will be startuped and shutdown by the nutch plugin
management system.
A possible usecase of the Plugin
implementation is to create
or close a database connection.
Field Summary | |
---|---|
protected Configuration |
conf
|
Constructor Summary | |
---|---|
Plugin(PluginDescriptor pDescriptor,
Configuration conf)
Constructor |
Method Summary | |
---|---|
protected void |
finalize()
|
PluginDescriptor |
getDescriptor()
Returns the plugin descriptor |
void |
shutDown()
Shutdown the plugin. |
void |
startUp()
Will be invoked until plugin start up. |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected Configuration conf
Constructor Detail |
---|
public Plugin(PluginDescriptor pDescriptor, Configuration conf)
Method Detail |
---|
public void startUp() throws PluginRuntimeException
PluginRuntimeException
- If the startup was without successs.public void shutDown() throws PluginRuntimeException
PluginRuntimeException
- if a problems occurs until shutdown the plugin.public PluginDescriptor getDescriptor()
protected void finalize() throws Throwable
finalize
in class Object
Throwable
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |