com.ecyrd.jspwiki.plugin
Class Denounce

java.lang.Object
  extended by com.ecyrd.jspwiki.plugin.Denounce
All Implemented Interfaces:
WikiPlugin

public class Denounce
extends Object
implements WikiPlugin

Denounces a link by removing it from any search engine. The bots are listed in com/ecyrd/jspwiki/plugin/denounce.properties.

Since:
2.1.40.
Author:
Janne Jalkanen

Field Summary
static String PARAM_LINK
           
static String PARAM_TEXT
           
static String PROP_AGENTPATTERN
           
static String PROP_DENOUNCETEXT
           
static String PROP_HOSTPATTERN
           
static String PROP_REFERERPATTERN
           
static String PROPERTYFILE
           
 
Constructor Summary
Denounce()
           
 
Method Summary
 String execute(WikiContext context, Map params)
          This is the main entry point for any plugin.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PARAM_LINK

public static final String PARAM_LINK
See Also:
Constant Field Values

PARAM_TEXT

public static final String PARAM_TEXT
See Also:
Constant Field Values

PROPERTYFILE

public static final String PROPERTYFILE
See Also:
Constant Field Values

PROP_AGENTPATTERN

public static final String PROP_AGENTPATTERN
See Also:
Constant Field Values

PROP_HOSTPATTERN

public static final String PROP_HOSTPATTERN
See Also:
Constant Field Values

PROP_REFERERPATTERN

public static final String PROP_REFERERPATTERN
See Also:
Constant Field Values

PROP_DENOUNCETEXT

public static final String PROP_DENOUNCETEXT
See Also:
Constant Field Values
Constructor Detail

Denounce

public Denounce()
Method Detail

execute

public String execute(WikiContext context,
                      Map params)
               throws PluginException
Description copied from interface: WikiPlugin
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.