WikiSoapService (Atlassian Confluence 6.6.0 API)

java.lang.Object
- com.atlassian.confluence.rpc.soap.WikiSoapService

All Implemented Interfaces:

SecureRpc, ConfluenceSoapService
```
public class WikiSoapService
extends Object
implements ConfluenceSoapService
```
SOAP API for wikimarkup formatted input and output.
All methods that retrieve remote objects (for example RemotePage) that contain wiki markup throw exceptions. As of 4.0, all wiki content is migrated to xhtml storage format and as such, there will be no wiki formatted content to return. Throwing an exception is preferable because we don't want scripts to continue to operate on content that it assumes to be wiki markup but is not. This can lead to corrupted content being saved.

Field Summary
- Fields inherited from interface com.atlassian.confluence.rpc.soap.ConfluenceSoapService
  ADMIN_SPACE_PERMISSION, COMMENT_PERMISSION, MODIFY_PERMISSION, VIEW_PERMISSION

Constructor Summary

Constructors
Constructor and Description

WikiSoapService()

Constructors
Constructor and Description
`WikiSoapService()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`addAnonymousPermissionsToSpace(String token, String[] permissions, String spaceKey)` Add Space Permissions for anonymous users
`boolean`	`addAnonymousPermissionToSpace(String token, String permission, String spaceKey)` Add a Space Permission for anonymous users
`boolean`	`addAnonymousUsePermission(String token)`
`boolean`	`addAnonymousViewUserProfilePermission(String token)` This permission can only be set if the anonymous user already has 'use' permission.
`RemoteAttachment`	`addAttachment(String token, long contentId, RemoteAttachment attachment, byte[] attachmentData)` Add a new attachment to a ContentEntityObject.
`RemoteAttachment`	`addAttachment(String token, RemoteAttachment attachment, byte[] attachmentData)` Deprecated. since 2.7. Use `addAttachment(String, long, com.atlassian.confluence.rpc.soap.beans.RemoteAttachment, byte[])`
`RemoteComment`	`addComment(String token, RemoteComment comment)` Adds a comment to a page or blog post
`boolean`	`addGlobalPermission(String token, String permission, String remoteEntityName)` Add global permissions for a user or group
`boolean`	`addGlobalPermissions(String token, String[] permissions, String remoteEntityName)` Add a global permission for a user or group
`boolean`	`addGroup(String token, String groupname)` Adds a new group
`boolean`	`addLabelById(String token, long labelId, long objectId)` Adds a label with the given ID to the object with the given ContentEntityObject ID.
`boolean`	`addLabelByName(String token, String labelName, long objectId)` Adds a label to the object with the given ContentEntityObject ID.
`boolean`	`addLabelByNameToSpace(String token, String labelName, String spaceKey)` Adds a label to the object with the given ContentEntityObject ID.
`boolean`	`addLabelByObject(String token, RemoteLabel labelObject, long objectId)` Adds the given label object to the object with the given ContentEntityObject ID.
`boolean`	`addPermissionsToSpace(String token, String[] permissions, String remoteEntityName, String spaceKey)` Add Space Permissions for a user or group
`boolean`	`addPermissionToSpace(String token, String permission, String remoteEntityName, String spaceKey)` Add a Space Permission for a user or group
`RemoteSpace`	`addPersonalSpace(String token, RemoteSpace space, String username)`
`RemoteSpace`	`addPersonalSpaceWithDefaultPermissions(String token, RemoteSpace space, String username)`
`boolean`	`addProfilePicture(String token, String userName, String fileName, String mimeType, byte[] pictureData)` Add a profile picture to a user's profile
`RemoteSpace`	`addSpace(String token, RemoteSpace space)`
`RemoteSpaceGroup`	`addSpaceGroup(String token, RemoteSpaceGroup spaceGroup)` Add a space Group to Confluence
`RemoteSpace`	`addSpaceWithDefaultPermissions(String token, RemoteSpace space)`
`void`	`addUser(String token, RemoteUser remoteUser, String password)` Adds a user with the given RemoteUser object and password
`void`	`addUser(String token, RemoteUser remoteUser, String password, boolean notifyUser)` Adds a user with the given RemoteUser object and password
`boolean`	`addUserToGroup(String token, String username, String groupname)`
`boolean`	`changeMyPassword(String token, String oldPass, String newPass)` Change the current user's password
`boolean`	`changeUserPassword(String token, String username, String newPass)` Change a user's password
`boolean`	`clearIndexQueue(String token)`
`String`	`convertWikiToStorageFormat(String token, String markup)` Converts a string from wiki markup to the XHTML based storage format.
`boolean`	`deactivateUser(String token, String username)` Deactivates the given user
`RemoteComment`	`editComment(String token, RemoteComment comment)` Updates a comment
`boolean`	`editUser(String token, RemoteUser remoteUser)` Edits a user with the values in the given RemoteUser object
`Boolean`	`emptyTrash(String token, String spaceKey)`
`String`	`exportSite(String token, boolean exportAttachments)`
`String`	`exportSpace(String token, String spaceKey, String exportType)`
`String`	`exportSpace(String token, String spaceKey, String exportType, boolean exportAll)`
`boolean`	`flushIndexQueue(String token)`
`String[]`	`getActiveUsers(String token, boolean viewAll)` Returns a list of the current system users
`RemotePageSummary[]`	`getAncestors(String token, long pageId)` Returns all direct ancestor pages of the page with the given pageId the user authenticated by token is allowed to view.
`RemoteAttachment`	`getAttachment(String token, long entityId, String fileName, int version)` Retrieve information about an attachment.
`byte[]`	`getAttachmentData(String token, long entityId, String fileName, int version)` Retrieve the contents of an attachment.
`RemoteAttachment[]`	`getAttachments(String token, long pageId)`
`RemoteBlogEntrySummary[]`	`getBlogEntries(String token, String spaceKey)`
`RemoteBlogEntry`	`getBlogEntry(String token, long entryId)`
`RemoteBlogEntry`	`getBlogEntryByDateAndTitle(String token, String spaceKey, int year, int month, int dayOfMonth, String postTitle)` Retrieves a blog post in the given space, with the title and date as specified.
`RemoteBlogEntry`	`getBlogEntryByDayAndTitle(String token, String spaceKey, int dayOfMonth, String postTitle)` Retrieves a blog post in the Space with the given spaceKey, with the title 'postTitle' and posted on the day 'dayOfMonth'
`RemotePageSummary[]`	`getChildren(String token, long pageId)` Returns all child pages of the page with the given pageId the user authenticated by token is allowed to view.
`RemoteClusterInformation`	`getClusterInformation(String token)`
`RemoteNodeStatus[]`	`getClusterNodeStatuses(String token)`
`RemoteComment`	`getComment(String token, long commentId)` Retrieves a comment with the given ID
`RemoteComment[]`	`getComments(String token, long pageId)` Retrieves the comments for a given abstract page
`RemoteContentPermissionSet`	`getContentPermissionSet(String token, long contentId, String permissionType)` Get the content permission set of a certain type for a particular piece of content
`RemoteContentPermissionSet[]`	`getContentPermissionSets(String token, long contentId)` Get the content permission sets for a particular piece of content
`RemotePageSummary[]`	`getDescendents(String token, long pageId)` Returns all descendent pages of the page with the given pageId the user authenticated by token is allowed to view.
`String[]`	`getGroups(String token)` Retrieves a list of user groups
`RemoteSearchResult[]`	`getLabelContentById(String token, long labelId)` Returns the content for a given label ID
`RemoteSearchResult[]`	`getLabelContentByName(String token, String labelName)` Returns the content for a given label name
`RemoteSearchResult[]`	`getLabelContentByObject(String token, RemoteLabel labelObject)` Returns the content for a given label object
`RemoteLabel[]`	`getLabelsByDetail(String token, String labelName, String namespace, String spaceKey, String owner)` Retrieves the labels matching the given labelName, namespace or owner.
`RemoteLabel[]`	`getLabelsById(String token, long objectId)` Returns all labels for the given ContentEntityObject ID.
`RemoteLabel[]`	`getMostPopularLabels(String token, int maxCount)` Returns the most popular labels for the Confluence instance, with a specified maximum number of results.
`RemoteLabel[]`	`getMostPopularLabelsInSpace(String token, String spaceKey, int maxCount)` Returns the most popular labels for the given spaceKey, with a specified maximum number of results.
`RemotePage`	`getPage(String token, long pageId)`
`RemotePage`	`getPage(String token, String spaceKey, String pageTitle)`
`RemotePageHistory[]`	`getPageHistory(String token, long pageId)`
`RemotePermission[]`	`getPagePermissions(String token, long pageId)`
`RemotePageSummary[]`	`getPages(String token, String spaceKey)` Returns all pages of the space with the given spaceKey the user authenticated by token is allowed to view.
`RemotePageSummary`	`getPageSummary(String token, long pageId)`
`RemotePageSummary`	`getPageSummary(String token, String spaceKey, String pageTitle)`
`String[]`	`getPermissions(String token, String spaceKey)`
`String[]`	`getPermissionsForUser(String token, String spaceKey, String userName)`
`RemoteLabel[]`	`getRecentlyUsedLabels(String token, int maxResults)` Returns the recently used labels for the Confluence instance, with a specified maximum number of results.
`RemoteLabel[]`	`getRecentlyUsedLabelsInSpace(String token, String spaceKey, int maxResults)` Returns the recently used labels for the given spaceKey, with a specified maximum number of results.
`RemoteLabel[]`	`getRelatedLabels(String token, String labelName, int maxResults)` Returns the labels related to the given label name, with a specified maximum number of results.
`RemoteLabel[]`	`getRelatedLabelsInSpace(String token, String labelName, String spaceKey, int maxResults)` Returns the labels related to the given label name for the given spaceKey, with a specified maximum number of results.
`RemoteServerInfo`	`getServerInfo(String token)`
`RemoteSpace`	`getSpace(String token, String spaceKey)`
`RemoteSpaceGroup`	`getSpaceGroup(String token, String spaceGroup)`
`RemoteSpaceGroup[]`	`getSpaceGroups(String token)`
`String[]`	`getSpaceLevelPermissions(String token)`
`RemoteSpacePermissionSet`	`getSpacePermissionSet(String token, String spaceKey, String permissionType)`
`RemoteSpacePermissionSet[]`	`getSpacePermissionSets(String token, String spaceKey)`
`RemoteSpaceSummary[]`	`getSpaces(String token)`
`RemoteSpace[]`	`getSpacesContainingContentWithLabel(String token, String labelName)` Returns all Spaces that have content labelled with labelName
`RemoteSpaceSummary[]`	`getSpacesInGroup(String token, String spaceGroupKey)`
`String`	`getSpaceStatus(String token, String spaceKey)`
`RemoteSpace[]`	`getSpacesWithLabel(String token, String labelName)` Returns an array of Spaces that have been labelled with labelName
`RemotePageSummary[]`	`getTopLevelPages(String token, String spaceKey)` Returns all top level pages of the space with the given spaceKey the user authenticated by token is allowed to view.
`RemoteContentSummaries`	`getTrashContents(String token, String spaceKey, int offset, int count)`
`RemoteUser`	`getUser(String token, String username)` Retrieves a user with the given username
`RemoteConfluenceUser`	`getUserByKey(String token, String key)` Retrieves a user with the given user key.
`RemoteConfluenceUser`	`getUserByName(String token, String username)` Retrieves a user with the given username.
`String[]`	`getUserGroups(String token, String username)` Retrieves the groups that a given user belongs to
`RemoteUserInformation`	`getUserInformation(String token, String username)` Retrieves a user's information
`boolean`	`getUserPreferenceBoolean(String token, String username, String key)` Get a user preference as a boolean value.
`long`	`getUserPreferenceLong(String token, String username, String key)` Get a user preference as a long integer value.
`String`	`getUserPreferenceString(String token, String username, String key)` Get a user preference as a String value.
`RemoteUser[]`	`getWatchersForPage(String token, long pageId)` Returns the list of users watching the page or blog post with the given ID.
`RemoteUser[]`	`getWatchersForSpace(String token, String spaceKey)` Returns the list of users watching the space with the given key.
`boolean`	`hasGroup(String token, String groupname)` Determines whether a group exists
`boolean`	`hasUser(String token, String username)` Determines whether a user exists
`boolean`	`importSpace(String token, byte[] importData)` Import a space in a compressed XML format
`boolean`	`installPlugin(String token, String pluginFileName, byte[] pluginData)` Installs a plugin.
`boolean`	`isActiveUser(String token, String username)` Checks if a given user is active.
`boolean`	`isDarkFeatureEnabled(String token, String key)`
`boolean`	`isPluginEnabled(String token, String pluginKey)` Returns true if the specified plugin is enabled.
`boolean`	`isPluginInstalled(String token, String pluginKey)` Returns true if the specified plugin is installed.
`boolean`	`isWatchingPage(String token, long pageId, String username)` Returns true if the specified user is watching the page or blog post with the given ID, otherwise false.
`boolean`	`isWatchingSpace(String token, String spaceKey, String username)` Returns true if the specified user is watching the space with the given key, otherwise false.
`boolean`	`isWatchingSpaceForType(String token, String spaceKey, String contentType, String username)` Returns true if the specified user is watching the specified type of content in space with the given key, otherwise false.
`String`	`login(String username, String password)`
`boolean`	`logout(String token)`
`boolean`	`moveAttachment(String token, long originalContentId, String originalFileName, long newContentId, String newFileName)` Move or rename an attachment
`Boolean`	`movePage(String token, long sourcePageId, long targetPageId, String position)`
`Boolean`	`movePageToTopLevel(String token, long pageId, String targetSpaceKey)`
`String`	`performBackup(String token, boolean exportAttachments)`
`Boolean`	`purgeFromTrash(String token, String spaceKey, long pageId)`
`boolean`	`reactivateUser(String token, String username)` Reactivates the given user
`boolean`	`recoverMainIndex(String token)`
`boolean`	`removeAllPermissionsForGroup(String token, String groupname)` Deletes all global and space permissions for the given group
`boolean`	`removeAnonymousPermissionFromSpace(String token, String permission, String spaceKey)` Removes a Space Permission for anonymous users
`boolean`	`removeAnonymousUsePermission(String token)` Remove anonymous use permission.
`boolean`	`removeAnonymousViewUserProfilePermission(String token)`
`boolean`	`removeAttachment(String token, long contentId, String fileName)` Remove an attachment.
`boolean`	`removeComment(String token, long commentId)` Removes a comment with the given ID
`boolean`	`removeGlobalPermission(String token, String permission, String remoteEntityName)` Remove a global permission
`boolean`	`removeGroup(String token, String groupname, String defaultGroupName)` Removes an existing group
`boolean`	`removeLabelById(String token, long labelId, long objectId)` Removes the label with the given ID from the object with the given ContentEntityObject ID.
`boolean`	`removeLabelByName(String token, String labelName, long objectId)` Removes the given label from the object with the given ContentEntityObject ID.
`boolean`	`removeLabelByNameFromSpace(String token, String labelName, String spaceKey)` Removes the given label from the given Space
`boolean`	`removeLabelByObject(String token, RemoteLabel labelObject, long objectId)` Removes the given label object from the object with the given ContentEntityObject ID.
`Boolean`	`removePage(String token, long pageId)`
`Boolean`	`removePageVersionById(String token, long historicalPageId)` Remove a historical version of a page.
`Boolean`	`removePageVersionByVersion(String token, long pageId, int version)` Remove the identified version of a page.
`boolean`	`removePageWatch(String token, long pageId)` Remove a watch for the current user on the page or blog post with the specified page ID.
`boolean`	`removePageWatchForUser(String token, long pageId, String username)` Removes a watch from a specific page or blog post for a particular user.
`boolean`	`removePermissionFromSpace(String token, String permission, String remoteEntityName, String spaceKey)` Removes a Space Permission for a user or group
`Boolean`	`removeSpace(String token, String spaceKey)`
`boolean`	`removeSpaceGroup(String token, String spaceGroupKey)` Removes a Space Group from Confluence without removeing the space it contains.
`boolean`	`removeSpaceWatch(String token, String spaceKey)` Removes a watch for the current user on the space with the specified space key.
`boolean`	`removeUser(String token, String username)` Removes a user with the given username
`boolean`	`removeUserFromGroup(String token, String username, String groupname)` Removes the given user from a group
`boolean`	`renameUser(String token, String oldUsername, String newUsername)` Change user's username
`String[]`	`renameUsers(String token, Map<String,String> oldUsernamesToNewUsernames)` Change usernames for a set of users
`String`	`renderContent(String token, String spaceKey, long pageId, String newContent)`
`String`	`renderContent(String token, String spaceKey, long pageId, String newContent, Map renderParameters)`
`RemoteSearchResult[]`	`search(String token, String query, int maxResults)` Search Confluence for the supplied query String.
`RemoteSearchResult[]`	`search(String token, String query, Map params, int maxResults)` Search Confluence for the supplied query String.
`void`	`setContentEntityObjectDao(ContentEntityObjectDao contentEntityObjectDao)`
`boolean`	`setContentPermissions(String token, long contentId, String permissionType, RemoteContentPermission[] remoteContentPermissions)` Set the content permissions for a particular permission type on some content.
`boolean`	`setEnableAnonymousAccess(String token, boolean value)`
`boolean`	`setEnableWysiwyg(String token, boolean value)` Deprecated. since 4.0. You can no longer disable the wysiwyg editor.
`void`	`setSettingsManager(SettingsManager settingsManager)`
`Boolean`	`setSpaceStatus(String token, String spaceKey, String status)`
`boolean`	`setUserInformation(String token, RemoteUserInformation userInfo)` Updates a user's information
`boolean`	`setUserPreferenceBoolean(String token, String username, String key, boolean value)` Set a user preference to a boolean value.
`boolean`	`setUserPreferenceLong(String token, String username, String key, long value)` Set a user preference to an long integer value.
`boolean`	`setUserPreferenceString(String token, String username, String key, String value)` Set a user preference to a String value.
`void`	`setWikiToXhtmlMigrator(ExceptionTolerantMigrator wikiToXhtmlMigrator)`
`void`	`setXhtmlSoapService(ConfluenceSoapService soapService)`
`boolean`	`startActivity(String token, String key, String user)` Call startActivity on the heartbeat manager bean
`boolean`	`stopActivity(String token, String key, String user)` Call stopActivity on the heartbeat manager bean
`RemoteBlogEntry`	`storeBlogEntry(String token, RemoteBlogEntry blogEntry)`
`RemotePage`	`storePage(String token, RemotePage page)`
`RemoteSpace`	`storeSpace(String token, RemoteSpace remoteSpace)` Allows for modifying space details via the remote API.
`RemotePage`	`updatePage(String token, RemotePage page, RemotePageUpdateOptions options)`
`boolean`	`watchPage(String token, long pageId)` Adds a watch for the current user on the page or blog post with the specified page ID.
`boolean`	`watchPageForUser(String token, long pageId, String username)` Adds a watch to a specific page or blog post for a particular user.
`boolean`	`watchSpace(String token, String spaceKey)` Adds a watch for the current user on the space with the specified space key.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WikiSoapService
```
public WikiSoapService()
```
- Method Detail
  - getBlogEntryByDayAndTitle
```
public RemoteBlogEntry getBlogEntryByDayAndTitle(String token,
                                                 String spaceKey,
                                                 int dayOfMonth,
                                                 String postTitle)
                                          throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Retrieves a blog post in the Space with the given spaceKey, with the title 'postTitle' and posted on the day 'dayOfMonth'
    
    Specified by:
    
    getBlogEntryByDayAndTitle in interface ConfluenceSoapService
    
    Parameters:
    
    token - the authentication token
    
    spaceKey - the key of the Space the blog post belongs to
    
    dayOfMonth - the day of the month the blog post was made
    
    postTitle - the title of the blog post
    
    Returns:
    
    A RemoteBlogEntry object
    
    Throws:
    
    RemoteException - if the user does not have permission to view the blog post, or it does not exist
  - getBlogEntryByDateAndTitle
```
public RemoteBlogEntry getBlogEntryByDateAndTitle(String token,
                                                  String spaceKey,
                                                  int year,
                                                  int month,
                                                  int dayOfMonth,
                                                  String postTitle)
                                           throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Retrieves a blog post in the given space, with the title and date as specified.
    
    Specified by:
    
    getBlogEntryByDateAndTitle in interface ConfluenceSoapService
    
    Returns:
    
    a blog post matching the criteria
    
    Throws:
    
    RemoteException - if the user does not have permission to view the blog post or it does not exist
  - getBlogEntry
```
public RemoteBlogEntry getBlogEntry(String token,
                                    long entryId)
                             throws RemoteException
```
    Specified by:
    
    getBlogEntry in interface ConfluenceSoapService
    
    Throws:
    
    RemoteException
  - getPage
```
public RemotePage getPage(String token,
                          String spaceKey,
                          String pageTitle)
                   throws InvalidSessionException,
                          RemoteException
```
    Specified by:
    
    getPage in interface ConfluenceSoapService
    
    Throws:
    
    InvalidSessionException
    
    RemoteException
  - getPageSummary
```
public RemotePageSummary getPageSummary(String token,
                                        String spaceKey,
                                        String pageTitle)
                                 throws InvalidSessionException,
                                        RemoteException
```
    Specified by:
    
    getPageSummary in interface ConfluenceSoapService
    
    Throws:
    
    InvalidSessionException
    
    RemoteException
  - getPage
```
public RemotePage getPage(String token,
                          long pageId)
                   throws InvalidSessionException,
                          RemoteException
```
    Specified by:
    
    getPage in interface ConfluenceSoapService
    
    Throws:
    
    InvalidSessionException
    
    RemoteException
  - getPageSummary
```
public RemotePageSummary getPageSummary(String token,
                                        long pageId)
                                 throws InvalidSessionException,
                                        RemoteException
```
    Specified by:
    
    getPageSummary in interface ConfluenceSoapService
    
    Throws:
    
    InvalidSessionException
    
    RemoteException
  - getComments
```
public RemoteComment[] getComments(String token,
                                   long pageId)
                            throws InvalidSessionException,
                                   RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Retrieves the comments for a given abstract page
    
    Specified by:
    
    getComments in interface ConfluenceSoapService
    
    Parameters:
    
    token - the authentication token
    
    pageId - the content ID of the abstract page
    
    Returns:
    
    RemoteComment object with the comment details
    
    Throws:
    
    InvalidSessionException
    
    RemoteException - if the object for the pageId is null, or the user lacks permissions
  - getComment
```
public RemoteComment getComment(String token,
                                long commentId)
                         throws InvalidSessionException,
                                RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Retrieves a comment with the given ID
    
    Specified by:
    
    getComment in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    commentId - The ID of the comment to be retrieved
    
    Returns:
    
    A RemoteComment object containing the comment information
    
    Throws:
    
    InvalidSessionException
    
    RemoteException - if the comment cannot be found
  - login
```
public String login(String username,
                    String password)
             throws AuthenticationFailedException,
                    RemoteException
```
    Specified by:
    
    login in interface SecureRpc
    
    Specified by:
    
    login in interface ConfluenceSoapService
    
    Throws:
    
    AuthenticationFailedException
    
    RemoteException
  - logout
```
public boolean logout(String token)
               throws RemoteException
```
    Specified by:
    
    logout in interface SecureRpc
    
    Specified by:
    
    logout in interface ConfluenceSoapService
    
    Throws:
    
    RemoteException
  - getSpaces
```
public RemoteSpaceSummary[] getSpaces(String token)
                               throws InvalidSessionException,
                                      RemoteException
```
    Specified by:
    
    getSpaces in interface ConfluenceSoapService
    
    Throws:
    
    InvalidSessionException
    
    RemoteException
  - getSpacesInGroup
```
public RemoteSpaceSummary[] getSpacesInGroup(String token,
                                             String spaceGroupKey)
                                      throws RemoteException
```
    Specified by:
    
    getSpacesInGroup in interface ConfluenceSoapService
    
    Throws:
    
    RemoteException
  - addSpaceWithDefaultPermissions
```
public RemoteSpace addSpaceWithDefaultPermissions(String token,
                                                  RemoteSpace space)
                                           throws NotPermittedException,
                                                  InvalidSessionException,
                                                  AlreadyExistsException,
                                                  RemoteException
```
    Specified by:
    
    addSpaceWithDefaultPermissions in interface ConfluenceSoapService
    
    Throws:
    
    NotPermittedException
    
    InvalidSessionException
    
    AlreadyExistsException
    
    RemoteException
  - addSpace
```
public RemoteSpace addSpace(String token,
                            RemoteSpace space)
                     throws NotPermittedException,
                            InvalidSessionException,
                            AlreadyExistsException,
                            RemoteException
