|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.xpn.xwiki.api.Api
com.xpn.xwiki.plugin.PluginApi<T>
T
- The type of the internal plugin.
@Deprecated public class PluginApi<T extends XWikiPluginInterface>
Base class for all plugin APIs. API Objects are the Java Objects that can be manipulated from Velocity or Groovy scripts in XWiki documents. They wrap around a fully functional and privileged Plugin object, and forward safe calls to that object.
Field Summary |
---|
Fields inherited from class com.xpn.xwiki.api.Api |
---|
context |
Constructor Summary | |
---|---|
PluginApi(T plugin,
XWikiContext context)
Deprecated. API constructor. |
Method Summary | |
---|---|
T |
getInternalPlugin()
Deprecated. Return the inner plugin object, if the user has the required programming rights. |
protected T |
getProtectedPlugin()
Deprecated. Return the inner plugin object. |
void |
setPlugin(T plugin)
Deprecated. Set the inner plugin object. |
Methods inherited from class com.xpn.xwiki.api.Api |
---|
convert, convert, getXWikiContext, hasAccessLevel, hasAdminRights, hasProgrammingRights, hasWikiAdminRights |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PluginApi(T plugin, XWikiContext context)
plugin
- The wrapped plugin object.context
- Context of the request.Method Detail |
---|
protected T getProtectedPlugin()
public T getInternalPlugin()
public void setPlugin(T plugin)
plugin
- The wrapped plugin object.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |