org.blojsom.plugin.helper
Class PluginHelperPlugin.PluginHelper

java.lang.Object
  org.blojsom.plugin.helper.PluginHelperPlugin.PluginHelper

Enclosing class:

PluginHelperPlugin

public class PluginHelperPlugin.PluginHelper

extends java.lang.Object

Plugin helper defines methods to execute plugins by name or by flavor

Constructor Summary

PluginHelperPlugin.PluginHelper(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.util.Map context, BlogUser blog)
Create a new plugin helper instance

Method Summary

protected void	process(BlogEntry[] entries, java.lang.String plugin, java.lang.String flavor) Executes the plugin(s) on the entries
void	processEntriesForFlavor(BlogEntry[] entries, java.lang.String flavor) Process a set of entries for the plugins in the plugin chain for the specified flavor
void	processEntriesForPlugin(BlogEntry[] entries, java.lang.String plugin) Process a set of entries for a named plugin
void	processEntryForFlavor(BlogEntry blogEntry, java.lang.String flavor) Process a single entry for the plugins in the plugin chain for the specified flavor
void	processEntryForPlugin(BlogEntry blogEntry, java.lang.String plugin) Process a single entry for a named plugin

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginHelperPlugin.PluginHelper

public PluginHelperPlugin.PluginHelper(javax.servlet.http.HttpServletRequest request,
                                       javax.servlet.http.HttpServletResponse response,
                                       java.util.Map context,
                                       BlogUser blog)

Create a new plugin helper instance

Parameters:

request - HttpServletRequest

response - HttpServletResponse

context - Context information

blog - BlogUser information

Method Detail

processEntryForPlugin

public void processEntryForPlugin(BlogEntry blogEntry,
                                  java.lang.String plugin)

Process a single entry for a named plugin

Parameters:

blogEntry - BlogEntry

plugin - Name of plugin

processEntryForFlavor

public void processEntryForFlavor(BlogEntry blogEntry,
                                  java.lang.String flavor)

Process a single entry for the plugins in the plugin chain for the specified flavor

Parameters:

blogEntry - BlogEntry

flavor - Flavor

processEntriesForPlugin

public void processEntriesForPlugin(BlogEntry[] entries,
                                    java.lang.String plugin)

Process a set of entries for a named plugin

Parameters:

entries - Array of BlogEntry

plugin - Name of plguin

processEntriesForFlavor

public void processEntriesForFlavor(BlogEntry[] entries,
                                    java.lang.String flavor)

Process a set of entries for the plugins in the plugin chain for the specified flavor

Parameters:

entries - Array of BlogEntry

flavor - Flavor

process

protected void process(BlogEntry[] entries,
                       java.lang.String plugin,
                       java.lang.String flavor)

Executes the plugin(s) on the entries

Parameters:

entries - Array of BlogEntry

plugin - Plugin name, null if using flavor

flavor - Flavor name, null if using specific plugin name