Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 4E83C200CBC for ; Tue, 20 Jun 2017 18:19:46 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 4D410160BEF; Tue, 20 Jun 2017 16:19:46 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 31FE7160C09 for ; Tue, 20 Jun 2017 18:19:43 +0200 (CEST) Received: (qmail 68075 invoked by uid 500); 20 Jun 2017 16:19:42 -0000 Mailing-List: contact commits-help@jspwiki.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@jspwiki.apache.org Delivered-To: mailing list commits@jspwiki.apache.org Received: (qmail 67460 invoked by uid 99); 20 Jun 2017 16:19:40 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 20 Jun 2017 16:19:40 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id C432BE112D; Tue, 20 Jun 2017 16:19:39 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit From: juanpablo@apache.org To: commits@jspwiki.apache.org Date: Tue, 20 Jun 2017 16:20:12 -0000 Message-Id: <4d7b86057dd6410ca1975f0206c42b76@git.apache.org> In-Reply-To: <14ae8e698c93460fb84035fc8f60e577@git.apache.org> References: <14ae8e698c93460fb84035fc8f60e577@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [35/51] [partial] jspwiki-site git commit: Manual testing of new & upcoming ci.sh / mvn-ci.sh on jbake branch archived-at: Tue, 20 Jun 2017 16:19:46 -0000 http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/04f45623/apidocs/2.10.1/org/apache/wiki/api/engine/FilterManager.html ---------------------------------------------------------------------- diff --git a/apidocs/2.10.1/org/apache/wiki/api/engine/FilterManager.html b/apidocs/2.10.1/org/apache/wiki/api/engine/FilterManager.html new file mode 100755 index 0000000..78dc95f --- /dev/null +++ b/apidocs/2.10.1/org/apache/wiki/api/engine/FilterManager.html @@ -0,0 +1,502 @@ + + + + + + + +FilterManager (Apache JSPWiki Main War 2.10.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.apache.wiki.api.engine +
+Interface FilterManager

+
+
All Known Implementing Classes:
DefaultFilterManager
+
+
+
+
public interface FilterManager
+ + + + + +
+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static StringDEFAULT_XMLFILE + +
+          Default location for the filter XML property file.
+static StringPROP_FILTERXML + +
+          Property name for setting the filter XML property file.
+static intSYSTEM_FILTER_PRIORITY + +
+          JSPWiki system filters are all below this value.
+static intUSER_FILTER_PRIORITY + +
+          The standard user level filtering.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddPageFilter(PageFilter f, + int priority) + +
+          Adds a page filter to the queue.
+ voiddestroy() + +
+          Notifies PageFilters to clean up their ressources.
+ voiddoPostSaveFiltering(WikiContext context, + String pageData) + +
+          Does the page filtering after the page has been saved.
+ StringdoPostTranslateFiltering(WikiContext context, + String htmlData) + +
+          Does the filtering after HTML translation.
+ StringdoPreSaveFiltering(WikiContext context, + String pageData) + +
+          Does the filtering before a save to the page repository.
+ StringdoPreTranslateFiltering(WikiContext context, + String pageData) + +
+          Does the filtering before a translation.
+ List<PageFilter>getFilterList() + +
+          Returns the list of filters currently installed.
+ Collectionmodules() + +
+          Returns a collection of modules currently managed by this ModuleManager.
+  +

+ + + + + + + + +
+Field Detail
+ +

+PROP_FILTERXML

+
+static final String PROP_FILTERXML
+
+
Property name for setting the filter XML property file. Value is "jspwiki.filterConfig". +

+

+
See Also:
Constant Field Values
+
+
+ +

+DEFAULT_XMLFILE

+
+static final 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

+
+static final int SYSTEM_FILTER_PRIORITY
+
+
JSPWiki system filters are all below this value. +

+

+
See Also:
Constant Field Values
+
+
+ +

+USER_FILTER_PRIORITY

+
+static final int USER_FILTER_PRIORITY
+
+
The standard user level filtering. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Method Detail
+ +

+addPageFilter

+
+void addPageFilter(PageFilter f,
+                   int priority)
+                   throws 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: +
IllegalArgumentException - If the PageFilter is null or invalid.
Since:
+
2.1.44.
+
+
+
+
+ +

+doPreTranslateFiltering

+
+String doPreTranslateFiltering(WikiContext context,
+                               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

+
+String doPostTranslateFiltering(WikiContext context,
+                                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

+
+String doPreSaveFiltering(WikiContext context,
+                          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

+
+void doPostSaveFiltering(WikiContext context,
+                         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

+
+List<PageFilter> 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

+
+void destroy()
+
+
Notifies PageFilters to clean up their ressources. +

+

+
+
+
+
+ +

+modules

+
+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. +

+

+ +
Returns:
A Collection of WikiModuleInfo instances.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © {inceptionYear}-2014 The Apache Software Foundation. All rights reserved. + + http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/04f45623/apidocs/2.10.1/org/apache/wiki/api/engine/FilterManager.png ---------------------------------------------------------------------- diff --git a/apidocs/2.10.1/org/apache/wiki/api/engine/FilterManager.png b/apidocs/2.10.1/org/apache/wiki/api/engine/FilterManager.png new file mode 100755 index 0000000..cf6db67 Binary files /dev/null and b/apidocs/2.10.1/org/apache/wiki/api/engine/FilterManager.png differ http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/04f45623/apidocs/2.10.1/org/apache/wiki/api/engine/PluginManager.html ---------------------------------------------------------------------- diff --git a/apidocs/2.10.1/org/apache/wiki/api/engine/PluginManager.html b/apidocs/2.10.1/org/apache/wiki/api/engine/PluginManager.html new file mode 100755 index 0000000..3f1af6f --- /dev/null +++ b/apidocs/2.10.1/org/apache/wiki/api/engine/PluginManager.html @@ -0,0 +1,602 @@ + + + + + + + +PluginManager (Apache JSPWiki Main War 2.10.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.apache.wiki.api.engine +
+Interface PluginManager

+
+
All Known Implementing Classes:
DefaultPluginManager
+
+
+
+
public interface PluginManager
+ + + + + +
+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static StringDEFAULT_PACKAGE + +
+          This is the default package to try in case the instantiation fails.
+static StringPARAM_BODY + +
+          The name of the body content.
+static StringPARAM_BOUNDS + +
+          The name of the parameter containing the start and end positions in the + read stream of the plugin text (stored as a two-element int[], start + and end resp.).
+static StringPARAM_CMDLINE + +
+          The name of the command line content parameter.
+static StringPARAM_DEBUG + +
+          A special name to be used in case you want to see debug output
+static StringPROP_EXTERNALJARS + +
+          The property name defining which external jars will be added to the classpath when searching for plugin classes.
+static StringPROP_SEARCHPATH + +
+          The property name defining which packages will be searched for plugin classes.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidenablePlugins(boolean enabled) + +
+          Enables or disables plugin execution.
+ Stringexecute(WikiContext context, + String commandline) + +
+          Parses a plugin.
+ Stringexecute(WikiContext context, + String classname, + Map<String,String> params) + +
+          Executes a plugin class in the given context.
+ org.apache.oro.text.regex.PatterngetPluginPattern() + +
+          Returns plugin insert pattern.
+ StringgetPluginSearchPath() + +
+          Returns plugins' search path.
+ Collectionmodules() + +
+          Returns a collection of modules currently managed by this ModuleManager.
+ WikiPluginnewWikiPlugin(String pluginName, + ResourceBundle rb) + +
+          Creates a WikiPlugin.
+ Map<String,String>parseArgs(String argstring) + +
+          Parses plugin arguments.
+ booleanpluginsEnabled() + +
+          Returns plugin execution status.
+  +

+ + + + + + + + +
+Field Detail
+ +

+PROP_SEARCHPATH

+
+static final String PROP_SEARCHPATH
+
+
The property name defining which packages will be searched for plugin classes. +

+

+
See Also:
Constant Field Values
+
+
+ +

+PROP_EXTERNALJARS

+
+static final String PROP_EXTERNALJARS
+
+
The property name defining which external jars will be added to the classpath when searching for plugin classes. +

+

+
See Also:
Constant Field Values
+
+
+ +

+DEFAULT_PACKAGE

+
+static final String DEFAULT_PACKAGE
+
+
This is the default package to try in case the instantiation fails. +

+

+
See Also:
Constant Field Values
+
+
+ +

+PARAM_BODY

+
+static final String PARAM_BODY
+
+
The name of the body content. Current value is "_body". +

+

+
See Also:
Constant Field Values
+
+
+ +

+PARAM_CMDLINE

+
+static final String PARAM_CMDLINE
+
+
The name of the command line content parameter. The value is "_cmdline". +

+

+
See Also:
Constant Field Values
+
+
+ +

+PARAM_BOUNDS

+
+static final String PARAM_BOUNDS
+
+
The name of the parameter containing the start and end positions in the + read stream of the plugin text (stored as a two-element int[], start + and end resp.). +

+

+
See Also:
Constant Field Values
+
+
+ +

+PARAM_DEBUG

+
+static final String PARAM_DEBUG
+
+
A special name to be used in case you want to see debug output +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Method Detail
+ +

+enablePlugins

+
+void enablePlugins(boolean enabled)
+
+
Enables or disables plugin execution. +

+

+
Parameters:
enabled - True, if plugins should be globally enabled; false, if disabled.
+
+
+
+ +

+pluginsEnabled

+
+boolean pluginsEnabled()
+
+
Returns plugin execution status. If false, plugins are not + executed when they are encountered on a WikiPage, and an + empty string is returned in their place. +

+

+ +
Returns:
True, if plugins are enabled; false otherwise.
+
+
+
+ +

+getPluginPattern

+
+org.apache.oro.text.regex.Pattern getPluginPattern()
+
+
Returns plugin insert pattern. +

+

+ +
Returns:
plugin insert pattern.
+
+
+
+ +

+getPluginSearchPath

+
+String getPluginSearchPath()
+
+
Returns plugins' search path. +

+

+ +
Returns:
plugins' search path.
+
+
+
+ +

+execute

+
+String execute(WikiContext context,
+               String classname,
+               Map<String,String> params)
+               throws PluginException
+
+
Executes a plugin class in the given context. +

Used to be private, but is public since 1.9.21. +

+

+
Parameters:
context - The current WikiContext.
classname - The name of the class. Can also be a + shortened version without the package name, since the class name is searched from the + package search path.
params - A parsed map of key-value pairs. +
Returns:
Whatever the plugin returns. +
Throws: +
PluginException - If the plugin execution failed for + some reason.
Since:
+
2.0
+
+
+
+
+ +

+parseArgs

+
+Map<String,String> parseArgs(String argstring)
+                             throws IOException
+
+
Parses plugin arguments. Handles quotes and all other kewl stuff. + +

Special parameters

+ The plugin body is put into a special parameter defined by PARAM_BODY; + the plugin's command line into a parameter defined by PARAM_CMDLINE; + and the bounds of the plugin within the wiki page text by a parameter defined + by PARAM_BOUNDS, whose value is stored as a two-element int[] array, + i.e., [start,end]. +

+

+
Parameters:
argstring - The argument string to the plugin. This is + typically a list of key-value pairs, using "'" to escape + spaces in strings, followed by an empty line and then the + plugin body. In case the parameter is null, will return an + empty parameter list. +
Returns:
A parsed list of parameters. +
Throws: +
IOException - If the parsing fails.
+
+
+
+ +

+execute

+
+String execute(WikiContext context,
+               String commandline)
+               throws PluginException
+
+
Parses a plugin. Plugin commands are of the form: + [{INSERT myplugin WHERE param1=value1, param2=value2}] + myplugin may either be a class name or a plugin alias. +

+ This is the main entry point that is used. +

+

+
Parameters:
context - The current WikiContext.
commandline - The full command line, including plugin + name, parameters and body. +
Returns:
HTML as returned by the plugin, or possibly an error + message. +
Throws: +
PluginException - From the plugin itself, it propagates, waah!
+
+
+
+ +

+modules

+
+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. +

+

+ +
Returns:
A Collection of WikiModuleInfo instances.
+
+
+
+ +

+newWikiPlugin

+
+WikiPlugin newWikiPlugin(String pluginName,
+                         ResourceBundle rb)
+                         throws PluginException
+
+
Creates a WikiPlugin. +

+

+
Parameters:
pluginName - plugin's classname
rb - ResourceBundle with i18ned text for exceptions. +
Returns:
a WikiPlugin. +
Throws: +
PluginException - if there is a problem building the WikiPlugin.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © {inceptionYear}-2014 The Apache Software Foundation. All rights reserved. + + http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/04f45623/apidocs/2.10.1/org/apache/wiki/api/engine/PluginManager.png ---------------------------------------------------------------------- diff --git a/apidocs/2.10.1/org/apache/wiki/api/engine/PluginManager.png b/apidocs/2.10.1/org/apache/wiki/api/engine/PluginManager.png new file mode 100755 index 0000000..58dd454 Binary files /dev/null and b/apidocs/2.10.1/org/apache/wiki/api/engine/PluginManager.png differ http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/04f45623/apidocs/2.10.1/org/apache/wiki/api/engine/class-use/AdminBeanManager.html ---------------------------------------------------------------------- diff --git a/apidocs/2.10.1/org/apache/wiki/api/engine/class-use/AdminBeanManager.html b/apidocs/2.10.1/org/apache/wiki/api/engine/class-use/AdminBeanManager.html new file mode 100755 index 0000000..03e7a93 --- /dev/null +++ b/apidocs/2.10.1/org/apache/wiki/api/engine/class-use/AdminBeanManager.html @@ -0,0 +1,210 @@ + + + + + + + +Uses of Interface org.apache.wiki.api.engine.AdminBeanManager (Apache JSPWiki Main War 2.10.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
org.apache.wiki.api.engine.AdminBeanManager

+
+ + + + + + + + + + + + + +
+Packages that use AdminBeanManager
org.apache.wikiThe chief package of JSPWiki. 
org.apache.wiki.ui.adminContains classes for the JSPWiki administrative interface. 
+  +

+ + + + + +
+Uses of AdminBeanManager in org.apache.wiki
+  +

+ + + + + + + + + +
Methods in org.apache.wiki that return AdminBeanManager
+ AdminBeanManagerWikiEngine.getAdminBeanManager() + +
+          Returns the current AdminBeanManager.
+  +

+ + + + + +
+Uses of AdminBeanManager in org.apache.wiki.ui.admin
+  +

+ + + + + + + + + +
Classes in org.apache.wiki.ui.admin that implement AdminBeanManager
+ classDefaultAdminBeanManager + +
+          Provides a manager class for all AdminBeans within JSPWiki.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © {inceptionYear}-2014 The Apache Software Foundation. All rights reserved. + + http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/04f45623/apidocs/2.10.1/org/apache/wiki/api/engine/class-use/FilterManager.html ---------------------------------------------------------------------- diff --git a/apidocs/2.10.1/org/apache/wiki/api/engine/class-use/FilterManager.html b/apidocs/2.10.1/org/apache/wiki/api/engine/class-use/FilterManager.html new file mode 100755 index 0000000..b3d0440 --- /dev/null +++ b/apidocs/2.10.1/org/apache/wiki/api/engine/class-use/FilterManager.html @@ -0,0 +1,219 @@ + + + + + + + +Uses of Interface org.apache.wiki.api.engine.FilterManager (Apache JSPWiki Main War 2.10.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
org.apache.wiki.api.engine.FilterManager

+
+ + + + + + + + + + + + + +
+Packages that use FilterManager
org.apache.wikiThe chief package of JSPWiki. 
org.apache.wiki.filtersProvides page and content filtering functionality for JSPWiki. 
+  +

+ + + + + +
+Uses of FilterManager in org.apache.wiki
+  +

+ + + + + + + + + +
Methods in org.apache.wiki with type parameters of type FilterManager
+ + + + + +
+<T extends FilterManager> +
+T
+
WikiEngine.getFilterManager() + +
+          Returns the manager responsible for the filters.
+  +

+ + + + + +
+Uses of FilterManager in org.apache.wiki.filters
+  +

+ + + + + + + + + +
Classes in org.apache.wiki.filters that implement FilterManager
+ classDefaultFilterManager + +
+          Manages the page filters.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © {inceptionYear}-2014 The Apache Software Foundation. All rights reserved. + +