ConfluenceXmlRpcHandler (Atlassian Confluence 6.6.0 API)

All Superinterfaces:

SecureRpc

All Known Implementing Classes:

ConfluenceXmlRpcHandlerImpl
```
public interface ConfluenceXmlRpcHandler
extends SecureRpc
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`addAnonymousPermissionsToSpace(String token, Vector permissions, String spaceKey)`
`boolean`	`addAnonymousPermissionToSpace(String token, String permission, String spaceKey)`
`boolean`	`addAnonymousUsePermission(String token)`
`boolean`	`addAnonymousViewUserProfilePermission(String token)`
`Hashtable`	`addAttachment(String token, String contentId, Hashtable attachment, byte[] attachmentData)`
`Hashtable`	`addComment(String token, Hashtable comment)`
`boolean`	`addGlobalPermission(String token, String permission, String remoteEntityName)`
`boolean`	`addGlobalPermissions(String token, Vector permissions, String remoteEntityName)`
`boolean`	`addGroup(String token, String groupname)`
`boolean`	`addLabelById(String token, String labelId, String objectId)`
`boolean`	`addLabelByName(String token, String labelName, String objectId)`
`boolean`	`addLabelByNameToSpace(String token, String labelName, String spaceKey)`
`boolean`	`addLabelByObject(String token, Hashtable labelObject, String objectId)`
`boolean`	`addPermissionsToSpace(String token, Vector permissions, String remoteEntityName, String spaceKey)`
`boolean`	`addPermissionToSpace(String token, String permission, String remoteEntityName, String spaceKey)`
`Hashtable`	`addPersonalSpace(String token, Hashtable space, String username)`
`boolean`	`addProfilePicture(String token, String userName, String fileName, String mimeType, byte[] pictureData)`
`Hashtable`	`addSpace(String token, Hashtable space)`
`Hashtable`	`addSpaceGroup(String token, Hashtable spaceGroup)` Deprecated. since 5.9. `SpaceGroup` and related classes like `SpaceGroupManager` and `SpaceGroupComparator` will be removed. Please do not use them.
`boolean`	`addUser(String token, Hashtable remoteUser, String password)`
`boolean`	`addUser(String token, Hashtable remoteUser, String password, boolean NotifyUser)`
`boolean`	`addUserToGroup(String token, String username, String groupname)`
`boolean`	`changeMyPassword(String token, String oldPass, String newPass)`
`boolean`	`changeUserPassword(String token, String username, String newPass)`
`boolean`	`clearIndexQueue(String token)`
`String`	`convertWikiToStorageFormat(String token, String wiki)`
`boolean`	`deactivateUser(String token, String username)`
`Hashtable`	`editComment(String token, Hashtable comment)`
`boolean`	`editUser(String token, Hashtable remoteUser)`
`Boolean`	`emptyTrash(String token, String spaceKey)`
`String`	`exportSite(String token, boolean exportAttachments)`
`String`	`exportSpace(String token, String spaceKey, String exportType)`
`boolean`	`flushIndexQueue(String token)`
`Vector`	`getActiveUsers(String token, boolean viewAll)`
`Vector`	`getAncestors(String token, String pageId)`
`Hashtable`	`getAttachment(String token, String contentId, String fileName, String version)`
`byte[]`	`getAttachmentData(String token, String contentId, String fileName, String version)`
`Vector`	`getAttachments(String token, String pageId)`
`Vector`	`getBlogEntries(String token, String spaceKey)`
`Hashtable`	`getBlogEntry(String token, String blogEntryId)`
`Hashtable`	`getBlogEntryByDateAndTitle(String token, String spaceKey, int year, int month, int dayOfMonth, String postTitle)`
`Hashtable`	`getBlogEntryByDayAndTitle(String token, String spaceKey, int dayOfMonth, String postTitle)`
`Vector`	`getChildren(String token, String pageId)`
`Hashtable`	`getClusterInformation(String token)`
`Vector`	`getClusterNodeStatuses(String token)`
`Hashtable`	`getComment(String token, String commentId)`
`Vector`	`getComments(String token, String pageId)`
`Vector`	`getContentPermissions(String token, String contentId)`
`Hashtable`	`getContentPermissionSet(String token, String contentId, String permissionType)`
`Vector`	`getContentPermissionSets(String token, String contentId)`
`Vector`	`getDescendents(String token, String pageId)`
`Vector`	`getGroups(String token)`
`Vector`	`getLabelContentById(String token, String labelId)`
`Vector`	`getLabelContentByName(String token, String labelName)`
`Vector`	`getLabelContentByObject(String token, Hashtable labelObject)`
`Vector`	`getLabelsByDetail(String token, String labelName, String namespace, String spaceKey, String owner)`
`Vector`	`getLabelsById(String token, String objectId)`
`Vector`	`getMostPopularLabels(String token, int maxCount)`
`Vector`	`getMostPopularLabelsInSpace(String token, String spaceKey, int maxCount)`
`Hashtable`	`getPage(String token, String pageId)`
`Hashtable`	`getPage(String token, String spaceKey, String pageTitle)`
`Vector`	`getPageHistory(String token, String pageId)`
`Vector`	`getPagePermissions(String token, String pageId)`
`Vector`	`getPages(String token, String spaceKey)`
`Hashtable`	`getPageSummary(String token, String pageId)`
`Hashtable`	`getPageSummary(String token, String spaceKey, String pageTitle)`
`Vector`	`getPermissions(String token, String spaceKey)`
`Vector`	`getPermissionsForUser(String token, String spaceKey, String userName)`
`Vector`	`getRecentlyUsedLabels(String token, int maxResults)`
`Vector`	`getRecentlyUsedLabelsInSpace(String token, String spaceKey, int maxResults)`
`Vector`	`getRelatedLabels(String token, String labelName, int maxResults)`
`Vector`	`getRelatedLabelsInSpace(String token, String labelName, String spaceKey, int maxResults)`
`Hashtable`	`getServerInfo(String token)`
`Hashtable`	`getSpace(String token, String spaceKey)`
`Hashtable`	`getSpaceGroup(String token, String spaceGroupKey)` Deprecated. since 5.9. `SpaceGroup` and related classes like `SpaceGroupManager` and `SpaceGroupComparator` will be removed. Please do not use them.
`Vector`	`getSpaceGroups(String token)` Deprecated. since 5.9. `SpaceGroup` and related classes like `SpaceGroupManager` and `SpaceGroupComparator` will be removed. Please do not use them.
`String[]`	`getSpaceLevelPermissions(String token)`
`Hashtable`	`getSpacePermissionSet(String token, String spaceKey, String permissionType)`
`Vector`	`getSpacePermissionSets(String token, String spaceKey)`
`Vector`	`getSpaces(String token)`
`Vector`	`getSpacesContainingContentWithLabel(String token, String labelName)`
`Vector`	`getSpacesInGroup(String token, String spaceGroupKey)`
`String`	`getSpaceStatus(String token, String spaceKey)`
`Vector`	`getSpacesWithLabel(String token, String labelName)`
`Vector`	`getTopLevelPages(String token, String spaceKey)`
`Hashtable`	`getTrashContents(String token, String spaceKey, int offset, int maxResults)`
`Hashtable`	`getUser(String token, String username)`
`Hashtable`	`getUserByKey(String token, String userKey)`
`Vector`	`getUserGroups(String token, String username)`
`Hashtable`	`getUserInformation(String token, String username)`
`boolean`	`getUserPreferenceBoolean(String token, String username, String key)`
`String`	`getUserPreferenceLong(String token, String username, String key)`
`String`	`getUserPreferenceString(String token, String username, String key)`
`Vector`	`getWatchersForPage(String token, String pageId)`
`Vector`	`getWatchersForSpace(String token, String spaceKey)`
`boolean`	`hasGroup(String token, String groupname)`
`boolean`	`hasUser(String token, String username)`
`boolean`	`importSpace(String token, byte[] importData)` Import a space in a compressed XML format
`boolean`	`installPlugin(String token, String pluginFileName, byte[] pluginData)`
`boolean`	`isActiveUser(String token, String username)`
`boolean`	`isDarkFeatureEnabled(String token, String key)`
`boolean`	`isPluginEnabled(String token, String pluginKey)`
`boolean`	`isPluginInstalled(String token, String pluginKey)`
`boolean`	`isWatchingPage(String token, String pageId, String username)`
`boolean`	`isWatchingSpace(String token, String spaceKey, String username)`
`boolean`	`isWatchingSpaceForType(String token, String spaceKey, String contentType, String username)`
`String`	`login(String username, String password)`
`boolean`	`logout(String token)`
`boolean`	`moveAttachment(String token, String originalContentId, String originalFileName, String newContentId, String newFileName)`
`Boolean`	`movePage(String token, String sourcePageId, String targetPageId, String position)`
`Boolean`	`movePageToTopLevel(String token, String pageId, String targetSpaceKey)`
`String`	`performBackup(String token, boolean exportAttachments)`
`Boolean`	`purgeFromTrash(String token, String spaceKey, String pageId)`
`boolean`	`reactivateUser(String token, String username)`
`boolean`	`recoverMainIndex(String token)`
`boolean`	`removeAllPermissionsForGroup(String token, String groupname)`
`boolean`	`removeAnonymousPermissionFromSpace(String token, String permission, String spaceKey)`
`boolean`	`removeAnonymousUsePermission(String token)`
`boolean`	`removeAnonymousViewUserProfilePermission(String token)`
`boolean`	`removeAttachment(String token, String contentId, String fileName)`
`boolean`	`removeComment(String token, String commentId)`
`boolean`	`removeGlobalPermission(String token, String permission, String remoteEntityName)`
`boolean`	`removeGroup(String token, String groupname, String defaultGroupName)`
`boolean`	`removeLabelById(String token, String labelId, String objectId)`
`boolean`	`removeLabelByName(String token, String labelName, String objectId)`
`boolean`	`removeLabelByNameFromSpace(String token, String labelName, String spaceKey)`
`boolean`	`removeLabelByObject(String token, Hashtable labelObject, String objectId)`
`Boolean`	`removePage(String token, String pageId)`
`Boolean`	`removePageVersionById(String token, String historicalPageId)`
`Boolean`	`removePageVersionByVersion(String token, String pageId, int version)`
`boolean`	`removePageWatch(String token, String pageId)`
`boolean`	`removePageWatchForUser(String token, String pageId, String username)`
`boolean`	`removePermissionFromSpace(String token, String permission, String remoteEntityName, String spaceKey)`
`Boolean`	`removeSpace(String token, String spaceKey)`
`boolean`	`removeSpaceGroup(String token, String spaceGroupKey)` Deprecated. since 5.9. `SpaceGroup` and related classes like `SpaceGroupManager` and `SpaceGroupComparator` will be removed. Please do not use them.
`boolean`	`removeSpaceWatch(String token, String spaceKey)`
`boolean`	`removeUser(String token, String username)`
`boolean`	`removeUserFromGroup(String token, String username, String groupname)`
`boolean`	`renameUser(String token, String oldUsername, String newUsername)`
`Vector`	`renameUsers(String token, Hashtable oldUsernamesToNewUsernames)`
`String`	`renderContent(String token, String spaceKey, String pageId, String newContent)`
`String`	`renderContent(String token, String spaceKey, String pageId, String newContent, Hashtable renderParameters)`
`Vector`	`search(String token, String query, Hashtable params, int maxResults)`
`Vector`	`search(String token, String query, int maxResults)`
`Boolean`	`setContentPermissions(String token, String contentId, String permissionType, Vector permissions)`
`boolean`	`setEnableAnonymousAccess(String token, String value)`
`boolean`	`setEnableWysiwyg(String token, String value)` Deprecated. since 4.0. You can no longer disable the wysiwyg editor.
`Boolean`	`setSpaceStatus(String token, String spaceKey, String statusString)`
`boolean`	`setUserInformation(String token, Hashtable userInfo)`
`boolean`	`setUserPreferenceBoolean(String token, String username, String key, boolean value)`
`boolean`	`setUserPreferenceLong(String token, String username, String key, String value)`
`boolean`	`setUserPreferenceString(String token, String username, String key, String value)`
`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
`Hashtable`	`storeBlogEntry(String token, Hashtable blogEntryStruct)`
`Hashtable`	`storePage(String token, Hashtable pageStruct)`
`Hashtable`	`storeSpace(String token, Hashtable remoteSpace)`
`Hashtable`	`updatePage(String token, Hashtable pageStruct, Hashtable editOptionsStruct)`
`boolean`	`watchPage(String token, String pageId)`
`boolean`	`watchPageForUser(String token, String pageId, String username)`
`boolean`	`watchSpace(String token, String spaceKey)`