```
    Specified by:
    
    addSpace in interface ConfluenceSoapService
    
    Throws:
    
    NotPermittedException
    
    InvalidSessionException
    
    AlreadyExistsException
    
    RemoteException
  - storeSpace
```
public RemoteSpace storeSpace(String token,
                              RemoteSpace remoteSpace)
                       throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    Allows for modifying space details via the remote API. Currently you can update the following space properties:
    - Name
    - Homepage
    - SpaceGroup
    Specified by:
    
    storeSpace in interface ConfluenceSoapService
    
    Returns:
    
    Throws:
    
    RemoteException
  - addSpaceGroup
```
public RemoteSpaceGroup addSpaceGroup(String token,
                                      RemoteSpaceGroup spaceGroup)
                               throws NotPermittedException,
                                      InvalidSessionException,
                                      AlreadyExistsException,
                                      RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Add a space Group to Confluence
    
    Specified by:
    
    addSpaceGroup in interface ConfluenceSoapService
    
    Parameters:
    
    token - the authentication token
    
    spaceGroup - the spacegroup to add
    
    Returns:
    
    Throws:
    
    NotPermittedException - if the user lacks permissions to perform the action
    
    InvalidSessionException
    
    AlreadyExistsException - if a group with the same key already exists
    
    RemoteException
  - getSpaceGroup
```
public RemoteSpaceGroup getSpaceGroup(String token,
                                      String spaceGroup)
                               throws NotPermittedException,
                                      InvalidSessionException,
                                      AlreadyExistsException,
                                      RemoteException
```
    Specified by:
    
    getSpaceGroup in interface ConfluenceSoapService
    
    Throws:
    
    NotPermittedException
    
    InvalidSessionException
    
    AlreadyExistsException
    
    RemoteException
  - getSpaceGroups
```
public RemoteSpaceGroup[] getSpaceGroups(String token)
                                  throws InvalidSessionException,
                                         RemoteException
```
    Specified by:
    
    getSpaceGroups in interface ConfluenceSoapService
    
    Throws:
    
    InvalidSessionException
    
    RemoteException
  - removeSpaceGroup
```
public boolean removeSpaceGroup(String token,
                                String spaceGroupKey)
                         throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Removes a Space Group from Confluence without removeing the space it contains. Currently requires global administration rights
    
    Specified by:
    
    removeSpaceGroup in interface ConfluenceSoapService
    
    Parameters:
    
    token - the authentication token
    
    spaceGroupKey - the id of the spacegroup to be removed
    
    Returns:
    
    Throws:
    
    RemoteException
  - addPersonalSpace
```
public RemoteSpace addPersonalSpace(String token,
                                    RemoteSpace space,
                                    String username)
                             throws NotPermittedException,
                                    InvalidSessionException,
                                    AlreadyExistsException,
                                    RemoteException
```
    Specified by:
    
    addPersonalSpace in interface ConfluenceSoapService
    
    Throws:
    
    NotPermittedException
    
    InvalidSessionException
    
    AlreadyExistsException
    
    RemoteException
  - addPersonalSpaceWithDefaultPermissions
```
public RemoteSpace addPersonalSpaceWithDefaultPermissions(String token,
                                                          RemoteSpace space,
                                                          String username)
                                                   throws NotPermittedException,
                                                          InvalidSessionException,
                                                          AlreadyExistsException,
                                                          RemoteException
```
    Specified by:
    
    addPersonalSpaceWithDefaultPermissions in interface ConfluenceSoapService
    
    Throws:
    
    NotPermittedException
    
    InvalidSessionException
    
    AlreadyExistsException
    
    RemoteException
  - removeSpace
```
public Boolean removeSpace(String token,
                           String spaceKey)
                    throws NotPermittedException,
                           InvalidSessionException,
                           RemoteException
```
    Specified by:
    
    removeSpace in interface ConfluenceSoapService
    
    Throws:
    
    NotPermittedException
    
    InvalidSessionException
    
    RemoteException
  - getSpace
```
public RemoteSpace getSpace(String token,
                            String spaceKey)
                     throws InvalidSessionException,
                            RemoteException
```
    Specified by:
    
    getSpace in interface ConfluenceSoapService
    
    Throws:
    
    InvalidSessionException
    
    RemoteException
  - getPermissions
```
public String[] getPermissions(String token,
                               String spaceKey)
                        throws InvalidSessionException,
                               RemoteException
```
    Specified by:
    
    getPermissions in interface ConfluenceSoapService
    
    Throws:
    
    InvalidSessionException
    
    RemoteException
  - getPermissionsForUser
```
public String[] getPermissionsForUser(String token,
                                      String spaceKey,
                                      String userName)
                               throws InvalidSessionException,
                                      RemoteException
```
    Specified by:
    
    getPermissionsForUser in interface ConfluenceSoapService
    
    Throws:
    
    InvalidSessionException
    
    RemoteException
  - getSpacePermissionSets
```
public RemoteSpacePermissionSet[] getSpacePermissionSets(String token,
                                                         String spaceKey)
                                                  throws InvalidSessionException,
                                                         NotPermittedException,
                                                         RemoteException
```
    Specified by:
    
    getSpacePermissionSets in interface ConfluenceSoapService
    
    Throws:
    
    InvalidSessionException
    
    NotPermittedException
    
    RemoteException
  - getSpacePermissionSet
```
public RemoteSpacePermissionSet getSpacePermissionSet(String token,
                                                      String spaceKey,
                                                      String permissionType)
                                               throws InvalidSessionException,
                                                      NotPermittedException,
                                                      RemoteException
```
    Specified by:
    
    getSpacePermissionSet in interface ConfluenceSoapService
    
    Throws:
    
    InvalidSessionException
    
    NotPermittedException
    
    RemoteException
  - addPermissionToSpace
```
public boolean addPermissionToSpace(String token,
                                    String permission,
                                    String remoteEntityName,
                                    String spaceKey)
                             throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Add a Space Permission for a user or group
    
    Specified by:
    
    addPermissionToSpace in interface ConfluenceSoapService
    
    Parameters:
    
    token - the authentication token
    
    permission - the Space Permission to add
    
    remoteEntityName - the name of the user or group
    
    spaceKey - the key of the Space affected by this action
    
    Returns:
    
    True if successful, false otherwise
    
    Throws:
    
    RemoteException - if the Space Permission is null
    
    NotPermittedException - if the user lacks permissions to perform the action
  - addPermissionsToSpace
```
public boolean addPermissionsToSpace(String token,
                                     String[] permissions,
                                     String remoteEntityName,
                                     String spaceKey)
                              throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Add Space Permissions for a user or group
    
    Specified by:
    
    addPermissionsToSpace in interface ConfluenceSoapService
    
    Parameters:
    
    token - the authentication token
    
    permissions - the Space Permissions to add
    
    remoteEntityName - the name of the user or group
    
    spaceKey - the key of the Space affected by this action
    
    Returns:
    
    True if successful, false otherwise
    
    Throws:
    
    RemoteException - if the Space Permissions array is null
    
    NotPermittedException - if the user lacks permissions to perform the action
  - removePermissionFromSpace
```
public boolean removePermissionFromSpace(String token,
                                         String permission,
                                         String remoteEntityName,
                                         String spaceKey)
                                  throws NotPermittedException,
                                         RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Removes a Space Permission for a user or group
    
    Specified by:
    
    removePermissionFromSpace in interface ConfluenceSoapService
    
    Parameters:
    
    token - the authentication token
    
    permission - the Space Permission to remove
    
    remoteEntityName - the name of the user or group
    
    spaceKey - the key of the Space affected by this action
    
    Returns:
    
    True if successful, false otherwise
    
    Throws:
    
    NotPermittedException - if the user lacks permissions to perform the action
    
    RemoteException - if the Space does not exist
  - addAnonymousPermissionToSpace
```
public boolean addAnonymousPermissionToSpace(String token,
                                             String permission,
                                             String spaceKey)
                                      throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Add a Space Permission for anonymous users
    
    Specified by:
    
    addAnonymousPermissionToSpace in interface ConfluenceSoapService
    
    Parameters:
    
    token - the authentication token
    
    permission - the Space Permission to add
    
    spaceKey - the key of the Space affected by this action
    
    Returns:
    
    True if successful, false otherwise
    
    Throws:
    
    RemoteException - if the Space Permission is null
    
    NotPermittedException - if the user lacks permissions to perform the action
  - addAnonymousPermissionsToSpace
```
public boolean addAnonymousPermissionsToSpace(String token,
                                              String[] permissions,
                                              String spaceKey)
                                       throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Add Space Permissions for anonymous users
    
    Specified by:
    
    addAnonymousPermissionsToSpace in interface ConfluenceSoapService
    
    Parameters:
    
    token - the authentication token
    
    permissions - the Space Permissions to add
    
    spaceKey - the key of the Space affected by this action
    
    Returns:
    
    True if successful, false otherwise
    
    Throws:
    
    RemoteException - if the Space Permissions array is null
    
    NotPermittedException - if the user lacks permissions to perform the action
  - removeAnonymousPermissionFromSpace
```
public boolean removeAnonymousPermissionFromSpace(String token,
                                                  String permission,
                                                  String spaceKey)
                                           throws NotPermittedException,
                                                  RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Removes a Space Permission for anonymous users
    
    Specified by:
    
    removeAnonymousPermissionFromSpace in interface ConfluenceSoapService
    
    Parameters:
    
    token - the authentication token
    
    permission - the Space Permission to remove
    
    spaceKey - the key of the Space affected by this action
    
    Returns:
    
    True if successful, false otherwise
    
    Throws:
    
    NotPermittedException - if the user lacks permissions to perform the action
    
    RemoteException - if the Space does not exist
  - getSpaceLevelPermissions
```
public String[] getSpaceLevelPermissions(String token)
                                  throws RemoteException
```
    Specified by:
    
    getSpaceLevelPermissions in interface ConfluenceSoapService
    
    Throws:
    
    RemoteException
  - getPages
```
public RemotePageSummary[] getPages(String token,
                                    String spaceKey)
                             throws InvalidSessionException,
                                    RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Returns all pages of the space with the given spaceKey the user authenticated by token is allowed to view. The result is not ordered.
    
    Specified by:
    
    getPages in interface ConfluenceSoapService
    
    Parameters:
    
    token - the authentication token
    
    spaceKey - the key of the space which pages are to be returned
    
    Throws:
    
    InvalidSessionException
    
    RemoteException
  - addComment
```
public RemoteComment addComment(String token,
                                RemoteComment comment)
                         throws InvalidSessionException,
                                NotPermittedException,
                                RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Adds a comment to a page or blog post
    
    Specified by:
    
    addComment in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    comment - The RemoteComment object containing the comment information
    
    Returns:
    
    RemoteComment object
    
    Throws:
    
    InvalidSessionException
    
    NotPermittedException - if the user is unable to post the comment
    
    RemoteException - if the user does not have permission to view the page the comment is being posted to, or it does not exist
  - editComment
```
public RemoteComment editComment(String token,
                                 RemoteComment comment)
                          throws InvalidSessionException,
                                 NotPermittedException,
                                 RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Updates a comment
    
    Specified by:
    
    editComment in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    comment - The RemoteComment object containing the comment information
    
    Returns:
    
    RemoteComment object
    
    Throws:
    
    InvalidSessionException
    
    NotPermittedException - if the user is unable to edit the comment
    
    RemoteException - if the user does not have permission to view the page the comment is being posted to, or it does not exist
  - removeComment
```
public boolean removeComment(String token,
                             long commentId)
                      throws InvalidSessionException,
                             NotPermittedException,
                             RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Removes a comment with the given ID
    
    Specified by:
    
    removeComment in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    commentId - The ID of the comment to remove
    
    Returns:
    
    True if successful, false otherwise
    
    Throws:
    
    InvalidSessionException
    
    NotPermittedException - if the user does not have permission to remove the comment
    
    RemoteException - if the user does not have permission to view the page the comment is on, or it does not exist
  - getTopLevelPages
