net.sourceforge.blogentis.plugins
Interface IPlugin

All Known Implementing Classes:

AbstractPlugin

public interface IPlugin

Plugins and extensions should implement this.

Author:

abas

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.
java.lang.String	getDescription() Get a medium-sized description of the plugin and what its effects are.
java.lang.String	getName() Get the name of the plugin.
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.

Method Detail

getName

public java.lang.String getName()

Get the name of the plugin.

Returns:

the name of the plugin.

getDescription

public java.lang.String getDescription()

Get a medium-sized description of the plugin and what its effects are. You may use HTML in this descrpition.

Returns:

registerInBlog

public void registerInBlog(Blog blog)

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.

Parameters:

blog -

doAddToBlog

public void doAddToBlog(Blog blog)

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.

Parameters:

blog -

doRemoveFromBlog

public void doRemoveFromBlog(Blog blog)

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

Parameters:

blog -

startPlugin

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

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

Throws:

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

stopPlugin

public void stopPlugin()

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