com.xpn.xwiki.plugin.wikimanager
Class WikiCopy

java.lang.Object
  com.xpn.xwiki.plugin.wikimanager.WikiCopy

public final class WikiCopy
extends Object

Utility classe used to fill a newly created wiki.

Version:

$Id$

Field Summary

protected static org.slf4j.Logger

LOGGER The logging tool.

Constructor Summary

WikiCopy(XWikiPluginMessageTool messageTool)

Method Summary

void	copyWiki(String sourceWiki, String targetWiki, String comment, com.xpn.xwiki.XWikiContext context) Copy all documents from sourceWiki wiki to targetWiki wiki.
XWikiPluginMessageTool	getMessageTool(com.xpn.xwiki.XWikiContext context) Get the XWikiPluginMessageTool to use with WikiManager.
XWikiServer	getWikiTemplateAlias(String wikiName, int objectId, com.xpn.xwiki.XWikiContext context, boolean validate) Get template wiki descriptor document.
List<XWikiServer>	getWikiTemplateAliasList(com.xpn.xwiki.XWikiContext context) Get all the templates wikis descriptors documents.
void	importPackage(String packageName, String targetWiki, com.xpn.xwiki.XWikiContext context) Import XAR package into wiki.

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

WikiCopy

public WikiCopy(XWikiPluginMessageTool messageTool)

Parameters:

messageTool - the message tool

Method Detail

getMessageTool

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

Get the XWikiPluginMessageTool to use with WikiManager.

Parameters:

context - the XWiki context.

Returns:

a translated strings manager.

copyWiki

public void copyWiki(String sourceWiki,
                     String targetWiki,
                     String comment,
                     com.xpn.xwiki.XWikiContext context)
              throws com.xpn.xwiki.XWikiException

Copy all documents from sourceWiki wiki to targetWiki wiki.

It also take care of ApplicationManager descriptors "documents to include" and "documents to link".

Parameters:

sourceWiki - the wiki from where to copy documents and get lists of "document to link" and "documents to copy".

targetWiki - the wiki where to copy documents.

comment - the comment to use when saving documents.

context - the XWiki context.

Throws:

com.xpn.xwiki.XWikiException - error when:

• copying on of the source wiki to target wiki.
• or getting documents to include.
• or getting documents to link.

importPackage

public void importPackage(String packageName,
                          String targetWiki,
                          com.xpn.xwiki.XWikiContext context)
                   throws com.xpn.xwiki.XWikiException

Import XAR package into wiki.

Parameters:

packageName - the name of the attached package file.

targetWiki - the name of the wiki where to install loaded XWikiDocument from XAR package.

context - the XWiki context.

Throws:

com.xpn.xwiki.XWikiException - error when:

• WikiManagerException.ERROR_WM_XWIKINOTVIRTUAL: xwiki is not in virtual mode.
• WikiManagerException.ERROR_WM_PACKAGEDOESNOTEXISTS: attached package does not exists.
• WikiManagerException.ERROR_WM_PACKAGEIMPORT: package loading failed.
• WikiManagerException.ERROR_WM_PACKAGEINSTALL: loaded package insertion into database failed.

getWikiTemplateAlias

public XWikiServer getWikiTemplateAlias(String wikiName,
                                        int objectId,
                                        com.xpn.xwiki.XWikiContext context,
                                        boolean validate)
                                 throws com.xpn.xwiki.XWikiException

Get template wiki descriptor document.

A template wiki is a wiki which the XWiki.XWikiServerClass "visibility" field is set to "template".

Parameters:

wikiName - the name of the template wiki.

objectId - the id of the XWiki object included in the document to manage.

context - the XWiki context.

validate - when wiki descriptor document does not exist :

• if true, throw an exception with code WikiManagerException.ERROR_WM_WIKIDOESNOTEXISTS
• if false, return new document unsaved

Returns:

a wiki descriptor document.

Throws:

com.xpn.xwiki.XWikiException - error when:

• getting XWikiServerClass unique instance.
• or when searching for wiki descriptor with "visibility" field equals to "template".

getWikiTemplateAliasList

public List<XWikiServer> getWikiTemplateAliasList(com.xpn.xwiki.XWikiContext context)
                                           throws com.xpn.xwiki.XWikiException

Get all the templates wikis descriptors documents.

A template wiki is a wiki which the XWiki.XWikiServerClass "visibility" field is set to "template".

Parameters:

context - the XWiki context.

Returns:

a list of XWikiServer.

Throws:

com.xpn.xwiki.XWikiException - eeor when:

• getting XWikiServerClass unique instance.
• or when searching for all wikis descriptors with "visibility" field equals to "template".