```
public RemotePageSummary[] getTopLevelPages(String token,
                                            String spaceKey)
                                     throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Returns all top level pages of the space with the given spaceKey the user authenticated by token is allowed to view. The result is ordered by child page order.
    
    Specified by:
    
    getTopLevelPages in interface ConfluenceSoapService
    
    Parameters:
    
    token - the authentication token
    
    spaceKey - the key of the space which pages are to be returned
    
    Throws:
    
    RemoteException
  - getAncestors
```
public RemotePageSummary[] getAncestors(String token,
                                        long pageId)
                                 throws InvalidSessionException,
                                        RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Returns all direct ancestor pages of the page with the given pageId the user authenticated by token is allowed to view. The result is not ordered.
    
    Specified by:
    
    getAncestors in interface ConfluenceSoapService
    
    Parameters:
    
    token - the authentication token
    
    pageId - the id of the page which child pages are to be returned
    
    Throws:
    
    InvalidSessionException
    
    RemoteException
  - getChildren
```
public RemotePageSummary[] getChildren(String token,
                                       long pageId)
                                throws InvalidSessionException,
                                       RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Returns all child pages of the page with the given pageId the user authenticated by token is allowed to view. The result is ordered by child page order.
    
    Specified by:
    
    getChildren in interface ConfluenceSoapService
    
    Parameters:
    
    token - the authentication token
    
    pageId - the id of the page which child pages are to be returned
    
    Throws:
    
    InvalidSessionException
    
    RemoteException
  - getDescendents
```
public RemotePageSummary[] getDescendents(String token,
                                          long pageId)
                                   throws InvalidSessionException,
                                          RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Returns all descendent pages of the page with the given pageId the user authenticated by token is allowed to view. The result is not ordered.
    
    Specified by:
    
    getDescendents in interface ConfluenceSoapService
    
    Parameters:
    
    token - the authentication token
    
    pageId - the id of the page which child pages are to be returned
    
    Throws:
    
    InvalidSessionException
    
    RemoteException
  - getAttachments
```
public RemoteAttachment[] getAttachments(String token,
                                         long pageId)
                                  throws InvalidSessionException,
                                         RemoteException
```
    Specified by:
    
    getAttachments in interface ConfluenceSoapService
    
    Throws:
    
    InvalidSessionException
    
    RemoteException
  - getPageHistory
```
public RemotePageHistory[] getPageHistory(String token,
                                          long pageId)
                                   throws InvalidSessionException,
                                          RemoteException
```
    Specified by:
    
    getPageHistory in interface ConfluenceSoapService
    
    Throws:
    
    InvalidSessionException
    
    RemoteException
  - watchPage
```
public boolean watchPage(String token,
                         long pageId)
                  throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Adds a watch for the current user on the page or blog post with the specified page ID.
    
    Specified by:
    
    watchPage in interface ConfluenceSoapService
    
    Returns:
    
    true if the watch was added, or false if it already exists
    
    Throws:
    
    RemoteException - if the watch could not be added
  - watchSpace
```
public boolean watchSpace(String token,
                          String spaceKey)
                   throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Adds a watch for the current user on the space with the specified space key.
    
    Specified by:
    
    watchSpace in interface ConfluenceSoapService
    
    Returns:
    
    true if the watch was added, or false if it already exists
    
    Throws:
    
    RemoteException - if the watch could not be added
  - watchPageForUser
```
public boolean watchPageForUser(String token,
                                long pageId,
                                String username)
                         throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Adds a watch to a specific page or blog post for a particular user. This is only permitted for administrators of the space containing the page or blog post.
    
    Specified by:
    
    watchPageForUser in interface ConfluenceSoapService
    
    Returns:
    
    true if the watch was added, or false if it already exists
    
    Throws:
    
    RemoteException - if the watch could not be added, or the current user does not have permission to add it
  - removePageWatch
```
public boolean removePageWatch(String token,
                               long pageId)
                        throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Remove a watch for the current user on the page or blog post with the specified page ID.
    
    Specified by:
    
    removePageWatch in interface ConfluenceSoapService
    
    Returns:
    
    true if the watch was removed, or false if it doesn't exist
    
    Throws:
    
    RemoteException - if the watch could not be removed
  - removeSpaceWatch
```
public boolean removeSpaceWatch(String token,
                                String spaceKey)
                         throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Removes a watch for the current user on the space with the specified space key.
    
    Specified by:
    
    removeSpaceWatch in interface ConfluenceSoapService
    
    Returns:
    
    true if the watch was remove, or false if it doesn't exist
    
    Throws:
    
    RemoteException - if the watch could not be removed
  - removePageWatchForUser
```
public boolean removePageWatchForUser(String token,
                                      long pageId,
                                      String username)
                               throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Removes a watch from a specific page or blog post for a particular user. This is only permitted for administrators of the space containing the page or blog post.
    
    Specified by:
    
    removePageWatchForUser in interface ConfluenceSoapService
    
    Returns:
    
    true if the watch was removed, or false if it doesn't exist
    
    Throws:
    
    RemoteException - if the watch could not be removed, or the current user does not have permission to remove it
  - isWatchingPage
```
public boolean isWatchingPage(String token,
                              long pageId,
                              String username)
                       throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Returns true if the specified user is watching the page or blog post with the given ID, otherwise false. This information is only available to administrators of the space containing the page or blog post, if the username is not the same as the current user's.
    
    Specified by:
    
    isWatchingPage in interface ConfluenceSoapService
    
    Returns:
    
    true if the user is watching the page, otherwise false
    
    Throws:
    
    RemoteException - if the current user does not have permission to see the page or administer the space, or if the page or user does not exist
  - isWatchingSpace
```
public boolean isWatchingSpace(String token,
                               String spaceKey,
                               String username)
                        throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Returns true if the specified user is watching the space with the given key, otherwise false. This information is only available to administrators of the space if the username is not the same as the current user's.
    
    Specified by:
    
    isWatchingSpace in interface ConfluenceSoapService
    
    Returns:
    
    true if the user is watching the space, otherwise false
    
    Throws:
    
    RemoteException - if the current user does not have permission to administer the space, or if the user does not exist
  - isWatchingSpaceForType
```
public boolean isWatchingSpaceForType(String token,
                                      String spaceKey,
                                      String contentType,
                                      String username)
                               throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Returns true if the specified user is watching the specified type of content in space with the given key, otherwise false. This information is only available to administrators of the space if the username is not the same as the current user's.
    Note that this method will return false if the user is watching the entire space and not just the given type.
    
    Specified by:
    
    isWatchingSpaceForType in interface ConfluenceSoapService
    
    Returns:
    
    true if the user is watching the space for the type, otherwise false
    
    Throws:
    
    RemoteException - if the current user does not have permission to administer the space, or if the user does not exist
  - getWatchersForPage
```
public RemoteUser[] getWatchersForPage(String token,
                                       long pageId)
                                throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Returns the list of users watching the page or blog post with the given ID. This information is only available to administrators of the space containing the page or blog post.
    
    Specified by:
    
    getWatchersForPage in interface ConfluenceSoapService
    
    Returns:
    
    the list of users watching the page
    
    Throws:
    
    RemoteException - if the current user does not have permission to see the page or administer the space, or if the page does not exist
  - getWatchersForSpace
```
public RemoteUser[] getWatchersForSpace(String token,
                                        String spaceKey)
                                 throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Returns the list of users watching the space with the given key. This information is only available to administrators of the space.
    
    Specified by:
    
    getWatchersForSpace in interface ConfluenceSoapService
    
    Returns:
    
    the list of users watching the space
    
    Throws:
    
    RemoteException - if the current user does not have permission to administer the space, or if the space does not exist
  - renderContent
```
public String renderContent(String token,
                            String spaceKey,
                            long pageId,
                            String newContent)
                     throws InvalidSessionException,
                            RemoteException
```
    Specified by:
    
    renderContent in interface ConfluenceSoapService
    
    Throws:
    
    InvalidSessionException
    
    RemoteException
  - renderContent
```
public String renderContent(String token,
                            String spaceKey,
                            long pageId,
                            String newContent,
                            Map renderParameters)
                     throws RemoteException
```
    Specified by:
    
    renderContent in interface ConfluenceSoapService
    
    Throws:
    
    RemoteException
  - convertWikiToStorageFormat
```
public String convertWikiToStorageFormat(String token,
                                         String markup)
                                  throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Converts a string from wiki markup to the XHTML based storage format.
    
    Specified by:
    
    convertWikiToStorageFormat in interface ConfluenceSoapService
    
    Returns:
    
    a string converted to the storage format
    
    Throws:
    
    RemoteException
  - addAttachment
```
public RemoteAttachment addAttachment(String token,
                                      long contentId,
                                      RemoteAttachment attachment,
                                      byte[] attachmentData)
                               throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Add a new attachment to a ContentEntityObject.
    
    Specified by:
    
    addAttachment in interface ConfluenceSoapService
    
    Parameters:
    
    token - the authentication token
    
    contentId - the id of the ContentEntityObject to receive the new attachment.
    
    attachment - RemoteAttachment object containing attachment information
    
    attachmentData - a byte[] continaing the contents of the attachment.
    
    Returns:
    
    the newly created attachment
    
    Throws:
    
    RemoteException
  - addAttachment
```
@Deprecated
public RemoteAttachment addAttachment(String token,
                                                  RemoteAttachment attachment,
                                                  byte[] attachmentData)
                                           throws RemoteException
```
    Deprecated. since 2.7. Use addAttachment(String, long, com.atlassian.confluence.rpc.soap.beans.RemoteAttachment, byte[])
    
    Specified by:
    
    addAttachment in interface ConfluenceSoapService
    
    Throws:
    
    RemoteException
  - getAttachment
```
public RemoteAttachment getAttachment(String token,
                                      long entityId,
                                      String fileName,
                                      int version)
                               throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Retrieve information about an attachment.
    
    Specified by:
    
    getAttachment in interface ConfluenceSoapService
    
    Parameters:
    
    token - the authentication token.
    
    entityId - the id of the ContentEntityObject the attachemt belongs to.
    
    fileName - the name of the attachment.
    
    version - the version number of the attachment.
    
    Returns:
    
    the attachment
    
    Throws:
    
    RemoteException
  - getAttachmentData
```
public byte[] getAttachmentData(String token,
                                long entityId,
                                String fileName,
                                int version)
                         throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Retrieve the contents of an attachment.
    
    Specified by:
    
    getAttachmentData in interface ConfluenceSoapService
    
    Parameters:
    
    token - the authentication token.
    
    entityId - the id of the ContentEntityObject the attachemt belongs to.
    
    fileName - the name of the attachment.
    
    version - the version number of the attachment.
    
    Returns:
    
    the attachment's data
    
    Throws:
    
    RemoteException
  - removeAttachment
```
public boolean removeAttachment(String token,
                                long contentId,
                                String fileName)
                         throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Remove an attachment.
    
    Specified by:
    
    removeAttachment in interface ConfluenceSoapService
    
    Parameters:
    
    token - the authentication token.
    
    contentId - the id of the ContentEntityObject the attachment belongs to.
    
    fileName - the name of the attachment.
    
    Returns:
    
    true if the attachment was deleted.
    
    Throws:
    
    RemoteException
  - moveAttachment
```
public boolean moveAttachment(String token,
                              long originalContentId,
                              String originalFileName,
                              long newContentId,
                              String newFileName)
                       throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Move or rename an attachment
    
    Specified by:
    
    moveAttachment in interface ConfluenceSoapService
    
    Parameters:
    
    token - the authentication token.
    
    originalContentId - the id of the ContentEntityObject the attachment belongs to.
    
    originalFileName - the name of the attachment.
    
    newContentId - the id of the ContentEntityObject the attachment is to be moved to.
    
    newFileName - the name the attachment is to be renamed to.
    
    Returns:
    
    true
    
    Throws:
    
    RemoteException
  - storePage
```
public RemotePage storePage(String token,
                            RemotePage page)
                     throws VersionMismatchException,
                            NotPermittedException,
                            InvalidSessionException,
                            RemoteException
```
    Specified by:
    
    storePage in interface ConfluenceSoapService
    
    Throws:
    
    VersionMismatchException
    
    NotPermittedException
    
    InvalidSessionException
    
    RemoteException
  - updatePage
```
public RemotePage updatePage(String token,
                             RemotePage page,
                             RemotePageUpdateOptions options)
                      throws VersionMismatchException,
                             NotPermittedException,
                             InvalidSessionException,
                             RemoteException
