|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ecyrd.jspwiki.filters.FilterManager
public 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
|
static String |
PROP_FILTERXML
|
static int |
SYSTEM_FILTER_PRIORITY
JSPWiki system filters are all below this value. |
static int |
USER_FILTER_PRIORITY
The standard user level filtering. |
Constructor Summary | |
---|---|
FilterManager(WikiEngine engine,
Properties props)
|
Method Summary | |
---|---|
void |
addPageFilter(PageFilter f,
int priority)
Adds a page filter to the queue. |
void |
doPostSaveFiltering(WikiContext context,
String pageData)
Does the page filtering after the page has been saved. |
String |
doPostTranslateFiltering(WikiContext context,
String pageData)
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. |
List |
getFilterList()
|
void |
initialize(WikiEngine engine,
Properties props)
Initializes the filters from an XML file. |
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
WikiException
Method Detail |
---|
public void addPageFilter(PageFilter f, int priority)
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.public void initialize(WikiEngine engine, Properties props) throws WikiException
WikiException
public String doPreTranslateFiltering(WikiContext context, String pageData) throws FilterException
FilterException
public String doPostTranslateFiltering(WikiContext context, String pageData) throws FilterException
FilterException
public String doPreSaveFiltering(WikiContext context, String pageData) throws FilterException
FilterException
public void doPostSaveFiltering(WikiContext context, String pageData) throws FilterException
FilterException
public List getFilterList()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |