|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.ecyrd.jspwiki.modules.ModuleManager
com.ecyrd.jspwiki.filters.FilterManager
public final class FilterManager
Manages the page filters. Page filters are components that can be executed at certain places:
The initial page filter configuration is kept in a file called "filters.xml". The format is really very simple:
The <filter> -sections define the filters. For more information, please see the PageFilterConfiguration page in the JSPWiki distribution.com.ecyrd.jspwiki.filters.ProfanityFilter com.ecyrd.jspwiki.filters.TestFilter foobar Zippadippadai blatblaa 5
| Field Summary | |
|---|---|
static String |
DEFAULT_XMLFILE
Default location for the filter XML property file. |
static 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 | |
|---|---|
FilterManager(WikiEngine engine,
Properties props)
Constructs a new FilterManager object. |
|
| Method Summary | |
|---|---|
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,
String pageData)
Does the page filtering after the page has been saved. |
String |
doPostTranslateFiltering(WikiContext context,
String htmlData)
Does the filtering after HTML translation. |
String |
doPreSaveFiltering(WikiContext context,
String pageData)
Does the filtering before a save to the page repository. |
String |
doPreTranslateFiltering(WikiContext context,
String pageData)
Does the filtering before a translation. |
void |
fireEvent(int type,
WikiContext context)
Fires a WikiPageEvent of the provided type and WikiContext. |
List |
getFilterList()
Returns the list of filters currently installed. |
protected void |
initialize(Properties props)
Initializes the filters from an XML file. |
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 |
|---|
public static final String PROP_FILTERXML
public static final String DEFAULT_XMLFILE
public static final int SYSTEM_FILTER_PRIORITY
public static final int USER_FILTER_PRIORITY
| Constructor Detail |
|---|
public FilterManager(WikiEngine engine,
Properties props)
throws WikiException
engine - The WikiEngine which owns the FilterManagerprops - Properties to initialize the FilterManager with
WikiException - If something goes wrong.| Method Detail |
|---|
public void addPageFilter(PageFilter f,
int priority)
throws IllegalArgumentException
In case two filters have the same priority, their execution order is the insertion order.
f - PageFilter to addpriority - The priority in which position to add it in.
IllegalArgumentException - If the PageFilter is null or invalid.
protected void initialize(Properties props)
throws WikiException
props - The list of properties. Typically jspwiki.properties
WikiException - If something goes wrong.
public String doPreTranslateFiltering(WikiContext context,
String pageData)
throws FilterException
context - The WikiContextpageData - WikiMarkup data to be passed through the preTranslate chain.
FilterException - If any of the filters throws a FilterExceptionPageFilter.preTranslate(WikiContext, String)
public String doPostTranslateFiltering(WikiContext context,
String htmlData)
throws FilterException
context - The WikiContexthtmlData - HTML data to be passed through the postTranslate
FilterException - If any of the filters throws a FilterExceptionPageFilter.postTranslate(WikiContext, String)
public String doPreSaveFiltering(WikiContext context,
String pageData)
throws FilterException
context - The WikiContextpageData - WikiMarkup data to be passed through the preSave chain.
FilterException - If any of the filters throws a FilterExceptionPageFilter.preSave(WikiContext, String)
public void doPostSaveFiltering(WikiContext context,
String pageData)
throws FilterException
context - The WikiContextpageData - WikiMarkup data to be passed through the postSave chain.
FilterException - If any of the filters throws a FilterExceptionPageFilter.postSave(WikiContext, String)public List getFilterList()
public void destroy()
public final void fireEvent(int type,
WikiContext context)
type - the WikiPageEvent type to be fired.context - the WikiContext of the event.WikiPageEventpublic Collection modules()
modules in class ModuleManager
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||