```
    Specified by:
    
    updatePage in interface ConfluenceSoapService
    
    Throws:
    
    VersionMismatchException
    
    NotPermittedException
    
    InvalidSessionException
    
    RemoteException
  - movePageToTopLevel
```
public Boolean movePageToTopLevel(String token,
                                  long pageId,
                                  String targetSpaceKey)
                           throws RemoteException
```
    Specified by:
    
    movePageToTopLevel in interface ConfluenceSoapService
    
    Throws:
    
    RemoteException
  - movePage
```
public Boolean movePage(String token,
                        long sourcePageId,
                        long targetPageId,
                        String position)
                 throws RemoteException
```
    Specified by:
    
    movePage in interface ConfluenceSoapService
    
    Throws:
    
    RemoteException
  - removePage
```
public Boolean removePage(String token,
                          long pageId)
                   throws NotPermittedException,
                          InvalidSessionException,
                          RemoteException
```
    Specified by:
    
    removePage in interface ConfluenceSoapService
    
    Throws:
    
    NotPermittedException
    
    InvalidSessionException
    
    RemoteException
  - removePageVersionById
```
public Boolean removePageVersionById(String token,
                                     long historicalPageId)
                              throws NotPermittedException,
                                     InvalidSessionException,
                                     RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Remove a historical version of a page. The id supplied must identify a historical version of a page rather than the latest version of the page. If you want to remove the latest version of a page and its full version history then see ConfluenceSoapService.removePage(String, long).
    
    Specified by:
    
    removePageVersionById in interface ConfluenceSoapService
    
    historicalPageId - the id of a historical version of a page
    
    Returns:
    
    true if successfully remove, otherwise false.
    
    Throws:
    
    NotPermittedException
    
    InvalidSessionException
    
    RemoteException
  - removePageVersionByVersion
```
public Boolean removePageVersionByVersion(String token,
                                          long pageId,
                                          int version)
                                   throws NotPermittedException,
                                          InvalidSessionException,
                                          RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Remove the identified version of a page. The pageId must identify a current page.
    
    Specified by:
    
    removePageVersionByVersion in interface ConfluenceSoapService
    
    pageId - the id of the page which you want to remove a version from.
    
    version - the version of the page to be removed (with 1 being the first).
    
    Returns:
    
    true if successful; otherwise false.
    
    Throws:
    
    NotPermittedException
    
    InvalidSessionException
    
    RemoteException
  - search
```
public RemoteSearchResult[] search(String token,
                                   String query,
                                   int maxResults)
                            throws InvalidSessionException,
                                   RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Search Confluence for the supplied query String. Please be sensible in your use of the maxResults parameter. Too large a value will result in this call taking a long time.
    
    Specified by:
    
    search in interface ConfluenceSoapService
    
    Parameters:
    
    token - the authentication token
    
    query - the query term for the search
    
    maxResults - the maximum number of results to be returned.
    
    Returns:
    
    an array of RemoteSearchResults. If there are no results then an empty array will be returned.
    
    Throws:
    
    InvalidSessionException
    
    RemoteException
  - search
```
public RemoteSearchResult[] search(String token,
                                   String query,
                                   Map params,
                                   int maxResults)
                            throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    Search Confluence for the supplied query String. Please be sensible in your use of the maxResults parameter.
    
    A Map of search criteria can be specified. The following keys are understood -
    - spaceKey - a key representing a single space to limit the search to.
    - type - the type of content to limit the search to.
    - modified - a String representation of a time range. See the Bonnie documentation for com.atlassian.bonnie.search.SinceDateQueryFactory for a list of understood representations.
    Specified by:
    
    search in interface ConfluenceSoapService
    
    Parameters:
    
    token - the authentication token
    
    query - the query term for the search
    
    params - a Map providing criteria to the search.
    
    maxResults - the maximum number of results to be returned.
    
    Returns:
    
    an array of RemoteSearchResults. If there are no results then an empty array will be returned.
    
    Throws:
    
    RemoteException
  - getBlogEntries
```
public RemoteBlogEntrySummary[] getBlogEntries(String token,
                                               String spaceKey)
                                        throws InvalidSessionException,
                                               RemoteException
```
    Specified by:
    
    getBlogEntries in interface ConfluenceSoapService
    
    Throws:
    
    InvalidSessionException
    
    RemoteException
  - storeBlogEntry
```
public RemoteBlogEntry storeBlogEntry(String token,
                                      RemoteBlogEntry blogEntry)
                               throws VersionMismatchException,
                                      NotPermittedException,
                                      InvalidSessionException,
                                      RemoteException
```
    Specified by:
    
    storeBlogEntry in interface ConfluenceSoapService
    
    Throws:
    
    VersionMismatchException
    
    NotPermittedException
    
    InvalidSessionException
    
    RemoteException
  - getServerInfo
```
public RemoteServerInfo getServerInfo(String token)
                               throws InvalidSessionException,
                                      RemoteException
```
    Specified by:
    
    getServerInfo in interface ConfluenceSoapService
    
    Throws:
    
    InvalidSessionException
    
    RemoteException
  - getPagePermissions
```
public RemotePermission[] getPagePermissions(String token,
                                             long pageId)
                                      throws InvalidSessionException,
                                             RemoteException
```
    Specified by:
    
    getPagePermissions in interface ConfluenceSoapService
    
    Throws:
    
    InvalidSessionException
    
    RemoteException
  - exportSpace
```
public String exportSpace(String token,
                          String spaceKey,
                          String exportType)
                   throws RemoteException
```
    Specified by:
    
    exportSpace in interface ConfluenceSoapService
    
    Throws:
    
    RemoteException
  - exportSpace
```
public String exportSpace(String token,
                          String spaceKey,
                          String exportType,
                          boolean exportAll)
                   throws RemoteException
```
    Specified by:
    
    exportSpace in interface ConfluenceSoapService
    
    Throws:
    
    RemoteException
  - exportSite
```
public String exportSite(String token,
                         boolean exportAttachments)
                  throws RemoteException
```
    Specified by:
    
    exportSite in interface ConfluenceSoapService
    
    Throws:
    
    RemoteException
  - performBackup
```
public String performBackup(String token,
                            boolean exportAttachments)
                     throws RemoteException
```
    Specified by:
    
    performBackup in interface ConfluenceSoapService
    
    Throws:
    
    RemoteException
  - importSpace
```
public boolean importSpace(String token,
                           byte[] importData)
                    throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Import a space in a compressed XML format
    
    Specified by:
    
    importSpace in interface ConfluenceSoapService
    
    Parameters:
    
    token - The authentication token
    
    importData - The contents of the Space export file
    
    Returns:
    
    True if successful, otherwise false
    
    Throws:
    
    RemoteException - If the space exists or the export file is invalid
  - flushIndexQueue
```
public boolean flushIndexQueue(String token)
                        throws RemoteException
```
    Specified by:
    
    flushIndexQueue in interface ConfluenceSoapService
    
    Throws:
    
    RemoteException
  - clearIndexQueue
```
public boolean clearIndexQueue(String token)
                        throws RemoteException
```
    Specified by:
    
    clearIndexQueue in interface ConfluenceSoapService
    
    Throws:
    
    RemoteException
  - recoverMainIndex
```
public boolean recoverMainIndex(String token)
                         throws RemoteException
```
    Specified by:
    
    recoverMainIndex in interface ConfluenceSoapService
    
    Throws:
    
    RemoteException
  - getClusterInformation
```
public RemoteClusterInformation getClusterInformation(String token)
                                               throws RemoteException
```
    Specified by:
    
    getClusterInformation in interface ConfluenceSoapService
    
    Throws:
    
    RemoteException
  - getClusterNodeStatuses
```
public RemoteNodeStatus[] getClusterNodeStatuses(String token)
                                          throws RemoteException
```
    Specified by:
    
    getClusterNodeStatuses in interface ConfluenceSoapService
    
    Throws:
    
    RemoteException
  - getGroups
```
public String[] getGroups(String token)
                   throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Retrieves a list of user groups
    
    Specified by:
    
    getGroups in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    Returns:
    
    An array of group names
    
    Throws:
    
    NotPermittedException - if the current user lacks permission to administer
    
    RemoteException
  - hasGroup
```
public boolean hasGroup(String token,
                        String groupname)
                 throws InvalidSessionException,
                        RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Determines whether a group exists
    
    Specified by:
    
    hasGroup in interface ConfluenceSoapService
    
    Parameters:
    
    token - the token identifying the current user
    
    groupname - the group to look up
    
    Returns:
    
    True if the user exists, false otherwise
    
    Throws:
    
    InvalidSessionException
    
    RemoteException
  - addGroup
```
public boolean addGroup(String token,
                        String groupname)
                 throws NotPermittedException,
                        InvalidSessionException,
                        RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Adds a new group
    
    Specified by:
    
    addGroup in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    groupname - The name of the group to be added
    
    Returns:
    
    True when the group was successfully added, false if it already exists
    
    Throws:
    
    NotPermittedException - if the current user lacks permission to administer
    
    InvalidSessionException
    
    RemoteException
  - removeGroup
```
public boolean removeGroup(String token,
                           String groupname,
                           String defaultGroupName)
                    throws NotPermittedException,
                           InvalidSessionException,
                           RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Removes an existing group
    If a valid defaultGroupName is specified, users will be added to the new group (defaultGroupName).
    
    Specified by:
    
    removeGroup in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    groupname - The name of the group to be removed
    
    defaultGroupName - The name of the group that users will be moved to
    
    Returns:
    
    True if successful, false otherwise.
    
    Throws:
    
    NotPermittedException - if the current user lacks permission to administer
    
    InvalidSessionException
    
    RemoteException - if the given groupname does not exist
  - removeAllPermissionsForGroup
```
public boolean removeAllPermissionsForGroup(String token,
                                            String groupname)
                                     throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Deletes all global and space permissions for the given group
    
    Specified by:
    
    removeAllPermissionsForGroup in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    groupname - The group to delete permissions for
    
    Returns:
    
    True if successful, false otherwise.
    
    Throws:
    
    NotPermittedException - if the current user lacks permission to administer
    
    RemoteException - if the given groupname does not exist
  - getUserGroups
```
public String[] getUserGroups(String token,
                              String username)
                       throws NotPermittedException,
                              InvalidSessionException,
                              RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Retrieves the groups that a given user belongs to
    
    Specified by:
    
    getUserGroups in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    username - The username to retrieve groups for
    
    Returns:
    
    An array of group names as Strings
    
    Throws:
    
    NotPermittedException - if the current user lacks permission to administer
    
    InvalidSessionException
    
    RemoteException - if the given username does not exist
  - addUserToGroup
```
public boolean addUserToGroup(String token,
                              String username,
                              String groupname)
                       throws NotPermittedException,
                              InvalidSessionException,
                              RemoteException
```
    Specified by:
    
    addUserToGroup in interface ConfluenceSoapService
    
    Returns:
    
    True if successful, false otherwise
    
    Throws:
    
    NotPermittedException - if the current user lacks permission to administer
    
    InvalidSessionException
    
    RemoteException - if the given username does not exist
  - removeUserFromGroup
```
public boolean removeUserFromGroup(String token,
                                   String username,
                                   String groupname)
                            throws NotPermittedException,
                                   InvalidSessionException,
                                   RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Removes the given user from a group
    
    Specified by:
    
    removeUserFromGroup in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    username - The username to remove from a group
    
    groupname - The name of the group the user is to be removed from
    
    Returns:
    
    True if successful, false otherwise
    
    Throws:
    
    NotPermittedException - if the current user lacks permission to administer
    
    InvalidSessionException
    
    RemoteException - if the given username does not exist
  - getUser
```
public RemoteUser getUser(String token,
                          String username)
                   throws InvalidSessionException,
                          RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Retrieves a user with the given username
    
    Specified by:
    
    getUser in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    username - The username of the user to be retrieved
    
    Returns:
    
    A RemoteUser object, containing the username, full name, email and URL
    
    Throws:
    
    InvalidSessionException
    
    RemoteException - if a user with the given username cannot be found
  - getUserByName
