org.apache.wiki.plugin
Class RPCSamplePlugin
java.lang.Object
org.apache.wiki.plugin.RPCSamplePlugin
- All Implemented Interfaces:
- WikiPlugin, RPCCallable
public class RPCSamplePlugin
- extends Object
- implements WikiPlugin, RPCCallable
Simple plugin which shows how to add JSON calls to your plugin.
Parameters :
NONE
- Since:
- 2.5.4
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
RPCSamplePlugin
public RPCSamplePlugin()
myFunction
public String myFunction(String echo)
- This method is called when the Javascript is encountered by
the browser.
- Parameters:
echo
- The parameter
- Returns:
- the string
JSON says:
, plus the value
supplied by the echo
parameter
Parameters :
NONE
execute
public String execute(WikiContext context,
Map<String,String> params)
throws PluginException
- 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 interface WikiPlugin
- 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.
Copyright © {inceptionYear}-2014 The Apache Software Foundation. All rights reserved.