public class XhtmlSoapService extends Object implements ConfluenceSoapService
| Modifier and Type | Field and Description | 
|---|---|
| static List | ADMINISTER_PERMISSION_TYPES | 
| static List | EXPORT_SPACE_PERMISSION_TYPES | 
| static List | MODIFY_SPACE_PERMISSION_TYPES | 
| static List | REMOVE_PAGE_PERMISSION_TYPES | 
| static List | SPACE_ADMIN_PERMISSION_TYPES | 
| static List | VIEW_SPACE_PERMISSION_TYPES | 
ADMIN_SPACE_PERMISSION, COMMENT_PERMISSION, MODIFY_PERMISSION, VIEW_PERMISSION| Constructor and Description | 
|---|
| XhtmlSoapService() | 
| 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. | 
| 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 contentId,
             String fileName,
             int version)Retrieve information about an attachment. | 
| byte[] | getAttachmentData(String token,
                 long contentId,
                 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 spaceGroupKey) | 
| 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) | 
| 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 | setAdminSoapService(AdminSoapService adminSoapService) | 
| void | setAttachmentsSoapService(AttachmentsSoapService attachmentsService) | 
| void | setBlogsSoapService(BlogsSoapService blogsService) | 
| 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) | 
| void | setGlobalSoapService(AdminSoapService adminSoapService) | 
| void | setLabelsSoapService(LabelsSoapService labelsSoapService) | 
| void | setMailServerManager(com.atlassian.mail.server.MailServerManager mailServerManager) | 
| void | setNotificationsSoapService(NotificationsSoapService notificationsSoapService) | 
| void | setPagesSoapService(PagesSoapService pagesService) | 
| void | setSpacesSoapService(SpacesSoapService spacesService) | 
| 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 | setUsersSoapService(UsersSoapService usersService) | 
| void | setWikiToXhtmlMigrator(ExceptionTolerantMigrator wikiToXhtmlMigrator) | 
| void | setXhtmlRoundTripMigrator(ExceptionTolerantMigrator xhtmlRoundTripMigrator) | 
| 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. | 
public static final List VIEW_SPACE_PERMISSION_TYPES
public static final List MODIFY_SPACE_PERMISSION_TYPES
public static final List ADMINISTER_PERMISSION_TYPES
public static final List SPACE_ADMIN_PERMISSION_TYPES
public static final List REMOVE_PAGE_PERMISSION_TYPES
public static final List EXPORT_SPACE_PERMISSION_TYPES
public void setSpacesSoapService(SpacesSoapService spacesService)
public void setPagesSoapService(PagesSoapService pagesService)
public void setUsersSoapService(UsersSoapService usersService)
public void setBlogsSoapService(BlogsSoapService blogsService)
public void setGlobalSoapService(AdminSoapService adminSoapService)
public void setAdminSoapService(AdminSoapService adminSoapService)
public void setLabelsSoapService(LabelsSoapService labelsSoapService)
public void setAttachmentsSoapService(AttachmentsSoapService attachmentsService)
public void setNotificationsSoapService(NotificationsSoapService notificationsSoapService)
public String login(String username, String password)
login in interface SecureRpclogin in interface ConfluenceSoapServicepublic boolean logout(String token)
logout in interface SecureRpclogout in interface ConfluenceSoapServicepublic RemoteSpaceSummary[] getSpaces(String token)
getSpaces in interface ConfluenceSoapServicepublic RemoteSpaceSummary[] getSpacesInGroup(String token, String spaceGroupKey)
getSpacesInGroup in interface ConfluenceSoapServicepublic RemoteSpace addSpaceWithDefaultPermissions(String token, RemoteSpace space) throws RemoteException
addSpaceWithDefaultPermissions in interface ConfluenceSoapServiceRemoteExceptionpublic RemoteSpace addSpace(String token, RemoteSpace space) throws RemoteException
addSpace in interface ConfluenceSoapServiceRemoteExceptionpublic RemoteSpace storeSpace(String token, RemoteSpace remoteSpace) throws RemoteException
ConfluenceSoapService
storeSpace in interface ConfluenceSoapServiceRemoteExceptionpublic RemoteSpaceGroup addSpaceGroup(String token, RemoteSpaceGroup spaceGroup) throws RemoteException
ConfluenceSoapServiceaddSpaceGroup in interface ConfluenceSoapServicetoken - the authentication tokenspaceGroup - the spacegroup to addNotPermittedException - if the user lacks permissions to perform the actionInvalidSessionExceptionAlreadyExistsException - if a group with the same key already existsRemoteExceptionpublic RemoteSpaceGroup getSpaceGroup(String token, String spaceGroupKey) throws RemoteException
getSpaceGroup in interface ConfluenceSoapServiceRemoteExceptionpublic RemoteSpaceGroup[] getSpaceGroups(String token) throws RemoteException
getSpaceGroups in interface ConfluenceSoapServiceRemoteExceptionpublic boolean removeSpaceGroup(String token, String spaceGroupKey) throws RemoteException
ConfluenceSoapServiceremoveSpaceGroup in interface ConfluenceSoapServicetoken - the authentication tokenspaceGroupKey - the id of the spacegroup to be removedRemoteExceptionpublic RemoteSpace addPersonalSpace(String token, RemoteSpace space, String username) throws RemoteException
addPersonalSpace in interface ConfluenceSoapServiceRemoteExceptionpublic RemoteSpace addPersonalSpaceWithDefaultPermissions(String token, RemoteSpace space, String username) throws RemoteException
addPersonalSpaceWithDefaultPermissions in interface ConfluenceSoapServiceRemoteExceptionpublic Boolean removeSpace(String token, String spaceKey) throws RemoteException
removeSpace in interface ConfluenceSoapServiceRemoteExceptionpublic RemoteSpace getSpace(String token, String spaceKey) throws RemoteException
getSpace in interface ConfluenceSoapServiceRemoteExceptionpublic String getSpaceStatus(String token, String spaceKey) throws RemoteException
getSpaceStatus in interface ConfluenceSoapServiceRemoteExceptionpublic Boolean setSpaceStatus(String token, String spaceKey, String status) throws RemoteException
setSpaceStatus in interface ConfluenceSoapServiceRemoteExceptionpublic String[] getPermissions(String token, String spaceKey) throws RemoteException
getPermissions in interface ConfluenceSoapServiceRemoteExceptionpublic String[] getPermissionsForUser(String token, String spaceKey, String userName) throws RemoteException
getPermissionsForUser in interface ConfluenceSoapServiceRemoteExceptionpublic RemoteSpacePermissionSet[] getSpacePermissionSets(String token, String spaceKey) throws RemoteException
getSpacePermissionSets in interface ConfluenceSoapServiceRemoteExceptionpublic RemoteSpacePermissionSet getSpacePermissionSet(String token, String spaceKey, String permissionType) throws RemoteException
getSpacePermissionSet in interface ConfluenceSoapServiceRemoteExceptionpublic boolean addPermissionToSpace(String token, String permission, String remoteEntityName, String spaceKey) throws RemoteException
ConfluenceSoapServiceaddPermissionToSpace in interface ConfluenceSoapServicetoken - the authentication tokenpermission - the Space Permission to addremoteEntityName - the name of the user or groupspaceKey - the key of the Space affected by this actionRemoteException - if the Space Permission is nullNotPermittedException - if the user lacks permissions to perform the actionpublic boolean addPermissionsToSpace(String token, String[] permissions, String remoteEntityName, String spaceKey) throws RemoteException
ConfluenceSoapServiceaddPermissionsToSpace in interface ConfluenceSoapServicetoken - the authentication tokenpermissions - the Space Permissions to addremoteEntityName - the name of the user or groupspaceKey - the key of the Space affected by this actionRemoteException - if the Space Permissions array is nullNotPermittedException - if the user lacks permissions to perform the actionpublic boolean removePermissionFromSpace(String token, String permission, String remoteEntityName, String spaceKey) throws RemoteException
ConfluenceSoapServiceremovePermissionFromSpace in interface ConfluenceSoapServicetoken - the authentication tokenpermission - the Space Permission to removeremoteEntityName - the name of the user or groupspaceKey - the key of the Space affected by this actionRemoteException - if the Space does not existNotPermittedException - if the user lacks permissions to perform the actionpublic boolean addGlobalPermission(String token, String permission, String remoteEntityName) throws RemoteException
ConfluenceSoapServiceaddGlobalPermission in interface ConfluenceSoapServicetoken - the login tokenpermission - the Space Permission to addremoteEntityName - the name of the user or groupNotPermittedException - if the user lacks permissions to perform the actionRemoteExceptionpublic boolean addGlobalPermissions(String token, String[] permissions, String remoteEntityName) throws RemoteException
ConfluenceSoapServiceaddGlobalPermissions in interface ConfluenceSoapServicetoken - the login tokenpermissions - Array of permissions to addremoteEntityName - the name of the user or groupNotPermittedException - if the user lacks permissions to perform the actionRemoteExceptionpublic boolean removeGlobalPermission(String token, String permission, String remoteEntityName) throws RemoteException
ConfluenceSoapServiceremoveGlobalPermission in interface ConfluenceSoapServicetoken - the login tokenpermission - the Space Permission to addremoteEntityName - the name of the user or groupNotPermittedException - if the user lacks permissions to perform the actionRemoteExceptionpublic boolean addAnonymousUsePermission(String token) throws RemoteException
addAnonymousUsePermission in interface ConfluenceSoapServiceRemoteExceptionpublic boolean removeAnonymousUsePermission(String token) throws RemoteException
ConfluenceSoapServiceremoveAnonymousUsePermission in interface ConfluenceSoapServicetoken - the login tokenRemoteExceptionpublic boolean addAnonymousViewUserProfilePermission(String token) throws RemoteException
ConfluenceSoapServiceaddAnonymousViewUserProfilePermission in interface ConfluenceSoapServicetoken - the login tokenRemoteExceptionpublic boolean removeAnonymousViewUserProfilePermission(String token) throws RemoteException
removeAnonymousViewUserProfilePermission in interface ConfluenceSoapServiceRemoteExceptionpublic boolean addAnonymousPermissionToSpace(String token, String permission, String spaceKey) throws RemoteException
ConfluenceSoapServiceaddAnonymousPermissionToSpace in interface ConfluenceSoapServicetoken - the authentication tokenpermission - the Space Permission to addspaceKey - the key of the Space affected by this actionRemoteException - if the Space Permission is nullNotPermittedException - if the user lacks permissions to perform the actionpublic boolean addAnonymousPermissionsToSpace(String token, String[] permissions, String spaceKey) throws RemoteException
ConfluenceSoapServiceaddAnonymousPermissionsToSpace in interface ConfluenceSoapServicetoken - the authentication tokenpermissions - the Space Permissions to addspaceKey - the key of the Space affected by this actionRemoteException - if the Space Permissions array is nullNotPermittedException - if the user lacks permissions to perform the actionpublic boolean removeAnonymousPermissionFromSpace(String token, String permission, String spaceKey) throws RemoteException
ConfluenceSoapServiceremoveAnonymousPermissionFromSpace in interface ConfluenceSoapServicetoken - the authentication tokenpermission - the Space Permission to removespaceKey - the key of the Space affected by this actionRemoteException - if the Space does not existNotPermittedException - if the user lacks permissions to perform the actionpublic String[] getSpaceLevelPermissions(String token)
getSpaceLevelPermissions in interface ConfluenceSoapServicepublic RemotePageSummary[] getPages(String token, String spaceKey) throws RemoteException
ConfluenceSoapServicegetPages in interface ConfluenceSoapServicetoken - the authentication tokenspaceKey - the key of the space which pages are to be returnedRemoteExceptionpublic RemotePage getPage(String token, String spaceKey, String pageTitle) throws RemoteException
getPage in interface ConfluenceSoapServiceRemoteExceptionpublic RemotePage getPage(String token, long pageId) throws RemoteException
getPage in interface ConfluenceSoapServiceRemoteExceptionpublic RemotePageSummary getPageSummary(String token, String spaceKey, String pageTitle) throws RemoteException
getPageSummary in interface ConfluenceSoapServiceRemoteExceptionpublic RemotePageSummary getPageSummary(String token, long pageId) throws RemoteException
getPageSummary in interface ConfluenceSoapServiceRemoteExceptionpublic RemoteComment[] getComments(String token, long pageId) throws RemoteException
ConfluenceSoapServicegetComments in interface ConfluenceSoapServicetoken - the authentication tokenpageId - the content ID of the abstract pageInvalidSessionExceptionRemoteException - if the object for the pageId is null, or the user lacks permissionspublic RemoteComment getComment(String token, long commentId) throws RemoteException
ConfluenceSoapServicegetComment in interface ConfluenceSoapServicetoken - The token identifying the current usercommentId - The ID of the comment to be retrievedInvalidSessionExceptionRemoteException - if the comment cannot be foundpublic RemoteComment addComment(String token, RemoteComment comment) throws RemoteException
ConfluenceSoapServiceaddComment in interface ConfluenceSoapServicetoken - The token identifying the current usercomment - The RemoteComment object containing the comment informationInvalidSessionExceptionRemoteException - if the user does not have permission to view the page the comment is being posted to, or it does not existNotPermittedException - if the user is unable to post the commentpublic RemoteComment editComment(String token, RemoteComment comment) throws RemoteException
ConfluenceSoapServiceeditComment in interface ConfluenceSoapServicetoken - The token identifying the current usercomment - The RemoteComment object containing the comment informationInvalidSessionExceptionRemoteException - if the user does not have permission to view the page the comment is being posted to, or it does not existNotPermittedException - if the user is unable to edit the commentpublic boolean removeComment(String token, long commentId) throws RemoteException
ConfluenceSoapServiceremoveComment in interface ConfluenceSoapServicetoken - The token identifying the current usercommentId - The ID of the comment to removeInvalidSessionExceptionRemoteException - if the user does not have permission to view the page the comment is on, or it does not existNotPermittedException - if the user does not have permission to remove the commentpublic RemotePageSummary[] getTopLevelPages(String token, String spaceKey) throws RemoteException
ConfluenceSoapServicegetTopLevelPages in interface ConfluenceSoapServicetoken - the authentication tokenspaceKey - the key of the space which pages are to be returnedRemoteExceptionpublic RemotePageSummary[] getAncestors(String token, long pageId) throws RemoteException
ConfluenceSoapServicegetAncestors in interface ConfluenceSoapServicetoken - the authentication tokenpageId - the id of the page which child pages are to be returnedRemoteExceptionpublic RemotePageSummary[] getChildren(String token, long pageId) throws RemoteException
ConfluenceSoapServicegetChildren in interface ConfluenceSoapServicetoken - the authentication tokenpageId - the id of the page which child pages are to be returnedRemoteExceptionpublic RemotePageSummary[] getDescendents(String token, long pageId) throws RemoteException
ConfluenceSoapServicegetDescendents in interface ConfluenceSoapServicetoken - the authentication tokenpageId - the id of the page which child pages are to be returnedRemoteExceptionpublic RemoteAttachment[] getAttachments(String token, long pageId) throws RemoteException
getAttachments in interface ConfluenceSoapServiceRemoteExceptionpublic RemotePageHistory[] getPageHistory(String token, long pageId) throws RemoteException
getPageHistory in interface ConfluenceSoapServiceRemoteExceptionpublic boolean watchPage(String token, long pageId) throws RemoteException
ConfluenceSoapServicewatchPage in interface ConfluenceSoapServiceRemoteException - if the watch could not be addedpublic boolean watchSpace(String token, String spaceKey) throws RemoteException
ConfluenceSoapServicewatchSpace in interface ConfluenceSoapServiceRemoteException - if the watch could not be addedpublic boolean watchPageForUser(String token, long pageId, String username) throws RemoteException
ConfluenceSoapServicewatchPageForUser in interface ConfluenceSoapServiceRemoteException - if the watch could not be added, or the current user does not have permission to add itpublic boolean removePageWatch(String token, long pageId) throws RemoteException
ConfluenceSoapServiceremovePageWatch in interface ConfluenceSoapServiceRemoteException - if the watch could not be removedpublic boolean removeSpaceWatch(String token, String spaceKey) throws RemoteException
ConfluenceSoapServiceremoveSpaceWatch in interface ConfluenceSoapServiceRemoteException - if the watch could not be removedpublic boolean removePageWatchForUser(String token, long pageId, String username) throws RemoteException
ConfluenceSoapServiceremovePageWatchForUser in interface ConfluenceSoapServiceRemoteException - if the watch could not be removed, or the current user does not have permission to remove itpublic boolean isWatchingPage(String token, long pageId, String username) throws RemoteException
ConfluenceSoapServiceisWatchingPage in interface ConfluenceSoapServiceRemoteException - if the current user does not have permission to see the page or administer the space, or
                         if the page or user does not existpublic boolean isWatchingSpace(String token, String spaceKey, String username) throws RemoteException