```
public RemoteConfluenceUser getUserByName(String token,
                                          String username)
                                   throws InvalidSessionException,
                                          RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Retrieves a user with the given username.
    
    Specified by:
    
    getUserByName in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    username - The username of the user to be retrieved
    
    Returns:
    
    A RemoteConfluenceUser object, containing the user key, username, full name, email and URL
    
    Throws:
    
    InvalidSessionException
    
    RemoteException - if a user with the given username cannot be found
  - getUserByKey
```
public RemoteConfluenceUser getUserByKey(String token,
                                         String key)
                                  throws InvalidSessionException,
                                         RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Retrieves a user with the given user key.
    
    Specified by:
    
    getUserByKey in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    key - The user key of the user to be retrieved
    
    Returns:
    
    A RemoteUser object, containing the user key, username, full name, email and URL
    
    Throws:
    
    InvalidSessionException
    
    RemoteException - if a user with the given user key cannot be found
  - setUserPreferenceBoolean
```
public boolean setUserPreferenceBoolean(String token,
                                        String username,
                                        String key,
                                        boolean value)
                                 throws InvalidSessionException,
                                        RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Set a user preference to a boolean value.
    
    Specified by:
    
    setUserPreferenceBoolean in interface ConfluenceSoapService
    
    Parameters:
    
    token - the token identifying the current user
    
    key - The user preference key
    
    value - The value
    
    Throws:
    
    InvalidSessionException - If the rpc token expired
    
    RemoteException - If any other exception occurred
  - getUserPreferenceBoolean
```
public boolean getUserPreferenceBoolean(String token,
                                        String username,
                                        String key)
                                 throws InvalidSessionException,
                                        RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Get a user preference as a boolean value.
    
    Specified by:
    
    getUserPreferenceBoolean in interface ConfluenceSoapService
    
    Parameters:
    
    token - the token identifying the current user
    
    key - The user preference key
    
    Throws:
    
    InvalidSessionException - If the rpc token expired
    
    RemoteException - If any other exception occurred (including not being able to find the key)
  - setUserPreferenceLong
```
public boolean setUserPreferenceLong(String token,
                                     String username,
                                     String key,
                                     long value)
                              throws InvalidSessionException,
                                     RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Set a user preference to an long integer value.
    
    Specified by:
    
    setUserPreferenceLong in interface ConfluenceSoapService
    
    Parameters:
    
    token - the token identifying the current user
    
    key - The user preference key
    
    value - The value
    
    Throws:
    
    InvalidSessionException - If the rpc token expired
    
    RemoteException - If any other exception occurred
  - getUserPreferenceLong
```
public long getUserPreferenceLong(String token,
                                  String username,
                                  String key)
                           throws InvalidSessionException,
                                  RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Get a user preference as a long integer value.
    
    Specified by:
    
    getUserPreferenceLong in interface ConfluenceSoapService
    
    Parameters:
    
    token - the token identifying the current user
    
    key - The user preference key
    
    Throws:
    
    InvalidSessionException - If the rpc token expired
    
    RemoteException - If any other exception occurred (including not being able to find the key)
  - setUserPreferenceString
```
public boolean setUserPreferenceString(String token,
                                       String username,
                                       String key,
                                       String value)
                                throws InvalidSessionException,
                                       RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Set a user preference to a String value.
    
    Specified by:
    
    setUserPreferenceString in interface ConfluenceSoapService
    
    Parameters:
    
    token - the token identifying the current user
    
    key - The user preference key
    
    value - The value
    
    Throws:
    
    InvalidSessionException - If the rpc token expired
    
    RemoteException - If any other exception occurred
  - getUserPreferenceString
```
public String getUserPreferenceString(String token,
                                      String username,
                                      String key)
                               throws InvalidSessionException,
                                      RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Get a user preference as a String value.
    
    Specified by:
    
    getUserPreferenceString in interface ConfluenceSoapService
    
    Parameters:
    
    token - the token identifying the current user
    
    key - The user preference key
    
    Throws:
    
    InvalidSessionException - If the rpc token expired
    
    RemoteException - If any other exception occurred (including not being able to find the key)
  - hasUser
```
public boolean hasUser(String token,
                       String username)
                throws InvalidSessionException,
                       RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Determines whether a user exists
    
    Specified by:
    
    hasUser in interface ConfluenceSoapService
    
    Parameters:
    
    token - the token identifying the current user
    
    username - the username to look up
    
    Returns:
    
    True if the user exists, false otherwise
    
    Throws:
    
    InvalidSessionException
    
    RemoteException
  - addUser
```
public void addUser(String token,
                    RemoteUser remoteUser,
                    String password)
             throws NotPermittedException,
                    InvalidSessionException,
                    RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Adds a user with the given RemoteUser object and password
    
    Specified by:
    
    addUser in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    remoteUser - The object containing the user information
    
    password - The password of the user
    
    Throws:
    
    NotPermittedException - if the current user lacks permissions to create new users
    
    InvalidSessionException
    
    RemoteException - if a user with the given username cannot be found
  - addUser
```
public void addUser(String token,
                    RemoteUser remoteUser,
                    String password,
                    boolean notifyUser)
             throws NotPermittedException,
                    InvalidSessionException,
                    RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Adds a user with the given RemoteUser object and password
    
    Specified by:
    
    addUser in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    remoteUser - The object containing the user information
    
    password - The password of the user
    
    notifyUser - Whether or not you want the new user to be notified of their new account
    
    Throws:
    
    NotPermittedException - if the current user lacks permissions to create new users
    
    InvalidSessionException
    
    RemoteException - if a user with the given username cannot be found
  - removeUser
```
public boolean removeUser(String token,
                          String username)
                   throws NotPermittedException,
                          InvalidSessionException,
                          RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Removes a user with the given username
    
    Specified by:
    
    removeUser in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    username - The username of the user to be removed
    
    Returns:
    
    True if successful, false otherwise
    
    Throws:
    
    NotPermittedException - if the current user lacks the permission to remove users
    
    InvalidSessionException
    
    RemoteException - if the given username cannot be found
  - editUser
```
public boolean editUser(String token,
                        RemoteUser remoteUser)
                 throws NotPermittedException,
                        InvalidSessionException,
                        RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Edits a user with the values in the given RemoteUser object
    Currently this will only update the user's full name and email
    
    Specified by:
    
    editUser in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    remoteUser - The object containing the user information
    
    Throws:
    
    NotPermittedException - if the current user cannot administer users or is not the actual user
    
    InvalidSessionException
    
    RemoteException - if a user with the given username cannot be found
  - deactivateUser
```
public boolean deactivateUser(String token,
                              String username)
                       throws NotPermittedException,
                              InvalidSessionException,
                              RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Deactivates the given user
    
    Specified by:
    
    deactivateUser in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    username - The username of the user to deactivate
    
    Returns:
    
    True if the user was successfully deactivated, false otherwise
    
    Throws:
    
    NotPermittedException - if the current user does not have permissions to perform the action
    
    InvalidSessionException
    
    RemoteException - if the given username cannot be found
  - reactivateUser
```
public boolean reactivateUser(String token,
                              String username)
                       throws NotPermittedException,
                              InvalidSessionException,
                              RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Reactivates the given user
    
    Specified by:
    
    reactivateUser in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    username - The username of the user to reactivate
    
    Returns:
    
    True if the user was successfully reactivated, false otherwise
    
    Throws:
    
    NotPermittedException - if the current user does not have permissions to perform the action
    
    InvalidSessionException
    
    RemoteException - if the given username cannot be found
  - isActiveUser
```
public boolean isActiveUser(String token,
                            String username)
                     throws NotPermittedException,
                            RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Checks if a given user is active.
    
    Specified by:
    
    isActiveUser in interface ConfluenceSoapService
    
    username - The username to check
    
    Returns:
    
    True if the user is active or does not exist, false otherwise.
    
    Throws:
    
    RemoteException - If the username does not exist
    
    NotPermittedException
  - getActiveUsers
```
public String[] getActiveUsers(String token,
                               boolean viewAll)
                        throws InvalidSessionException,
                               RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Returns a list of the current system users
    
    Specified by:
    
    getActiveUsers in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    viewAll - Whether all users should be shown. When it is false, all users in the default users group will be returned. Otherwise, every registered user is returned.
    
    Returns:
    
    An array of usernames as Strings
    
    Throws:
    
    InvalidSessionException
    
    NotPermittedException - if the current user does not have administration permissions
    
    RemoteException
  - setUserInformation
```
public boolean setUserInformation(String token,
                                  RemoteUserInformation userInfo)
                           throws NotPermittedException,
                                  InvalidSessionException,
                                  RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Updates a user's information
    Currently this will only update a user's "description", stored in the 'content' attribute
    
    Specified by:
    
    setUserInformation in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    userInfo - A RemoteUserInformation object, containing the username, email, fullname, url and information
    
    Throws:
    
    NotPermittedException - if the current user cannot administer users or is not the actual user
    
    InvalidSessionException
    
    RemoteException - if there was an error saving the personal information
  - getUserInformation
```
public RemoteUserInformation getUserInformation(String token,
                                                String username)
                                         throws InvalidSessionException,
                                                RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Retrieves a user's information
    
    Specified by:
    
    getUserInformation in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    username - The name of the user to get information on
    
    Throws:
    
    InvalidSessionException
    
    RemoteException - if a user with the given username cannot be found
  - changeMyPassword
```
public boolean changeMyPassword(String token,
                                String oldPass,
                                String newPass)
                         throws InvalidSessionException,
                                RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Change the current user's password
    
    Specified by:
    
    changeMyPassword in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    oldPass - The old password of the user, required for security purposes
    
    newPass - The new password for the user
    
    Throws:
    
    InvalidSessionException
    
    NotPermittedException - if newPass was incorrect
    
    RemoteException - if oldPass does not match the user's password
  - changeUserPassword
