com.xpn.xwiki.plugin.rightsmanager

Class RightsManagerPlugin

java.lang.Object

com.xpn.xwiki.plugin.XWikiDefaultPlugin

com.xpn.xwiki.plugin.rightsmanager.RightsManagerPlugin

All Implemented Interfaces:

XWikiPluginInterface

public class RightsManagerPlugin
extends XWikiDefaultPlugin

Entry point of the Rights Manager plugin.

Since:

1.1.2, 1.2M2

Version:

$Id: c567dfb0d970444ec0d9120e9c55576de3b5ec56 $

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	LOGGER The logging tool.
static String	PLUGIN_NAME Identifier of Wiki Manager plugin.

Constructor Summary

Constructors

Constructor and Description
RightsManagerPlugin(String name, String className, XWikiContext context) Construct the entry point of the Rights Manager plugin.

Method Summary

Modifier and Type	Method and Description
Api	getPluginApi(XWikiPluginInterface plugin, XWikiContext context) Get a public scriptable API that can be used to call methods of the (privileged) plugin.
void	init(XWikiContext context) Global initialization, called when the platform is started and the plugin list is initialized.

Methods inherited from class com.xpn.xwiki.plugin.XWikiDefaultPlugin

beginParsing, beginRendering, commonTagsHandler, downloadAttachment, endParsing, endRendering, endRenderingHandler, flushCache, flushCache, getClassName, getLocalization, getName, insidePREHandler, localizePlainOrKey, outsidePREHandler, setClassName, setName, startRenderingHandler, virtualInit

Methods inherited from class java.lang.Object

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

Field Detail

PLUGIN_NAME

public static final String PLUGIN_NAME

Identifier of Wiki Manager plugin.

See Also:

Constant Field Values

LOGGER

protected static final org.slf4j.Logger LOGGER

The logging tool.

Constructor Detail

RightsManagerPlugin

public RightsManagerPlugin(String name,
                           String className,
                           XWikiContext context)

Construct the entry point of the Rights Manager plugin.

Parameters:

name - the identifier of the plugin.

className - the class name of the entry point of the plugin.

context - the XWiki context.

Method Detail

init

public void init(XWikiContext context)

Description copied from interface: XWikiPluginInterface

Global initialization, called when the platform is started and the plugin list is initialized.

Specified by:

init in interface XWikiPluginInterface

Overrides:

init in class XWikiDefaultPlugin

Parameters:

context - the current context, should not be stored since it will become mostly unreliable once the initial request is terminated

getPluginApi

public Api getPluginApi(XWikiPluginInterface plugin,
                        XWikiContext context)

Description copied from interface: XWikiPluginInterface

Get a public scriptable API that can be used to call methods of the (privileged) plugin.

Specified by:

getPluginApi in interface XWikiPluginInterface

Overrides:

getPluginApi in class XWikiDefaultPlugin

Parameters:

plugin - the plugin instance to wrap

context - the current request context

Returns:

an instance of the corresponding API, or null if the plugin doesn't want to expose a public API