ConfluenceSoapServiceisWatchingSpace in interface ConfluenceSoapServiceRemoteException - if the current user does not have permission to administer the space, or if the user does
                         not existpublic boolean isWatchingSpaceForType(String token, String spaceKey, String contentType, String username) throws RemoteException
ConfluenceSoapServiceNote that this method will return false if the user is watching the entire space and not just the given type.
isWatchingSpaceForType in interface ConfluenceSoapServiceRemoteException - if the current user does not have permission to administer the space, or if the user does
                         not existpublic RemoteUser[] getWatchersForPage(String token, long pageId) throws RemoteException
ConfluenceSoapServicegetWatchersForPage in interface ConfluenceSoapServiceRemoteException - if the current user does not have permission to see the page or administer the space, or
                         if the page does not existpublic RemoteUser[] getWatchersForSpace(String token, String spaceKey) throws RemoteException
ConfluenceSoapServicegetWatchersForSpace in interface ConfluenceSoapServiceRemoteException - if the current user does not have permission to administer the space, or if the space does not existpublic RemoteSearchResult[] search(String token, String query, int maxResults) throws RemoteException
ConfluenceSoapServiceSearch 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.
search in interface ConfluenceSoapServicetoken - the authentication tokenquery - the query term for the searchmaxResults - the maximum number of results to be returned.RemoteSearchResults. If there are no results then an empty array will be returned.RemoteExceptionpublic RemoteSearchResult[] search(String token, String query, Map params, int maxResults) throws RemoteException
ConfluenceSoapServiceSearch 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 -
com.atlassian.bonnie.search.SinceDateQueryFactory for a list of understood representations.
 search in interface ConfluenceSoapServicetoken - the authentication tokenquery - the query term for the searchparams - a MapmaxResults - the maximum number of results to be returned.RemoteSearchResults. If there are no results then an empty array will be returned.RemoteExceptionpublic RemoteBlogEntry getBlogEntryByDayAndTitle(String token, String spaceKey, int dayOfMonth, String postTitle) throws RemoteException
