com.xpn.xwiki.plugin.applicationmanager
Class ApplicationManager

java.lang.Object
  com.xpn.xwiki.plugin.applicationmanager.ApplicationManager

public final class ApplicationManager
extends Object

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

Version:

$Id$

Field Summary

protected static org.slf4j.Logger

LOGGER The logging tool.

Constructor Summary

ApplicationManager(XWikiPluginMessageTool messageTool)

Method Summary

void	createApplication(XWikiApplication userAppSuperDoc, boolean failOnExist, String comment, com.xpn.xwiki.XWikiContext context) Create a new application descriptor base on provided application descriptor.
void	deleteApplication(String appName, com.xpn.xwiki.XWikiContext context) Delete an application descriptor document.
XWikiApplication	getApplication(String appName, com.xpn.xwiki.XWikiContext context, boolean validate) Get the application descriptor document of the provided application name.
List<XWikiApplication>	getApplicationList(com.xpn.xwiki.XWikiContext context) Search for all document containing a object of class XWikiApplicationClass.
XWikiPluginMessageTool	getMessageTool(com.xpn.xwiki.XWikiContext context) Get the XWikiPluginMessageTool to use with ApplicationManager.
XWikiApplication	getRootApplication(com.xpn.xwiki.XWikiContext context) Get the current wiki root application.
void	reloadAllApplications(String comment, com.xpn.xwiki.XWikiContext context) Reload all xwiki applications.
void	reloadApplication(XWikiApplication app, String comment, com.xpn.xwiki.XWikiContext context) Reload xwiki application.
void	updateAllApplicationTranslation(com.xpn.xwiki.XWikiContext context) Insert in XWiki.XWikiPreferences "documentBundles" field the translation documents of all applications in the context's wiki.
void	updateApplicationsTranslation(Collection<XWikiApplication> applications, String comment, com.xpn.xwiki.XWikiContext context) Insert in XWiki.XWikiPreferences "documentBundles" field the translation documents of all applications in the context's wiki.
void	updateApplicationsTranslation(com.xpn.xwiki.doc.XWikiDocument document, com.xpn.xwiki.XWikiContext context) Insert in XWiki.XWikiPreferences "documentBundles" field the translation documents of all applications in the context's wiki.
boolean	updateApplicationTranslation(List<String> translationPrefs, XWikiApplication app) Insert in translationPrefs the translation documents of the provided application.
void	updateApplicationTranslation(XWikiApplication app, String comment, com.xpn.xwiki.XWikiContext context) Insert in XWiki.XWikiPreferences "documentBundles" field the translation documents of the provided application.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

protected static final org.slf4j.Logger LOGGER

The logging tool.

Constructor Detail

ApplicationManager

public ApplicationManager(XWikiPluginMessageTool messageTool)

Parameters:

messageTool - the message tool

Method Detail

getMessageTool

public XWikiPluginMessageTool getMessageTool(com.xpn.xwiki.XWikiContext context)

Get the XWikiPluginMessageTool to use with ApplicationManager.

Parameters:

context - the XWiki context.

Returns:

a translated strings manager.

getRootApplication

public XWikiApplication getRootApplication(com.xpn.xwiki.XWikiContext context)
                                    throws com.xpn.xwiki.XWikiException

Get the current wiki root application.

Parameters:

context - the XWiki context.

Returns:

the root application descriptor document. If can't find root application return null.

Throws:

com.xpn.xwiki.XWikiException - error when getting root application descriptor document from database.

getApplicationList

public List<XWikiApplication> getApplicationList(com.xpn.xwiki.XWikiContext context)
                                          throws com.xpn.xwiki.XWikiException

Search for all document containing a object of class XWikiApplicationClass.

Parameters:

context - the XWiki context.

Returns:

a list if XWikiApplication.

Throws:

com.xpn.xwiki.XWikiException - error when searching documents.

createApplication

public void createApplication(XWikiApplication userAppSuperDoc,
                              boolean failOnExist,
                              String comment,
                              com.xpn.xwiki.XWikiContext context)
                       throws com.xpn.xwiki.XWikiException

Create a new application descriptor base on provided application descriptor.

Parameters:

userAppSuperDoc - appXObjectDocument the user application descriptor from which new descriptor will be created.

failOnExist - if true fail if the application descriptor to create already exists.

comment - a comment used when saving application descriptor document.

context - the XWiki Context.

Throws:

com.xpn.xwiki.XWikiException - error when calling for XWiki.getDocument(String, XWikiContext)

deleteApplication