```
public boolean changeUserPassword(String token,
                                  String username,
                                  String newPass)
                           throws NotPermittedException,
                                  InvalidSessionException,
                                  RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Change a user's password
    
    Specified by:
    
    changeUserPassword in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    username - The username of the user we are changing the password for
    
    newPass - The new password for the user
    
    Throws:
    
    NotPermittedException - if the current user does not have permission to administer the user
    
    InvalidSessionException
    
    RemoteException - if the user cannot be found
  - addProfilePicture
```
public boolean addProfilePicture(String token,
                                 String userName,
                                 String fileName,
                                 String mimeType,
                                 byte[] pictureData)
                          throws NotPermittedException,
                                 InvalidSessionException,
                                 RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Add a profile picture to a user's profile
    
    Specified by:
    
    addProfilePicture in interface ConfluenceSoapService
    
    userName - The user name of the profile
    
    fileName - File name of the picture
    
    mimeType - Image mime type (must be from image/*)
    
    pictureData - The image data
    
    Returns:
    
    true if successful
    
    Throws:
    
    NotPermittedException - Principal is not permitted to add pictures to the specified profile
    
    InvalidSessionException
    
    RemoteException - if the user can not be found
  - renameUser
```
public boolean renameUser(String token,
                          String oldUsername,
                          String newUsername)
                   throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Change user's username
    
    Specified by:
    
    renameUser in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    oldUsername - current username of the user
    
    newUsername - new username of the user
    
    Returns:
    
    true if successful
    
    Throws:
    
    NotPermittedException - if the current user does not have permissions to perform the action
    
    InvalidSessionException
    
    RemoteException - if the new username does not meet username requirements
  - renameUsers
```
public String[] renameUsers(String token,
                            Map<String,String> oldUsernamesToNewUsernames)
                     throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Change usernames for a set of users
    
    Specified by:
    
    renameUsers in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    oldUsernamesToNewUsernames - mapping of current usernames to new usernames of users
    
    Returns:
    
    empty array if the operation was successful or usernames of users that could not be renamed
    
    Throws:
    
    NotPermittedException - if the current user does not have permissions to perform the action
    
    InvalidSessionException
    
    RemoteException - if a new username does not meet username requirements
  - getLabelsById
```
public RemoteLabel[] getLabelsById(String token,
                                   long objectId)
                            throws InvalidSessionException,
                                   RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Returns all labels for the given ContentEntityObject ID.
    
    Specified by:
    
    getLabelsById in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    objectId - The ID of the ContentEntityObject the method will retrieve the labels for
    
    Returns:
    
    An array of RemoteLabel objects
    
    Throws:
    
    RemoteException - if the object cannot be retrieved from the ContentEntityManager
    
    InvalidSessionException
  - getMostPopularLabels
```
public RemoteLabel[] getMostPopularLabels(String token,
                                          int maxCount)
                                   throws InvalidSessionException,
                                          RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Returns the most popular labels for the Confluence instance, with a specified maximum number of results.
    
    Specified by:
    
    getMostPopularLabels in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    maxCount - The maximum number of labels to return. A maxCount of 0 means there is no limit.
    
    Returns:
    
    An array of RemoteLabel objects, sorted by descending popularity
    
    Throws:
    
    InvalidSessionException
    
    RemoteException
  - getMostPopularLabelsInSpace
```
public RemoteLabel[] getMostPopularLabelsInSpace(String token,
                                                 String spaceKey,
                                                 int maxCount)
                                          throws InvalidSessionException,
                                                 RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Returns the most popular labels for the given spaceKey, with a specified maximum number of results.
    
    Specified by:
    
    getMostPopularLabelsInSpace in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    spaceKey - The key of the space to limit the labels to
    
    maxCount - The maximum number of labels to return. A maxCount of 0 means there is no limit.
    
    Returns:
    
    An array of RemoteLabel objects, sorted by descending popularity
    
    Throws:
    
    RemoteException - if the space cannot be retrieved from the SpaceManager
    
    NotPermittedException - if the given user does not have VIEW permissions for the space
    
    InvalidSessionException
  - getRecentlyUsedLabels
```
public RemoteLabel[] getRecentlyUsedLabels(String token,
                                           int maxResults)
                                    throws InvalidSessionException,
                                           RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Returns the recently used labels for the Confluence instance, with a specified maximum number of results.
    
    Specified by:
    
    getRecentlyUsedLabels in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    maxResults - The maximum number of labels to return. A value of 0 means the default is used.
    
    Returns:
    
    An array of RemoteLabel objects, sorted by most recent use
    
    Throws:
    
    InvalidSessionException
    
    RemoteException
  - getRecentlyUsedLabelsInSpace
```
public RemoteLabel[] getRecentlyUsedLabelsInSpace(String token,
                                                  String spaceKey,
                                                  int maxResults)
                                           throws InvalidSessionException,
                                                  RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Returns the recently used labels for the given spaceKey, with a specified maximum number of results.
    
    Specified by:
    
    getRecentlyUsedLabelsInSpace in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    spaceKey - The key of the space to limit the labels to
    
    maxResults - The maximum number of labels to return. A value of 0 means the default is used.
    
    Returns:
    
    An array of RemoteLabel objects, sorted by most recent use
    
    Throws:
    
    RemoteException - if the space does not exist, or the user lacks permission to view it
    
    NotPermittedException - if the given user does not have VIEW permissions for the space
    
    InvalidSessionException
  - getSpacesWithLabel
```
public RemoteSpace[] getSpacesWithLabel(String token,
                                        String labelName)
                                 throws InvalidSessionException,
                                        RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Returns an array of Spaces that have been labelled with labelName
    
    Specified by:
    
    getSpacesWithLabel in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    labelName - The name of the label (namespace prefixes permitted)
    
    Returns:
    
    An array of RemoteSpace instances
    
    Throws:
    
    InvalidSessionException
    
    RemoteException - if labelName is an empty string or null
  - getRelatedLabels
```
public RemoteLabel[] getRelatedLabels(String token,
                                      String labelName,
                                      int maxResults)
                               throws InvalidSessionException,
                                      RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Returns the labels related to the given label name, with a specified maximum number of results.
    
    Specified by:
    
    getRelatedLabels in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    labelName - The name of the label (namespace prefixes permitted)
    
    maxResults - The maximum number of labels to return. A value of 0 means the default is used.
    
    Returns:
    
    An array of RemoteLabel objects (sorted by frequency of use)
    
    Throws:
    
    RemoteException - if labelName is an empty string or null
    
    InvalidSessionException
  - getRelatedLabelsInSpace
```
public RemoteLabel[] getRelatedLabelsInSpace(String token,
                                             String labelName,
                                             String spaceKey,
                                             int maxResults)
                                      throws InvalidSessionException,
                                             RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Returns the labels related to the given label name for the given spaceKey, with a specified maximum number of results.
    
    Specified by:
    
    getRelatedLabelsInSpace in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    labelName - The name of the label (namespace prefixes permitted)
    
    spaceKey - The key of the space to limit the labels to
    
    maxResults - The maximum number of labels to return. A maxCount of 0 means the default is used.
    
    Returns:
    
    An array of RemoteLabel objects (sorted by frequency of use)
    
    Throws:
    
    RemoteException - if labelName is an empty string or null
    
    InvalidSessionException
  - getLabelsByDetail
```
public RemoteLabel[] getLabelsByDetail(String token,
                                       String labelName,
                                       String namespace,
                                       String spaceKey,
                                       String owner)
                                throws InvalidSessionException,
                                       RemoteException,
                                       NotPermittedException
```
    Description copied from interface: ConfluenceSoapService
    
    Retrieves the labels matching the given labelName, namespace or owner.
    This method can be used to retrieve labels of a specfic type, such as personal labels, by setting the namespace.
    Parameters with empty strings are ignored.
    
    Specified by:
    
    getLabelsByDetail in interface ConfluenceSoapService
    
    Parameters:
    
    token - the authentication token for the user
    
    labelName - the name of the label to search for (not parsed for prefixes)
    
    namespace - the namespace to restrict by
    
    spaceKey - the key of the space to restrict by
    
    owner - the owner of the labels
    
    Returns:
    
    an array of matching RemoteLabel objects
    
    Throws:
    
    InvalidSessionException
    
    RemoteException - if labelName is an empty string or null
    
    NotPermittedException
    
    See Also:
    
    Namespace
  - getLabelContentById
```
public RemoteSearchResult[] getLabelContentById(String token,
                                                long labelId)
                                         throws InvalidSessionException,
                                                RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Returns the content for a given label ID
    
    Specified by:
    
    getLabelContentById in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    labelId - The ID of the label
    
    Returns:
    
    An array of RemoteSearchResult objects
    
    Throws:
    
    RemoteException - if a Label could not be retrieved for the given ID
    
    InvalidSessionException
  - getLabelContentByName
```
public RemoteSearchResult[] getLabelContentByName(String token,
                                                  String labelName)
                                           throws InvalidSessionException,
                                                  RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Returns the content for a given label name
    
    Specified by:
    
    getLabelContentByName in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    labelName - The name of a label (namespace prefixes permitted)
    
    Returns:
    
    An array of RemoteSearchResult objects
    
    Throws:
    
    RemoteException - if the label name is null
    
    InvalidSessionException
  - getLabelContentByObject
```
public RemoteSearchResult[] getLabelContentByObject(String token,
                                                    RemoteLabel labelObject)
                                             throws InvalidSessionException,
                                                    RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Returns the content for a given label object
    
    Specified by:
    
    getLabelContentByObject in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    labelObject - The RemoteLabel object
    
    Returns:
    
    An array of RemoteSearchResult objects
    
    Throws:
    
    RemoteException - if the RemoteLabel object is null
    
    InvalidSessionException
  - getSpacesContainingContentWithLabel
```
public RemoteSpace[] getSpacesContainingContentWithLabel(String token,
                                                         String labelName)
                                                  throws InvalidSessionException,
                                                         RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Returns all Spaces that have content labelled with labelName
    
    Specified by:
    
    getSpacesContainingContentWithLabel in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    labelName - The label to retrieve the content for (namespace prefixes permitted)
    
    Returns:
    
    An array of RemoteSpace instances (order undefined)
    
    Throws:
    
    InvalidSessionException
    
    RemoteException - if labelName is an empty string or null
  - addLabelByName
```
public boolean addLabelByName(String token,
                              String labelName,
                              long objectId)
                       throws NotPermittedException,
                              InvalidSessionException,
                              RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Adds a label to the object with the given ContentEntityObject ID.
    
    Specified by:
    
    addLabelByName in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    labelName - The name of the label(s) to be added to the ContentEntityObject, in the form of a space-separated string
    
    objectId - The ID of the ContentEntityObject the method will act on
    
    Returns:
    
    True if successfully added, false otherwise.
    
    Throws:
    
    NotPermittedException - if the user lacks EDIT permissions for the object
    
    RemoteException - if the label name is null or an empty String
    
    InvalidSessionException
  - addLabelById
```
public boolean addLabelById(String token,
                            long labelId,
                            long objectId)
                     throws NotPermittedException,
                            InvalidSessionException,
                            RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Adds a label with the given ID to the object with the given ContentEntityObject ID.
    
    Specified by:
    
    addLabelById in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    labelId - The ID of the label to be added to the ContentEntityObject
    
    objectId - The ID of the ContentEntityObject the method will act on
    
    Returns:
    
    True if successfully added, false otherwise.
    
    Throws:
    
    NotPermittedException - if the user lacks EDIT permissions for the object
    
    RemoteException - if a Label could not be retrieved for the given ID
    
    InvalidSessionException
  - addLabelByObject
```
public boolean addLabelByObject(String token,
                                RemoteLabel labelObject,
                                long objectId)
                         throws NotPermittedException,
                                InvalidSessionException,
                                RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Adds the given label object to the object with the given ContentEntityObject ID.
    
    Specified by:
    
    addLabelByObject in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    labelObject - The label to be added to the ContentEntityObject
    
    objectId - The ID of the ContentEntityObject the method will act on
    
    Returns:
    
    True if successfully added, false otherwise.
    
    Throws:
    
    NotPermittedException - if the user lacks EDIT permissions for the object
    
    RemoteException - if the given RemoteLabel object is null
    
    InvalidSessionException
  - addLabelByNameToSpace
```
public boolean addLabelByNameToSpace(String token,
                                     String labelName,
                                     String spaceKey)
                              throws NotPermittedException,
                                     InvalidSessionException,
                                     RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Adds a label to the object with the given ContentEntityObject ID.
    
    Specified by:
    
    addLabelByNameToSpace in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    labelName - The name of the label(s) to be added to the Space, in the form of a space-separated string
    
    spaceKey - The Space to add the label to
    
    Returns:
    
    True if successfully added, false otherwise.
    
    Throws:
    
    NotPermittedException - if the user does not have permission to add the label
    
    RemoteException - if the label name is null or an empty String
    
    InvalidSessionException
  - removeLabelByName
```
public boolean removeLabelByName(String token,
                                 String labelName,
                                 long objectId)
                          throws NotPermittedException,
                                 InvalidSessionException,
                                 RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Removes the given label from the object with the given ContentEntityObject ID.
    
    Specified by:
    
    removeLabelByName in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    labelName - The name of the label(s) to be removed from the ContentEntityObject, in the form of a space-separated String
    
    objectId - The ID of the ContentEntityObject the method will act on
    
    Returns:
    
    True if successfully removed, false otherwise.
    
    Throws:
    
    NotPermittedException - if the user lacks EDIT permissions for the object
    
    RemoteException - if the label name is null
    
    InvalidSessionException
  - removeLabelById
```
public boolean removeLabelById(String token,
                               long labelId,
                               long objectId)
                        throws NotPermittedException,
                               InvalidSessionException,
                               RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Removes the label with the given ID from the object with the given ContentEntityObject ID.
    
    Specified by:
    
    removeLabelById in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    labelId - The ID of the label to be removed from the ContentEntityObject
    
    objectId - The ID of the ContentEntityObject the method will act on
    
    Returns:
    
    True if successfully removed, false otherwise.
    
    Throws:
    
    NotPermittedException - if the user lacks EDIT permissions for the object
    
    RemoteException - if a Label could not be retrieved for the given ID
    
    InvalidSessionException
  - removeLabelByObject
```
public boolean removeLabelByObject(String token,
                                   RemoteLabel labelObject,
                                   long objectId)
                            throws NotPermittedException,
                                   InvalidSessionException,
                                   RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Removes the given label object from the object with the given ContentEntityObject ID.
    
    Specified by:
    
    removeLabelByObject in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    labelObject - The label to be removed from the ContentEntityObject
    
    objectId - The ID of the ContentEntityObject the method will act on
    
    Returns:
    
    True if successfully removed, false otherwise.
    
    Throws:
    
    NotPermittedException - if the user lacks EDIT permissions for the object
    
    RemoteException - if the RemoteLabel object is null
    
    InvalidSessionException
  - removeLabelByNameFromSpace
```
public boolean removeLabelByNameFromSpace(String token,
                                          String labelName,
                                          String spaceKey)
                                   throws NotPermittedException,
                                          InvalidSessionException,
                                          RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Removes the given label from the given Space
    
    Specified by:
    
    removeLabelByNameFromSpace in interface ConfluenceSoapService
    
    Parameters:
    
    token - The token identifying the current user
    
    labelName - The name of the label(s) to be removed from the Space, in the form of a space-separated String
    
    spaceKey - The Space the method will act on
    
    Returns:
    
    True if successfully removed, false otherwise.
    
    Throws:
    
    NotPermittedException - if the user lacks EDIT permissions for the Space
    
    RemoteException - if the label name is null
    
    InvalidSessionException
  - getContentPermissionSets
```
public RemoteContentPermissionSet[] getContentPermissionSets(String token,
                                                             long contentId)
                                                      throws NotPermittedException,
                                                             InvalidSessionException,
                                                             RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Get the content permission sets for a particular piece of content
    
    Specified by:
    
    getContentPermissionSets in interface ConfluenceSoapService
    
    Parameters:
    
    token - the login token for the current user
    
    contentId - the content ID of the content to be looked up
    
    Returns:
    
    an array of the permission sets applied to that content
    
    Throws:
    
    NotPermittedException - if the content can not be found, or can not be accessed by the current user
    
    InvalidSessionException - if no login session can be found for the supplied token
    
    RemoteException - if something random goes wrong
  - getContentPermissionSet
```
public RemoteContentPermissionSet getContentPermissionSet(String token,
                                                          long contentId,
                                                          String permissionType)
                                                   throws NotPermittedException,
                                                          InvalidSessionException,
                                                          RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Get the content permission set of a certain type for a particular piece of content
    
    Specified by:
    
    getContentPermissionSet in interface ConfluenceSoapService
    
    Parameters:
    
    token - the login token for the current user
    
    contentId - the content ID of the content to be looked up
    
    permissionType - type of content permission
    
    Returns:
    
    a content permission set of the specified type on the content object to be looked up
    
    Throws:
    
    NotPermittedException - if the content can not be found, or can not be accessed by the current user
    
    InvalidSessionException - if no login session can be found for the supplied token
    
    RemoteException - if something random goes wrong
  - setContentPermissions
```
public boolean setContentPermissions(String token,
                                     long contentId,
                                     String permissionType,
                                     RemoteContentPermission[] remoteContentPermissions)
                              throws NotPermittedException,
                                     InvalidSessionException,
                                     RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Set the content permissions for a particular permission type on some content. These permissions will replace any permissions that already exist for that permission type.
    
    Specified by:
    
    setContentPermissions in interface ConfluenceSoapService
    
    Parameters:
    
    token - the login token
    
    contentId - the id of the content to have permissions set on it
    
    permissionType - the type of the permissions (one of the constants from ContentPermission)
    
    remoteContentPermissions - the permissions to set
    
    Returns:
    
    true (because RPC methods can't be void)
    
    Throws:
    
    NotPermittedException - if the content can not be found or can not be accessed by the current user
    
    InvalidSessionException - if no login session can be found for the supplied token
    
    RemoteException - if something random goes wrong
  - addGlobalPermission
```
public boolean addGlobalPermission(String token,
                                   String permission,
                                   String remoteEntityName)
                            throws NotPermittedException,
                                   RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Add global permissions for a user or group
    
    Specified by:
    
    addGlobalPermission in interface ConfluenceSoapService
    
    Parameters:
    
    token - the login token
    
    permission - the Space Permission to add
    
    remoteEntityName - the name of the user or group
    
    Returns:
    
    True if successful, false otherwise
    
    Throws:
    
    NotPermittedException - if the user lacks permissions to perform the action
    
    RemoteException
  - addGlobalPermissions
```
public boolean addGlobalPermissions(String token,
                                    String[] permissions,
                                    String remoteEntityName)
                             throws NotPermittedException,
                                    RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Add a global permission for a user or group
    
    Specified by:
    
    addGlobalPermissions in interface ConfluenceSoapService
    
    Parameters:
    
    token - the login token
    
    permissions - Array of permissions to add
    
    remoteEntityName - the name of the user or group
    
    Returns:
    
    True if successful, false otherwise
    
    Throws:
    
    NotPermittedException - if the user lacks permissions to perform the action
    
    RemoteException
  - removeGlobalPermission
```
public boolean removeGlobalPermission(String token,
                                      String permission,
                                      String remoteEntityName)
                               throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Remove a global permission
    
    Specified by:
    
    removeGlobalPermission in interface ConfluenceSoapService
    
    Parameters:
    
    token - the login token
    
    permission - the Space Permission to add
    
    remoteEntityName - the name of the user or group
    
    Returns:
    
    True if successful, false otherwise
    
    Throws:
    
    NotPermittedException - if the user lacks permissions to perform the action
    
    RemoteException
  - addAnonymousUsePermission
```
public boolean addAnonymousUsePermission(String token)
                                  throws RemoteException
```
    Specified by:
    
    addAnonymousUsePermission in interface ConfluenceSoapService
    
    Throws:
    
    RemoteException
  - removeAnonymousUsePermission
```
public boolean removeAnonymousUsePermission(String token)
                                     throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Remove anonymous use permission. If the anonymous user also has 'view user profile' permission then this will also be removed.
    
    Specified by:
    
    removeAnonymousUsePermission in interface ConfluenceSoapService
    
    Parameters:
    
    token - the login token
    
    Returns:
    
    true if successful, false otherwise.
    
    Throws:
    
    RemoteException
  - addAnonymousViewUserProfilePermission
```
public boolean addAnonymousViewUserProfilePermission(String token)
                                              throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    This permission can only be set if the anonymous user already has 'use' permission. If this is not the case then false will be returned.
    
    Specified by:
    
    addAnonymousViewUserProfilePermission in interface ConfluenceSoapService
    
    Parameters:
    
    token - the login token
    
    Returns:
    
    true if successfully set; otherwise false.
    
    Throws:
    
    RemoteException
  - removeAnonymousViewUserProfilePermission
```
public boolean removeAnonymousViewUserProfilePermission(String token)
                                                 throws RemoteException
```
    Specified by:
    
    removeAnonymousViewUserProfilePermission in interface ConfluenceSoapService
    
    Throws:
    
    RemoteException
  - startActivity
```
public boolean startActivity(String token,
                             String key,
                             String user)
                      throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Call startActivity on the heartbeat manager bean
    
    Specified by:
    
    startActivity in interface ConfluenceSoapService
    
    Parameters:
    
    token - rpc authentication token
    
    key - the activity key to start
    
    user - the username of the user starting the activity
    
    Returns:
    
    true if executes startActivity without error.
    
    Throws:
    
    RemoteException
  - stopActivity
```
public boolean stopActivity(String token,
                            String key,
                            String user)
                     throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Call stopActivity on the heartbeat manager bean
    
    Specified by:
    
    stopActivity in interface ConfluenceSoapService
    
    Parameters:
    
    token - rpc authentication token
    
    key - the activity key to stop
    
    user - the username of the user stopping the activity
    
    Returns:
    
    true if executes stopActivity without error.
    
    Throws:
    
    RemoteException
  - setEnableWysiwyg
```
@Deprecated
public boolean setEnableWysiwyg(String token,
                                            boolean value)
                                     throws RemoteException
```
    Deprecated. since 4.0. You can no longer disable the wysiwyg editor.
    
    Specified by:
    
    setEnableWysiwyg in interface ConfluenceSoapService
    
    Throws:
    
    RemoteException
  - setEnableAnonymousAccess
```
public boolean setEnableAnonymousAccess(String token,
                                        boolean value)
                                 throws RemoteException
```
    Specified by:
    
    setEnableAnonymousAccess in interface ConfluenceSoapService
    
    Throws:
    
    RemoteException
  - isPluginEnabled
```
public boolean isPluginEnabled(String token,
                               String pluginKey)
                        throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Returns true if the specified plugin is enabled.
    
    Specified by:
    
    isPluginEnabled in interface ConfluenceSoapService
    
    Throws:
    
    RemoteException
  - isPluginInstalled
```
public boolean isPluginInstalled(String token,
                                 String pluginKey)
                          throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Returns true if the specified plugin is installed.
    
    Specified by:
    
    isPluginInstalled in interface ConfluenceSoapService
    
    Throws:
    
    RemoteException
  - installPlugin
```
public boolean installPlugin(String token,
                             String pluginFileName,
                             byte[] pluginData)
                      throws RemoteException
```
    Description copied from interface: ConfluenceSoapService
    
    Installs a plugin.
    
    Specified by:
    
    installPlugin in interface ConfluenceSoapService
    
    pluginFileName - the original filename of the plugin. It should end with the correct file extension .xml or .jar.
    
    pluginData - a byte[] containing the contents of the plugin xml or jar file.
    
    Throws:
    
    RemoteException
  - isDarkFeatureEnabled
```
public boolean isDarkFeatureEnabled(String token,
                                    String key)
                             throws RemoteException
```
    Specified by:
    
    isDarkFeatureEnabled in interface ConfluenceSoapService
    
    Throws:
    
    RemoteException
  - getTrashContents
```
public RemoteContentSummaries getTrashContents(String token,
                                               String spaceKey,
                                               int offset,
                                               int count)
                                        throws RemoteException
```
    Specified by:
    
    getTrashContents in interface ConfluenceSoapService
    
    Throws:
    
    RemoteException
  - purgeFromTrash
```
public Boolean purgeFromTrash(String token,
                              String spaceKey,
                              long pageId)
                       throws RemoteException
```
    Specified by:
    
    purgeFromTrash in interface ConfluenceSoapService
    
    Throws:
    
    RemoteException
  - emptyTrash
```
public Boolean emptyTrash(String token,
                          String spaceKey)
                   throws RemoteException
```
    Specified by:
    
    emptyTrash in interface ConfluenceSoapService
    
    Throws:
    
    RemoteException
  - getSpaceStatus
```
public String getSpaceStatus(String token,
                             String spaceKey)
                      throws NotPermittedException,
                             InvalidSessionException,
                             RemoteException
```
    Specified by:
    
    getSpaceStatus in interface ConfluenceSoapService
    
    Throws:
    
    NotPermittedException
    
    InvalidSessionException
    
    RemoteException
  - setSpaceStatus
```
public Boolean setSpaceStatus(String token,
                              String spaceKey,
                              String status)
                       throws NotPermittedException,
                              InvalidSessionException,
                              RemoteException
```
    Specified by:
    
    setSpaceStatus in interface ConfluenceSoapService
    
    Throws:
    
    NotPermittedException
    
    InvalidSessionException
    
    RemoteException
  - setXhtmlSoapService
```
public void setXhtmlSoapService(ConfluenceSoapService soapService)
```
  - setWikiToXhtmlMigrator
```
public void setWikiToXhtmlMigrator(ExceptionTolerantMigrator wikiToXhtmlMigrator)
```
  - setContentEntityObjectDao
```
public void setContentEntityObjectDao(ContentEntityObjectDao contentEntityObjectDao)
```
  - setSettingsManager
```
public void setSettingsManager(SettingsManager settingsManager)
```

Class WikiSoapService

Field Summary

Fields inherited from interface com.atlassian.confluence.rpc.soap.ConfluenceSoapService

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WikiSoapService

Method Detail

getBlogEntryByDayAndTitle

getBlogEntryByDateAndTitle

getBlogEntry

getPage

getPageSummary

getPage

getPageSummary

getComments

getComment

login

logout

getSpaces

getSpacesInGroup

addSpaceWithDefaultPermissions

addSpace

storeSpace

addSpaceGroup

getSpaceGroup

getSpaceGroups

removeSpaceGroup

addPersonalSpace

addPersonalSpaceWithDefaultPermissions

removeSpace

getSpace

getPermissions

getPermissionsForUser

getSpacePermissionSets

getSpacePermissionSet

addPermissionToSpace

addPermissionsToSpace

removePermissionFromSpace

addAnonymousPermissionToSpace

addAnonymousPermissionsToSpace

removeAnonymousPermissionFromSpace

getSpaceLevelPermissions

getPages

addComment

editComment

removeComment

getTopLevelPages

getAncestors

getChildren

getDescendents

getAttachments

getPageHistory

watchPage

watchSpace

watchPageForUser

removePageWatch

removeSpaceWatch

removePageWatchForUser

isWatchingPage

isWatchingSpace

isWatchingSpaceForType

getWatchersForPage

getWatchersForSpace

renderContent

renderContent

convertWikiToStorageFormat

addAttachment

addAttachment

getAttachment

getAttachmentData

removeAttachment

moveAttachment

storePage

updatePage

movePageToTopLevel

movePage

removePage

removePageVersionById