com.xpn.xwiki.plugin.applicationmanager
Class ApplicationManager

java.lang.Object
  extended by 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: 325ed67984873b01669c0a465eb813143990baea $

Field Summary
protected static org.slf4j.Logger LOGGER
          The logging tool.
 
Constructor Summary
ApplicationManager()
          Default constructor.
ApplicationManager(XWikiPluginMessageTool messageTool)
          Deprecated. since 5.0M1 use ApplicationManager() instead
 
Method Summary
 void createApplication(XWikiApplication userAppSuperDoc, boolean failOnExist, String comment, XWikiContext context)
          Create a new application descriptor base on provided application descriptor.
 void deleteApplication(String appName, XWikiContext context)
          Delete an application descriptor document.
 XWikiApplication getApplication(String appName, XWikiContext context, boolean validate)
          Get the application descriptor document of the provided application name.
 List<XWikiApplication> getApplicationList(XWikiContext context)
          Search for all document containing a object of class XWikiApplicationClass.
 XWikiPluginMessageTool getMessageTool(XWikiContext context)
          Deprecated. since 5.0M1 use LocalizationManager instead
 XWikiApplication getRootApplication(XWikiContext context)
          Get the current wiki root application.
 void reloadAllApplications(String comment, XWikiContext context)
          Reload all xwiki applications.
 void reloadApplication(XWikiApplication app, String comment, XWikiContext context)
          Reload xwiki application.
 void updateAllApplicationTranslation(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, XWikiContext context)
          Insert in XWiki.XWikiPreferences "documentBundles" field the translation documents of all applications in the context's wiki.
 void updateApplicationsTranslation(XWikiDocument document, 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, 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()
Default constructor.


ApplicationManager

@Deprecated
public ApplicationManager(XWikiPluginMessageTool messageTool)
Deprecated. since 5.0M1 use ApplicationManager() instead

Parameters:
messageTool - the message tool
Method Detail

getMessageTool

@Deprecated
public XWikiPluginMessageTool getMessageTool(XWikiContext context)
Deprecated. since 5.0M1 use LocalizationManager instead

Get the XWikiPluginMessageTool to use with ApplicationManager.

Parameters:
context - the XWiki context.
Returns:
a translated strings manager.

getRootApplication

public XWikiApplication getRootApplication(XWikiContext context)
                                    throws 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:
XWikiException - error when getting root application descriptor document from database.

getApplicationList

public List<XWikiApplication> getApplicationList(XWikiContext context)
                                          throws XWikiException
Search for all document containing a object of class XWikiApplicationClass.

Parameters:
context - the XWiki context.
Returns:
a list if XWikiApplication.
Throws:
XWikiException - error when searching documents.

createApplication

public void createApplication(XWikiApplication userAppSuperDoc,
                              boolean failOnExist,
                              String comment,
                              XWikiContext context)
                       throws 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:
XWikiException - error when calling for XWiki.getDocument(String, XWikiContext)

deleteApplication

public void deleteApplication(String appName,
                              XWikiContext context)
                       throws XWikiException
Delete an application descriptor document.

Parameters:
appName - the name of the application.
context - the XWiki context.
Throws:
XWikiException - error when calling for DefaultXObjectDocument.delete()

getApplication

public XWikiApplication getApplication(String appName,
                                       XWikiContext context,
                                       boolean validate)
                                throws 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:
XWikiException - error when searching for application descriptor document.

reloadApplication

public void reloadApplication(XWikiApplication app,
                              String comment,
                              XWikiContext context)
                       throws XWikiException
Reload xwiki application. It means :

Parameters:
app - the application to reload.
comment - the comment to use when saving documents.
context - the XWiki context.
Throws:
XWikiException - error when :
  • getting wiki preferences document.
  • or saving wiki preferences document.

reloadAllApplications

public void reloadAllApplications(String comment,
                                  XWikiContext context)
                           throws XWikiException
Reload all xwiki applications. It means :

Parameters:
comment - the comment to use when saving documents.
context - the XWiki context.
Throws:
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,
                                          XWikiContext context)
                                   throws 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:
XWikiException - error when :
  • getting wiki preferences document.
  • or searching for all applications in the wiki.
  • or saving wiki preferences document.

updateAllApplicationTranslation

public void updateAllApplicationTranslation(XWikiContext context)
                                     throws XWikiException
Insert in XWiki.XWikiPreferences "documentBundles" field the translation documents of all applications in the context's wiki.

Parameters:
context - the XWiki context.
Throws:
XWikiException - error when :
  • getting wiki preferences document.
  • or searching for all applications in the wiki.
  • or saving wiki preferences document.

updateApplicationsTranslation

public void updateApplicationsTranslation(XWikiDocument document,
                                          XWikiContext context)
                                   throws 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:
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,
                                         XWikiContext context)
                                  throws 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:
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.


Copyright © 2004-2013 XWiki. All Rights Reserved.