public void deleteApplication(String appName,
                              com.xpn.xwiki.XWikiContext context)
                       throws com.xpn.xwiki.XWikiException

Delete an application descriptor document.

Parameters:

appName - the name of the application.

context - the XWiki context.

Throws:

com.xpn.xwiki.XWikiException - error when calling for DefaultXObjectDocument.delete()

getApplication

public XWikiApplication getApplication(String appName,
                                       com.xpn.xwiki.XWikiContext context,
                                       boolean validate)
                                throws com.xpn.xwiki.XWikiException

Get the application descriptor document of the provided application name.

Parameters:

appName - the name of the application.

context - the XWiki context.

validate - indicate if it return new XWikiDocument or throw exception if application descriptor does not exist.

Returns:

the XWikiApplication representing application descriptor.

Throws:

com.xpn.xwiki.XWikiException - error when searching for application descriptor document.

reloadApplication

public void reloadApplication(XWikiApplication app,
                              String comment,
                              com.xpn.xwiki.XWikiContext context)
                       throws com.xpn.xwiki.XWikiException

Reload xwiki application. It means :

• update XWikiPreferences with application translation documents.

Parameters:

app - the application to reload.

comment - the comment to use when saving documents.

context - the XWiki context.

Throws:

com.xpn.xwiki.XWikiException - error when :

• getting wiki preferences document.
• or saving wiki preferences document.

reloadAllApplications

public void reloadAllApplications(String comment,
                                  com.xpn.xwiki.XWikiContext context)
                           throws com.xpn.xwiki.XWikiException

Reload all xwiki applications. It means :

• update XWikiPreferences with application translation documents.

Parameters:

comment - the comment to use when saving documents.

context - the XWiki context.

Throws:

com.xpn.xwiki.XWikiException - error when :

• getting wiki preferences document.
• or searching for all applications in the wiki.
• or saving wiki preferences document.

updateApplicationsTranslation

public void updateApplicationsTranslation(Collection<XWikiApplication> applications,
                                          String comment,
                                          com.xpn.xwiki.XWikiContext context)
                                   throws com.xpn.xwiki.XWikiException

Insert in XWiki.XWikiPreferences "documentBundles" field the translation documents of all applications in the context's wiki.

Parameters:

applications - the applications for which to update translations informations.

comment - a comment used when saving XWiki.

context - the XWiki context.

Throws:

com.xpn.xwiki.XWikiException - error when :

• getting wiki preferences document.
• or searching for all applications in the wiki.
• or saving wiki preferences document.

updateAllApplicationTranslation

public void updateAllApplicationTranslation(com.xpn.xwiki.XWikiContext context)
                                     throws com.xpn.xwiki.XWikiException

Insert in XWiki.XWikiPreferences "documentBundles" field the translation documents of all applications in the context's wiki.

Parameters:

context - the XWiki context.

Throws:

com.xpn.xwiki.XWikiException - error when :

• getting wiki preferences document.
• or searching for all applications in the wiki.
• or saving wiki preferences document.

updateApplicationsTranslation

public void updateApplicationsTranslation(com.xpn.xwiki.doc.XWikiDocument document,
                                          com.xpn.xwiki.XWikiContext context)
                                   throws com.xpn.xwiki.XWikiException

Insert in XWiki.XWikiPreferences "documentBundles" field the translation documents of all applications in the context's wiki.

Parameters:

document - the document containing the applications descriptors

context - the XWiki context.

Throws:

com.xpn.xwiki.XWikiException - error when :

• getting wiki preferences document.
• or searching for all applications in the wiki.
• or saving wiki preferences document.

Since:

1.9

updateApplicationTranslation

public void updateApplicationTranslation(XWikiApplication app,
                                         String comment,
                                         com.xpn.xwiki.XWikiContext context)
                                  throws com.xpn.xwiki.XWikiException

Insert in XWiki.XWikiPreferences "documentBundles" field the translation documents of the provided application.

Parameters:

app - the application descriptor.

comment - a comment used when saving XWiki.

context - the XWiki context.

Throws:

com.xpn.xwiki.XWikiException - error when :

• getting wiki preferences document.
• or saving wiki preferences document.

updateApplicationTranslation

public boolean updateApplicationTranslation(List<String> translationPrefs,
                                            XWikiApplication app)

Insert in translationPrefs the translation documents of the provided application.

Parameters:

translationPrefs - the list of translation documents to complete.

app - the application's descriptor.

Returns:

true if at least one document has been inserted in translationPrefs.