Method Detail

login

String login(String username,
             String password)
      throws RemoteException

Specified by:: login in interface SecureRpc
Throws:: RemoteException

logout
```
boolean logout(String token)
        throws RemoteException
```
Specified by:

logout in interface SecureRpc

Throws:

RemoteException

getPages

Vector getPages(String token,
                String spaceKey)
         throws RemoteException

Throws:: RemoteException

getPage

Hashtable getPage(String token,
                  String pageId)
           throws RemoteException

Throws:: RemoteException

getPageSummary

Hashtable getPageSummary(String token,
                         String pageId)
                  throws RemoteException

Throws:: RemoteException

getPage

Hashtable getPage(String token,
                  String spaceKey,
                  String pageTitle)
           throws RemoteException

Throws:: RemoteException

getPageSummary

Hashtable getPageSummary(String token,
                         String spaceKey,
                         String pageTitle)
                  throws RemoteException

Throws:: RemoteException

getContentPermissionSets

Vector getContentPermissionSets(String token,
                                String contentId)
                         throws RemoteException

Throws:: RemoteException

getContentPermissionSet

Hashtable getContentPermissionSet(String token,
                                  String contentId,
                                  String permissionType)
                           throws RemoteException

Throws:: RemoteException

getContentPermissions

Vector getContentPermissions(String token,
                             String contentId)
                      throws RemoteException

