|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.xpn.xwiki.plugin.applicationmanager.ApplicationManager
public final class ApplicationManager
Hidden toolkit used by the plugin API that make all the plugins actions.
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 |
---|
protected static final org.slf4j.Logger LOGGER
Constructor Detail |
---|
public ApplicationManager()
@Deprecated public ApplicationManager(XWikiPluginMessageTool messageTool)
ApplicationManager()
instead
messageTool
- the message toolMethod Detail |
---|
@Deprecated public XWikiPluginMessageTool getMessageTool(XWikiContext context)
LocalizationManager
instead
XWikiPluginMessageTool
to use with ApplicationManager.
context
- the XWiki context.
public XWikiApplication getRootApplication(XWikiContext context) throws XWikiException
context
- the XWiki context.
XWikiException
- error when getting root application descriptor document from database.public List<XWikiApplication> getApplicationList(XWikiContext context) throws XWikiException
context
- the XWiki context.
XWikiApplication
.
XWikiException
- error when searching documents.public void createApplication(XWikiApplication userAppSuperDoc, boolean failOnExist, String comment, XWikiContext context) throws XWikiException
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.
XWikiException
- error when calling for XWiki.getDocument(String, XWikiContext)
public void deleteApplication(String appName, XWikiContext context) throws XWikiException
appName
- the name of the application.context
- the XWiki context.
XWikiException
- error when calling for DefaultXObjectDocument.delete()
public XWikiApplication getApplication(String appName, XWikiContext context, boolean validate) throws XWikiException
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.
XWikiException
- error when searching for application descriptor document.public void reloadApplication(XWikiApplication app, String comment, XWikiContext context) throws XWikiException
app
- the application to reload.comment
- the comment to use when saving documents.context
- the XWiki context.
XWikiException
- error when :
public void reloadAllApplications(String comment, XWikiContext context) throws XWikiException
comment
- the comment to use when saving documents.context
- the XWiki context.
XWikiException
- error when :
public void updateApplicationsTranslation(Collection<XWikiApplication> applications, String comment, XWikiContext context) throws XWikiException
applications
- the applications for which to update translations informations.comment
- a comment used when saving XWiki.context
- the XWiki context.
XWikiException
- error when :
public void updateAllApplicationTranslation(XWikiContext context) throws XWikiException
context
- the XWiki context.
XWikiException
- error when :
public void updateApplicationsTranslation(XWikiDocument document, XWikiContext context) throws XWikiException
document
- the document containing the applications descriptorscontext
- the XWiki context.
XWikiException
- error when :
public void updateApplicationTranslation(XWikiApplication app, String comment, XWikiContext context) throws XWikiException
app
- the application descriptor.comment
- a comment used when saving XWiki.context
- the XWiki context.
XWikiException
- error when :
public boolean updateApplicationTranslation(List<String> translationPrefs, XWikiApplication app)
translationPrefs
the translation documents of the provided application.
translationPrefs
- the list of translation documents to complete.app
- the application's descriptor.
translationPrefs
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |