com.atlassian.confluence.rpc.xmlrpc
Interface ConfluenceXmlRpcHandler

All Superinterfaces:
SecureRpc
All Known Implementing Classes:
ConfluenceXmlRpcHandlerImpl

public interface ConfluenceXmlRpcHandler
extends SecureRpc


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

Method Detail

login

java.lang.String login(java.lang.String username,
                       java.lang.String password)
                       throws RemoteException
Specified by:
login in interface SecureRpc
Throws:
RemoteException

logout

boolean logout(java.lang.String token)
               throws RemoteException
Specified by:
logout in interface SecureRpc
Throws:
RemoteException

getPages

java.util.Vector getPages(java.lang.String token,
                          java.lang.String spaceKey)
                          throws RemoteException
Throws:
RemoteException

getPage

java.util.Hashtable getPage(java.lang.String token,
                            java.lang.String pageId)
                            throws RemoteException
Throws:
RemoteException

getPageSummary

java.util.Hashtable getPageSummary(java.lang.String token,
                                   java.lang.String pageId)
                                   throws RemoteException
Throws:
RemoteException

getPage

java.util.Hashtable getPage(java.lang.String token,
                            java.lang.String spaceKey,
                            java.lang.String pageTitle)
                            throws RemoteException
Throws:
RemoteException

getPageSummary

java.util.Hashtable getPageSummary(java.lang.String token,
                                   java.lang.String spaceKey,
                                   java.lang.String pageTitle)
                                   throws RemoteException
Throws:
RemoteException

getContentPermissionSets

java.util.Vector getContentPermissionSets(java.lang.String token,
                                          java.lang.String contentId)
                                          throws RemoteException
Throws:
RemoteException

getContentPermissionSet

java.util.Hashtable getContentPermissionSet(java.lang.String token,
                                            java.lang.String contentId,
                                            java.lang.String permissionType)
                                            throws RemoteException
Throws:
RemoteException

getContentPermissions

java.util.Vector getContentPermissions(java.lang.String token,
                                       java.lang.String contentId)
                                       throws RemoteException
Throws:
RemoteException

setContentPermissions

java.lang.Boolean setContentPermissions(java.lang.String token,
                                        java.lang.String contentId,
                                        java.lang.String permissionType,
                                        java.util.Vector permissions)
                                        throws RemoteException
Throws:
RemoteException

getPermissions

java.util.Vector getPermissions(java.lang.String token,
                                java.lang.String spaceKey)
                                throws RemoteException
Throws:
RemoteException

getPermissionsForUser

java.util.Vector getPermissionsForUser(java.lang.String token,
                                       java.lang.String spaceKey,
                                       java.lang.String userName)
                                       throws RemoteException
Throws:
RemoteException

getSpacePermissionSets

java.util.Vector getSpacePermissionSets(java.lang.String token,
                                        java.lang.String spaceKey)
                                        throws RemoteException
Throws:
RemoteException

getSpacePermissionSet

java.util.Hashtable getSpacePermissionSet(java.lang.String token,
                                          java.lang.String spaceKey,
                                          java.lang.String permissionType)
                                          throws RemoteException
Throws:
RemoteException

renderContent

java.lang.String renderContent(java.lang.String token,
                               java.lang.String spaceKey,
                               java.lang.String pageId,
                               java.lang.String newContent)
                               throws RemoteException
Throws:
RemoteException

renderContent

java.lang.String renderContent(java.lang.String token,
                               java.lang.String spaceKey,
                               java.lang.String pageId,
                               java.lang.String newContent,
                               java.util.Hashtable renderParameters)
                               throws RemoteException
Throws:
RemoteException

storePage

java.util.Hashtable storePage(java.lang.String token,
                              java.util.Hashtable pageStruct)
                              throws RemoteException
Throws:
RemoteException

updatePage

java.util.Hashtable updatePage(java.lang.String token,
                               java.util.Hashtable pageStruct,
                               java.util.Hashtable editOptionsStruct)
                               throws RemoteException
Throws:
RemoteException

movePageToTopLevel

java.lang.Boolean movePageToTopLevel(java.lang.String token,
                                     java.lang.String pageId,
                                     java.lang.String targetSpaceKey)
                                     throws RemoteException
Throws:
RemoteException

movePage

java.lang.Boolean movePage(java.lang.String token,
                           java.lang.String sourcePageId,
                           java.lang.String targetPageId,
                           java.lang.String position)
                           throws RemoteException
Throws:
RemoteException

removePage

java.lang.Boolean removePage(java.lang.String token,
                             java.lang.String pageId)
                             throws RemoteException
Throws:
RemoteException

removePageVersionById

java.lang.Boolean removePageVersionById(java.lang.String token,
                                        java.lang.String historicalPageId)
                                        throws RemoteException
Throws:
RemoteException

removePageVersionByVersion

java.lang.Boolean removePageVersionByVersion(java.lang.String token,
                                             java.lang.String pageId,
                                             int version)
                                             throws RemoteException
Throws:
RemoteException

search

java.util.Vector search(java.lang.String token,
                        java.lang.String query,
                        int maxResults)
                        throws RemoteException
Throws:
RemoteException

search

java.util.Vector search(java.lang.String token,
                        java.lang.String query,
                        java.util.Hashtable params,
                        int maxResults)
                        throws RemoteException
Throws:
RemoteException

getPageHistory

java.util.Vector getPageHistory(java.lang.String token,
                                java.lang.String pageId)
                                throws RemoteException
Throws:
RemoteException

getPagePermissions

java.util.Vector getPagePermissions(java.lang.String token,
                                    java.lang.String pageId)
                                    throws RemoteException
Throws:
RemoteException

getTrashContents

java.util.Hashtable getTrashContents(java.lang.String token,
                                     java.lang.String spaceKey,
                                     int offset,
                                     int maxResults)
                                     throws RemoteException
Throws:
RemoteException

purgeFromTrash

java.lang.Boolean purgeFromTrash(java.lang.String token,
                                 java.lang.String spaceKey,
                                 java.lang.String pageId)
                                 throws RemoteException
Throws:
RemoteException

emptyTrash

java.lang.Boolean emptyTrash(java.lang.String token,
                             java.lang.String spaceKey)
                             throws RemoteException
Throws:
RemoteException

getBlogEntries

java.util.Vector getBlogEntries(java.lang.String token,
                                java.lang.String spaceKey)
                                throws RemoteException
Throws:
RemoteException

getBlogEntryByDayAndTitle

java.util.Hashtable getBlogEntryByDayAndTitle(java.lang.String token,
                                              java.lang.String spaceKey,
                                              int dayOfMonth,
                                              java.lang.String postTitle)
                                              throws RemoteException
Throws:
RemoteException

getBlogEntryByDateAndTitle

java.util.Hashtable getBlogEntryByDateAndTitle(java.lang.String token,
                                               java.lang.String spaceKey,
                                               int year,
                                               int month,
                                               int dayOfMonth,
                                               java.lang.String postTitle)
                                               throws RemoteException
Throws:
RemoteException

getBlogEntry

java.util.Hashtable getBlogEntry(java.lang.String token,
                                 java.lang.String blogEntryId)
                                 throws RemoteException
Throws:
RemoteException

storeBlogEntry

java.util.Hashtable storeBlogEntry(java.lang.String token,
                                   java.util.Hashtable blogEntryStruct)
                                   throws RemoteException
Throws:
RemoteException

getComments

java.util.Vector getComments(java.lang.String token,
                             java.lang.String pageId)
                             throws RemoteException
Throws:
RemoteException

getComment

java.util.Hashtable getComment(java.lang.String token,
                               java.lang.String commentId)
                               throws InvalidSessionException,
                                      RemoteException
Throws:
InvalidSessionException
RemoteException

addComment

java.util.Hashtable addComment(java.lang.String token,
                               java.util.Hashtable comment)
                               throws InvalidSessionException,
                                      NotPermittedException,
                                      RemoteException
Throws:
InvalidSessionException
NotPermittedException
RemoteException

editComment

java.util.Hashtable editComment(java.lang.String token,
                                java.util.Hashtable comment)
                                throws InvalidSessionException,
                                       NotPermittedException,
                                       RemoteException
Throws:
InvalidSessionException
NotPermittedException
RemoteException

removeComment

boolean removeComment(java.lang.String token,
                      java.lang.String commentId)
                      throws InvalidSessionException,
                             NotPermittedException,
                             RemoteException
Throws:
InvalidSessionException
NotPermittedException
RemoteException

getTopLevelPages

java.util.Vector getTopLevelPages(java.lang.String token,
                                  java.lang.String spaceKey)
                                  throws RemoteException
Throws:
RemoteException

getAncestors

java.util.Vector getAncestors(java.lang.String token,
                              java.lang.String pageId)
                              throws RemoteException
Throws:
RemoteException

getChildren

java.util.Vector getChildren(java.lang.String token,
                             java.lang.String pageId)
                             throws RemoteException
Throws:
RemoteException

getDescendents

java.util.Vector getDescendents(java.lang.String token,
                                java.lang.String pageId)
                                throws RemoteException
Throws:
RemoteException

getAttachments

java.util.Vector getAttachments(java.lang.String token,
                                java.lang.String pageId)
                                throws RemoteException
Throws:
RemoteException

convertWikiToStorageFormat

java.lang.String convertWikiToStorageFormat(java.lang.String token,
                                            java.lang.String wiki)
                                            throws RemoteException
Throws:
RemoteException

watchPage

boolean watchPage(java.lang.String token,
                  java.lang.String pageId)
                  throws RemoteException
Throws:
RemoteException

watchSpace

boolean watchSpace(java.lang.String token,
                   java.lang.String spaceKey)
                   throws RemoteException
Throws:
RemoteException

watchPageForUser

boolean watchPageForUser(java.lang.String token,
                         java.lang.String pageId,
                         java.lang.String username)
                         throws RemoteException
Throws:
RemoteException

removePageWatch

boolean removePageWatch(java.lang.String token,
                        java.lang.String pageId)
                        throws RemoteException
Throws:
RemoteException

removeSpaceWatch

boolean removeSpaceWatch(java.lang.String token,
                         java.lang.String spaceKey)
                         throws RemoteException
Throws:
RemoteException

removePageWatchForUser

boolean removePageWatchForUser(java.lang.String token,
                               java.lang.String pageId,
                               java.lang.String username)
                               throws RemoteException
Throws:
RemoteException

isWatchingPage

boolean isWatchingPage(java.lang.String token,
                       java.lang.String pageId,
                       java.lang.String username)
                       throws RemoteException
Throws:
RemoteException

isWatchingSpace

boolean isWatchingSpace(java.lang.String token,
                        java.lang.String spaceKey,
                        java.lang.String username)
                        throws RemoteException
Throws:
RemoteException

isWatchingSpaceForType

boolean isWatchingSpaceForType(java.lang.String token,
                               java.lang.String spaceKey,
                               java.lang.String contentType,
                               java.lang.String username)
                               throws RemoteException
Throws:
RemoteException

getWatchersForPage

java.util.Vector getWatchersForPage(java.lang.String token,
                                    java.lang.String pageId)
                                    throws RemoteException
Throws:
RemoteException

getWatchersForSpace

java.util.Vector getWatchersForSpace(java.lang.String token,
                                     java.lang.String spaceKey)
                                     throws RemoteException
Throws:
RemoteException

addAttachment

java.util.Hashtable addAttachment(java.lang.String token,
                                  java.lang.String contentId,
                                  java.util.Hashtable attachment,
                                  byte[] attachmentData)
                                  throws RemoteException,
                                         NotPermittedException
Throws:
RemoteException
NotPermittedException

getAttachment

java.util.Hashtable getAttachment(java.lang.String token,
                                  java.lang.String contentId,
                                  java.lang.String fileName,
                                  java.lang.String version)
                                  throws RemoteException,
                                         NotPermittedException
Throws:
RemoteException
NotPermittedException

getAttachmentData

byte[] getAttachmentData(java.lang.String token,
                         java.lang.String contentId,
                         java.lang.String fileName,
                         java.lang.String version)
                         throws RemoteException,
                                NotPermittedException
Throws:
RemoteException
NotPermittedException

removeAttachment

boolean removeAttachment(java.lang.String token,
                         java.lang.String contentId,
                         java.lang.String fileName)
                         throws RemoteException,
                                NotPermittedException
Throws:
RemoteException
NotPermittedException

moveAttachment

boolean moveAttachment(java.lang.String token,
                       java.lang.String originalContentId,
                       java.lang.String originalFileName,
                       java.lang.String newContentId,
                       java.lang.String newFileName)
                       throws RemoteException,
                              NotPermittedException
Throws:
RemoteException
NotPermittedException

getSpaces

java.util.Vector getSpaces(java.lang.String token)
                           throws RemoteException
Throws:
RemoteException

getSpacesInGroup

java.util.Vector getSpacesInGroup(java.lang.String token,
                                  java.lang.String spaceGroupKey)
                                  throws RemoteException
Throws:
RemoteException

getSpace

java.util.Hashtable getSpace(java.lang.String token,
                             java.lang.String spaceKey)
                             throws RemoteException
Throws:
RemoteException

addSpace

java.util.Hashtable addSpace(java.lang.String token,
                             java.util.Hashtable space)
                             throws RemoteException
Throws:
RemoteException

storeSpace

java.util.Hashtable storeSpace(java.lang.String token,
                               java.util.Hashtable remoteSpace)
                               throws RemoteException
Throws:
RemoteException

addPersonalSpace

java.util.Hashtable addPersonalSpace(java.lang.String token,
                                     java.util.Hashtable space,
                                     java.lang.String username)
                                     throws RemoteException
Throws:
RemoteException

removeSpace

java.lang.Boolean removeSpace(java.lang.String token,
                              java.lang.String spaceKey)
                              throws RemoteException
Throws:
RemoteException

getSpaceStatus

java.lang.String getSpaceStatus(java.lang.String token,
                                java.lang.String spaceKey)
                                throws RemoteException
Throws:
RemoteException

setSpaceStatus

java.lang.Boolean setSpaceStatus(java.lang.String token,
                                 java.lang.String spaceKey,
                                 java.lang.String statusString)
                                 throws RemoteException
Throws:
RemoteException

exportSpace

java.lang.String exportSpace(java.lang.String token,
                             java.lang.String spaceKey,
                             java.lang.String exportType)
                             throws RemoteException
Throws:
RemoteException

importSpace

boolean importSpace(java.lang.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(java.lang.String token,
                             java.lang.String permission,
                             java.lang.String remoteEntityName,
                             java.lang.String spaceKey)
                             throws RemoteException
Throws:
RemoteException

addPermissionsToSpace

boolean addPermissionsToSpace(java.lang.String token,
                              java.util.Vector permissions,
                              java.lang.String remoteEntityName,
                              java.lang.String spaceKey)
                              throws RemoteException
Throws:
RemoteException

removePermissionFromSpace

boolean removePermissionFromSpace(java.lang.String token,
                                  java.lang.String permission,
                                  java.lang.String remoteEntityName,
                                  java.lang.String spaceKey)
                                  throws NotPermittedException,
                                         RemoteException
Throws:
NotPermittedException
RemoteException

addAnonymousPermissionToSpace

boolean addAnonymousPermissionToSpace(java.lang.String token,
                                      java.lang.String permission,
                                      java.lang.String spaceKey)
                                      throws RemoteException
Throws:
RemoteException

addAnonymousPermissionsToSpace

boolean addAnonymousPermissionsToSpace(java.lang.String token,
                                       java.util.Vector permissions,
                                       java.lang.String spaceKey)
                                       throws RemoteException
Throws:
RemoteException

removeAnonymousPermissionFromSpace

boolean removeAnonymousPermissionFromSpace(java.lang.String token,
                                           java.lang.String permission,
                                           java.lang.String spaceKey)
                                           throws NotPermittedException,
                                                  RemoteException
Throws:
NotPermittedException
RemoteException

getSpaceLevelPermissions

java.lang.String[] getSpaceLevelPermissions(java.lang.String token)
                                            throws RemoteException
Throws:
RemoteException

addGlobalPermissions

boolean addGlobalPermissions(java.lang.String token,
                             java.util.Vector permissions,
                             java.lang.String remoteEntityName)
                             throws RemoteException
Throws:
RemoteException

addGlobalPermission

boolean addGlobalPermission(java.lang.String token,
                            java.lang.String permission,
                            java.lang.String remoteEntityName)
                            throws RemoteException
Throws:
RemoteException

removeGlobalPermission

boolean removeGlobalPermission(java.lang.String token,
                               java.lang.String permission,
                               java.lang.String remoteEntityName)
                               throws RemoteException
Throws:
RemoteException

addAnonymousUsePermission

boolean addAnonymousUsePermission(java.lang.String token)
                                  throws RemoteException
Throws:
RemoteException

removeAnonymousUsePermission

boolean removeAnonymousUsePermission(java.lang.String token)
                                     throws RemoteException
Throws:
RemoteException

addAnonymousViewUserProfilePermission

boolean addAnonymousViewUserProfilePermission(java.lang.String token)
                                              throws RemoteException
Throws:
RemoteException

removeAnonymousViewUserProfilePermission

boolean removeAnonymousViewUserProfilePermission(java.lang.String token)
                                                 throws RemoteException
Throws:
RemoteException

addSpaceGroup

java.util.Hashtable addSpaceGroup(java.lang.String token,
                                  java.util.Hashtable spaceGroup)
                                  throws RemoteException
Throws:
RemoteException

getSpaceGroup

java.util.Hashtable getSpaceGroup(java.lang.String token,
                                  java.lang.String spaceGroupKey)
                                  throws RemoteException
Throws:
RemoteException

getSpaceGroups

java.util.Vector getSpaceGroups(java.lang.String token)
                                throws RemoteException
Throws:
RemoteException

removeSpaceGroup

boolean removeSpaceGroup(java.lang.String token,
                         java.lang.String spaceGroupKey)
                         throws RemoteException
Throws:
RemoteException

exportSite

java.lang.String exportSite(java.lang.String token,
                            boolean exportAttachments)
                            throws RemoteException
Throws:
RemoteException

performBackup

java.lang.String performBackup(java.lang.String token,
                               boolean exportAttachments)
                               throws RemoteException
Throws:
RemoteException

getServerInfo

java.util.Hashtable getServerInfo(java.lang.String token)
                                  throws RemoteException
Throws:
RemoteException

flushIndexQueue

boolean flushIndexQueue(java.lang.String token)
                        throws RemoteException
Throws:
RemoteException

clearIndexQueue

boolean clearIndexQueue(java.lang.String token)
                        throws RemoteException
Throws:
RemoteException

getClusterInformation

java.util.Hashtable getClusterInformation(java.lang.String token)
                                          throws RemoteException
Throws:
RemoteException

getClusterNodeStatuses

java.util.Vector getClusterNodeStatuses(java.lang.String token)
                                        throws RemoteException
Throws:
RemoteException

getGroups

java.util.Vector getGroups(java.lang.String token)
                           throws RemoteException
Throws:
RemoteException

hasGroup

boolean hasGroup(java.lang.String token,
                 java.lang.String groupname)
                 throws InvalidSessionException,
                        RemoteException
Throws:
InvalidSessionException
RemoteException

addGroup

boolean addGroup(java.lang.String token,
                 java.lang.String groupname)
                 throws RemoteException
Throws:
RemoteException

removeGroup

boolean removeGroup(java.lang.String token,
                    java.lang.String groupname,
                    java.lang.String defaultGroupName)
                    throws RemoteException
Throws:
RemoteException

removeAllPermissionsForGroup

boolean removeAllPermissionsForGroup(java.lang.String token,
                                     java.lang.String groupname)
                                     throws RemoteException
Throws:
RemoteException

getUserGroups

java.util.Vector getUserGroups(java.lang.String token,
                               java.lang.String username)
                               throws RemoteException
Throws:
RemoteException

addUserToGroup

boolean addUserToGroup(java.lang.String token,
                       java.lang.String username,
                       java.lang.String groupname)
                       throws RemoteException
Throws:
RemoteException

removeUserFromGroup

boolean removeUserFromGroup(java.lang.String token,
                            java.lang.String username,
                            java.lang.String groupname)
                            throws RemoteException
Throws:
RemoteException

getUser

java.util.Hashtable getUser(java.lang.String token,
                            java.lang.String username)
                            throws RemoteException
Throws:
RemoteException

getUserByKey

java.util.Hashtable getUserByKey(java.lang.String token,
                                 java.lang.String userKey)
                                 throws RemoteException
Throws:
RemoteException

hasUser

boolean hasUser(java.lang.String token,
                java.lang.String username)
                throws InvalidSessionException,
                       RemoteException
Throws:
InvalidSessionException
RemoteException

addUser

boolean addUser(java.lang.String token,
                java.util.Hashtable remoteUser,
                java.lang.String password)
                throws RemoteException
Throws:
RemoteException

addUser

boolean addUser(java.lang.String token,
                java.util.Hashtable remoteUser,
                java.lang.String password,
                boolean NotifyUser)
                throws RemoteException
Throws:
RemoteException

removeUser

boolean removeUser(java.lang.String token,
                   java.lang.String username)
                   throws RemoteException
Throws:
RemoteException

editUser

boolean editUser(java.lang.String token,
                 java.util.Hashtable remoteUser)
                 throws NotPermittedException,
                        InvalidSessionException,
                        RemoteException
Throws:
NotPermittedException
InvalidSessionException
RemoteException

deactivateUser

boolean deactivateUser(java.lang.String token,
                       java.lang.String username)
                       throws NotPermittedException,
                              InvalidSessionException,
                              RemoteException
Throws:
NotPermittedException
InvalidSessionException
RemoteException

reactivateUser

boolean reactivateUser(java.lang.String token,
                       java.lang.String username)
                       throws NotPermittedException,
                              InvalidSessionException,
                              RemoteException
Throws:
NotPermittedException
InvalidSessionException
RemoteException

isActiveUser

boolean isActiveUser(java.lang.String token,
                     java.lang.String username)
                     throws NotPermittedException,
                            RemoteException
Throws:
NotPermittedException
RemoteException

getActiveUsers

java.util.Vector getActiveUsers(java.lang.String token,
                                boolean viewAll)
                                throws InvalidSessionException,
                                       RemoteException
Throws:
InvalidSessionException
RemoteException

setUserInformation

boolean setUserInformation(java.lang.String token,
                           java.util.Hashtable userInfo)
                           throws NotPermittedException,
                                  InvalidSessionException,
                                  RemoteException
Throws:
NotPermittedException
InvalidSessionException
RemoteException

getUserInformation

java.util.Hashtable getUserInformation(java.lang.String token,
                                       java.lang.String username)
                                       throws InvalidSessionException,
                                              RemoteException
Throws:
InvalidSessionException
RemoteException

changeMyPassword

boolean changeMyPassword(java.lang.String token,
                         java.lang.String oldPass,
                         java.lang.String newPass)
                         throws InvalidSessionException,
                                RemoteException
Throws:
InvalidSessionException
RemoteException

changeUserPassword

boolean changeUserPassword(java.lang.String token,
                           java.lang.String username,
                           java.lang.String newPass)
                           throws NotPermittedException,
                                  InvalidSessionException,
                                  RemoteException
Throws:
NotPermittedException
InvalidSessionException
RemoteException

addProfilePicture

boolean addProfilePicture(java.lang.String token,
                          java.lang.String userName,
                          java.lang.String fileName,
                          java.lang.String mimeType,
                          byte[] pictureData)
                          throws RemoteException
Throws:
RemoteException

renameUser

boolean renameUser(java.lang.String token,
                   java.lang.String oldUsername,
                   java.lang.String newUsername)
                   throws RemoteException
Throws:
RemoteException

renameUsers

java.util.Vector renameUsers(java.lang.String token,
                             java.util.Hashtable oldUsernamesToNewUsernames)
                             throws RemoteException
Throws:
RemoteException

setUserPreferenceBoolean

boolean setUserPreferenceBoolean(java.lang.String token,
                                 java.lang.String username,
                                 java.lang.String key,
                                 boolean value)
                                 throws InvalidSessionException,
                                        RemoteException
Throws:
InvalidSessionException
RemoteException

getUserPreferenceBoolean

boolean getUserPreferenceBoolean(java.lang.String token,
                                 java.lang.String username,
                                 java.lang.String key)
                                 throws InvalidSessionException,
                                        RemoteException
Throws:
InvalidSessionException
RemoteException

setUserPreferenceLong

boolean setUserPreferenceLong(java.lang.String token,
                              java.lang.String username,
                              java.lang.String key,
                              java.lang.String value)
                              throws InvalidSessionException,
                                     RemoteException
Throws:
InvalidSessionException
RemoteException

getUserPreferenceLong

java.lang.String getUserPreferenceLong(java.lang.String token,
                                       java.lang.String username,
                                       java.lang.String key)
                                       throws InvalidSessionException,
                                              RemoteException
Throws:
InvalidSessionException
RemoteException

setUserPreferenceString

boolean setUserPreferenceString(java.lang.String token,
                                java.lang.String username,
                                java.lang.String key,
                                java.lang.String value)
                                throws InvalidSessionException,
                                       RemoteException
Throws:
InvalidSessionException
RemoteException

getUserPreferenceString

java.lang.String getUserPreferenceString(java.lang.String token,
                                         java.lang.String username,
                                         java.lang.String key)
                                         throws InvalidSessionException,
                                                RemoteException
Throws:
InvalidSessionException
RemoteException

getLabelsById

java.util.Vector getLabelsById(java.lang.String token,
                               java.lang.String objectId)
                               throws RemoteException
Throws:
RemoteException

getMostPopularLabels

java.util.Vector getMostPopularLabels(java.lang.String token,
                                      int maxCount)
                                      throws RemoteException
Throws:
RemoteException

getMostPopularLabelsInSpace

java.util.Vector getMostPopularLabelsInSpace(java.lang.String token,
                                             java.lang.String spaceKey,
                                             int maxCount)
                                             throws RemoteException
Throws:
RemoteException

getLabelContentById

java.util.Vector getLabelContentById(java.lang.String token,
                                     java.lang.String labelId)
                                     throws RemoteException
Throws:
RemoteException

getLabelContentByName

java.util.Vector getLabelContentByName(java.lang.String token,
                                       java.lang.String labelName)
                                       throws RemoteException
Throws:
RemoteException

getLabelContentByObject

java.util.Vector getLabelContentByObject(java.lang.String token,
                                         java.util.Hashtable labelObject)
                                         throws RemoteException
Throws:
RemoteException

getRecentlyUsedLabels

java.util.Vector getRecentlyUsedLabels(java.lang.String token,
                                       int maxResults)
                                       throws InvalidSessionException,
                                              RemoteException
Throws:
InvalidSessionException
RemoteException

getRecentlyUsedLabelsInSpace

java.util.Vector getRecentlyUsedLabelsInSpace(java.lang.String token,
                                              java.lang.String spaceKey,
                                              int maxResults)
                                              throws InvalidSessionException,
                                                     RemoteException
Throws:
InvalidSessionException
RemoteException

getSpacesWithLabel

java.util.Vector getSpacesWithLabel(java.lang.String token,
                                    java.lang.String labelName)
                                    throws InvalidSessionException,
                                           RemoteException
Throws:
InvalidSessionException
RemoteException

getRelatedLabels

java.util.Vector getRelatedLabels(java.lang.String token,
                                  java.lang.String labelName,
                                  int maxResults)
                                  throws InvalidSessionException,
                                         RemoteException
Throws:
InvalidSessionException
RemoteException

getRelatedLabelsInSpace

java.util.Vector getRelatedLabelsInSpace(java.lang.String token,
                                         java.lang.String labelName,
                                         java.lang.String spaceKey,
                                         int maxResults)
                                         throws InvalidSessionException,
                                                RemoteException
Throws:
InvalidSessionException
RemoteException

getLabelsByDetail

java.util.Vector getLabelsByDetail(java.lang.String token,
                                   java.lang.String labelName,
                                   java.lang.String namespace,
                                   java.lang.String spaceKey,
                                   java.lang.String owner)
                                   throws InvalidSessionException,
                                          RemoteException,
                                          NotPermittedException
Throws:
InvalidSessionException
RemoteException
NotPermittedException

getSpacesContainingContentWithLabel

java.util.Vector getSpacesContainingContentWithLabel(java.lang.String token,
                                                     java.lang.String labelName)
                                                     throws InvalidSessionException,
                                                            RemoteException
Throws:
InvalidSessionException
RemoteException

addLabelByName

boolean addLabelByName(java.lang.String token,
                       java.lang.String labelName,
                       java.lang.String objectId)
                       throws NotPermittedException,
                              RemoteException
Throws:
NotPermittedException
RemoteException

addLabelById

boolean addLabelById(java.lang.String token,
                     java.lang.String labelId,
                     java.lang.String objectId)
                     throws NotPermittedException,
                            RemoteException
Throws:
NotPermittedException
RemoteException

addLabelByObject

boolean addLabelByObject(java.lang.String token,
                         java.util.Hashtable labelObject,
                         java.lang.String objectId)
                         throws NotPermittedException,
                                RemoteException
Throws:
NotPermittedException
RemoteException

addLabelByNameToSpace

boolean addLabelByNameToSpace(java.lang.String token,
                              java.lang.String labelName,
                              java.lang.String spaceKey)
                              throws NotPermittedException,
                                     InvalidSessionException,
                                     RemoteException
Throws:
NotPermittedException
InvalidSessionException
RemoteException

removeLabelByName

boolean removeLabelByName(java.lang.String token,
                          java.lang.String labelName,
                          java.lang.String objectId)
                          throws NotPermittedException,
                                 RemoteException
Throws:
NotPermittedException
RemoteException

removeLabelById

boolean removeLabelById(java.lang.String token,
                        java.lang.String labelId,
                        java.lang.String objectId)
                        throws NotPermittedException,
                               RemoteException
Throws:
NotPermittedException
RemoteException

removeLabelByObject

boolean removeLabelByObject(java.lang.String token,
                            java.util.Hashtable labelObject,
                            java.lang.String objectId)
                            throws NotPermittedException,
                                   RemoteException
Throws:
NotPermittedException
RemoteException

removeLabelByNameFromSpace

boolean removeLabelByNameFromSpace(java.lang.String token,
                                   java.lang.String labelName,
                                   java.lang.String spaceKey)
                                   throws NotPermittedException,
                                          InvalidSessionException,
                                          RemoteException
Throws:
NotPermittedException
InvalidSessionException
RemoteException

setEnableWysiwyg

@Deprecated
boolean setEnableWysiwyg(java.lang.String token,
                                    java.lang.String value)
                         throws RemoteException
Deprecated. since 4.0. You can no longer disable the wysiwyg editor.

Throws:
RemoteException

setEnableAnonymousAccess

boolean setEnableAnonymousAccess(java.lang.String token,
                                 java.lang.String value)
                                 throws RemoteException
Throws:
RemoteException

isPluginEnabled

boolean isPluginEnabled(java.lang.String token,
                        java.lang.String pluginKey)
                        throws RemoteException
Throws:
RemoteException

isPluginInstalled

boolean isPluginInstalled(java.lang.String token,
                          java.lang.String pluginKey)
                          throws RemoteException
Throws:
RemoteException

installPlugin

boolean installPlugin(java.lang.String token,
                      java.lang.String pluginFileName,
                      byte[] pluginData)
                      throws RemoteException
Throws:
RemoteException

isDarkFeatureEnabled

boolean isDarkFeatureEnabled(java.lang.String token,
                             java.lang.String key)
                             throws RemoteException
Throws:
RemoteException


Copyright © 2003-2014 Atlassian. All Rights Reserved.