com.xpn.xwiki.plugin.wikimanager.doc
Class Wiki

java.lang.Object
  com.xpn.xwiki.api.Api
      com.xpn.xwiki.api.Document
          com.xpn.xwiki.plugin.wikimanager.doc.Wiki

public class Wiki
extends Document

This class manage wiki document descriptor.

Version:

$Id$

Field Summary

protected static org.slf4j.Logger

LOGGER The logging tool.

Fields inherited from class com.xpn.xwiki.api.Document

cloned, currentObj, doc

Fields inherited from class com.xpn.xwiki.api.Api

context

Constructor Summary

Wiki(com.xpn.xwiki.doc.XWikiDocument xdoc, com.xpn.xwiki.XWikiContext context)
Create instance of wiki descriptor.

Method Summary

boolean	containsWikiAlias(String domain) Check if a wiki alias with provided name exists.
int	countWikiAliases()
void	delete(boolean deleteDatabase) Delete the wiki.
XWikiServer	getFirstWikiAlias()
XWikiServer	getWikiAlias(int id) Get wiki alias with provided id.
XWikiServer	getWikiAlias(String domain) Get wiki alias with provided domain name.
int	getWikiAliasIdFromDomain(String domain) Get wiki alias id from domain name.
Collection<XWikiServer>	getWikiAliasList()
String	getWikiName()
String	toString()

Methods inherited from class com.xpn.xwiki.api.Document

addAttachment, addAttachment, addAttachments, addAttachments, addObjectFromRequest, addObjectFromRequest, addObjectFromRequest, addObjectsFromRequest, addObjectsFromRequest, checkAccess, convertSyntax, createNewObject, delete, deleteAsAuthor, deleteDocument, deleteWithProgrammingRights, display, display, display, display, display, display, display, displayEdit, displayForm, displayForm, displayForm, displayHidden, displayPrettyName, displayPrettyName, displayPrettyName, displayPrettyName, displayPrettyName, displayPrettyName, displayRendered, displayTooltip, displayTooltip, displayView, dropPermissions, equals, get, getActiveClass, getArchive, getAttachment, getAttachmentDiff, getAttachmentList, getAttachmentRevisionURL, getAttachmentRevisionURL, getAttachmentURL, getAttachmentURL, getAttachmentURL, getAuthor, getBacklinks, getChildren, getChildren, getClassDiff, getComment, getComments, getComments, getContent, getContentAuthor, getContentDiff, getContentUpdateDate, getCreationDate, getCreator, getCurrentMonthPageStats, getCurrentMonthRefStats, getCurrentMonthSpaceStats, getDate, getDefaultEditMode, getDefaultEditURL, getDefaultLanguage, getDefaultTemplate, getDisplayTitle, getDoc, getDocument, getDocumentArchive, getDocumentReference, getDocumentRevision, getEditURL, getEditURL, getEscapedContent, getExternalURL, getExternalURL, getExternalURL, getFirstObject, getFormat, getFullName, getId, getIncludedMacros, getIncludedPages, getLanguage, getLastChanges, getLinkedPages, getLinks, getLocked, getLockingDate, getLockingUser, getMetaDataDiff, getName, getObject, getObject, getObject, getObject, getObject, getObjectDiff, getObjectNumbers, getObjects, getObjects, getParent, getParentURL, getPlainTitle, getPrefixedFullName, getPreviousDocument, getPreviousVersion, getRCSVersion, getRealLanguage, getRecentRevisions, getRecentRevisions, getRenderedContent, getRenderedContent, getRenderedContent, getRenderedContent, getRenderedContent, getRenderedContentDiff, getRenderedTitle, getRevisionInfo, getRevisions, getRevisions, getSections, getSpace, getSyntax, getSyntaxId, getTagList, getTags, getTagsPossibleValues, getTemplate, getTextArea, getTitle, getTOC, getTranslatedContent, getTranslatedContent, getTranslatedDocument, getTranslatedDocument, getTranslationList, getURL, getURL, getURL, getValidationScript, getValue, getValue, getVersion, getVersionHashCode, getWeb, getWiki, getXMLContent, getXMLDiff, getXObjects, getxWikiClass, getxWikiClasses, getxWikiObjects, hasAccessLevel, hasAccessLevel, insertText, isAdvancedContent, isCreator, isCurrentLocalUserPage, isCurrentUserCreator, isCurrentUserPage, isFromCache, isMinorEdit, isMostRecent, isNew, isProgrammaticContent, newObject, removeObject, removeObjects, rename, rename, rename, rename, rename, renameDocument, renameDocument, save, save, save, saveAsAuthor, saveAsAuthor, saveAsAuthor, saveDocument, saveWithProgrammingRights, saveWithProgrammingRights, saveWithProgrammingRights, set, set, setComment, setContent, setCustomClass, setDefaultTemplate, setMinorEdit, setParent, setSyntax, setSyntaxId, setTitle, setValidationScript, toXML, toXMLDocument, updateObjectFromRequest, updateObjectFromRequest, updateObjectsFromRequest, updateObjectsFromRequest, use, use, use, validate, validate