ConfluenceSoapServicegetBlogEntryByDayAndTitle in interface ConfluenceSoapServicetoken - the authentication tokenspaceKey - the key of the Space the blog post belongs todayOfMonth - the day of the month the blog post was madepostTitle - the title of the blog postRemoteException - if the user does not have permission to view the blog post, or it does not existpublic RemoteBlogEntry getBlogEntryByDateAndTitle(String token, String spaceKey, int year, int month, int dayOfMonth, String postTitle) throws RemoteException
ConfluenceSoapServicegetBlogEntryByDateAndTitle in interface ConfluenceSoapServiceRemoteException - if the user does not have permission to view the blog post or it does not existpublic String renderContent(String token, String spaceKey, long pageId, String newContent) throws RemoteException
renderContent in interface ConfluenceSoapServiceRemoteExceptionpublic String renderContent(String token, String spaceKey, long pageId, String newContent, Map renderParameters) throws RemoteException
renderContent in interface ConfluenceSoapServiceRemoteExceptionpublic String convertWikiToStorageFormat(String token, String markup) throws RemoteException
ConfluenceSoapServiceconvertWikiToStorageFormat in interface ConfluenceSoapServiceRemoteExceptionpublic RemoteAttachment addAttachment(String token, long contentId, RemoteAttachment attachment, byte[] attachmentData) throws RemoteException
ConfluenceSoapServiceaddAttachment in interface ConfluenceSoapServicetoken - the authentication tokencontentId - the id of the ContentEntityObject to receive the new attachment.attachment - RemoteAttachment object containing attachment informationattachmentData - a byte[] continaing the contents of the attachment.RemoteExceptionpublic RemoteAttachment getAttachment(String token, long contentId, String fileName, int version) throws RemoteException
ConfluenceSoapServicegetAttachment in interface ConfluenceSoapServicetoken - the authentication token.contentId - the id of the ContentEntityObject the attachemt belongs to.fileName - the name of the attachment.version - the version number of the attachment.RemoteExceptionpublic byte[] getAttachmentData(String token, long contentId, String fileName, int version) throws RemoteException
ConfluenceSoapServicegetAttachmentData in interface ConfluenceSoapServicetoken - the authentication token.contentId - the id of the ContentEntityObject the attachemt belongs to.fileName - the name of the attachment.version - the version number of the attachment.RemoteExceptionpublic boolean removeAttachment(String token, long contentId, String fileName) throws RemoteException
ConfluenceSoapServiceremoveAttachment in interface ConfluenceSoapServicetoken - the authentication token.contentId - the id of the ContentEntityObject the attachment belongs to.fileName - the name of the attachment.RemoteExceptionpublic boolean moveAttachment(String token, long originalContentId, String originalFileName, long newContentId, String newFileName) throws RemoteException
ConfluenceSoapServicemoveAttachment in interface ConfluenceSoapServicetoken - 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.RemoteExceptionpublic Boolean movePageToTopLevel(String token, long pageId, String targetSpaceKey) throws RemoteException
movePageToTopLevel in interface ConfluenceSoapServiceRemoteExceptionpublic Boolean movePage(String token, long sourcePageId, long targetPageId, String position) throws RemoteException
movePage in interface ConfluenceSoapServiceRemoteExceptionpublic Boolean removePage(String token, long pageId) throws RemoteException
removePage in interface ConfluenceSoapServiceRemoteExceptionpublic Boolean removePageVersionById(String token, long historicalPageId) throws RemoteException
ConfluenceSoapServiceConfluenceSoapService.removePage(String, long).removePageVersionById in interface ConfluenceSoapServicehistoricalPageId - the id of a historical version of a pageNotPermittedExceptionInvalidSessionExceptionRemoteExceptionpublic Boolean removePageVersionByVersion(String token, long pageId, int version) throws RemoteException
ConfluenceSoapServiceremovePageVersionByVersion in interface ConfluenceSoapServicepageId - 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).NotPermittedExceptionInvalidSessionExceptionRemoteExceptionpublic RemotePage storePage(String token, RemotePage page) throws RemoteException
storePage in interface ConfluenceSoapServiceRemoteExceptionpublic RemotePage updatePage(String token, RemotePage page, RemotePageUpdateOptions options) throws RemoteException
updatePage in interface ConfluenceSoapServiceRemoteExceptionpublic RemotePermission[] getPagePermissions(String token, long pageId) throws RemoteException
getPagePermissions in interface ConfluenceSoapServiceRemoteExceptionpublic RemoteContentSummaries getTrashContents(String token, String spaceKey, int offset, int count) throws RemoteException
getTrashContents in interface ConfluenceSoapServiceRemoteExceptionpublic Boolean purgeFromTrash(String token, String spaceKey, long pageId) throws RemoteException
purgeFromTrash in interface ConfluenceSoapServiceRemoteExceptionpublic Boolean emptyTrash(String token, String spaceKey) throws RemoteException
emptyTrash in interface ConfluenceSoapServiceRemoteExceptionpublic RemoteBlogEntry getBlogEntry(String token, long entryId) throws RemoteException
getBlogEntry in interface ConfluenceSoapServiceRemoteExceptionpublic RemoteBlogEntrySummary[] getBlogEntries(String token, String spaceKey) throws RemoteException
getBlogEntries in interface ConfluenceSoapServiceRemoteExceptionpublic RemoteBlogEntry storeBlogEntry(String token, RemoteBlogEntry blogEntry) throws RemoteException
storeBlogEntry in interface ConfluenceSoapServiceRemoteExceptionpublic String[] getGroups(String token) throws RemoteException
ConfluenceSoapServicegetGroups in interface ConfluenceSoapServicetoken - The token identifying the current userNotPermittedException - if the current user lacks permission to administerRemoteExceptionpublic boolean hasGroup(String token, String groupname)
ConfluenceSoapServicehasGroup in interface ConfluenceSoapServicetoken - the token identifying the current usergroupname - the group to look uppublic boolean addGroup(String token, String groupname) throws RemoteException
ConfluenceSoapServiceaddGroup in interface ConfluenceSoapServicetoken - The token identifying the current usergroupname - The name of the group to be addedNotPermittedException - if the current user lacks permission to administerInvalidSessionExceptionRemoteExceptionpublic boolean removeGroup(String token, String groupname, String defaultGroupName) throws RemoteException
ConfluenceSoapServiceIf a valid defaultGroupName is specified, users will be added to the new group (defaultGroupName).
removeGroup in interface ConfluenceSoapServicetoken - The token identifying the current usergroupname - The name of the group to be removeddefaultGroupName - The name of the group that users will be moved toNotPermittedException - if the current user lacks permission to administerInvalidSessionExceptionRemoteException - if the given groupname does not existpublic boolean removeAllPermissionsForGroup(String token, String groupname) throws RemoteException
ConfluenceSoapServiceremoveAllPermissionsForGroup in interface ConfluenceSoapServicetoken - The token identifying the current usergroupname - The group to delete permissions forNotPermittedException - if the current user lacks permission to administerRemoteException - if the given groupname does not existpublic String[] getUserGroups(String token, String username) throws RemoteException
ConfluenceSoapServicegetUserGroups in interface ConfluenceSoapServicetoken - The token identifying the current userusername - The username to retrieve groups forNotPermittedException - if the current user lacks permission to administerInvalidSessionExceptionRemoteException - if the given username does not existpublic boolean addUserToGroup(String token, String username, String groupname) throws RemoteException
addUserToGroup in interface ConfluenceSoapServiceNotPermittedException - if the current user lacks permission to administerInvalidSessionExceptionRemoteException - if the given username does not existpublic boolean removeUserFromGroup(String token, String username, String groupname) throws RemoteException
ConfluenceSoapServiceremoveUserFromGroup in interface ConfluenceSoapServicetoken - The token identifying the current userusername - The username to remove from a groupgroupname - The name of the group the user is to be removed fromNotPermittedException - if the current user lacks permission to administerInvalidSessionExceptionRemoteException - if the given username does not existpublic RemoteConfluenceUser getUserByName(String token, String username) throws RemoteException
ConfluenceSoapServicegetUserByName in interface ConfluenceSoapServicetoken - The token identifying the current userusername - The username of the user to be retrievedInvalidSessionExceptionRemoteException - if a user with the given username cannot be foundpublic RemoteConfluenceUser getUserByKey(String token, String key) throws RemoteException
ConfluenceSoapServicegetUserByKey in interface ConfluenceSoapServicetoken - The token identifying the current userkey - The user key of the user to be retrievedInvalidSessionExceptionRemoteException - if a user with the given user key cannot be foundpublic boolean setUserPreferenceBoolean(String token, String username, String key, boolean value) throws RemoteException
ConfluenceSoapServicesetUserPreferenceBoolean in interface ConfluenceSoapServicetoken - the token identifying the current userkey - The user preference keyvalue - The valueInvalidSessionException - If the rpc token expiredRemoteException - If any other exception occurredpublic boolean getUserPreferenceBoolean(String token, String username, String key) throws RemoteException
ConfluenceSoapServicegetUserPreferenceBoolean in interface ConfluenceSoapServicetoken - the token identifying the current userkey - The user preference keyInvalidSessionException - If the rpc token expiredRemoteException - If any other exception occurred (including not being able to find the key)public boolean setUserPreferenceLong(String token, String username, String key, long value) throws RemoteException
ConfluenceSoapServicesetUserPreferenceLong in interface ConfluenceSoapServicetoken - the token identifying the current userkey - The user preference keyvalue - The valueInvalidSessionException - If the rpc token expiredRemoteException - If any other exception occurredpublic long getUserPreferenceLong(String token, String username, String key) throws RemoteException
ConfluenceSoapServicegetUserPreferenceLong in interface ConfluenceSoapServicetoken - the token identifying the current userkey - The user preference keyInvalidSessionException - If the rpc token expiredRemoteException - If any other exception occurred (including not being able to find the key)public boolean setUserPreferenceString(String token, String username, String key, String value) throws RemoteException
ConfluenceSoapServicesetUserPreferenceString in interface ConfluenceSoapServicetoken - the token identifying the current userkey - The user preference keyvalue - The valueInvalidSessionException - If the rpc token expiredRemoteException - If any other exception occurredpublic String getUserPreferenceString(String token, String username, String key) throws RemoteException
ConfluenceSoapServicegetUserPreferenceString in interface ConfluenceSoapServicetoken - the token identifying the current userkey - The user preference keyInvalidSessionException - If the rpc token expiredRemoteException - If any other exception occurred (including not being able to find the key)public boolean hasUser(String token, String username)
ConfluenceSoapServicehasUser in interface ConfluenceSoapServicetoken - the token identifying the current userusername - the username to look uppublic void addUser(String token, RemoteUser remoteUser, String password) throws RemoteException
ConfluenceSoapServiceaddUser in interface ConfluenceSoapServicetoken - The token identifying the current userremoteUser - The object containing the user informationpassword - The password of the userNotPermittedException - if the current user lacks permissions to create new usersInvalidSessionExceptionRemoteException - if a user with the given username cannot be foundpublic void addUser(String token, RemoteUser remoteUser, String password, boolean notifyUser) throws RemoteException
ConfluenceSoapServiceaddUser in interface ConfluenceSoapServicetoken - The token identifying the current userremoteUser - The object containing the user informationpassword - The password of the usernotifyUser - Whether or not you want the new user to be notified of their new accountNotPermittedException - if the current user lacks permissions to create new usersInvalidSessionExceptionRemoteException - if a user with the given username cannot be foundpublic boolean removeUser(String token, String username) throws RemoteException
ConfluenceSoapServiceremoveUser in interface ConfluenceSoapServicetoken - The token identifying the current userusername - The username of the user to be removedInvalidSessionExceptionNotPermittedException - if the current user lacks the permission to remove usersRemoteException - if the given username cannot be foundpublic boolean editUser(String token, RemoteUser remoteUser) throws RemoteException
ConfluenceSoapServiceCurrently this will only update the user's full name and email
editUser in interface ConfluenceSoapServicetoken - The token identifying the current userremoteUser - The object containing the user informationNotPermittedException - if the current user cannot administer users or is not the actual userInvalidSessionExceptionRemoteException - if a user with the given username cannot be foundpublic boolean deactivateUser(String token, String username) throws RemoteException
ConfluenceSoapServicedeactivateUser in interface ConfluenceSoapServicetoken - The token identifying the current userusername - The username of the user to deactivateNotPermittedException - if the current user does not have permissions to perform the actionInvalidSessionExceptionRemoteException - if the given username cannot be foundpublic boolean reactivateUser(String token, String username) throws RemoteException
ConfluenceSoapServicereactivateUser in interface ConfluenceSoapServicetoken - The token identifying the current userusername - The username of the user to reactivateNotPermittedException - if the current user does not have permissions to perform the actionInvalidSessionExceptionRemoteException - if the given username cannot be foundpublic boolean isActiveUser(String token, String username) throws RemoteException
ConfluenceSoapServiceisActiveUser in interface ConfluenceSoapServiceusername - The username to checkRemoteException - If the username does not existpublic String[] getActiveUsers(String token, boolean viewAll) throws RemoteException
ConfluenceSoapServicegetActiveUsers in interface ConfluenceSoapServicetoken - The token identifying the current userviewAll - 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.NotPermittedException - if the current user does not have administration permissionsInvalidSessionExceptionRemoteExceptionpublic boolean setUserInformation(String token, RemoteUserInformation userInfo) throws RemoteException
ConfluenceSoapServiceCurrently this will only update a user's "description", stored in the 'content' attribute
setUserInformation in interface ConfluenceSoapServicetoken - The token identifying the current useruserInfo - A RemoteUserInformation object, containing the username, email, fullname, url and informationNotPermittedException - if the current user cannot administer users or is not the actual userInvalidSessionExceptionRemoteException - if there was an error saving the personal informationpublic RemoteUserInformation getUserInformation(String token, String username) throws RemoteException
ConfluenceSoapServicegetUserInformation in interface ConfluenceSoapServicetoken - The token identifying the current userusername - The name of the user to get information onInvalidSessionExceptionRemoteException - if a user with the given username cannot be foundpublic boolean changeMyPassword(String token, String oldPass, String newPass) throws RemoteException
ConfluenceSoapServicechangeMyPassword in interface ConfluenceSoapServicetoken - The token identifying the current useroldPass - The old password of the user, required for security purposesnewPass - The new password for the userNotPermittedException - if newPass was incorrectInvalidSessionExceptionRemoteException - if oldPass does not match the user's passwordpublic boolean changeUserPassword(String token, String username, String newPass) throws RemoteException
ConfluenceSoapServicechangeUserPassword in interface ConfluenceSoapServicetoken - The token identifying the current userusername - The username of the user we are changing the password fornewPass - The new password for the userNotPermittedException - if the current user does not have permission to administer the userInvalidSessionExceptionRemoteException - if the user cannot be foundpublic boolean addProfilePicture(String token, String userName, String fileName, String mimeType, byte[] pictureData) throws RemoteException
ConfluenceSoapServiceaddProfilePicture in interface ConfluenceSoapServiceuserName - The user name of the profilefileName - File name of the picturemimeType - Image mime type (must be from image/*)pictureData - The image dataNotPermittedException - Principal is not permitted to add pictures to the specified profileInvalidSessionExceptionRemoteException - if the user can not be foundpublic boolean renameUser(String token, String oldUsername, String newUsername) throws RemoteException
ConfluenceSoapServicerenameUser in interface ConfluenceSoapServicetoken - The token identifying the current useroldUsername - current username of the usernewUsername - new username of the userNotPermittedException - if the current user does not have permissions to perform the actionInvalidSessionExceptionRemoteException - if the new username does not meet username requirementspublic String[] renameUsers(String token, Map<String,String> oldUsernamesToNewUsernames)
ConfluenceSoapServicerenameUsers in interface ConfluenceSoapServicetoken - The token identifying the current useroldUsernamesToNewUsernames - mapping of current usernames to new usernames of userspublic RemoteServerInfo getServerInfo(String token) throws RemoteException
getServerInfo in interface ConfluenceSoapServiceRemoteExceptionpublic String exportSpace(String token, String spaceKey, String exportType) throws RemoteException
exportSpace in interface ConfluenceSoapServiceRemoteExceptionpublic String exportSpace(String token, String spaceKey, String exportType, boolean exportAll) throws RemoteException
exportSpace in interface ConfluenceSoapServiceRemoteExceptionpublic String exportSite(String token, boolean exportAttachments) throws RemoteException
exportSite in interface ConfluenceSoapServiceRemoteExceptionpublic String performBackup(String token, boolean exportAttachments) throws RemoteException
performBackup in interface ConfluenceSoapServiceRemoteExceptionpublic boolean importSpace(String token, byte[] importData) throws RemoteException
ConfluenceSoapServiceimportSpace in interface ConfluenceSoapServicetoken - The authentication tokenimportData - The contents of the Space export fileRemoteException - If the space exists or the export file is invalidpublic boolean flushIndexQueue(String token) throws RemoteException
flushIndexQueue in interface ConfluenceSoapServiceRemoteExceptionpublic boolean clearIndexQueue(String token) throws RemoteException
clearIndexQueue in interface ConfluenceSoapServiceRemoteExceptionpublic boolean recoverMainIndex(String token) throws RemoteException
recoverMainIndex in interface ConfluenceSoapServiceRemoteExceptionpublic RemoteClusterInformation getClusterInformation(String token)
getClusterInformation in interface ConfluenceSoapServicepublic RemoteNodeStatus[] getClusterNodeStatuses(String token)
getClusterNodeStatuses in interface ConfluenceSoapServicepublic RemoteLabel[] getLabelsById(String token, long objectId) throws RemoteException
ConfluenceSoapServicegetLabelsById in interface ConfluenceSoapServicetoken - The token identifying the current userobjectId - The ID of the ContentEntityObject the method will retrieve the labels forRemoteException - if the object cannot be retrieved from the ContentEntityManagerpublic RemoteLabel[] getMostPopularLabels(String token, int maxCount) throws RemoteException
ConfluenceSoapServicegetMostPopularLabels in interface ConfluenceSoapServicetoken - The token identifying the current usermaxCount - The maximum number of labels to return. A maxCount of 0 means there is no limit.RemoteExceptionpublic RemoteLabel[] getMostPopularLabelsInSpace(String token, String spaceKey, int maxCount) throws RemoteException
ConfluenceSoapServicegetMostPopularLabelsInSpace in interface ConfluenceSoapServicetoken - The token identifying the current userspaceKey - The key of the space to limit the labels tomaxCount - The maximum number of labels to return. A maxCount of 0 means there is no limit.RemoteException - if the space cannot be retrieved from the SpaceManagerNotPermittedException - if the given user does not have VIEW permissions for the spacepublic RemoteLabel[] getRecentlyUsedLabels(String token, int maxResults)
ConfluenceSoapServicegetRecentlyUsedLabels in interface ConfluenceSoapServicetoken - The token identifying the current usermaxResults - The maximum number of labels to return. A value of 0 means the default is used.public RemoteLabel[] getRecentlyUsedLabelsInSpace(String token, String spaceKey, int maxResults) throws RemoteException
ConfluenceSoapServicegetRecentlyUsedLabelsInSpace in interface ConfluenceSoapServicetoken - The token identifying the current userspaceKey - The key of the space to limit the labels tomaxResults - The maximum number of labels to return. A value of 0 means the default is used.RemoteException - if the space does not exist, or the user lacks permission to view itNotPermittedException - if the given user does not have VIEW permissions for the spacepublic RemoteSpace[] getSpacesWithLabel(String token, String labelName) throws RemoteException
ConfluenceSoapServicegetSpacesWithLabel in interface ConfluenceSoapServicetoken - The token identifying the current userlabelName - The name of the label (namespace prefixes permitted)InvalidSessionExceptionRemoteException - if labelName is an empty string or nullpublic RemoteLabel[] getRelatedLabels(String token, String labelName, int maxResults) throws RemoteException
ConfluenceSoapServicegetRelatedLabels in interface ConfluenceSoapServicetoken - The token identifying the current userlabelName - 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.RemoteException - if labelName is an empty string or nullpublic RemoteLabel[] getRelatedLabelsInSpace(String token, String labelName, String spaceKey, int maxResults) throws RemoteException
ConfluenceSoapServicegetRelatedLabelsInSpace in interface ConfluenceSoapServicetoken - The token identifying the current userlabelName - The name of the label (namespace prefixes permitted)spaceKey - The key of the space to limit the labels tomaxResults - The maximum number of labels to return. A maxCount of 0 means the default is used.RemoteException - if labelName is an empty string or nullpublic RemoteLabel[] getLabelsByDetail(String token, String labelName, String namespace, String spaceKey, String owner) throws RemoteException
ConfluenceSoapServiceThis 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.
getLabelsByDetail in interface ConfluenceSoapServicetoken - the authentication token for the userlabelName - the name of the label to search for (not parsed for prefixes)namespace - the namespace to restrict byspaceKey - the key of the space to restrict byowner - the owner of the labelsInvalidSessionExceptionRemoteException - if labelName is an empty string or nullNamespacepublic RemoteSearchResult[] getLabelContentById(String token, long labelId) throws RemoteException
ConfluenceSoapServicegetLabelContentById in interface ConfluenceSoapServicetoken - The token identifying the current userlabelId - The ID of the labelRemoteException - if a Label could not be retrieved for the given IDpublic RemoteSearchResult[] getLabelContentByName(String token, String labelName) throws RemoteException
ConfluenceSoapServicegetLabelContentByName in interface ConfluenceSoapServicetoken - The token identifying the current userlabelName - The name of a label (namespace prefixes permitted)RemoteException - if the label name is nullpublic RemoteSearchResult[] getLabelContentByObject(String token, RemoteLabel labelObject) throws RemoteException
ConfluenceSoapServicegetLabelContentByObject in interface ConfluenceSoapServicetoken - The token identifying the current userlabelObject - The RemoteLabel objectRemoteException - if the RemoteLabel object is nullpublic RemoteSpace[] getSpacesContainingContentWithLabel(String token, String labelName) throws RemoteException
ConfluenceSoapServicegetSpacesContainingContentWithLabel in interface ConfluenceSoapServicetoken - The token identifying the current userlabelName - The label to retrieve the content for (namespace prefixes permitted)InvalidSessionExceptionRemoteException - if labelName is an empty string or nullpublic boolean addLabelByName(String token, String labelName, long objectId) throws RemoteException
ConfluenceSoapServiceaddLabelByName in interface ConfluenceSoapServicetoken - The token identifying the current userlabelName - The name of the label(s) to be added to the ContentEntityObject, in the form of a space-separated stringobjectId - The ID of the ContentEntityObject the method will act onRemoteException - if the label name is null or an empty StringNotPermittedException - if the user lacks EDIT permissions for the objectpublic boolean addLabelById(String token, long labelId, long objectId) throws RemoteException
ConfluenceSoapServiceaddLabelById in interface ConfluenceSoapServicetoken - The token identifying the current userlabelId - The ID of the label to be added to the ContentEntityObjectobjectId - The ID of the ContentEntityObject the method will act onRemoteException - if a Label could not be retrieved for the given IDNotPermittedException - if the user lacks EDIT permissions for the objectpublic boolean addLabelByObject(String token, RemoteLabel labelObject, long objectId) throws RemoteException
ConfluenceSoapServiceaddLabelByObject in interface ConfluenceSoapServicetoken - The token identifying the current userlabelObject - The label to be added to the ContentEntityObjectobjectId - The ID of the ContentEntityObject the method will act onRemoteException - if the given RemoteLabel object is nullNotPermittedException - if the user lacks EDIT permissions for the objectpublic boolean addLabelByNameToSpace(String token, String labelName, String spaceKey) throws RemoteException
ConfluenceSoapServiceaddLabelByNameToSpace in interface ConfluenceSoapServicetoken - The token identifying the current userlabelName - The name of the label(s) to be added to the Space, in the form of a space-separated stringspaceKey - The Space to add the label toRemoteException - if the label name is null or an empty StringNotPermittedException - if the user does not have permission to add the labelpublic boolean removeLabelByName(String token, String labelName, long objectId) throws RemoteException
ConfluenceSoapServiceremoveLabelByName in interface ConfluenceSoapServicetoken - The token identifying the current userlabelName - The name of the label(s) to be removed from the ContentEntityObject, in the form of a space-separated StringobjectId - The ID of the ContentEntityObject the method will act onRemoteException - if the label name is nullNotPermittedException - if the user lacks EDIT permissions for the objectpublic boolean removeLabelById(String token, long labelId, long objectId) throws RemoteException
ConfluenceSoapServiceremoveLabelById in interface ConfluenceSoapServicetoken - The token identifying the current userlabelId - The ID of the label to be removed from the ContentEntityObjectobjectId - The ID of the ContentEntityObject the method will act onRemoteException - if a Label could not be retrieved for the given IDNotPermittedException - if the user lacks EDIT permissions for the objectpublic boolean removeLabelByObject(String token, RemoteLabel labelObject, long objectId) throws RemoteException
ConfluenceSoapServiceremoveLabelByObject in interface ConfluenceSoapServicetoken - The token identifying the current userlabelObject - The label to be removed from the ContentEntityObjectobjectId - The ID of the ContentEntityObject the method will act onRemoteException - if the RemoteLabel object is nullNotPermittedException - if the user lacks EDIT permissions for the objectpublic boolean removeLabelByNameFromSpace(String token, String labelName, String spaceKey) throws RemoteException
ConfluenceSoapServiceremoveLabelByNameFromSpace in interface ConfluenceSoapServicetoken - The token identifying the current userlabelName - The name of the label(s) to be removed from the Space, in the form of a space-separated StringspaceKey - The Space the method will act onRemoteException - if the label name is nullNotPermittedException - if the user lacks EDIT permissions for the Spacepublic RemoteContentPermissionSet[] getContentPermissionSets(String token, long contentId) throws RemoteException
ConfluenceSoapServicegetContentPermissionSets in interface ConfluenceSoapServicetoken - the login token for the current usercontentId - the content ID of the content to be looked upNotPermittedException - if the content can not be found, or can not be accessed by the current userInvalidSessionException - if no login session can be found for the supplied tokenRemoteException - if something random goes wrongpublic RemoteContentPermissionSet getContentPermissionSet(String token, long contentId, String permissionType) throws RemoteException
ConfluenceSoapServicegetContentPermissionSet in interface ConfluenceSoapServicetoken - the login token for the current usercontentId - the content ID of the content to be looked uppermissionType - type of content permissionNotPermittedException - if the content can not be found, or can not be accessed by the current userInvalidSessionException - if no login session can be found for the supplied tokenRemoteException - if something random goes wrongpublic boolean setContentPermissions(String token, long contentId, String permissionType, RemoteContentPermission[] remoteContentPermissions) throws RemoteException
ConfluenceSoapServicesetContentPermissions in interface ConfluenceSoapServicetoken - the login tokencontentId - the id of the content to have permissions set on itpermissionType - the type of the permissions (one of the constants from ContentPermission)remoteContentPermissions - the permissions to setNotPermittedException - if the content can not be found or can not be accessed by the current userInvalidSessionException - if no login session can be found for the supplied tokenRemoteException - if something random goes wrongpublic boolean setEnableAnonymousAccess(String token, boolean value) throws RemoteException
setEnableAnonymousAccess in interface ConfluenceSoapServiceRemoteExceptionpublic boolean isPluginEnabled(String token, String pluginKey) throws RemoteException
ConfluenceSoapServiceisPluginEnabled in interface ConfluenceSoapServiceRemoteExceptionpublic boolean isPluginInstalled(String token, String pluginKey) throws RemoteException
ConfluenceSoapServiceisPluginInstalled in interface ConfluenceSoapServiceRemoteExceptionpublic boolean installPlugin(String token, String pluginFileName, byte[] pluginData) throws RemoteException
ConfluenceSoapServiceinstallPlugin in interface ConfluenceSoapServicepluginFileName - 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.RemoteExceptionpublic boolean isDarkFeatureEnabled(String token, String key)
isDarkFeatureEnabled in interface ConfluenceSoapServicepublic boolean startActivity(String token, String key, String user)
ConfluenceSoapServicestartActivity in interface ConfluenceSoapServicetoken - rpc authentication tokenkey - the activity key to startuser - the username of the user starting the activitypublic boolean stopActivity(String token, String key, String user)
ConfluenceSoapServicestopActivity in interface ConfluenceSoapServicetoken - rpc authentication tokenkey - the activity key to stopuser - the username of the user stopping the activitypublic void setWikiToXhtmlMigrator(ExceptionTolerantMigrator wikiToXhtmlMigrator)
public void setXhtmlRoundTripMigrator(ExceptionTolerantMigrator xhtmlRoundTripMigrator)
public void setContentEntityObjectDao(ContentEntityObjectDao contentEntityObjectDao)
public void setMailServerManager(com.atlassian.mail.server.MailServerManager mailServerManager)
Copyright © 2003–2022 Atlassian. All rights reserved.