Throws:: RemoteException

setContentPermissions

Boolean setContentPermissions(String token,
                              String contentId,
                              String permissionType,
                              Vector permissions)
                       throws RemoteException

Throws:: RemoteException

getPermissions

Vector getPermissions(String token,
                      String spaceKey)
               throws RemoteException

Throws:: RemoteException

getPermissionsForUser

Vector getPermissionsForUser(String token,
                             String spaceKey,
                             String userName)
                      throws RemoteException

Throws:: RemoteException

getSpacePermissionSets

Vector getSpacePermissionSets(String token,
                              String spaceKey)
                       throws RemoteException

Throws:: RemoteException

getSpacePermissionSet

Hashtable getSpacePermissionSet(String token,
                                String spaceKey,
                                String permissionType)
                         throws RemoteException

Throws:: RemoteException

renderContent

String renderContent(String token,
                     String spaceKey,
                     String pageId,
                     String newContent)
              throws RemoteException

Throws:: RemoteException

renderContent

String renderContent(String token,
                     String spaceKey,
                     String pageId,
                     String newContent,
                     Hashtable renderParameters)
              throws RemoteException

Throws:: RemoteException

storePage

Hashtable storePage(String token,
                    Hashtable pageStruct)
             throws RemoteException

Throws:: RemoteException

updatePage

