com.xpn.xwiki.plugin.wikimanager
Class WikiManagerMessageTool

java.lang.Object
  com.xpn.xwiki.web.XWikiMessageTool
      com.xpn.xwiki.plugin.applicationmanager.core.plugin.XWikiPluginMessageTool
          com.xpn.xwiki.plugin.wikimanager.WikiManagerMessageTool

public class WikiManagerMessageTool
extends XWikiPluginMessageTool

Wiki Manager plugin translation messages manager.

The main use of this class is construct XWikiPluginMessageTool with the correct ResourceBundle and to list all the message keys used internally in the plugin.

Version:

$Id$

Field Summary

static String	COMMENT_CREATEEMPTYWIKI Used as comment when creating a new empty wiki.
static String	COMMENT_CREATEWIKIFROMPACKAGE Used as comment when creating a new wiki from XAR package.
static String	COMMENT_CREATEWIKIFROMTEMPLATE Used as comment when creating a new wiki from wiki template.
static String	COMMENT_CREATEWIKITEMPLATE Used as comment when creating a new wiki template.
static String	ERROR_DELETEMAINWIKI Used as WikiManagerException message when trying to delete the main wiki.
static String	ERROR_DESCRIPTORALREADYEXISTS Used as WikiManagerException message when trying to create a new wiki with a wiki descriptor that already exist.
static String	ERROR_PACKAGEDOESNOTEXISTS Used as WikiManagerException message when provided XAR package does not exists.
static String	ERROR_PACKAGEIMPORT Used as WikiManagerException message when failed to load XAR package as list of XWikiDocument.
static String	ERROR_PACKAGEINSTALL Used as WikiManagerException message when failed to insert loaded XWikiDocument from package into database.
static String	ERROR_RIGHTTOCREATEWIKI Used as WikiManagerException message when trying to create wiki when it's not administrator user.
static String	ERROR_RIGHTTODELETEWIKI Used as WikiManagerException message when trying to delete wiki when it's not administrator user.
static String	ERROR_UPDATEDATABASE Used as WikiManagerException message when call to XWiki.updateDatabase(String, XWikiContext) failed.
static String	ERROR_USERDOESNOTEXIST Used as WikiManagerException message when provided user does not exists.
static String	ERROR_USERNOTACTIVE Used as WikiManagerException message when provided user is not active.
static String	ERROR_WIKIALIASDOESNOTEXISTS Used as WikiManagerException message when trying to get a wiki alias which does not exists.
static String	ERROR_WIKIDOESNOTEXISTS Used as WikiManagerException message when trying to get a wiki which does not exists.
static String	ERROR_WIKINAMEFORBIDDEN Used as WikiManagerException message when tring to create a new wiki with a wiki name forbidden.
static String	ERROR_WIKITEMPLATEALIASDOESNOTEXISTS Used as WikiManagerException message when trying to delete wiki with not administrator user.
static String	ERROR_XWIKINOTVIRTUAL Used as WikiManagerException message when trying to make action that require virtual mode in a wiki not in virtual mode.
static String	LOG_DATABASEALREADYEXISTS Used as log message when trying to create a new database/schema that already exists.
static String	LOG_DATABASECREATION Used as log message when database/schema creation failed.
static String	LOG_DATABASECREATIONEXCEPTION Used as log message when database/schema creation thrown unknown exception.
static String	LOG_DESCRIPTORALREADYEXISTS Used as log message when trying to create a new wiki with a wiki descriptor that already exist.
static String	LOG_WIKIALIASGET Used as log message when failed to find wiki descriptor document.
static String	LOG_WIKIALIASGETALL Used as log message when failed to find all the wikis aliases.
static String	LOG_WIKICREATION Used as log message when wiki creation failed.
static String	LOG_WIKIDELETION Used as log message when wiki deletion failed.
static String	LOG_WIKIGET Used as log message when failed to find wiki alias.
static String	LOG_WIKIGETALL Used as log message when failed to find all the wikis descriptors documents.
static String	LOG_WIKISETVISIBILITY Used as log message when modification of the "visibility" field of a wiki descriptor failed.
static String	LOG_WIKITEMPLATEGET Used as log message when failed to find wiki template descriptor document.
static String	LOG_WIKITEMPLATEGETALL Used as log message when failed to find all the wikis templates descriptors documents.
static String	MESSAGETOOL_CONTEXT_KEY Key to use with Hashtable.get(Object).

Fields inherited from class com.xpn.xwiki.web.XWikiMessageTool

bundle, context

Method Summary

static WikiManagerMessageTool

getDefault(com.xpn.xwiki.XWikiContext context) Get Wiki Manager message tool registered in XWiki context.

Methods inherited from class com.xpn.xwiki.plugin.applicationmanager.core.plugin.XWikiPluginMessageTool

get, get, getTranslation

Methods inherited from class com.xpn.xwiki.web.XWikiMessageTool

get, get, get, getDocumentBundle, getDocumentBundleNames, getDocumentBundleProperties, getDocumentBundles, getDocumentBundles

Methods inherited from class java.lang.Object

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

Field Detail

MESSAGETOOL_CONTEXT_KEY

public static final String MESSAGETOOL_CONTEXT_KEY

Key to use with Hashtable.get(Object).

Since:

1.1

See Also:

Constant Field Values

