Package org.apache.wiki.plugin
Class SampleAjaxPlugin
java.lang.Object
org.apache.wiki.plugin.SampleAjaxPlugin
- All Implemented Interfaces:
WikiAjaxServlet
,Plugin
public class SampleAjaxPlugin extends Object implements Plugin, WikiAjaxServlet
- Since:
- 2.10.2-svn10
-
Field Summary
Fields inherited from interface org.apache.wiki.api.plugin.Plugin
CORE_PLUGINS_RESOURCEBUNDLE
-
Constructor Summary
Constructors Constructor Description SampleAjaxPlugin()
-
Method Summary
Modifier and Type Method Description String
execute(Context context, Map<String,String> params)
This is the main entry point for any plugin.String
getServletMapping()
void
service(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String actionName, List<String> params)
-
Constructor Details
-
SampleAjaxPlugin
public SampleAjaxPlugin()
-
-
Method Details
-
execute
Description copied from interface:Plugin
This is the main entry point for any plugin. The parameters are parsed, and a special parameter called "_body" signifies the name of the plugin body, i.e. the part of the plugin that is not a parameter of the form "key=value". This has been separated using an empty line.Note that it is preferred that the plugin returns XHTML-compliant HTML (i.e. close all tags, use <br /> instead of <br>, etc.
- Specified by:
execute
in interfacePlugin
- Parameters:
context
- The current WikiContext.params
- A Map which contains key-value pairs. Any parameter that the user has specified on the wiki page will contain String-String parameters, but it is possible that at some future date, JSPWiki will give you other things that are not Strings.- Returns:
- HTML, ready to be included into the rendered page.
- Throws:
PluginException
- In case anything goes wrong.
-
getServletMapping
- Specified by:
getServletMapping
in interfaceWikiAjaxServlet
-
service
public void service(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String actionName, List<String> params) throws javax.servlet.ServletException, IOException- Specified by:
service
in interfaceWikiAjaxServlet
- Throws:
javax.servlet.ServletException
IOException
-