Hashtable updatePage(String token,
                     Hashtable pageStruct,
                     Hashtable editOptionsStruct)
              throws RemoteException

Throws:: RemoteException

movePageToTopLevel

Boolean movePageToTopLevel(String token,
                           String pageId,
                           String targetSpaceKey)
                    throws RemoteException

Throws:: RemoteException

movePage

Boolean movePage(String token,
                 String sourcePageId,
                 String targetPageId,
                 String position)
          throws RemoteException

Throws:: RemoteException

removePage

Boolean removePage(String token,
                   String pageId)
            throws RemoteException

Throws:: RemoteException

removePageVersionById

Boolean removePageVersionById(String token,
                              String historicalPageId)
                       throws RemoteException

Throws:: RemoteException

removePageVersionByVersion

Boolean removePageVersionByVersion(String token,
                                   String pageId,
                                   int version)
                            throws RemoteException

Throws:: RemoteException

search

Vector search(String token,
              String query,
              int maxResults)
       throws RemoteException

Throws:: RemoteException

search

Vector search(String token,
              String query,
              Hashtable params,
              int maxResults)
       throws RemoteException

Throws:: RemoteException

getPageHistory

Vector getPageHistory(String token,
                      String pageId)
               throws RemoteException

Throws:: RemoteException

getPagePermissions

Vector getPagePermissions(String token,
                          String pageId)
                   throws RemoteException

Throws:: RemoteException

getTrashContents

Hashtable getTrashContents(String token,
                           String spaceKey,
                           int offset,
                           int maxResults)
                    throws RemoteException

Throws:: RemoteException

purgeFromTrash

Boolean purgeFromTrash(String token,
                       String spaceKey,
                       String pageId)
                throws RemoteException

Throws:: RemoteException

emptyTrash

Boolean emptyTrash(String token,
                   String spaceKey)
            throws RemoteException

Throws:: RemoteException

getBlogEntries

Vector getBlogEntries(String token,
                      String spaceKey)
               throws RemoteException

Throws:: RemoteException

getBlogEntryByDayAndTitle

Hashtable getBlogEntryByDayAndTitle(String token,
                                    String spaceKey,
                                    int dayOfMonth,
                                    String postTitle)
                             throws RemoteException

Throws:: RemoteException

getBlogEntryByDateAndTitle

Hashtable getBlogEntryByDateAndTitle(String token,
                                     String spaceKey,
                                     int year,
                                     int month,
                                     int dayOfMonth,
                                     String postTitle)
                              throws RemoteException

Throws:: RemoteException

getBlogEntry

Hashtable getBlogEntry(String token,
                       String blogEntryId)
                throws RemoteException

Throws:: RemoteException

storeBlogEntry

Hashtable storeBlogEntry(String token,
                         Hashtable blogEntryStruct)
                  throws RemoteException

Throws:: RemoteException

getComments

Vector getComments(String token,
                   String pageId)
            throws RemoteException

Throws:: RemoteException

getComment

Hashtable getComment(String token,
                     String commentId)
              throws InvalidSessionException,
                     RemoteException

Throws:: InvalidSessionException; RemoteException

addComment

Hashtable addComment(String token,
                     Hashtable comment)
              throws InvalidSessionException,
                     NotPermittedException,
                     RemoteException

Throws:: InvalidSessionException; NotPermittedException; RemoteException

editComment

Hashtable editComment(String token,
                      Hashtable comment)
               throws InvalidSessionException,
                      NotPermittedException,
                      RemoteException

Throws:: InvalidSessionException; NotPermittedException; RemoteException

removeComment

boolean removeComment(String token,
                      String commentId)
               throws InvalidSessionException,
                      NotPermittedException,
                      RemoteException

Throws:: InvalidSessionException; NotPermittedException; RemoteException

getTopLevelPages

Vector getTopLevelPages(String token,
                        String spaceKey)
                 throws RemoteException

Throws:: RemoteException

getAncestors

Vector getAncestors(String token,
                    String pageId)
             throws RemoteException

Throws:: RemoteException

getChildren

Vector getChildren(String token,
                   String pageId)
            throws RemoteException

Throws:: RemoteException

getDescendents

Vector getDescendents(String token,
                      String pageId)
               throws RemoteException

Throws:: RemoteException

getAttachments

Vector getAttachments(String token,
                      String pageId)
               throws RemoteException

Throws:: RemoteException

convertWikiToStorageFormat

String convertWikiToStorageFormat(String token,
                                  String wiki)
                           throws RemoteException

Throws:: RemoteException

watchPage

boolean watchPage(String token,
                  String pageId)
           throws RemoteException

Throws:: RemoteException

watchSpace

boolean watchSpace(String token,
                   String spaceKey)
            throws RemoteException

Throws:: RemoteException

watchPageForUser

boolean watchPageForUser(String token,
                         String pageId,
                         String username)
                  throws RemoteException

Throws:: RemoteException

removePageWatch

boolean removePageWatch(String token,
                        String pageId)
                 throws RemoteException

Throws:: RemoteException

removeSpaceWatch

boolean removeSpaceWatch(String token,
                         String spaceKey)
                  throws RemoteException

Throws:: RemoteException

removePageWatchForUser

boolean removePageWatchForUser(String token,
                               String pageId,
                               String username)
                        throws RemoteException