COMMENT_CREATEEMPTYWIKI

public static final String COMMENT_CREATEEMPTYWIKI

Used as comment when creating a new empty wiki.

See Also:

Constant Field Values

COMMENT_CREATEWIKIFROMTEMPLATE

public static final String COMMENT_CREATEWIKIFROMTEMPLATE

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

See Also:

Constant Field Values

COMMENT_CREATEWIKIFROMPACKAGE

public static final String COMMENT_CREATEWIKIFROMPACKAGE

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

See Also:

Constant Field Values

COMMENT_CREATEWIKITEMPLATE

public static final String COMMENT_CREATEWIKITEMPLATE

Used as comment when creating a new wiki template.

See Also:

Constant Field Values

ERROR_XWIKINOTVIRTUAL

public static final String ERROR_XWIKINOTVIRTUAL

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

See Also:

Constant Field Values

ERROR_USERDOESNOTEXIST

public static final String ERROR_USERDOESNOTEXIST

Used as WikiManagerException message when provided user does not exists.

See Also:

Constant Field Values

ERROR_USERNOTACTIVE

public static final String ERROR_USERNOTACTIVE

Used as WikiManagerException message when provided user is not active.

See Also:

Constant Field Values

ERROR_WIKINAMEFORBIDDEN

public static final String ERROR_WIKINAMEFORBIDDEN

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

See Also:

Constant Field Values

ERROR_DESCRIPTORALREADYEXISTS

public static final String ERROR_DESCRIPTORALREADYEXISTS

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

See Also:

Constant Field Values

ERROR_UPDATEDATABASE

public static final String ERROR_UPDATEDATABASE

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

See Also:

Constant Field Values

ERROR_PACKAGEDOESNOTEXISTS

public static final String ERROR_PACKAGEDOESNOTEXISTS

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

See Also:

Constant Field Values

ERROR_PACKAGEIMPORT

public static final String ERROR_PACKAGEIMPORT

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

See Also:

Constant Field Values

ERROR_PACKAGEINSTALL

public static final String ERROR_PACKAGEINSTALL

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

See Also:

Constant Field Values

ERROR_RIGHTTOCREATEWIKI

public static final String ERROR_RIGHTTOCREATEWIKI

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

Since:

1.1

See Also:

Constant Field Values

ERROR_RIGHTTODELETEWIKI

public static final String ERROR_RIGHTTODELETEWIKI

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

Since:

1.1

See Also:

Constant Field Values

ERROR_WIKIALIASDOESNOTEXISTS

public static final String ERROR_WIKIALIASDOESNOTEXISTS

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

Since:

1.1

See Also:

Constant Field Values

ERROR_WIKIDOESNOTEXISTS

public static final String ERROR_WIKIDOESNOTEXISTS

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

Since:

1.1

See Also:

Constant Field Values

ERROR_WIKITEMPLATEALIASDOESNOTEXISTS

public static final String ERROR_WIKITEMPLATEALIASDOESNOTEXISTS

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

Since:

1.1

See Also:

Constant Field Values

ERROR_DELETEMAINWIKI

public static final String ERROR_DELETEMAINWIKI

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

Since:

1.1

See Also:

Constant Field Values

LOG_DESCRIPTORALREADYEXISTS

public static final String LOG_DESCRIPTORALREADYEXISTS

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

See Also:

Constant Field Values

LOG_DATABASEALREADYEXISTS

public static final String LOG_DATABASEALREADYEXISTS

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

See Also:

Constant Field Values

LOG_DATABASECREATION

public static final String LOG_DATABASECREATION

Used as log message when database/schema creation failed.

See Also:

Constant Field Values

LOG_DATABASECREATIONEXCEPTION

public static final String LOG_DATABASECREATIONEXCEPTION

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

See Also:

Constant Field Values

LOG_WIKICREATION

public static final String LOG_WIKICREATION

Used as log message when wiki creation failed.

See Also:

Constant Field Values

LOG_WIKIDELETION

public static final String LOG_WIKIDELETION

Used as log message when wiki deletion failed.

See Also:

Constant Field Values

LOG_WIKIGET

public static final String LOG_WIKIGET

Used as log message when failed to find wiki alias.

See Also:

Constant Field Values

LOG_WIKIALIASGET

public static final String LOG_WIKIALIASGET

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

See Also:

Constant Field Values

LOG_WIKIGETALL

public static final String LOG_WIKIGETALL

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

See Also:

Constant Field Values

LOG_WIKIALIASGETALL

public static final String LOG_WIKIALIASGETALL

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

See Also:

Constant Field Values

LOG_WIKISETVISIBILITY

public static final String LOG_WIKISETVISIBILITY

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

See Also:

Constant Field Values

LOG_WIKITEMPLATEGET

public static final String LOG_WIKITEMPLATEGET

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

See Also:

Constant Field Values

LOG_WIKITEMPLATEGETALL

public static final String LOG_WIKITEMPLATEGETALL

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

See Also:

Constant Field Values

Method Detail

getDefault

public static WikiManagerMessageTool getDefault(com.xpn.xwiki.XWikiContext context)

Get Wiki Manager message tool registered in XWiki context. If not return default.

Parameters:

context - the XWiki context from which to get message tool.

Returns:

the default Wiki Manager message tool.

Since:

1.1