A C D E F G I L M N P S T U W X

A

addParameter(Object) - Method in class com.xpn.xwiki.plugin.globalsearch.tools.GlobalSearchQuery

addParameterList(Collection<?>) - Method in class com.xpn.xwiki.plugin.globalsearch.tools.GlobalSearchQuery

addWikiName(String) - Method in class com.xpn.xwiki.plugin.globalsearch.tools.GlobalSearchQuery

addWikiNameList(Collection<String>) - Method in class com.xpn.xwiki.plugin.globalsearch.tools.GlobalSearchQuery

C

canCreateWiki(XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManager

canCreateWiki() - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi

canDeleteWiki(XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManager

canDeleteWiki() - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi

canEditWiki(XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManager

canEditWiki() - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi

check(XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

com.xpn.xwiki.plugin.globalsearch - package com.xpn.xwiki.plugin.globalsearch

com.xpn.xwiki.plugin.globalsearch.tools - package com.xpn.xwiki.plugin.globalsearch.tools

com.xpn.xwiki.plugin.wikimanager - package com.xpn.xwiki.plugin.wikimanager

com.xpn.xwiki.plugin.wikimanager.doc - package com.xpn.xwiki.plugin.wikimanager.doc

COMMENT_CREATEEMPTYWIKI - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Used as comment when creating a new empty wiki.

COMMENT_CREATEWIKIFROMPACKAGE - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Used as comment when creating a new wiki from XAR package.

COMMENT_CREATEWIKIFROMTEMPLATE - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Used as comment when creating a new wiki from wiki template.

COMMENT_CREATEWIKITEMPLATE - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Used as comment when creating a new wiki template.

containsWikiAlias(String) - Method in class com.xpn.xwiki.plugin.wikimanager.doc.Wiki

Check if a wiki alias with provided name exists.

CONTEXT_LASTERRORCODE - Static variable in class com.xpn.xwiki.plugin.globalsearch.GlobalSearchPluginApi

Field name of the last error code inserted in context.

CONTEXT_LASTERRORCODE - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi

Field name of the last error code inserted in context.

CONTEXT_LASTEXCEPTION - Static variable in class com.xpn.xwiki.plugin.globalsearch.GlobalSearchPluginApi

Field name of the last API exception inserted in context.

CONTEXT_LASTEXCEPTION - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi

Field name of the last API exception inserted in context.

copyWiki(String, String, String, XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiCopy

Copy all documents from sourceWiki wiki to targetWiki wiki.

countWikiAliases() - Method in class com.xpn.xwiki.plugin.wikimanager.doc.Wiki

createNewWiki(XWikiServer, boolean, String, XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManager

Create a new empty virtual wiki.

createNewWiki(XWikiServer, boolean, String, String, String, XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManager

Create new wiki.

createNewWiki(String, String, String, XWikiServer, boolean) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi

Create a new wiki from template.

createNewWikiFromPackage(XWikiServer, String, boolean, String, XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManager

Create a new virtual wiki.

createNewWikiFromTemplate(XWikiServer, String, boolean, String, XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManager

Create a new virtual wiki.

createWikiDocument() - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi

Create an empty not saved XWikiServer.

createWikiTemplate(XWikiServer, String, String, XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManager

Create a template wiki.

createWikiTemplate(String, String, String) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi

Create a new xiki with XWikiServerClass "visibility" field set to "template".

D

DEFAULT_FIELDS - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Default list separators of XWiki.XWikiServerClass fields.

DEFAULT_HOMEPAGE - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

The full name of the default home page of a newly created wiki.

DEFAULT_ISWIKITEMPLATE - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Default value of field iswikitemplate for the XWiki class XWiki.XWikiServerClass.

DEFAULT_PAGE_PARENT - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

The full name of the default parent of a newly created document.

DEFAULT_SECURE - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Default value of field secure for the XWiki class XWiki.XWikiServerClass.

delete(boolean) - Method in class com.xpn.xwiki.plugin.wikimanager.doc.Wiki

Delete the wiki.

deleteWiki(String, boolean, XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManager

Delete an existing wiki.

deleteWiki(String, boolean) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi

Delete wiki descriptor document and wiki's database.

deleteWiki(String) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi

Delete wiki descriptor document and wiki's database.

deleteWiki(String, int) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi

Deprecated. Use WikiManagerPluginApi.deleteWikiAlias(String, int) since 1.1.

deleteWikiAlias(String, int, XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManager

Delete an existing wiki alias.

deleteWikiAlias(String, int) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi

Delete wiki descriptor alias document from database.

E

ERROR_CANTACCESSFIELD - Static variable in class com.xpn.xwiki.plugin.globalsearch.GlobalSearchMessageTool

Used as GlobalSearchException message when provided field does not exist in the document.

ERROR_DELETEMAINWIKI - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Used as WikiManagerException message when trying to delete the main wiki.

ERROR_DESCRIPTORALREADYEXISTS - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Used as WikiManagerException message when trying to create a new wiki with a wiki descriptor that already exist.

ERROR_DOCUMENTTRANSLATIONS - Static variable in class com.xpn.xwiki.plugin.globalsearch.GlobalSearchMessageTool

Used as GlobalSearchException message when failed to get document translations.

ERROR_FS_CANT_ACCESS_FIELD - Static variable in exception com.xpn.xwiki.plugin.globalsearch.GlobalSearchException

Error when trying to create wiki descriptor that already exists.

ERROR_PACKAGEDOESNOTEXISTS - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Used as WikiManagerException message when provided XAR package does not exists.

ERROR_PACKAGEIMPORT - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Used as WikiManagerException message when failed to load XAR package as list of XWikiDocument.

ERROR_PACKAGEINSTALL - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Used as WikiManagerException message when failed to insert loaded XWikiDocument from package into database.

ERROR_RIGHTTOCREATEWIKI - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Used as WikiManagerException message when trying to create wiki when it's not administrator user.

ERROR_RIGHTTODELETEWIKI - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Used as WikiManagerException message when trying to delete wiki when it's not administrator user.

ERROR_UPDATEDATABASE - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Used as WikiManagerException message when call to XWiki.updateDatabase(String, XWikiContext) failed.

ERROR_USERDOESNOTEXIST - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Used as WikiManagerException message when provided user does not exists.

ERROR_USERNOTACTIVE - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Used as WikiManagerException message when provided user is not active.

ERROR_WIKIALIASDOESNOTEXISTS - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Used as WikiManagerException message when trying to get a wiki alias which does not exists.

ERROR_WIKIDOESNOTEXISTS - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Used as WikiManagerException message when trying to get a wiki which does not exists.

ERROR_WIKINAMEFORBIDDEN - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Used as WikiManagerException message when tring to create a new wiki with a wiki name forbidden.

ERROR_WIKITEMPLATEALIASDOESNOTEXISTS - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Used as WikiManagerException message when trying to delete wiki with not administrator user.

ERROR_WM_PACKAGEDOESNOTEXISTS - Static variable in exception com.xpn.xwiki.plugin.wikimanager.WikiManagerException

Error when trying to get an attached XAR package that does not exists.

ERROR_WM_PACKAGEIMPORT - Static variable in exception com.xpn.xwiki.plugin.wikimanager.WikiManagerException

Error when trying to load a XAR package file in a list of XWikiDocument.

ERROR_WM_PACKAGEINSTALL - Static variable in exception com.xpn.xwiki.plugin.wikimanager.WikiManagerException

Error when trying to insert in wiki a loaded XAR package list of XWikiDocument.

ERROR_WM_UPDATEDATABASE - Static variable in exception com.xpn.xwiki.plugin.wikimanager.WikiManagerException

Error when trying to update the database/schema.

ERROR_WM_WIKIALIASDOESNOTEXISTS - Static variable in exception com.xpn.xwiki.plugin.wikimanager.WikiManagerException

Error when trying to get a provided wiki alias that does not exist.

ERROR_WM_WIKIALREADYEXISTS - Static variable in exception com.xpn.xwiki.plugin.wikimanager.WikiManagerException

Error when trying to create wiki descriptor that already exists.

ERROR_WM_WIKIDOESNOTEXISTS - Static variable in exception com.xpn.xwiki.plugin.wikimanager.WikiManagerException

Error when trying to use a provided wiki descriptor that does not exist.

ERROR_WM_WIKINAMEFORBIDDEN - Static variable in exception com.xpn.xwiki.plugin.wikimanager.WikiManagerException

Error when trying to create a wiki with a forbidden provided name.

ERROR_WM_XWIKINOTVIRTUAL - Static variable in exception com.xpn.xwiki.plugin.wikimanager.WikiManagerException

Error when trying to execute action that need xwiki engine to be in virtual mode and is not.

ERROR_XWIKI_USERDOESNOTEXIST - Static variable in exception com.xpn.xwiki.plugin.wikimanager.WikiManagerException

Error when trying to use provided user that does not exists.

ERROR_XWIKINOTVIRTUAL - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Used as WikiManagerException message when trying to make action that require virtual mode in a wiki not in virtual mode.

F

FIELD_DESCRIPTION - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Name of field description for the XWiki class XWiki.XWikiServerClass.

FIELD_HOMEPAGE - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Name of field homepage for the XWiki class XWiki.XWikiServerClass.

FIELD_ISWIKITEMPLATE - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Name of field iswikitemplate for the XWiki class XWiki.XWikiServerClass.

FIELD_LANGUAGE - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Name of field language for the XWiki class XWiki.XWikiServerClass.

FIELD_OWNER - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Name of field owner for the XWiki class XWiki.XWikiServerClass.

FIELD_SECURE - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Name of field secure for the XWiki class XWiki.XWikiServerClass.

FIELD_SERVER - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Name of field server for the XWiki class XWiki.XWikiServerClass.

FIELD_STATE - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Name of field state for the XWiki class XWiki.XWikiServerClass.

FIELD_VISIBILITY - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Name of field visibility for the XWiki class XWiki.XWikiServerClass.

FIELD_WIKIPRETTYNAME - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Name of field prettyname for the XWiki class XWiki.XWikiServerClass.

FIELDDT_ISWIKITEMPLATE - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Display type of field iswikitemplate for the XWiki class XWiki.XWikiServerClass.

FIELDDT_SECURE - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Display type of field secure for the XWiki class XWiki.XWikiServerClass.

FIELDDV_ISWIKITEMPLATE_INT - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Default value of field iswikitemplate for the XWiki class XWiki.XWikiServerClass.

FIELDL_LANGUAGE - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

List of possible values for language for the XWiki class XWiki.XWikiServerClass.

FIELDL_STATE - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

List of possible values for state for the XWiki class XWiki.XWikiServerClass.

FIELDL_STATE_ACTIVE - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

First possible values for state for the XWiki class XWiki.XWikiServerClass.

FIELDL_STATE_INACTIVE - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Second possible values for state for the XWiki class XWiki.XWikiServerClass.

FIELDL_STATE_LOCKED - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Third possible values for state for the XWiki class XWiki.XWikiServerClass.

FIELDL_VISIBILITY - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

List of possible values for visibility for the XWiki class XWiki.XWikiServerClass.

FIELDL_VISIBILITY_PRIVATE - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Second possible values for visibility for the XWiki class XWiki.XWikiServerClass.

FIELDL_VISIBILITY_PUBLIC - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

First possible values for visibility for the XWiki class XWiki.XWikiServerClass.

FIELDPN_DESCRIPTION - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Pretty name of field description for the XWiki class XWiki.XWikiServerClass.

FIELDPN_HOMEPAGE - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Pretty name of field homepage for the XWiki class XWiki.XWikiServerClass.

FIELDPN_ISWIKITEMPLATE - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Pretty name of field iswikitemplate for the XWiki class XWiki.XWikiServerClass.

FIELDPN_LANGUAGE - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Pretty name of field language for the XWiki class XWiki.XWikiServerClass.

FIELDPN_OWNER - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Pretty name of field owner for the XWiki class XWiki.XWikiServerClass.

FIELDPN_SECURE - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Pretty name of field secure for the XWiki class XWiki.XWikiServerClass.

FIELDPN_SERVER - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Pretty name of field server for the XWiki class XWiki.XWikiServerClass.

FIELDPN_STATE - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Pretty name of field state for the XWiki class XWiki.XWikiServerClass.

FIELDPN_VISIBILITY - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Pretty name of field visibility for the XWiki class XWiki.XWikiServerClass.

FIELDPN_WIKIPRETTYNAME - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Pretty name of field prettyname for the XWiki class XWiki.XWikiServerClass.

forceValidDocumentName() - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

G

getAllWikis(XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManager

Get all Wiki.

getAllWikis() - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi

getDefault(XWikiContext) - Static method in class com.xpn.xwiki.plugin.globalsearch.GlobalSearchMessageTool

Get Global Search message tool registered in XWiki context.

getDefault(XWikiContext) - Static method in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Get Wiki Manager message tool registered in XWiki context.

getDefaultException() - Static method in exception com.xpn.xwiki.plugin.globalsearch.GlobalSearchException

getDefaultException() - Static method in exception com.xpn.xwiki.plugin.wikimanager.WikiManagerException

getDefaultException() - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi

getDescription() - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServer

getDocument(String, String, XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManager

Encapsulate XWiki.getDocument(String, XWikiContext) adding wiki switch.

getFirstWikiAlias() - Method in class com.xpn.xwiki.plugin.wikimanager.doc.Wiki

getGlobalSearchApiPlugin(XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPlugin

getHomePage() - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServer

getHomePageUrl() - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServer

getHql() - Method in class com.xpn.xwiki.plugin.globalsearch.tools.GlobalSearchQuery

getInstance(XWikiContext) - Static method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Return unique instance of XWikiServerClass and update documents for this context.

getMax() - Method in class com.xpn.xwiki.plugin.globalsearch.tools.GlobalSearchQuery

getMessageTool(XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiCopy

Get the XWikiPluginMessageTool to use with WikiManager.

getMessageTool(XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManager

Get the XWikiPluginMessageTool to use with WikiManager.

getMessageTool() - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi

getOwner() - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServer

getParameterList() - Method in class com.xpn.xwiki.plugin.globalsearch.tools.GlobalSearchQuery

getPluginApi(XWikiPluginInterface, XWikiContext) - Method in class com.xpn.xwiki.plugin.globalsearch.GlobalSearchPlugin

getPluginApi(XWikiPluginInterface, XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPlugin

getResult() - Method in class com.xpn.xwiki.plugin.globalsearch.tools.GlobalSearchResult

getSearchApi() - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi

getSecure() - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServer

getServer() - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServer

getServerUrl() - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServer

getServerUrl(String, String) - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServer

Get the complete URL of the provided wiki page.

getStart() - Method in class com.xpn.xwiki.plugin.globalsearch.tools.GlobalSearchQuery

getState() - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServer

getVisibility() - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServer

getWikiAlias(String) - Method in class com.xpn.xwiki.plugin.wikimanager.doc.Wiki

Get wiki alias with provided domain name.

getWikiAlias(int) - Method in class com.xpn.xwiki.plugin.wikimanager.doc.Wiki

Get wiki alias with provided id.

getWikiAlias(String, int, boolean, XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Get wiki alias XWikiServer.

getWikiAlias(String, int, boolean, XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManager

Get the wiki descriptor document.

getWikiAliasIdFromDomain(String) - Method in class com.xpn.xwiki.plugin.wikimanager.doc.Wiki

Get wiki alias id from domain name.

getWikiAliasList() - Method in class com.xpn.xwiki.plugin.wikimanager.doc.Wiki

getWikiAliasList(XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManager

Get all the wikis descriptors documents.

getWikiDocument(String) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi

Get wiki descriptor document corresponding to provided wiki name.

getWikiDocument(String, int) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi

Get wiki descriptor document corresponding to provided wiki name.

getWikiDocumentList() - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi

Get the list of all wiki descriptor documents.

getWikiFromDocument(XWikiDocument, XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManager

Get Wiki described by provided document.

getWikiFromDocumentName(String, XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManager

Get Wiki described by document with provided full name.

getWikiFromDocumentName(String) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi

Get Wiki described by document with provided full name.

getWikiFromName(String, XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManager

Get Wiki with provided name.

getWikiFromName(String) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi

Get Wiki with provided name.

getWikiLanguage() - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServer

getWikiName() - Method in class com.xpn.xwiki.plugin.globalsearch.tools.GlobalSearchResult

getWikiName() - Method in class com.xpn.xwiki.plugin.wikimanager.doc.Wiki

getWikiName() - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServer

getWikiNameList() - Method in class com.xpn.xwiki.plugin.globalsearch.tools.GlobalSearchQuery

getWikiPrettyName() - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServer

getWikiTemplateAlias(String, int, boolean, XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Get wiki template alias XWikiServer.

getWikiTemplateAlias(String, int, XWikiContext, boolean) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiCopy

Get template wiki descriptor document.

getWikiTemplateAlias(String, int, XWikiContext, boolean) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManager

Get template wiki descriptor document.

getWikiTemplateAliasList(XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiCopy

Get all the templates wikis descriptors documents.

getWikiTemplateAliasList(XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManager

Get all the templates wikis descriptors documents.

getWikiTemplateDocument(String) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi

Get wiki descriptor document corresponding to provided wiki name with XWikiServerClass "visibility" field set to "template".

getWikiTemplateDocument(String, int) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi

Get wiki descriptor document corresponding to provided wiki name with XWikiServerClass "visibility" field set to "template".

getWikiTemplateList() - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi

getWikiUrl(String) - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServer

Get the complete URL of the provided wiki page.

getXObjectDocument(String, int, boolean, XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

GlobalSearchException - Exception in com.xpn.xwiki.plugin.globalsearch

Global Search plugin base exception.

GlobalSearchException(int, String) - Constructor for exception com.xpn.xwiki.plugin.globalsearch.GlobalSearchException

Create an GlobalSearchException.

GlobalSearchException(int, String, Throwable, Object[]) - Constructor for exception com.xpn.xwiki.plugin.globalsearch.GlobalSearchException

Create an GlobalSearchException.

GlobalSearchException(int, String, Throwable) - Constructor for exception com.xpn.xwiki.plugin.globalsearch.GlobalSearchException

Create an GlobalSearchException.

GlobalSearchMessageTool - Class in com.xpn.xwiki.plugin.globalsearch

Global Search plugin translation messages manager.

GlobalSearchPlugin - Class in com.xpn.xwiki.plugin.globalsearch

Entry point of the Global Search plugin.

GlobalSearchPlugin(String, String, XWikiContext) - Constructor for class com.xpn.xwiki.plugin.globalsearch.GlobalSearchPlugin

Construct the entry point of the Global Search plugin.

GlobalSearchPluginApi - Class in com.xpn.xwiki.plugin.globalsearch

API tool to be able to make and merge multi wikis search queries.

GlobalSearchPluginApi(GlobalSearchPlugin, XWikiContext) - Constructor for class com.xpn.xwiki.plugin.globalsearch.GlobalSearchPluginApi

Create an instance of GlobalSearchPluginApi.

GlobalSearchQuery - Class in com.xpn.xwiki.plugin.globalsearch.tools

Contains all parameters for a global search query.

GlobalSearchQuery() - Constructor for class com.xpn.xwiki.plugin.globalsearch.tools.GlobalSearchQuery

GlobalSearchResult - Class in com.xpn.xwiki.plugin.globalsearch.tools

Contains one query result line.

GlobalSearchResult() - Constructor for class com.xpn.xwiki.plugin.globalsearch.tools.GlobalSearchResult

Create new GlobalSearchResult instance.

GlobalSearchResult(String, Iterable<String>, Object[]) - Constructor for class com.xpn.xwiki.plugin.globalsearch.tools.GlobalSearchResult

Create new GlobalSearchResult instance.

I

importPackage(String, String, XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiCopy

Import XAR package into wiki.

init(XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPlugin

isWikiAliasExist(String, int, XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManager

Indicate of wiki descriptor document exist.

isWikiExist(String) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi

Check if a Server of the given name exists in the master Wiki by checking if the "XWiki.XWikiServer{serverName}" document is new.

isWikiExist(String, int) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi

Check if a Server of the given name exists in the master Wiki by checking if the "XWiki.XWikiServer{serverName}" document is new.

isWikiNameAvailable(String) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi

Indicate if the provided wiki name could be used to create a new wiki.

isWikiTemplate() - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServer

L

LOG_DATABASEALREADYEXISTS - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Used as log message when trying to create a new database/schema that already exists.

LOG_DATABASECREATION - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Used as log message when database/schema creation failed.

LOG_DATABASECREATIONEXCEPTION - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Used as log message when database/schema creation thrown unknown exception.

LOG_DESCRIPTORALREADYEXISTS - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Used as log message when trying to create a new wiki with a wiki descriptor that already exist.

LOG_GETDOCUMENTFROMNAME - Static variable in class com.xpn.xwiki.plugin.globalsearch.GlobalSearchMessageTool

Used as log message when trying to get document from name.

LOG_SEARCHDOCUMENTS - Static variable in class com.xpn.xwiki.plugin.globalsearch.GlobalSearchMessageTool

Used as log message when trying to search documents.

LOG_WIKIALIASGET - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Used as log message when failed to find wiki descriptor document.

LOG_WIKIALIASGETALL - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Used as log message when failed to find all the wikis aliases.

LOG_WIKICREATION - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Used as log message when wiki creation failed.

LOG_WIKIDELETION - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Used as log message when wiki deletion failed.

LOG_WIKIGET - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Used as log message when failed to find wiki alias.

LOG_WIKIGETALL - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Used as log message when failed to find all the wikis descriptors documents.

LOG_WIKISETVISIBILITY - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Used as log message when modification of the "visibility" field of a wiki descriptor failed.

LOG_WIKITEMPLATEGET - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Used as log message when failed to find wiki template descriptor document.

LOG_WIKITEMPLATEGETALL - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Used as log message when failed to find all the wikis templates descriptors documents.

logError(String, XWikiException) - Method in class com.xpn.xwiki.plugin.globalsearch.GlobalSearchPluginApi

Log error and store details in the context.

LOGGER - Static variable in class com.xpn.xwiki.plugin.globalsearch.GlobalSearchPlugin

The logging tool.

LOGGER - Static variable in class com.xpn.xwiki.plugin.globalsearch.GlobalSearchPluginApi

Logging tool.

LOGGER - Static variable in class com.xpn.xwiki.plugin.wikimanager.doc.Wiki

The logging tool.

LOGGER - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiCopy

The logging tool.

LOGGER - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManager

The logging tool.

LOGGER - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPlugin

The logging tool.

LOGGER - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi

Logging tool.

M

MESSAGETOOL_CONTEXT_KEY - Static variable in class com.xpn.xwiki.plugin.globalsearch.GlobalSearchMessageTool

Key to use with Hashtable.get(Object).

MESSAGETOOL_CONTEXT_KEY - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

Key to use with Hashtable.get(Object).

MODULE_PLUGIN_GLOABLSEARCH - Static variable in exception com.xpn.xwiki.plugin.globalsearch.GlobalSearchException

Global Search plugin error identifier.

MODULE_PLUGIN_WIKIMANAGER - Static variable in exception com.xpn.xwiki.plugin.wikimanager.WikiManagerException

Wiki Manager plugin error identifier.

N

newQuery() - Method in class com.xpn.xwiki.plugin.globalsearch.GlobalSearchPluginApi

Create a new instance of GlobalSearchQuery and return it.

newXObjectDocument(XWikiDocument, int, XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

P

PLUGIN_NAME - Static variable in class com.xpn.xwiki.plugin.globalsearch.GlobalSearchPlugin

Identifier of Global Search plugin.

PLUGIN_NAME - Static variable in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPlugin

Identifier of Wiki Manager plugin.

S

search(GlobalSearchQuery) - Method in class com.xpn.xwiki.plugin.globalsearch.GlobalSearchPluginApi

Execute query in all provided wikis and return list containing all results.

searchDocuments(GlobalSearchQuery, boolean) - Method in class com.xpn.xwiki.plugin.globalsearch.GlobalSearchPluginApi

Search wiki pages in all provided wikis and return list containing found Document.

searchDocuments(String, String, XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManager

Encapsulate XWikiStoreInterface.searchDocuments(String, XWikiContext) adding wiki switch.

searchDocumentsNames(GlobalSearchQuery, boolean, boolean) - Method in class com.xpn.xwiki.plugin.globalsearch.GlobalSearchPluginApi

Search wiki pages in all provided wikis and return list containing found Document.

searchXObjectDocumentsByFields(Object[][], XWikiContext) - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

setDescription(String) - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServer

Modify the description of the wiki.

setHomePage(String) - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServer

Modify the home page of the wiki.

setHql(String) - Method in class com.xpn.xwiki.plugin.globalsearch.tools.GlobalSearchQuery

setIsWikiTemplate(boolean) - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServer

setIsWikiTemplate(String, boolean) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi

Change the XWikiServerClass "visibility" field of a wiki descriptor document.

setMax(int) - Method in class com.xpn.xwiki.plugin.globalsearch.tools.GlobalSearchQuery

setOwner(String) - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServer

Modify the owner of the wiki.

setParameterList(Collection<?>) - Method in class com.xpn.xwiki.plugin.globalsearch.tools.GlobalSearchQuery

setResult(Collection<?>) - Method in class com.xpn.xwiki.plugin.globalsearch.tools.GlobalSearchResult

setResult(Object[]) - Method in class com.xpn.xwiki.plugin.globalsearch.tools.GlobalSearchResult

setSecure(boolean) - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServer

Modify the secure mode of the wiki.

setServer(String) - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServer

Modify the domain name of the wiki.

setStart(int) - Method in class com.xpn.xwiki.plugin.globalsearch.tools.GlobalSearchQuery

setState(String) - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServer

Modify the state of the wiki.

setVisibility(String) - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServer

Modify the visibility of the wiki.

setWikiLanguage(String) - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServer

Modify the language of the wiki.

setWikiName(String) - Method in class com.xpn.xwiki.plugin.globalsearch.tools.GlobalSearchResult

setWikiName(String) - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServer

Modify the name of the application.

setWikiNameList(Collection<String>) - Method in class com.xpn.xwiki.plugin.globalsearch.tools.GlobalSearchQuery

setWikiPrettyName(String) - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServer

Modify the pretty name of the application.

setWikiVisibility(String, String) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi

Change the XWikiServerClass "visibility" field of a wiki descriptor document.

setWikiVisibility(String, int, String) - Method in class com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi

Change the XWikiServerClass "visibility" field of a wiki descriptor document.

T

toString() - Method in class com.xpn.xwiki.plugin.wikimanager.doc.Wiki

toString() - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServer

U

updateBaseClass(BaseClass) - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

updateClassTemplateDocument(XWikiDocument) - Method in class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

W

Wiki - Class in com.xpn.xwiki.plugin.wikimanager.doc

This class manage wiki document descriptor.

Wiki(XWikiDocument, XWikiContext) - Constructor for class com.xpn.xwiki.plugin.wikimanager.doc.Wiki

Create instance of wiki descriptor.

WikiCopy - Class in com.xpn.xwiki.plugin.wikimanager

Utility classe used to fill a newly created wiki.

WikiCopy(XWikiPluginMessageTool) - Constructor for class com.xpn.xwiki.plugin.wikimanager.WikiCopy

WikiManager - Class in com.xpn.xwiki.plugin.wikimanager

Hidden toolkit use by the plugin API that make all the plugins actions.

WikiManager(XWikiPluginMessageTool) - Constructor for class com.xpn.xwiki.plugin.wikimanager.WikiManager

WikiManagerException - Exception in com.xpn.xwiki.plugin.wikimanager

Wiki Manager plugin base exception.

WikiManagerException(int, String) - Constructor for exception com.xpn.xwiki.plugin.wikimanager.WikiManagerException

Create an WikiManagerException.

WikiManagerException(int, String, Throwable, Object[]) - Constructor for exception com.xpn.xwiki.plugin.wikimanager.WikiManagerException

Create an WikiManagerException.

WikiManagerException(int, String, Throwable) - Constructor for exception com.xpn.xwiki.plugin.wikimanager.WikiManagerException

Create an WikiManagerException.

WikiManagerMessageTool - Class in com.xpn.xwiki.plugin.wikimanager

Wiki Manager plugin translation messages manager.

WikiManagerPlugin - Class in com.xpn.xwiki.plugin.wikimanager

Entry point of the Wiki Manager plugin.

WikiManagerPlugin(String, String, XWikiContext) - Constructor for class com.xpn.xwiki.plugin.wikimanager.WikiManagerPlugin

Construct the entry point of the Wiki Manager plugin.

WikiManagerPluginApi - Class in com.xpn.xwiki.plugin.wikimanager

API for managing wikis (create wiki, delete wiki, create wiki from template, etc).

WikiManagerPluginApi(WikiManagerPlugin, XWikiContext) - Constructor for class com.xpn.xwiki.plugin.wikimanager.WikiManagerPluginApi

Create an instance of the Wiki Manager plugin user api.

X

XWikiServer - Class in com.xpn.xwiki.plugin.wikimanager.doc

This class manage an XWiki document containing XWiki.XWikiServerClass object.

XWikiServer(XWikiDocument, int, XWikiContext) - Constructor for class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServer

Create new XWikiServer managing provided XWikiDocument.

XWikiServerClass - Class in com.xpn.xwiki.plugin.wikimanager.doc

XClassManager implementation for XWiki.XWikiServerClass class.

XWikiServerClass() - Constructor for class com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

Default constructor for XWikiServerClass.

A C D E F G I L M N P S T U W X