Throws:: RemoteException

isWatchingPage

boolean isWatchingPage(String token,
                       String pageId,
                       String username)
                throws RemoteException

Throws:: RemoteException

isWatchingSpace

boolean isWatchingSpace(String token,
                        String spaceKey,
                        String username)
                 throws RemoteException

Throws:: RemoteException

isWatchingSpaceForType

boolean isWatchingSpaceForType(String token,
                               String spaceKey,
                               String contentType,
                               String username)
                        throws RemoteException

Throws:: RemoteException

getWatchersForPage

Vector getWatchersForPage(String token,
                          String pageId)
                   throws RemoteException

Throws:: RemoteException

getWatchersForSpace

Vector getWatchersForSpace(String token,
                           String spaceKey)
                    throws RemoteException

Throws:: RemoteException

addAttachment

Hashtable addAttachment(String token,
                        String contentId,
                        Hashtable attachment,
                        byte[] attachmentData)
                 throws RemoteException,
                        NotPermittedException

Throws:: RemoteException; NotPermittedException

getAttachment

Hashtable getAttachment(String token,
                        String contentId,
                        String fileName,
                        String version)
                 throws RemoteException,
                        NotPermittedException

Throws:: RemoteException; NotPermittedException

getAttachmentData

byte[] getAttachmentData(String token,
                         String contentId,
                         String fileName,
                         String version)
                  throws RemoteException,
                         NotPermittedException

Throws:: RemoteException; NotPermittedException

removeAttachment

boolean removeAttachment(String token,
                         String contentId,
                         String fileName)
                  throws RemoteException,
                         NotPermittedException

Throws:: RemoteException; NotPermittedException

moveAttachment

boolean moveAttachment(String token,
                       String originalContentId,
                       String originalFileName,
                       String newContentId,
                       String newFileName)
                throws RemoteException,
                       NotPermittedException

Throws:: RemoteException; NotPermittedException

getSpaces

Vector getSpaces(String token)
          throws RemoteException

Throws:: RemoteException

getSpacesInGroup

Vector getSpacesInGroup(String token,
                        String spaceGroupKey)
                 throws RemoteException

Throws:: RemoteException

getSpace

Hashtable getSpace(String token,
                   String spaceKey)
            throws RemoteException

Throws:: RemoteException

addSpace

Hashtable addSpace(String token,
                   Hashtable space)
            throws RemoteException

Throws:: RemoteException

storeSpace

Hashtable storeSpace(String token,
                     Hashtable remoteSpace)
              throws RemoteException

Throws:: RemoteException

addPersonalSpace

Hashtable addPersonalSpace(String token,
                           Hashtable space,
                           String username)
                    throws RemoteException

Throws:: RemoteException

removeSpace

Boolean removeSpace(String token,
                    String spaceKey)
             throws RemoteException

Throws:: RemoteException

getSpaceStatus

String getSpaceStatus(String token,
                      String spaceKey)
               throws RemoteException

Throws:: RemoteException

setSpaceStatus

Boolean setSpaceStatus(String token,
                       String spaceKey,
                       String statusString)
                throws RemoteException

Throws:: RemoteException

exportSpace

String exportSpace(String token,
                   String spaceKey,
                   String exportType)
            throws RemoteException

Throws:: RemoteException

importSpace
```
boolean importSpace(String token,
                    byte[] importData)
             throws RemoteException
```
Import a space in a compressed XML format

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

Since:

2.4

addPermissionToSpace

boolean addPermissionToSpace(String token,
                             String permission,
                             String remoteEntityName,
                             String spaceKey)
                      throws RemoteException

Throws:: RemoteException

addPermissionsToSpace

boolean addPermissionsToSpace(String token,
                              Vector permissions,
                              String remoteEntityName,
                              String spaceKey)
                       throws RemoteException

Throws:: RemoteException

removePermissionFromSpace

boolean removePermissionFromSpace(String token,
                                  String permission,
                                  String remoteEntityName,
                                  String spaceKey)
                           throws NotPermittedException,
                                  RemoteException

Throws:: NotPermittedException; RemoteException

addAnonymousPermissionToSpace

boolean addAnonymousPermissionToSpace(String token,
                                      String permission,
                                      String spaceKey)
                               throws RemoteException

Throws:: RemoteException

addAnonymousPermissionsToSpace

boolean addAnonymousPermissionsToSpace(String token,
                                       Vector permissions,
                                       String spaceKey)
                                throws RemoteException

Throws:: RemoteException

removeAnonymousPermissionFromSpace

boolean removeAnonymousPermissionFromSpace(String token,
                                           String permission,
                                           String spaceKey)
                                    throws NotPermittedException,
                                           RemoteException

Throws:: NotPermittedException; RemoteException

getSpaceLevelPermissions

String[] getSpaceLevelPermissions(String token)
                           throws RemoteException

Throws:: RemoteException

addGlobalPermissions

boolean addGlobalPermissions(String token,
                             Vector permissions,
                             String remoteEntityName)
                      throws RemoteException

Throws:: RemoteException

addGlobalPermission

boolean addGlobalPermission(String token,
                            String permission,
                            String remoteEntityName)
                     throws RemoteException

