com.ecyrd.jspwiki.filters

Class FilterManager

java.lang.Object

com.ecyrd.jspwiki.modules.ModuleManager

com.ecyrd.jspwiki.filters.FilterManager

public final class FilterManager
extends ModuleManager

Manages the page filters. Page filters are components that can be executed at certain places:

• Before the page is translated into HTML.
• After the page has been translated into HTML.
• Before the page is saved.
• After the page has been saved.

Using page filters allows you to modify the page data on-the-fly, and do things like adding your own custom WikiMarkup.

The initial page filter configuration is kept in a file called "filters.xml". The format is really very simple:

  

  

    
      com.ecyrd.jspwiki.filters.ProfanityFilter
    

    
      com.ecyrd.jspwiki.filters.TestFilter

      
        foobar
        Zippadippadai
      

      
        blatblaa
        5
      

    
  
 

The <filter> -sections define the filters. For more information, please see the PageFilterConfiguration page in the JSPWiki distribution.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_XMLFILE Default location for the filter XML property file.
static java.lang.String	PROP_FILTERXML Property name for setting the filter XML property file.
static int	SYSTEM_FILTER_PRIORITY JSPWiki system filters are all below this value.
static int	USER_FILTER_PRIORITY The standard user level filtering.

Fields inherited from class com.ecyrd.jspwiki.modules.ModuleManager

m_engine, PLUGIN_RESOURCE_LOCATION

Constructor Summary

Constructors

Constructor and Description
FilterManager(WikiEngine engine, java.util.Properties props) Constructs a new FilterManager object.

Method Summary

Modifier and Type	Method and Description
void	addPageFilter(PageFilter f, int priority) Adds a page filter to the queue.
void	destroy() Notifies PageFilters to clean up their ressources.
void	doPostSaveFiltering(WikiContext context, java.lang.String pageData) Does the page filtering after the page has been saved.
java.lang.String	doPostTranslateFiltering(WikiContext context, java.lang.String htmlData) Does the filtering after HTML translation.
java.lang.String	doPreSaveFiltering(WikiContext context, java.lang.String pageData) Does the filtering before a save to the page repository.
java.lang.String	doPreTranslateFiltering(WikiContext context, java.lang.String pageData) Does the filtering before a translation.
void	fireEvent(int type, WikiContext context) Fires a WikiPageEvent of the provided type and WikiContext.
java.util.List	getFilterList() Returns the list of filters currently installed.
protected void	initialize(java.util.Properties props) Initializes the filters from an XML file.
java.util.Collection	modules() Returns a collection of modules currently managed by this ModuleManager.

Methods inherited from class com.ecyrd.jspwiki.modules.ModuleManager

checkCompatibility

Methods inherited from class java.lang.Object

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

Field Detail

PROP_FILTERXML

public static final java.lang.String PROP_FILTERXML

Property name for setting the filter XML property file. Value is "jspwiki.filterConfig".

See Also:

Constant Field Values

DEFAULT_XMLFILE

public static final java.lang.String DEFAULT_XMLFILE

Default location for the filter XML property file. Value is "/WEB-INF/filters.xml".

See Also:

Constant Field Values

SYSTEM_FILTER_PRIORITY

public static final int SYSTEM_FILTER_PRIORITY

JSPWiki system filters are all below this value.

See Also:

Constant Field Values

USER_FILTER_PRIORITY

public static final int USER_FILTER_PRIORITY

The standard user level filtering.

See Also:

Constant Field Values

Constructor Detail

FilterManager

public FilterManager(WikiEngine engine,
                     java.util.Properties props)
              throws WikiException

Constructs a new FilterManager object.

Parameters:

engine - The WikiEngine which owns the FilterManager

props - Properties to initialize the FilterManager with

Throws:

WikiException - If something goes wrong.

Method Detail

addPageFilter

public void addPageFilter(PageFilter f,
                          int priority)
                   throws java.lang.IllegalArgumentException

Adds a page filter to the queue. The priority defines in which order the page filters are run, the highest priority filters go in the queue first.

In case two filters have the same priority, their execution order is the insertion order.

Parameters:

f - PageFilter to add

priority - The priority in which position to add it in.

Throws:

java.lang.IllegalArgumentException - If the PageFilter is null or invalid.

Since:

2.1.44.

initialize

protected void initialize(java.util.Properties props)
                   throws WikiException

Initializes the filters from an XML file.

Parameters:

props - The list of properties. Typically jspwiki.properties

Throws:

WikiException - If something goes wrong.

doPreTranslateFiltering

public java.lang.String doPreTranslateFiltering(WikiContext context,
                                                java.lang.String pageData)
                                         throws FilterException

Does the filtering before a translation.

Parameters:

context - The WikiContext

pageData - WikiMarkup data to be passed through the preTranslate chain.

Returns:

The modified WikiMarkup

Throws:

FilterException - If any of the filters throws a FilterException

See Also:

PageFilter.preTranslate(WikiContext, String)

doPostTranslateFiltering

public java.lang.String doPostTranslateFiltering(WikiContext context,
                                                 java.lang.String htmlData)
                                          throws FilterException

Does the filtering after HTML translation.

Parameters:

context - The WikiContext

htmlData - HTML data to be passed through the postTranslate

Returns:

The modified HTML

Throws:

FilterException - If any of the filters throws a FilterException

See Also:

PageFilter.postTranslate(WikiContext, String)

doPreSaveFiltering

public java.lang.String doPreSaveFiltering(WikiContext context,
                                           java.lang.String pageData)
                                    throws FilterException

Does the filtering before a save to the page repository.

Parameters:

context - The WikiContext

pageData - WikiMarkup data to be passed through the preSave chain.

Returns:

The modified WikiMarkup

Throws:

FilterException - If any of the filters throws a FilterException

See Also:

PageFilter.preSave(WikiContext, String)

doPostSaveFiltering

public void doPostSaveFiltering(WikiContext context,
                                java.lang.String pageData)
                         throws FilterException

Does the page filtering after the page has been saved.

Parameters:

context - The WikiContext

pageData - WikiMarkup data to be passed through the postSave chain.

Throws:

FilterException - If any of the filters throws a FilterException

See Also:

PageFilter.postSave(WikiContext, String)

getFilterList

public java.util.List getFilterList()

Returns the list of filters currently installed. Note that this is not a copy, but the actual list. So be careful with it.

Returns:

A List of PageFilter objects

destroy

public void destroy()

Notifies PageFilters to clean up their ressources.

fireEvent

public final void fireEvent(int type,
                            WikiContext context)

Fires a WikiPageEvent of the provided type and WikiContext. Invalid WikiPageEvent types are ignored.

Parameters:

type - the WikiPageEvent type to be fired.

context - the WikiContext of the event.

See Also:

WikiPageEvent

modules

public java.util.Collection modules()

Returns a collection of modules currently managed by this ModuleManager. Each entry is an instance of the WikiModuleInfo class. This method should return something which is safe to iterate over, even if the underlying collection changes.

Specified by:

modules in class ModuleManager

Returns:

A Collection of WikiModuleInfo instances.