Methods inherited from class com.xpn.xwiki.api.Api

convert, convert, getXWikiContext, hasAdminRights, hasProgrammingRights, hasWikiAdminRights

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

protected static final org.slf4j.Logger LOGGER

The logging tool.

Constructor Detail

Wiki

public Wiki(com.xpn.xwiki.doc.XWikiDocument xdoc,
            com.xpn.xwiki.XWikiContext context)
     throws com.xpn.xwiki.XWikiException

Create instance of wiki descriptor.

Parameters:

xdoc - the encapsulated XWikiDocument.

context - the XWiki context.

Throws:

com.xpn.xwiki.XWikiException - error when creating Document.

Method Detail

getWikiName

public String getWikiName()
                   throws com.xpn.xwiki.XWikiException

Returns:

the name of the wiki.

Throws:

com.xpn.xwiki.XWikiException - error when getting XWikiServerClass instance.

delete

public void delete(boolean deleteDatabase)
            throws com.xpn.xwiki.XWikiException

Delete the wiki.

Parameters:

deleteDatabase - if true wiki's database is also removed.

Throws:

com.xpn.xwiki.XWikiException - error deleting the wiki.

Since:

1.1

countWikiAliases

public int countWikiAliases()
                     throws com.xpn.xwiki.XWikiException

Returns:

the number of wiki aliases in this wiki.

Throws:

com.xpn.xwiki.XWikiException - when getting the number of wiki aliases.

Since:

1.1

getWikiAliasIdFromDomain

public int getWikiAliasIdFromDomain(String domain)
                             throws com.xpn.xwiki.XWikiException

Get wiki alias id from domain name.

Parameters:

domain - the wiki alias domain name.

Returns:

the wiki alias id.

Throws:

com.xpn.xwiki.XWikiException - error when getting wiki alias id from domain name.

Since:

1.1

getWikiAliasList

public Collection<XWikiServer> getWikiAliasList()
                                         throws com.xpn.xwiki.XWikiException

Returns:

the list of aliases to of this wiki.

Throws:

com.xpn.xwiki.XWikiException - error when getting aliases.

getWikiAlias

public XWikiServer getWikiAlias(String domain)
                         throws com.xpn.xwiki.XWikiException

Get wiki alias with provided domain name.

Parameters:

domain - the domain name of the wiki alias.

Returns:

a wiki alias.

Throws:

com.xpn.xwiki.XWikiException - error when :

• getting XWikiServerClass instance
• or creating wiki alias object.

getWikiAlias

public XWikiServer getWikiAlias(int id)
                         throws com.xpn.xwiki.XWikiException

Get wiki alias with provided id.

Parameters:

id - the id of the wiki alias.

Returns:

an wiki alias.

Throws:

com.xpn.xwiki.XWikiException - error when creating wiki alias object.

getFirstWikiAlias

public XWikiServer getFirstWikiAlias()
                              throws com.xpn.xwiki.XWikiException

Returns:

the first wiki alias used to describe the wiki itself.

Throws:

com.xpn.xwiki.XWikiException - error when creating wiki alias object.

containsWikiAlias

public boolean containsWikiAlias(String domain)

Check if a wiki alias with provided name exists.

Parameters:

domain - the domain name of the wiki alias.

Returns:

true if the wiki alias with provided domain name exists, false otherwise or if there is any error.

Since:

1.1

toString

public String toString()

Overrides:

toString in class Document

See Also:

Object.toString()