Throws:: RemoteException

removeGlobalPermission

boolean removeGlobalPermission(String token,
                               String permission,
                               String remoteEntityName)
                        throws RemoteException

Throws:: RemoteException

addAnonymousUsePermission

boolean addAnonymousUsePermission(String token)
                           throws RemoteException

Throws:: RemoteException

removeAnonymousUsePermission

boolean removeAnonymousUsePermission(String token)
                              throws RemoteException

Throws:: RemoteException

addAnonymousViewUserProfilePermission

boolean addAnonymousViewUserProfilePermission(String token)
                                       throws RemoteException

Throws:: RemoteException

removeAnonymousViewUserProfilePermission

boolean removeAnonymousViewUserProfilePermission(String token)
                                          throws RemoteException

Throws:: RemoteException

addSpaceGroup

@Deprecated
Hashtable addSpaceGroup(String token,
                                    Hashtable spaceGroup)
                             throws RemoteException

Deprecated. since 5.9.

SpaceGroup and related classes like SpaceGroupManager and SpaceGroupComparator will be removed. Please do not use them.

Throws:: RemoteException

getSpaceGroup

@Deprecated
Hashtable getSpaceGroup(String token,
                                    String spaceGroupKey)
                             throws RemoteException

Deprecated. since 5.9.

SpaceGroup and related classes like SpaceGroupManager and SpaceGroupComparator will be removed. Please do not use them.

Throws:: RemoteException

getSpaceGroups
```
@Deprecated
Vector getSpaceGroups(String token)
                           throws RemoteException
```
Deprecated. since 5.9.
SpaceGroup and related classes like SpaceGroupManager and SpaceGroupComparator will be removed. Please do not use them.

Throws:

RemoteException

removeSpaceGroup

@Deprecated
boolean removeSpaceGroup(String token,
                                     String spaceGroupKey)
                              throws RemoteException

Deprecated. since 5.9.

SpaceGroup and related classes like SpaceGroupManager and SpaceGroupComparator will be removed. Please do not use them.

Throws:: RemoteException

exportSite

String exportSite(String token,
                  boolean exportAttachments)
           throws RemoteException

Throws:: RemoteException

performBackup

String performBackup(String token,
                     boolean exportAttachments)
              throws RemoteException

Throws:: RemoteException

getServerInfo

Hashtable getServerInfo(String token)
                 throws RemoteException

Throws:: RemoteException

flushIndexQueue

boolean flushIndexQueue(String token)
                 throws RemoteException

Throws:: RemoteException

clearIndexQueue

boolean clearIndexQueue(String token)
                 throws RemoteException

Throws:: RemoteException

recoverMainIndex

boolean recoverMainIndex(String token)
                  throws RemoteException

Throws:: RemoteException

getClusterInformation

Hashtable getClusterInformation(String token)
                         throws RemoteException

Throws:: RemoteException

getClusterNodeStatuses

Vector getClusterNodeStatuses(String token)
                       throws RemoteException

Throws:: RemoteException

getGroups

Vector getGroups(String token)
          throws RemoteException

Throws:: RemoteException

hasGroup

boolean hasGroup(String token,
                 String groupname)
          throws InvalidSessionException,
                 RemoteException

Throws:: InvalidSessionException; RemoteException

addGroup

boolean addGroup(String token,
                 String groupname)
          throws RemoteException

Throws:: RemoteException

removeGroup

boolean removeGroup(String token,
                    String groupname,
                    String defaultGroupName)
             throws RemoteException

Throws:: RemoteException

removeAllPermissionsForGroup

boolean removeAllPermissionsForGroup(String token,
                                     String groupname)
                              throws RemoteException

Throws:: RemoteException

getUserGroups

Vector getUserGroups(String token,
                     String username)
              throws RemoteException

Throws:: RemoteException

addUserToGroup

boolean addUserToGroup(String token,
                       String username,
                       String groupname)
                throws RemoteException

Throws:: RemoteException

removeUserFromGroup

boolean removeUserFromGroup(String token,
                            String username,
                            String groupname)
                     throws RemoteException

Throws:: RemoteException

getUser

Hashtable getUser(String token,
                  String username)
           throws RemoteException

Throws:: RemoteException

getUserByKey

Hashtable getUserByKey(String token,
                       String userKey)
                throws RemoteException

Throws:: RemoteException

hasUser

boolean hasUser(String token,
                String username)
         throws InvalidSessionException,
                RemoteException

Throws:: InvalidSessionException; RemoteException

addUser

boolean addUser(String token,
                Hashtable remoteUser,
                String password)
         throws RemoteException

Throws:: RemoteException

addUser

boolean addUser(String token,
                Hashtable remoteUser,
                String password,
                boolean NotifyUser)
         throws RemoteException

Throws:: RemoteException

removeUser

boolean removeUser(String token,
                   String username)
            throws RemoteException

Throws:: RemoteException

editUser

boolean editUser(String token,
                 Hashtable remoteUser)
          throws NotPermittedException,
                 InvalidSessionException,
                 RemoteException

Throws:: NotPermittedException; InvalidSessionException; RemoteException

deactivateUser

boolean deactivateUser(String token,
                       String username)
                throws NotPermittedException,
                       InvalidSessionException,
                       RemoteException

