org.ceryle.wiki.plugin.redirect
Class RedirectPlugin

java.lang.Object
  org.ceryle.wiki.plugin.redirect.RedirectPlugin

All Implemented Interfaces:

WikiPlugin

Direct Known Subclasses:

Redirect

public class RedirectPlugin
extends Object
implements WikiPlugin

Will return a fragment of javascript to do an automatic redirection.

Requires only one parameter 'to', which can be InterWiki link. If it cannot be interperated as an interwiki we assume it's some external link and just redirect to it as given. If it is an interwiki, we first expand it then redirect.

Warning: If you use this plugin it can be hard to actually edit the page that contains the redirect plugin instance, you must hand edit a URL or have an edit link elsewhere.

Usage:

    [{INSERT RedirectPlugin to='http://www.google.com' delay='0'}]
 

or

    [{INSERT RedirectPlugin to='JSPWiki:Main'}]
 

Author:

John Volkar (john.volkar at gmail.com)

Field Summary

Fields inherited from interface com.ecyrd.jspwiki.plugin.WikiPlugin

CORE_PLUGINS_RESOURCEBUNDLE

Constructor Summary

RedirectPlugin()

Method Summary

String

execute(WikiContext context, Map paramMap) Execute this plugin, look for the 'to' parameter, return fragment of JavaScript to do the redirection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RedirectPlugin

public RedirectPlugin()

Method Detail

execute

public String execute(WikiContext context,
                      Map paramMap)

Execute this plugin, look for the 'to' parameter, return fragment of JavaScript to do the redirection.

Specified by:

execute in interface WikiPlugin

See Also:

WikiPlugin.execute(com.ecyrd.jspwiki.WikiContext, java.util.Map)