net.sourceforge.blogentis.plugins
Interface IPluginService

All Known Implementing Classes:

BlogPluginServiceImpl

public interface IPluginService

The PluginService instance will implement this interface.

Author:

abas

Field Summary

static java.lang.String

SERVICE_NAME

Method Summary

void	deregisterExtensionPoint(Blog blog, IBlogExtensionPoint point) Remove a blog-specific extension point
void	deregisterExtensionPoint(IExtensionPoint point) Remove a global extension point.
java.util.Iterator	getExtensionPoints(Blog blog) Get an Iterator over the extension points active for a blog.
java.util.Iterator	getPlugins() List the plugins in the order of their definition.
IPrefs	getPreferencesFor(Blog blog, java.lang.Class extensionClass) Get the preferences object.
IBlogExtensionPoint	locateExtensionPoint(Blog blog, java.lang.Class name) Locate the first extension point that has the specified class in the extension point list of the blog.
IExtensionPoint	locateExtensionPoint(java.lang.Class name) Locate the specified extension point in the global extension point list
void	registerExtensionPoint(Blog blog, IBlogExtensionPoint point) Register a blog-specific extension point.
void	registerExtensionPoint(IExtensionPoint point) Register a global extension point.
void	reloadExtensionPointsForBlog(Blog blog) Causes the active plugins, extensions points and extensions for a blog to be recomputed.

Field Detail

SERVICE_NAME

public static final java.lang.String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

getPlugins

public java.util.Iterator getPlugins()

List the plugins in the order of their definition.

Returns:

an iterator that returns IPlugin

registerExtensionPoint

public void registerExtensionPoint(IExtensionPoint point)

Register a global extension point.

Parameters:

point - the global extension point to register.

deregisterExtensionPoint

public void deregisterExtensionPoint(IExtensionPoint point)

Remove a global extension point.

Parameters:

point - the extension point to remove.

registerExtensionPoint

public void registerExtensionPoint(Blog blog,
                                   IBlogExtensionPoint point)

Register a blog-specific extension point.

Parameters:

blog - the blog that the extension point will apply.

point - the extension point that will be registered.

deregisterExtensionPoint

public void deregisterExtensionPoint(Blog blog,
                                     IBlogExtensionPoint point)

Remove a blog-specific extension point

Parameters:

blog - the blog that should contain the extension point.

point - the extension point to remove.

locateExtensionPoint

public IExtensionPoint locateExtensionPoint(java.lang.Class name)

Locate the specified extension point in the global extension point list

Parameters:

name - the class of the extension point

Returns:

the global extension point, or null if not found.

locateExtensionPoint

public IBlogExtensionPoint locateExtensionPoint(Blog blog,
                                                java.lang.Class name)

Locate the first extension point that has the specified class in the extension point list of the blog.

Parameters:

blog - the blog that will be searched for the extension point.

name - the class of the extension point.

Returns:

the extension point if found, null otherwise.

getExtensionPoints

public java.util.Iterator getExtensionPoints(Blog blog)

Get an Iterator over the extension points active for a blog.

Parameters:

blog -

Returns:

reloadExtensionPointsForBlog

public void reloadExtensionPointsForBlog(Blog blog)

Causes the active plugins, extensions points and extensions for a blog to be recomputed.

Parameters:

blog - the blog to reload the plugins.

getPreferencesFor

public IPrefs getPreferencesFor(Blog blog,
                                java.lang.Class extensionClass)

Get the preferences object.

Parameters:

blog - the blog to search for.

extensionClass - the extension or extension point

Returns:

the preferences object for that class.