Throws:: NotPermittedException; InvalidSessionException; RemoteException

reactivateUser

boolean reactivateUser(String token,
                       String username)
                throws NotPermittedException,
                       InvalidSessionException,
                       RemoteException

Throws:: NotPermittedException; InvalidSessionException; RemoteException

isActiveUser

boolean isActiveUser(String token,
                     String username)
              throws NotPermittedException,
                     RemoteException

Throws:: NotPermittedException; RemoteException

getActiveUsers

Vector getActiveUsers(String token,
                      boolean viewAll)
               throws InvalidSessionException,
                      RemoteException

Throws:: InvalidSessionException; RemoteException

setUserInformation

boolean setUserInformation(String token,
                           Hashtable userInfo)
                    throws NotPermittedException,
                           InvalidSessionException,
                           RemoteException

Throws:: NotPermittedException; InvalidSessionException; RemoteException

getUserInformation

Hashtable getUserInformation(String token,
                             String username)
                      throws InvalidSessionException,
                             RemoteException

Throws:: InvalidSessionException; RemoteException

changeMyPassword

boolean changeMyPassword(String token,
                         String oldPass,
                         String newPass)
                  throws InvalidSessionException,
                         RemoteException

Throws:: InvalidSessionException; RemoteException

changeUserPassword

boolean changeUserPassword(String token,
                           String username,
                           String newPass)
                    throws NotPermittedException,
                           InvalidSessionException,
                           RemoteException

Throws:: NotPermittedException; InvalidSessionException; RemoteException

addProfilePicture

boolean addProfilePicture(String token,
                          String userName,
                          String fileName,
                          String mimeType,
                          byte[] pictureData)
                   throws RemoteException

Throws:: RemoteException

renameUser

boolean renameUser(String token,
                   String oldUsername,
                   String newUsername)
            throws RemoteException

Throws:: RemoteException

renameUsers

Vector renameUsers(String token,
                   Hashtable oldUsernamesToNewUsernames)
            throws RemoteException

Throws:: RemoteException

setUserPreferenceBoolean

boolean setUserPreferenceBoolean(String token,
                                 String username,
                                 String key,
                                 boolean value)
                          throws InvalidSessionException,
                                 RemoteException

Throws:: InvalidSessionException; RemoteException

getUserPreferenceBoolean

boolean getUserPreferenceBoolean(String token,
                                 String username,
                                 String key)
                          throws InvalidSessionException,
                                 RemoteException

Throws:: InvalidSessionException; RemoteException

setUserPreferenceLong

boolean setUserPreferenceLong(String token,
                              String username,
                              String key,
                              String value)
                       throws InvalidSessionException,
                              RemoteException

Throws:: InvalidSessionException; RemoteException

getUserPreferenceLong

String getUserPreferenceLong(String token,
                             String username,
                             String key)
                      throws InvalidSessionException,
                             RemoteException

Throws:: InvalidSessionException; RemoteException

setUserPreferenceString

boolean setUserPreferenceString(String token,
                                String username,
                                String key,
                                String value)
                         throws InvalidSessionException,
                                RemoteException

Throws:: InvalidSessionException; RemoteException

getUserPreferenceString

String getUserPreferenceString(String token,
                               String username,
                               String key)
                        throws InvalidSessionException,
                               RemoteException

Throws:: InvalidSessionException; RemoteException

getLabelsById

Vector getLabelsById(String token,
                     String objectId)
              throws RemoteException

Throws:: RemoteException

getMostPopularLabels

Vector getMostPopularLabels(String token,
                            int maxCount)
                     throws RemoteException

Throws:: RemoteException

getMostPopularLabelsInSpace

Vector getMostPopularLabelsInSpace(String token,
                                   String spaceKey,
                                   int maxCount)
                            throws RemoteException

Throws:: RemoteException

getLabelContentById

Vector getLabelContentById(String token,
                           String labelId)
                    throws RemoteException

Throws:: RemoteException

getLabelContentByName

Vector getLabelContentByName(String token,
                             String labelName)
                      throws RemoteException

Throws:: RemoteException

getLabelContentByObject

Vector getLabelContentByObject(String token,
                               Hashtable labelObject)
                        throws RemoteException

Throws:: RemoteException

getRecentlyUsedLabels

Vector getRecentlyUsedLabels(String token,
                             int maxResults)
                      throws InvalidSessionException,
                             RemoteException

Throws:: InvalidSessionException; RemoteException

getRecentlyUsedLabelsInSpace

Vector getRecentlyUsedLabelsInSpace(String token,
                                    String spaceKey,
                                    int maxResults)
                             throws InvalidSessionException,
                                    RemoteException

Throws:: InvalidSessionException; RemoteException

getSpacesWithLabel

Vector getSpacesWithLabel(String token,
                          String labelName)
                   throws InvalidSessionException,
                          RemoteException

Throws:: InvalidSessionException; RemoteException

getRelatedLabels

Vector getRelatedLabels(String token,
                        String labelName,
                        int maxResults)
                 throws InvalidSessionException,
                        RemoteException

Throws:: InvalidSessionException; RemoteException

getRelatedLabelsInSpace

