net.sourceforge.blogentis.plugins
Class AbstractPlugin

java.lang.Object
  net.sourceforge.blogentis.plugins.AbstractPlugin

All Implemented Interfaces:

IPlugin

Direct Known Subclasses:

BaseBlogPlugin, StorageUIPluginImpl, TrackbackPlugin, XmlRpcPlugin

public abstract class AbstractPlugin

extends java.lang.Object

implements IPlugin

A base plugin that implements no functionality.

Author:

abas

Constructor Summary

AbstractPlugin()

Method Summary

void	doAddToBlog(Blog blog) Register this plugin as being used in the specified blog.
void	doRemoveFromBlog(Blog blog) Remove all plugin-specific data from the specified blog.
void	registerInBlog(Blog blog) Register any run-time data with the specified blog.
void	startPlugin() Start the plugin and cause it to register to all extension points that are not blog-specific.
void	stopPlugin() Clean up any plugin data, as the system is shutting down.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sourceforge.blogentis.plugins.IPlugin

getDescription, getName

Constructor Detail

AbstractPlugin

public AbstractPlugin()

Method Detail

registerInBlog

public void registerInBlog(Blog blog)

Description copied from interface: IPlugin

Register any run-time data with the specified blog. Event handlers, extension points and hooks should be registered here. This method gets called when the blog is first instantiated in the VM, and when the blog-specific active plugin list is reloaded.

Specified by:

registerInBlog in interface IPlugin

Parameters:

blog -

doAddToBlog

public void doAddToBlog(Blog blog)

Description copied from interface: IPlugin

Register this plugin as being used in the specified blog. This will get called once when the plugin is added by the user to the blog.

Specified by:

doAddToBlog in interface IPlugin

Parameters:

blog -

doRemoveFromBlog

public void doRemoveFromBlog(Blog blog)

Description copied from interface: IPlugin

Remove all plugin-specific data from the specified blog. This will get called when the user removes this plugin from the specified blog.

Specified by:

doRemoveFromBlog in interface IPlugin

Parameters:

blog -

startPlugin

public void startPlugin()
                 throws org.apache.turbine.services.InitializationException

Description copied from interface: IPlugin

Start the plugin and cause it to register to all extension points that are not blog-specific.

Specified by:

startPlugin in interface IPlugin

Throws:

org.apache.turbine.services.InitializationException - when an exception occurs

stopPlugin

public void stopPlugin()

Description copied from interface: IPlugin

Clean up any plugin data, as the system is shutting down. This method is named in symmetry to startPlugin().

Specified by:

stopPlugin in interface IPlugin