public interface FilterManager
Modifier and Type | Field and Description |
---|---|
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.
|
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,
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.
|
List<PageFilter> |
getFilterList()
Returns the list of filters currently installed.
|
WikiModuleInfo |
getModuleInfo(String filterName)
Returns the
WikiModuleInfo information about the provided filterName. |
Collection |
modules()
Returns a collection of modules currently managed by this ModuleManager.
|
static final String PROP_FILTERXML
static final String DEFAULT_XMLFILE
static final int SYSTEM_FILTER_PRIORITY
static final int USER_FILTER_PRIORITY
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.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)
String doPostTranslateFiltering(WikiContext context, String htmlData) throws FilterException
context
- The WikiContexthtmlData
- HTML data to be passed through the postTranslateFilterException
- If any of the filters throws a FilterExceptionPageFilter.postTranslate(WikiContext, String)
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)
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)
List<PageFilter> getFilterList()
void destroy()
Collection modules()
WikiModuleInfo
class. This method should return something
which is safe to iterate over, even if the underlying collection changes.WikiModuleInfo
instances.WikiModuleInfo getModuleInfo(String filterName)
WikiModuleInfo
information about the provided filterName.filterName
- Copyright © 2001-2018 The Apache Software Foundation. All rights reserved.