Vector getRelatedLabelsInSpace(String token,
                               String labelName,
                               String spaceKey,
                               int maxResults)
                        throws InvalidSessionException,
                               RemoteException

Throws:: InvalidSessionException; RemoteException

getLabelsByDetail

Vector getLabelsByDetail(String token,
                         String labelName,
                         String namespace,
                         String spaceKey,
                         String owner)
                  throws InvalidSessionException,
                         RemoteException,
                         NotPermittedException

Throws:: InvalidSessionException; RemoteException; NotPermittedException

getSpacesContainingContentWithLabel

Vector getSpacesContainingContentWithLabel(String token,
                                           String labelName)
                                    throws InvalidSessionException,
                                           RemoteException

Throws:: InvalidSessionException; RemoteException

addLabelByName

boolean addLabelByName(String token,
                       String labelName,
                       String objectId)
                throws NotPermittedException,
                       RemoteException

Throws:: NotPermittedException; RemoteException

addLabelById

boolean addLabelById(String token,
                     String labelId,
                     String objectId)
              throws NotPermittedException,
                     RemoteException

Throws:: NotPermittedException; RemoteException

addLabelByObject

boolean addLabelByObject(String token,
                         Hashtable labelObject,
                         String objectId)
                  throws NotPermittedException,
                         RemoteException

Throws:: NotPermittedException; RemoteException

addLabelByNameToSpace

boolean addLabelByNameToSpace(String token,
                              String labelName,
                              String spaceKey)
                       throws NotPermittedException,
                              InvalidSessionException,
                              RemoteException

Throws:: NotPermittedException; InvalidSessionException; RemoteException

removeLabelByName

boolean removeLabelByName(String token,
                          String labelName,
                          String objectId)
                   throws NotPermittedException,
                          RemoteException

Throws:: NotPermittedException; RemoteException

removeLabelById

boolean removeLabelById(String token,
                        String labelId,
                        String objectId)
                 throws NotPermittedException,
                        RemoteException

Throws:: NotPermittedException; RemoteException

removeLabelByObject

boolean removeLabelByObject(String token,
                            Hashtable labelObject,
                            String objectId)
                     throws NotPermittedException,
                            RemoteException

Throws:: NotPermittedException; RemoteException

removeLabelByNameFromSpace

boolean removeLabelByNameFromSpace(String token,
                                   String labelName,
                                   String spaceKey)
                            throws NotPermittedException,
                                   InvalidSessionException,
                                   RemoteException

Throws:: NotPermittedException; InvalidSessionException; RemoteException

startActivity
```
boolean startActivity(String token,
                      String key,
                      String user)
               throws RemoteException
```
Call startActivity on the heartbeat manager bean

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
```
boolean stopActivity(String token,
                     String key,
                     String user)
              throws RemoteException
```
Call stopActivity on the heartbeat manager bean

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
boolean setEnableWysiwyg(String token,
                                     String value)
                              throws RemoteException

Deprecated. since 4.0. You can no longer disable the wysiwyg editor.

Throws:: RemoteException

setEnableAnonymousAccess

boolean setEnableAnonymousAccess(String token,
                                 String value)
                          throws RemoteException

Throws:: RemoteException

isPluginEnabled

boolean isPluginEnabled(String token,
                        String pluginKey)
                 throws RemoteException

Throws:: RemoteException

isPluginInstalled

boolean isPluginInstalled(String token,
                          String pluginKey)
                   throws RemoteException

Throws:: RemoteException

installPlugin

boolean installPlugin(String token,
                      String pluginFileName,
                      byte[] pluginData)
               throws RemoteException

Throws:: RemoteException

isDarkFeatureEnabled

boolean isDarkFeatureEnabled(String token,
                             String key)
                      throws RemoteException

Throws:: RemoteException

Interface ConfluenceXmlRpcHandler

Method Summary

Method Detail

login

logout

getPages

getPage

getPageSummary

getPage

getPageSummary

getContentPermissionSets

getContentPermissionSet

getContentPermissions

setContentPermissions

getPermissions

getPermissionsForUser

getSpacePermissionSets

getSpacePermissionSet

renderContent

renderContent

storePage

updatePage

movePageToTopLevel

movePage

removePage

removePageVersionById

removePageVersionByVersion

search

search

getPageHistory

getPagePermissions

getTrashContents

purgeFromTrash

emptyTrash

getBlogEntries

getBlogEntryByDayAndTitle

getBlogEntryByDateAndTitle

getBlogEntry

storeBlogEntry

getComments

getComment

addComment

editComment

removeComment

getTopLevelPages

getAncestors

getChildren

getDescendents

getAttachments

convertWikiToStorageFormat

watchPage

watchSpace

watchPageForUser

removePageWatch

removeSpaceWatch

removePageWatchForUser

isWatchingPage

isWatchingSpace

isWatchingSpaceForType

getWatchersForPage

getWatchersForSpace

addAttachment

getAttachment

getAttachmentData

removeAttachment

moveAttachment

getSpaces

getSpacesInGroup

getSpace

addSpace

storeSpace

addPersonalSpace

removeSpace

getSpaceStatus

setSpaceStatus

exportSpace

importSpace

addPermissionToSpace

addPermissionsToSpace

removePermissionFromSpace