Class WikiSoapService
- java.lang.Object
-
- com.atlassian.confluence.rpc.soap.WikiSoapService
-
- All Implemented Interfaces:
SecureRpc
,ConfluenceSoapService
public class WikiSoapService extends Object implements ConfluenceSoapService
SOAP API for wikimarkup formatted input and output.All methods that retrieve remote objects (for example RemotePage) that contain wiki markup throw exceptions. As of 4.0, all wiki content is migrated to xhtml storage format and as such, there will be no wiki formatted content to return. Throwing an exception is preferable because we don't want scripts to continue to operate on content that it assumes to be wiki markup but is not. This can lead to corrupted content being saved.
-
-
Field Summary
-
Fields inherited from interface com.atlassian.confluence.rpc.soap.ConfluenceSoapService
ADMIN_SPACE_PERMISSION, COMMENT_PERMISSION, MODIFY_PERMISSION, VIEW_PERMISSION
-
-
Constructor Summary
Constructors Constructor Description WikiSoapService()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
addAnonymousPermissionsToSpace(String token, String[] permissions, String spaceKey)
Add Space Permissions for anonymous usersboolean
addAnonymousPermissionToSpace(String token, String permission, String spaceKey)
Add a Space Permission for anonymous usersboolean
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 postboolean
addGlobalPermission(String token, String permission, String remoteEntityName)
Add global permissions for a user or groupboolean
addGlobalPermissions(String token, String[] permissions, String remoteEntityName)
Add a global permission for a user or groupboolean
addGroup(String token, String groupname)
Adds a new groupboolean
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 groupboolean
addPermissionToSpace(String token, String permission, String remoteEntityName, String spaceKey)
Add a Space Permission for a user or groupRemoteSpace
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 profileRemoteSpace
addSpace(String token, RemoteSpace space)
RemoteSpaceGroup
addSpaceGroup(String token, RemoteSpaceGroup spaceGroup)
Add a space Group to ConfluenceRemoteSpace
addSpaceWithDefaultPermissions(String token, RemoteSpace space)
void
addUser(String token, RemoteUser remoteUser, String password)
Adds a user with the given RemoteUser object and passwordvoid
addUser(String token, RemoteUser remoteUser, String password, boolean notifyUser)
Adds a user with the given RemoteUser object and passwordboolean
addUserToGroup(String token, String username, String groupname)
boolean
changeMyPassword(String token, String oldPass, String newPass)
Change the current user's passwordboolean
changeUserPassword(String token, String username, String newPass)
Change a user's passwordboolean
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 userRemoteComment
editComment(String token, RemoteComment comment)
Updates a commentboolean
editUser(String token, RemoteUser remoteUser)
Edits a user with the values in the given RemoteUser objectBoolean
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 usersRemotePageSummary[]
getAncestors(String token, long pageId)
Returns all direct ancestor pages of the page with the given pageId the user authenticated by token is allowed to view.RemoteAttachment
getAttachment(String token, long entityId, String fileName, int version)
Retrieve information about an attachment.byte[]
getAttachmentData(String token, long entityId, String fileName, int version)
Retrieve the contents of an attachment.RemoteAttachment[]
getAttachments(String token, long pageId)
RemoteBlogEntrySummary[]
getBlogEntries(String token, String spaceKey)
RemoteBlogEntry
getBlogEntry(String token, long entryId)
RemoteBlogEntry
getBlogEntryByDateAndTitle(String token, String spaceKey, int year, int month, int dayOfMonth, String postTitle)
Retrieves a blog post in the given space, with the title and date as specified.RemoteBlogEntry
getBlogEntryByDayAndTitle(String token, String spaceKey, int dayOfMonth, String postTitle)
Retrieves a blog post in the Space with the given spaceKey, with the title 'postTitle' and posted on the day 'dayOfMonth'RemotePageSummary[]
getChildren(String token, long pageId)
Returns all child pages of the page with the given pageId the user authenticated by token is allowed to view.RemoteClusterInformation
getClusterInformation(String token)
RemoteNodeStatus[]
getClusterNodeStatuses(String token)
RemoteComment
getComment(String token, long commentId)
Retrieves a comment with the given IDRemoteComment[]
getComments(String token, long pageId)
Retrieves the comments for a given abstract pageRemoteContentPermissionSet
getContentPermissionSet(String token, long contentId, String permissionType)
Get the content permission set of a certain type for a particular piece of contentRemoteContentPermissionSet[]
getContentPermissionSets(String token, long contentId)
Get the content permission sets for a particular piece of contentRemotePageSummary[]
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 groupsRemoteSearchResult[]
getLabelContentById(String token, long labelId)
Returns the content for a given label IDRemoteSearchResult[]
getLabelContentByName(String token, String labelName)
Returns the content for a given label nameRemoteSearchResult[]
getLabelContentByObject(String token, RemoteLabel labelObject)
Returns the content for a given label objectRemoteLabel[]
getLabelsByDetail(String token, String labelName, String namespace, String spaceKey, String owner)
Retrieves the labels matching the given labelName, namespace or owner.RemoteLabel[]
getLabelsById(String token, long objectId)
Returns all labels for the given ContentEntityObject ID.RemoteLabel[]
getMostPopularLabels(String token, int maxCount)
Returns the most popular labels for the Confluence instance, with a specified maximum number of results.RemoteLabel[]
getMostPopularLabelsInSpace(String token, String spaceKey, int maxCount)
Returns the most popular labels for the given spaceKey, with a specified maximum number of results.RemotePage
getPage(String token, long pageId)
RemotePage
getPage(String token, String spaceKey, String pageTitle)
RemotePageHistory[]
getPageHistory(String token, long pageId)
RemotePermission[]
getPagePermissions(String token, long pageId)
RemotePageSummary[]
getPages(String token, String spaceKey)
Returns all pages of the space with the given spaceKey the user authenticated by token is allowed to view.RemotePageSummary
getPageSummary(String token, long pageId)
RemotePageSummary
getPageSummary(String token, String spaceKey, String pageTitle)
String[]
getPermissions(String token, String spaceKey)
String[]
getPermissionsForUser(String token, String spaceKey, String userName)
RemoteLabel[]
getRecentlyUsedLabels(String token, int maxResults)
Returns the recently used labels for the Confluence instance, with a specified maximum number of results.RemoteLabel[]
getRecentlyUsedLabelsInSpace(String token, String spaceKey, int maxResults)
Returns the recently used labels for the given spaceKey, with a specified maximum number of results.RemoteLabel[]
getRelatedLabels(String token, String labelName, int maxResults)
Returns the labels related to the given label name, with a specified maximum number of results.RemoteLabel[]
getRelatedLabelsInSpace(String token, String labelName, String spaceKey, int maxResults)
Returns the labels related to the given label name for the given spaceKey, with a specified maximum number of results.RemoteServerInfo
getServerInfo(String token)
RemoteSpace
getSpace(String token, String spaceKey)
RemoteSpaceGroup
getSpaceGroup(String token, String spaceGroup)
RemoteSpaceGroup[]
getSpaceGroups(String token)
String[]
getSpaceLevelPermissions(String token)
RemoteSpacePermissionSet
getSpacePermissionSet(String token, String spaceKey, String permissionType)
RemoteSpacePermissionSet[]
getSpacePermissionSets(String token, String spaceKey)
RemoteSpaceSummary[]
getSpaces(String token)
RemoteSpace[]
getSpacesContainingContentWithLabel(String token, String labelName)
Returns all Spaces that have content labelled with labelNameRemoteSpaceSummary[]
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 labelNameRemotePageSummary[]
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 toRemoteUserInformation
getUserInformation(String token, String username)
Retrieves a user's informationboolean
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 existsboolean
hasUser(String token, String username)
Determines whether a user existsboolean
importSpace(String token, byte[] importData)
Import a space in a compressed XML formatboolean
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 attachmentBoolean
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 userboolean
recoverMainIndex(String token)
boolean
removeAllPermissionsForGroup(String token, String groupname)
Deletes all global and space permissions for the given groupboolean
removeAnonymousPermissionFromSpace(String token, String permission, String spaceKey)
Removes a Space Permission for anonymous usersboolean
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 IDboolean
removeGlobalPermission(String token, String permission, String remoteEntityName)
Remove a global permissionboolean
removeGroup(String token, String groupname, String defaultGroupName)
Removes an existing groupboolean
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 Spaceboolean
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 groupBoolean
removeSpace(String token, String spaceKey)
boolean
removeSpaceGroup(String token, String spaceGroupKey)
Removes a Space Group from Confluence without removing 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 usernameboolean
removeUserFromGroup(String token, String username, String groupname)
Removes the given user from a groupboolean
renameUser(String token, String oldUsername, String newUsername)
Change user's usernameString[]
renameUsers(String token, Map<String,String> oldUsernamesToNewUsernames)
Change usernames for a set of usersString
renderContent(String token, String spaceKey, long pageId, String newContent)
String
renderContent(String token, String spaceKey, long pageId, String newContent, Map renderParameters)
RemoteSearchResult[]
search(String token, String query, int maxResults)
Search Confluence for the supplied query String.RemoteSearchResult[]
search(String token, String query, Map params, int maxResults)
Search Confluence for the supplied query String.void
setContentEntityObjectDao(ContentEntityObjectDao contentEntityObjectDao)
boolean
setContentPermissions(String token, long contentId, String permissionType, RemoteContentPermission[] remoteContentPermissions)
Set the content permissions for a particular permission type on some content.boolean
setEnableAnonymousAccess(String token, boolean value)
void
setSettingsManager(SettingsManager settingsManager)
Boolean
setSpaceStatus(String token, String spaceKey, String status)
boolean
setUserInformation(String token, RemoteUserInformation userInfo)
Updates a user's informationboolean
setUserPreferenceBoolean(String token, String username, String key, boolean value)
Set a user preference to a boolean value.boolean
setUserPreferenceLong(String token, String username, String key, long value)
Set a user preference to an long integer value.boolean
setUserPreferenceString(String token, String username, String key, String value)
Set a user preference to a String value.void
setWikiToXhtmlMigrator(ExceptionTolerantMigrator wikiToXhtmlMigrator)
void
setXhtmlSoapService(ConfluenceSoapService soapService)
boolean
startActivity(String token, String key, String user)
Call startActivity on the heartbeat manager beanboolean
stopActivity(String token, String key, String user)
Call stopActivity on the heartbeat manager beanRemoteBlogEntry
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.
-
-
-
Method Detail
-
getBlogEntryByDayAndTitle
public RemoteBlogEntry getBlogEntryByDayAndTitle(String token, String spaceKey, int dayOfMonth, String postTitle) throws RemoteException
Description copied from interface:ConfluenceSoapService
Retrieves a blog post in the Space with the given spaceKey, with the title 'postTitle' and posted on the day 'dayOfMonth'- Specified by:
getBlogEntryByDayAndTitle
in interfaceConfluenceSoapService
- Parameters:
token
- 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 post- Returns:
- A RemoteBlogEntry object
- Throws:
RemoteException
- if the user does not have permission to view the blog post, or it does not exist
-
getBlogEntryByDateAndTitle
public RemoteBlogEntry getBlogEntryByDateAndTitle(String token, String spaceKey, int year, int month, int dayOfMonth, String postTitle) throws RemoteException
Description copied from interface:ConfluenceSoapService
Retrieves a blog post in the given space, with the title and date as specified.- Specified by:
getBlogEntryByDateAndTitle
in interfaceConfluenceSoapService
- Returns:
- a blog post matching the criteria
- Throws:
RemoteException
- if the user does not have permission to view the blog post or it does not exist
-
getBlogEntry
public RemoteBlogEntry getBlogEntry(String token, long entryId) throws RemoteException
- Specified by:
getBlogEntry
in interfaceConfluenceSoapService
- Throws:
RemoteException
-
getPage
public RemotePage getPage(String token, String spaceKey, String pageTitle) throws InvalidSessionException, RemoteException
- Specified by:
getPage
in interfaceConfluenceSoapService
- Throws:
InvalidSessionException
RemoteException
-
getPageSummary
public RemotePageSummary getPageSummary(String token, String spaceKey, String pageTitle) throws InvalidSessionException, RemoteException
- Specified by:
getPageSummary
in interfaceConfluenceSoapService
- Throws:
InvalidSessionException
RemoteException
-
getPage
public RemotePage getPage(String token, long pageId) throws InvalidSessionException, RemoteException
- Specified by:
getPage
in interfaceConfluenceSoapService
- Throws:
InvalidSessionException
RemoteException
-
getPageSummary
public RemotePageSummary getPageSummary(String token, long pageId) throws InvalidSessionException, RemoteException
- Specified by:
getPageSummary
in interfaceConfluenceSoapService
- Throws:
InvalidSessionException
RemoteException
-
getComments
public RemoteComment[] getComments(String token, long pageId) throws InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Retrieves the comments for a given abstract page- Specified by:
getComments
in interfaceConfluenceSoapService
- Parameters:
token
- the authentication tokenpageId
- the content ID of the abstract page- Returns:
- RemoteComment object with the comment details
- Throws:
InvalidSessionException
RemoteException
- if the object for the pageId is null, or the user lacks permissions
-
getComment
public RemoteComment getComment(String token, long commentId) throws InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Retrieves a comment with the given ID- Specified by:
getComment
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current usercommentId
- The ID of the comment to be retrieved- Returns:
- A RemoteComment object containing the comment information
- Throws:
InvalidSessionException
RemoteException
- if the comment cannot be found
-
login
public String login(String username, String password) throws AuthenticationFailedException, RemoteException
- Specified by:
login
in interfaceConfluenceSoapService
- Specified by:
login
in interfaceSecureRpc
- Throws:
AuthenticationFailedException
RemoteException
-
logout
public boolean logout(String token) throws RemoteException
- Specified by:
logout
in interfaceConfluenceSoapService
- Specified by:
logout
in interfaceSecureRpc
- Throws:
RemoteException
-
getSpaces
public RemoteSpaceSummary[] getSpaces(String token) throws InvalidSessionException, RemoteException
- Specified by:
getSpaces
in interfaceConfluenceSoapService
- Throws:
InvalidSessionException
RemoteException
-
getSpacesInGroup
public RemoteSpaceSummary[] getSpacesInGroup(String token, String spaceGroupKey) throws RemoteException
- Specified by:
getSpacesInGroup
in interfaceConfluenceSoapService
- Throws:
RemoteException
-
addSpaceWithDefaultPermissions
public RemoteSpace addSpaceWithDefaultPermissions(String token, RemoteSpace space) throws NotPermittedException, InvalidSessionException, AlreadyExistsException, RemoteException
- Specified by:
addSpaceWithDefaultPermissions
in interfaceConfluenceSoapService
- Throws:
NotPermittedException
InvalidSessionException
AlreadyExistsException
RemoteException
-
addSpace
public RemoteSpace addSpace(String token, RemoteSpace space) throws NotPermittedException, InvalidSessionException, AlreadyExistsException, RemoteException
- Specified by:
addSpace
in interfaceConfluenceSoapService
- Throws:
NotPermittedException
InvalidSessionException
AlreadyExistsException
RemoteException
-
storeSpace
public RemoteSpace storeSpace(String token, RemoteSpace remoteSpace) throws RemoteException
Description copied from interface:ConfluenceSoapService
Allows for modifying space details via the remote API. Currently you can update the following space properties:- Name
- Homepage
- SpaceGroup
- Specified by:
storeSpace
in interfaceConfluenceSoapService
- Returns:
- the updated space
- Throws:
RemoteException
-
addSpaceGroup
public RemoteSpaceGroup addSpaceGroup(String token, RemoteSpaceGroup spaceGroup) throws NotPermittedException, InvalidSessionException, AlreadyExistsException, RemoteException
Description copied from interface:ConfluenceSoapService
Add a space Group to Confluence- Specified by:
addSpaceGroup
in interfaceConfluenceSoapService
- Parameters:
token
- the authentication tokenspaceGroup
- the spacegroup to add- Returns:
- the space group
- Throws:
NotPermittedException
- if the user lacks permissions to perform the actionInvalidSessionException
AlreadyExistsException
- if a group with the same key already existsRemoteException
-
getSpaceGroup
public RemoteSpaceGroup getSpaceGroup(String token, String spaceGroup) throws NotPermittedException, InvalidSessionException, AlreadyExistsException, RemoteException
- Specified by:
getSpaceGroup
in interfaceConfluenceSoapService
- Throws:
NotPermittedException
InvalidSessionException
AlreadyExistsException
RemoteException
-
getSpaceGroups
public RemoteSpaceGroup[] getSpaceGroups(String token) throws InvalidSessionException, RemoteException
- Specified by:
getSpaceGroups
in interfaceConfluenceSoapService
- Throws:
InvalidSessionException
RemoteException
-
removeSpaceGroup
public boolean removeSpaceGroup(String token, String spaceGroupKey) throws RemoteException
Description copied from interface:ConfluenceSoapService
Removes a Space Group from Confluence without removing the space it contains. Currently requires global administration rights- Specified by:
removeSpaceGroup
in interfaceConfluenceSoapService
- Parameters:
token
- the authentication tokenspaceGroupKey
- the id of the spacegroup to be removed- Returns:
- true, if the space group was removed
- Throws:
RemoteException
-
addPersonalSpace
public RemoteSpace addPersonalSpace(String token, RemoteSpace space, String username) throws NotPermittedException, InvalidSessionException, AlreadyExistsException, RemoteException
- Specified by:
addPersonalSpace
in interfaceConfluenceSoapService
- Throws:
NotPermittedException
InvalidSessionException
AlreadyExistsException
RemoteException
-
addPersonalSpaceWithDefaultPermissions
public RemoteSpace addPersonalSpaceWithDefaultPermissions(String token, RemoteSpace space, String username) throws NotPermittedException, InvalidSessionException, AlreadyExistsException, RemoteException
- Specified by:
addPersonalSpaceWithDefaultPermissions
in interfaceConfluenceSoapService
- Throws:
NotPermittedException
InvalidSessionException
AlreadyExistsException
RemoteException
-
removeSpace
public Boolean removeSpace(String token, String spaceKey) throws NotPermittedException, InvalidSessionException, RemoteException
- Specified by:
removeSpace
in interfaceConfluenceSoapService
- Throws:
NotPermittedException
InvalidSessionException
RemoteException
-
getSpace
public RemoteSpace getSpace(String token, String spaceKey) throws InvalidSessionException, RemoteException
- Specified by:
getSpace
in interfaceConfluenceSoapService
- Throws:
InvalidSessionException
RemoteException
-
getPermissions
public String[] getPermissions(String token, String spaceKey) throws InvalidSessionException, RemoteException
- Specified by:
getPermissions
in interfaceConfluenceSoapService
- Throws:
InvalidSessionException
RemoteException
-
getPermissionsForUser
public String[] getPermissionsForUser(String token, String spaceKey, String userName) throws InvalidSessionException, RemoteException
- Specified by:
getPermissionsForUser
in interfaceConfluenceSoapService
- Throws:
InvalidSessionException
RemoteException
-
getSpacePermissionSets
public RemoteSpacePermissionSet[] getSpacePermissionSets(String token, String spaceKey) throws InvalidSessionException, NotPermittedException, RemoteException
- Specified by:
getSpacePermissionSets
in interfaceConfluenceSoapService
- Throws:
InvalidSessionException
NotPermittedException
RemoteException
-
getSpacePermissionSet
public RemoteSpacePermissionSet getSpacePermissionSet(String token, String spaceKey, String permissionType) throws InvalidSessionException, NotPermittedException, RemoteException
- Specified by:
getSpacePermissionSet
in interfaceConfluenceSoapService
- Throws:
InvalidSessionException
NotPermittedException
RemoteException
-
addPermissionToSpace
public boolean addPermissionToSpace(String token, String permission, String remoteEntityName, String spaceKey) throws RemoteException
Description copied from interface:ConfluenceSoapService
Add a Space Permission for a user or group- Specified by:
addPermissionToSpace
in interfaceConfluenceSoapService
- Parameters:
token
- the authentication tokenpermission
- the Space Permission to addremoteEntityName
- the name of the user or groupspaceKey
- the key of the Space affected by this action- Returns:
- True if successful, false otherwise
- Throws:
RemoteException
- if the Space Permission is nullNotPermittedException
- if the user lacks permissions to perform the action
-
addPermissionsToSpace
public boolean addPermissionsToSpace(String token, String[] permissions, String remoteEntityName, String spaceKey) throws RemoteException
Description copied from interface:ConfluenceSoapService
Add Space Permissions for a user or group- Specified by:
addPermissionsToSpace
in interfaceConfluenceSoapService
- Parameters:
token
- the authentication tokenpermissions
- the Space Permissions to addremoteEntityName
- the name of the user or groupspaceKey
- the key of the Space affected by this action- Returns:
- True if successful, false otherwise
- Throws:
RemoteException
- if the Space Permissions array is nullNotPermittedException
- if the user lacks permissions to perform the action
-
removePermissionFromSpace
public boolean removePermissionFromSpace(String token, String permission, String remoteEntityName, String spaceKey) throws NotPermittedException, RemoteException
Description copied from interface:ConfluenceSoapService
Removes a Space Permission for a user or group- Specified by:
removePermissionFromSpace
in interfaceConfluenceSoapService
- Parameters:
token
- the authentication tokenpermission
- the Space Permission to removeremoteEntityName
- the name of the user or groupspaceKey
- the key of the Space affected by this action- Returns:
- True if successful, false otherwise
- Throws:
NotPermittedException
- if the user lacks permissions to perform the actionRemoteException
- if the Space does not exist
-
addAnonymousPermissionToSpace
public boolean addAnonymousPermissionToSpace(String token, String permission, String spaceKey) throws RemoteException
Description copied from interface:ConfluenceSoapService
Add a Space Permission for anonymous users- Specified by:
addAnonymousPermissionToSpace
in interfaceConfluenceSoapService
- Parameters:
token
- the authentication tokenpermission
- the Space Permission to addspaceKey
- the key of the Space affected by this action- Returns:
- True if successful, false otherwise
- Throws:
RemoteException
- if the Space Permission is nullNotPermittedException
- if the user lacks permissions to perform the action
-
addAnonymousPermissionsToSpace
public boolean addAnonymousPermissionsToSpace(String token, String[] permissions, String spaceKey) throws RemoteException
Description copied from interface:ConfluenceSoapService
Add Space Permissions for anonymous users- Specified by:
addAnonymousPermissionsToSpace
in interfaceConfluenceSoapService
- Parameters:
token
- the authentication tokenpermissions
- the Space Permissions to addspaceKey
- the key of the Space affected by this action- Returns:
- True if successful, false otherwise
- Throws:
RemoteException
- if the Space Permissions array is nullNotPermittedException
- if the user lacks permissions to perform the action
-
removeAnonymousPermissionFromSpace
public boolean removeAnonymousPermissionFromSpace(String token, String permission, String spaceKey) throws NotPermittedException, RemoteException
Description copied from interface:ConfluenceSoapService
Removes a Space Permission for anonymous users- Specified by:
removeAnonymousPermissionFromSpace
in interfaceConfluenceSoapService
- Parameters:
token
- the authentication tokenpermission
- the Space Permission to removespaceKey
- the key of the Space affected by this action- Returns:
- True if successful, false otherwise
- Throws:
NotPermittedException
- if the user lacks permissions to perform the actionRemoteException
- if the Space does not exist
-
getSpaceLevelPermissions
public String[] getSpaceLevelPermissions(String token) throws RemoteException
- Specified by:
getSpaceLevelPermissions
in interfaceConfluenceSoapService
- Throws:
RemoteException
-
getPages
public RemotePageSummary[] getPages(String token, String spaceKey) throws InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Returns all pages of the space with the given spaceKey the user authenticated by token is allowed to view. The result is not ordered.- Specified by:
getPages
in interfaceConfluenceSoapService
- Parameters:
token
- the authentication tokenspaceKey
- the key of the space which pages are to be returned- Throws:
InvalidSessionException
RemoteException
-
addComment
public RemoteComment addComment(String token, RemoteComment comment) throws InvalidSessionException, NotPermittedException, RemoteException
Description copied from interface:ConfluenceSoapService
Adds a comment to a page or blog post- Specified by:
addComment
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current usercomment
- The RemoteComment object containing the comment information- Returns:
- RemoteComment object
- Throws:
InvalidSessionException
NotPermittedException
- if the user is unable to post the commentRemoteException
- if the user does not have permission to view the page the comment is being posted to, or it does not exist
-
editComment
public RemoteComment editComment(String token, RemoteComment comment) throws InvalidSessionException, NotPermittedException, RemoteException
Description copied from interface:ConfluenceSoapService
Updates a comment- Specified by:
editComment
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current usercomment
- The RemoteComment object containing the comment information- Returns:
- RemoteComment object
- Throws:
InvalidSessionException
NotPermittedException
- if the user is unable to edit the commentRemoteException
- if the user does not have permission to view the page the comment is being posted to, or it does not exist
-
removeComment
public boolean removeComment(String token, long commentId) throws InvalidSessionException, NotPermittedException, RemoteException
Description copied from interface:ConfluenceSoapService
Removes a comment with the given ID- Specified by:
removeComment
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current usercommentId
- The ID of the comment to remove- Returns:
- True if successful, false otherwise
- Throws:
InvalidSessionException
NotPermittedException
- if the user does not have permission to remove the commentRemoteException
- if the user does not have permission to view the page the comment is on, or it does not exist
-
getTopLevelPages
public RemotePageSummary[] getTopLevelPages(String token, String spaceKey) throws RemoteException
Description copied from interface:ConfluenceSoapService
Returns all top level pages of the space with the given spaceKey the user authenticated by token is allowed to view. The result is ordered by child page order.- Specified by:
getTopLevelPages
in interfaceConfluenceSoapService
- Parameters:
token
- the authentication tokenspaceKey
- the key of the space which pages are to be returned- Throws:
RemoteException
-
getAncestors
public RemotePageSummary[] getAncestors(String token, long pageId) throws InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Returns all direct ancestor pages of the page with the given pageId the user authenticated by token is allowed to view. The result is not ordered.- Specified by:
getAncestors
in interfaceConfluenceSoapService
- Parameters:
token
- the authentication tokenpageId
- the id of the page which child pages are to be returned- Throws:
InvalidSessionException
RemoteException
-
getChildren
public RemotePageSummary[] getChildren(String token, long pageId) throws InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Returns all child pages of the page with the given pageId the user authenticated by token is allowed to view. The result is ordered by child page order.- Specified by:
getChildren
in interfaceConfluenceSoapService
- Parameters:
token
- the authentication tokenpageId
- the id of the page which child pages are to be returned- Throws:
InvalidSessionException
RemoteException
-
getDescendents
public RemotePageSummary[] getDescendents(String token, long pageId) throws InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Returns all descendent pages of the page with the given pageId the user authenticated by token is allowed to view. The result is not ordered.- Specified by:
getDescendents
in interfaceConfluenceSoapService
- Parameters:
token
- the authentication tokenpageId
- the id of the page which child pages are to be returned- Throws:
InvalidSessionException
RemoteException
-
getAttachments
public RemoteAttachment[] getAttachments(String token, long pageId) throws InvalidSessionException, RemoteException
- Specified by:
getAttachments
in interfaceConfluenceSoapService
- Throws:
InvalidSessionException
RemoteException
-
getPageHistory
public RemotePageHistory[] getPageHistory(String token, long pageId) throws InvalidSessionException, RemoteException
- Specified by:
getPageHistory
in interfaceConfluenceSoapService
- Throws:
InvalidSessionException
RemoteException
-
watchPage
public boolean watchPage(String token, long pageId) throws RemoteException
Description copied from interface:ConfluenceSoapService
Adds a watch for the current user on the page or blog post with the specified page ID.- Specified by:
watchPage
in interfaceConfluenceSoapService
- Returns:
- true if the watch was added, or false if it already exists
- Throws:
RemoteException
- if the watch could not be added
-
watchSpace
public boolean watchSpace(String token, String spaceKey) throws RemoteException
Description copied from interface:ConfluenceSoapService
Adds a watch for the current user on the space with the specified space key.- Specified by:
watchSpace
in interfaceConfluenceSoapService
- Returns:
- true if the watch was added, or false if it already exists
- Throws:
RemoteException
- if the watch could not be added
-
watchPageForUser
public boolean watchPageForUser(String token, long pageId, String username) throws RemoteException
Description copied from interface:ConfluenceSoapService
Adds a watch to a specific page or blog post for a particular user. This is only permitted for administrators of the space containing the page or blog post.- Specified by:
watchPageForUser
in interfaceConfluenceSoapService
- Returns:
- true if the watch was added, or false if it already exists
- Throws:
RemoteException
- if the watch could not be added, or the current user does not have permission to add it
-
removePageWatch
public boolean removePageWatch(String token, long pageId) throws RemoteException
Description copied from interface:ConfluenceSoapService
Remove a watch for the current user on the page or blog post with the specified page ID.- Specified by:
removePageWatch
in interfaceConfluenceSoapService
- Returns:
- true if the watch was removed, or false if it doesn't exist
- Throws:
RemoteException
- if the watch could not be removed
-
removeSpaceWatch
public boolean removeSpaceWatch(String token, String spaceKey) throws RemoteException
Description copied from interface:ConfluenceSoapService
Removes a watch for the current user on the space with the specified space key.- Specified by:
removeSpaceWatch
in interfaceConfluenceSoapService
- Returns:
- true if the watch was remove, or false if it doesn't exist
- Throws:
RemoteException
- if the watch could not be removed
-
removePageWatchForUser
public boolean removePageWatchForUser(String token, long pageId, String username) throws RemoteException
Description copied from interface:ConfluenceSoapService
Removes a watch from a specific page or blog post for a particular user. This is only permitted for administrators of the space containing the page or blog post.- Specified by:
removePageWatchForUser
in interfaceConfluenceSoapService
- Returns:
- true if the watch was removed, or false if it doesn't exist
- Throws:
RemoteException
- if the watch could not be removed, or the current user does not have permission to remove it
-
isWatchingPage
public boolean isWatchingPage(String token, long pageId, String username) throws RemoteException
Description copied from interface:ConfluenceSoapService
Returns true if the specified user is watching the page or blog post with the given ID, otherwise false. This information is only available to administrators of the space containing the page or blog post, if the username is not the same as the current user's.- Specified by:
isWatchingPage
in interfaceConfluenceSoapService
- Returns:
- true if the user is watching the page, otherwise false
- Throws:
RemoteException
- if the current user does not have permission to see the page or administer the space, or if the page or user does not exist
-
isWatchingSpace
public boolean isWatchingSpace(String token, String spaceKey, String username) throws RemoteException
Description copied from interface:ConfluenceSoapService
Returns true if the specified user is watching the space with the given key, otherwise false. This information is only available to administrators of the space if the username is not the same as the current user's.- Specified by:
isWatchingSpace
in interfaceConfluenceSoapService
- Returns:
- true if the user is watching the space, otherwise false
- Throws:
RemoteException
- if the current user does not have permission to administer the space, or if the user does not exist
-
isWatchingSpaceForType
public boolean isWatchingSpaceForType(String token, String spaceKey, String contentType, String username) throws RemoteException
Description copied from interface:ConfluenceSoapService
Returns true if the specified user is watching the specified type of content in space with the given key, otherwise false. This information is only available to administrators of the space if the username is not the same as the current user's.Note that this method will return false if the user is watching the entire space and not just the given type.
- Specified by:
isWatchingSpaceForType
in interfaceConfluenceSoapService
- Returns:
- true if the user is watching the space for the type, otherwise false
- Throws:
RemoteException
- if the current user does not have permission to administer the space, or if the user does not exist
-
getWatchersForPage
public RemoteUser[] getWatchersForPage(String token, long pageId) throws RemoteException
Description copied from interface:ConfluenceSoapService
Returns the list of users watching the page or blog post with the given ID. This information is only available to administrators of the space containing the page or blog post.- Specified by:
getWatchersForPage
in interfaceConfluenceSoapService
- Returns:
- the list of users watching the page
- Throws:
RemoteException
- if the current user does not have permission to see the page or administer the space, or if the page does not exist
-
getWatchersForSpace
public RemoteUser[] getWatchersForSpace(String token, String spaceKey) throws RemoteException
Description copied from interface:ConfluenceSoapService
Returns the list of users watching the space with the given key. This information is only available to administrators of the space.- Specified by:
getWatchersForSpace
in interfaceConfluenceSoapService
- Returns:
- the list of users watching the space
- Throws:
RemoteException
- if the current user does not have permission to administer the space, or if the space does not exist
-
renderContent
public String renderContent(String token, String spaceKey, long pageId, String newContent) throws InvalidSessionException, RemoteException
- Specified by:
renderContent
in interfaceConfluenceSoapService
- Throws:
InvalidSessionException
RemoteException
-
renderContent
public String renderContent(String token, String spaceKey, long pageId, String newContent, Map renderParameters) throws RemoteException
- Specified by:
renderContent
in interfaceConfluenceSoapService
- Throws:
RemoteException
-
convertWikiToStorageFormat
public String convertWikiToStorageFormat(String token, String markup) throws RemoteException
Description copied from interface:ConfluenceSoapService
Converts a string from wiki markup to the XHTML based storage format.- Specified by:
convertWikiToStorageFormat
in interfaceConfluenceSoapService
- Returns:
- a string converted to the storage format
- Throws:
RemoteException
-
addAttachment
public RemoteAttachment addAttachment(String token, long contentId, RemoteAttachment attachment, byte[] attachmentData) throws RemoteException
Description copied from interface:ConfluenceSoapService
Add a new attachment to a ContentEntityObject.- Specified by:
addAttachment
in interfaceConfluenceSoapService
- Parameters:
token
- 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.- Returns:
- the newly created attachment
- Throws:
RemoteException
-
getAttachment
public RemoteAttachment getAttachment(String token, long entityId, String fileName, int version) throws RemoteException
Description copied from interface:ConfluenceSoapService
Retrieve information about an attachment.- Specified by:
getAttachment
in interfaceConfluenceSoapService
- Parameters:
token
- the authentication token.entityId
- the id of the ContentEntityObject the attachemt belongs to.fileName
- the name of the attachment.version
- the version number of the attachment.- Returns:
- the attachment
- Throws:
RemoteException
-
getAttachmentData
public byte[] getAttachmentData(String token, long entityId, String fileName, int version) throws RemoteException
Description copied from interface:ConfluenceSoapService
Retrieve the contents of an attachment.- Specified by:
getAttachmentData
in interfaceConfluenceSoapService
- Parameters:
token
- the authentication token.entityId
- the id of the ContentEntityObject the attachemt belongs to.fileName
- the name of the attachment.version
- the version number of the attachment.- Returns:
- the attachment's data
- Throws:
RemoteException
-
removeAttachment
public boolean removeAttachment(String token, long contentId, String fileName) throws RemoteException
Description copied from interface:ConfluenceSoapService
Remove an attachment.- Specified by:
removeAttachment
in interfaceConfluenceSoapService
- Parameters:
token
- the authentication token.contentId
- the id of the ContentEntityObject the attachment belongs to.fileName
- the name of the attachment.- Returns:
- true if the attachment was deleted.
- Throws:
RemoteException
-
moveAttachment
public boolean moveAttachment(String token, long originalContentId, String originalFileName, long newContentId, String newFileName) throws RemoteException
Description copied from interface:ConfluenceSoapService
Move or rename an attachment- Specified by:
moveAttachment
in interfaceConfluenceSoapService
- Parameters:
token
- the authentication token.originalContentId
- the id of the ContentEntityObject the attachment belongs to.originalFileName
- the name of the attachment.newContentId
- the id of the ContentEntityObject the attachment is to be moved to.newFileName
- the name the attachment is to be renamed to.- Returns:
- true
- Throws:
RemoteException
-
storePage
public RemotePage storePage(String token, RemotePage page) throws VersionMismatchException, NotPermittedException, InvalidSessionException, RemoteException
- Specified by:
storePage
in interfaceConfluenceSoapService
- Throws:
VersionMismatchException
NotPermittedException
InvalidSessionException
RemoteException
-
updatePage
public RemotePage updatePage(String token, RemotePage page, RemotePageUpdateOptions options) throws VersionMismatchException, NotPermittedException, InvalidSessionException, RemoteException
- Specified by:
updatePage
in interfaceConfluenceSoapService
- Throws:
VersionMismatchException
NotPermittedException
InvalidSessionException
RemoteException
-
movePageToTopLevel
public Boolean movePageToTopLevel(String token, long pageId, String targetSpaceKey) throws RemoteException
- Specified by:
movePageToTopLevel
in interfaceConfluenceSoapService
- Throws:
RemoteException
-
movePage
public Boolean movePage(String token, long sourcePageId, long targetPageId, String position) throws RemoteException
- Specified by:
movePage
in interfaceConfluenceSoapService
- Throws:
RemoteException
-
removePage
public Boolean removePage(String token, long pageId) throws NotPermittedException, InvalidSessionException, RemoteException
- Specified by:
removePage
in interfaceConfluenceSoapService
- Throws:
NotPermittedException
InvalidSessionException
RemoteException
-
removePageVersionById
public Boolean removePageVersionById(String token, long historicalPageId) throws NotPermittedException, InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Remove a historical version of a page. The id supplied must identify a historical version of a page rather than the latest version of the page. If you want to remove the latest version of a page and its full version history then seeConfluenceSoapService.removePage(String, long)
.- Specified by:
removePageVersionById
in interfaceConfluenceSoapService
historicalPageId
- the id of a historical version of a page- Returns:
- true if successfully remove, otherwise false.
- Throws:
NotPermittedException
InvalidSessionException
RemoteException
-
removePageVersionByVersion
public Boolean removePageVersionByVersion(String token, long pageId, int version) throws NotPermittedException, InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Remove the identified version of a page. The pageId must identify a current page.- Specified by:
removePageVersionByVersion
in interfaceConfluenceSoapService
pageId
- the id of the page which you want to remove a version from.version
- the version of the page to be removed (with 1 being the first).- Returns:
- true if successful; otherwise false.
- Throws:
NotPermittedException
InvalidSessionException
RemoteException
-
search
public RemoteSearchResult[] search(String token, String query, int maxResults) throws InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Search Confluence for the supplied query String. Please be sensible in your use of the maxResults parameter. Too large a value will result in this call taking a long time.
- Specified by:
search
in interfaceConfluenceSoapService
- Parameters:
token
- the authentication tokenquery
- the query term for the searchmaxResults
- the maximum number of results to be returned.- Returns:
- an array of
RemoteSearchResult
s. If there are no results then an empty array will be returned. - Throws:
InvalidSessionException
RemoteException
-
search
public RemoteSearchResult[] search(String token, String query, Map params, int maxResults) throws RemoteException
Description copied from interface:ConfluenceSoapService
Search Confluence for the supplied query String. Please be sensible in your use of the maxResults parameter.
A Map of search criteria can be specified. The following keys are understood -
- spaceKey - a key representing a single space to limit the search to.
- type - the type of content to limit the search to.
- modified - a String representation of a time range.
- Specified by:
search
in interfaceConfluenceSoapService
- Parameters:
token
- the authentication tokenquery
- the query term for the searchparams
- aMap<String,String>
providing criteria to the search.maxResults
- the maximum number of results to be returned.- Returns:
- an array of
RemoteSearchResult
s. If there are no results then an empty array will be returned. - Throws:
RemoteException
-
getBlogEntries
public RemoteBlogEntrySummary[] getBlogEntries(String token, String spaceKey) throws InvalidSessionException, RemoteException
- Specified by:
getBlogEntries
in interfaceConfluenceSoapService
- Throws:
InvalidSessionException
RemoteException
-
storeBlogEntry
public RemoteBlogEntry storeBlogEntry(String token, RemoteBlogEntry blogEntry) throws VersionMismatchException, NotPermittedException, InvalidSessionException, RemoteException
- Specified by:
storeBlogEntry
in interfaceConfluenceSoapService
- Throws:
VersionMismatchException
NotPermittedException
InvalidSessionException
RemoteException
-
getServerInfo
public RemoteServerInfo getServerInfo(String token) throws InvalidSessionException, RemoteException
- Specified by:
getServerInfo
in interfaceConfluenceSoapService
- Throws:
InvalidSessionException
RemoteException
-
getPagePermissions
public RemotePermission[] getPagePermissions(String token, long pageId) throws InvalidSessionException, RemoteException
- Specified by:
getPagePermissions
in interfaceConfluenceSoapService
- Throws:
InvalidSessionException
RemoteException
-
exportSpace
public String exportSpace(String token, String spaceKey, String exportType) throws RemoteException
- Specified by:
exportSpace
in interfaceConfluenceSoapService
- Throws:
RemoteException
-
exportSpace
public String exportSpace(String token, String spaceKey, String exportType, boolean exportAll) throws RemoteException
- Specified by:
exportSpace
in interfaceConfluenceSoapService
- Throws:
RemoteException
-
exportSite
public String exportSite(String token, boolean exportAttachments) throws RemoteException
- Specified by:
exportSite
in interfaceConfluenceSoapService
- Throws:
RemoteException
-
performBackup
public String performBackup(String token, boolean exportAttachments) throws RemoteException
- Specified by:
performBackup
in interfaceConfluenceSoapService
- Throws:
RemoteException
-
importSpace
public boolean importSpace(String token, byte[] importData) throws RemoteException
Description copied from interface:ConfluenceSoapService
Import a space in a compressed XML format- Specified by:
importSpace
in interfaceConfluenceSoapService
- Parameters:
token
- The authentication tokenimportData
- The contents of the Space export file- Returns:
- True if successful, otherwise false
- Throws:
RemoteException
- If the space exists or the export file is invalid
-
flushIndexQueue
public boolean flushIndexQueue(String token) throws RemoteException
- Specified by:
flushIndexQueue
in interfaceConfluenceSoapService
- Throws:
RemoteException
-
clearIndexQueue
public boolean clearIndexQueue(String token) throws RemoteException
- Specified by:
clearIndexQueue
in interfaceConfluenceSoapService
- Throws:
RemoteException
-
recoverMainIndex
public boolean recoverMainIndex(String token) throws RemoteException
- Specified by:
recoverMainIndex
in interfaceConfluenceSoapService
- Throws:
RemoteException
-
getClusterInformation
public RemoteClusterInformation getClusterInformation(String token) throws RemoteException
- Specified by:
getClusterInformation
in interfaceConfluenceSoapService
- Throws:
RemoteException
-
getClusterNodeStatuses
public RemoteNodeStatus[] getClusterNodeStatuses(String token) throws RemoteException
- Specified by:
getClusterNodeStatuses
in interfaceConfluenceSoapService
- Throws:
RemoteException
-
getGroups
public String[] getGroups(String token) throws RemoteException
Description copied from interface:ConfluenceSoapService
Retrieves a list of user groups- Specified by:
getGroups
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current user- Returns:
- An array of group names
- Throws:
NotPermittedException
- if the current user lacks permission to administerRemoteException
-
hasGroup
public boolean hasGroup(String token, String groupname) throws InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Determines whether a group exists- Specified by:
hasGroup
in interfaceConfluenceSoapService
- Parameters:
token
- the token identifying the current usergroupname
- the group to look up- Returns:
- True if the user exists, false otherwise
- Throws:
InvalidSessionException
RemoteException
-
addGroup
public boolean addGroup(String token, String groupname) throws NotPermittedException, InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Adds a new group- Specified by:
addGroup
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current usergroupname
- The name of the group to be added- Returns:
- True when the group was successfully added, false if it already exists
- Throws:
NotPermittedException
- if the current user lacks permission to administerInvalidSessionException
RemoteException
-
removeGroup
public boolean removeGroup(String token, String groupname, String defaultGroupName) throws NotPermittedException, InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Removes an existing groupIf a valid defaultGroupName is specified, users will be added to the new group (defaultGroupName).
- Specified by:
removeGroup
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current usergroupname
- The name of the group to be removeddefaultGroupName
- The name of the group that users will be moved to- Returns:
- True if successful, false otherwise.
- Throws:
NotPermittedException
- if the current user lacks permission to administerInvalidSessionException
RemoteException
- if the given groupname does not exist
-
removeAllPermissionsForGroup
public boolean removeAllPermissionsForGroup(String token, String groupname) throws RemoteException
Description copied from interface:ConfluenceSoapService
Deletes all global and space permissions for the given group- Specified by:
removeAllPermissionsForGroup
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current usergroupname
- The group to delete permissions for- Returns:
- True if successful, false otherwise.
- Throws:
NotPermittedException
- if the current user lacks permission to administerRemoteException
- if the given groupname does not exist
-
getUserGroups
public String[] getUserGroups(String token, String username) throws NotPermittedException, InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Retrieves the groups that a given user belongs to- Specified by:
getUserGroups
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current userusername
- The username to retrieve groups for- Returns:
- An array of group names as Strings
- Throws:
NotPermittedException
- if the current user lacks permission to administerInvalidSessionException
RemoteException
- if the given username does not exist
-
addUserToGroup
public boolean addUserToGroup(String token, String username, String groupname) throws NotPermittedException, InvalidSessionException, RemoteException
- Specified by:
addUserToGroup
in interfaceConfluenceSoapService
- Returns:
- True if successful, false otherwise
- Throws:
NotPermittedException
- if the current user lacks permission to administerInvalidSessionException
RemoteException
- if the given username does not exist
-
removeUserFromGroup
public boolean removeUserFromGroup(String token, String username, String groupname) throws NotPermittedException, InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Removes the given user from a group- Specified by:
removeUserFromGroup
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current userusername
- The username to remove from a groupgroupname
- The name of the group the user is to be removed from- Returns:
- True if successful, false otherwise
- Throws:
NotPermittedException
- if the current user lacks permission to administerInvalidSessionException
RemoteException
- if the given username does not exist
-
getUserByName
public RemoteConfluenceUser getUserByName(String token, String username) throws InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Retrieves a user with the given username.- Specified by:
getUserByName
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current userusername
- The username of the user to be retrieved- Returns:
- A RemoteConfluenceUser object, containing the user key, username, full name, email and URL
- Throws:
InvalidSessionException
RemoteException
- if a user with the given username cannot be found
-
getUserByKey
public RemoteConfluenceUser getUserByKey(String token, String key) throws InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Retrieves a user with the given user key.- Specified by:
getUserByKey
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current userkey
- The user key of the user to be retrieved- Returns:
- A RemoteUser object, containing the user key, username, full name, email and URL
- Throws:
InvalidSessionException
RemoteException
- if a user with the given user key cannot be found
-
setUserPreferenceBoolean
public boolean setUserPreferenceBoolean(String token, String username, String key, boolean value) throws InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Set a user preference to a boolean value.- Specified by:
setUserPreferenceBoolean
in interfaceConfluenceSoapService
- Parameters:
token
- the token identifying the current userkey
- The user preference keyvalue
- The value- Throws:
InvalidSessionException
- If the rpc token expiredRemoteException
- If any other exception occurred
-
getUserPreferenceBoolean
public boolean getUserPreferenceBoolean(String token, String username, String key) throws InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Get a user preference as a boolean value.- Specified by:
getUserPreferenceBoolean
in interfaceConfluenceSoapService
- Parameters:
token
- the token identifying the current userkey
- The user preference key- Throws:
InvalidSessionException
- If the rpc token expiredRemoteException
- If any other exception occurred (including not being able to find the key)
-
setUserPreferenceLong
public boolean setUserPreferenceLong(String token, String username, String key, long value) throws InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Set a user preference to an long integer value.- Specified by:
setUserPreferenceLong
in interfaceConfluenceSoapService
- Parameters:
token
- the token identifying the current userkey
- The user preference keyvalue
- The value- Throws:
InvalidSessionException
- If the rpc token expiredRemoteException
- If any other exception occurred
-
getUserPreferenceLong
public long getUserPreferenceLong(String token, String username, String key) throws InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Get a user preference as a long integer value.- Specified by:
getUserPreferenceLong
in interfaceConfluenceSoapService
- Parameters:
token
- the token identifying the current userkey
- The user preference key- Throws:
InvalidSessionException
- If the rpc token expiredRemoteException
- If any other exception occurred (including not being able to find the key)
-
setUserPreferenceString
public boolean setUserPreferenceString(String token, String username, String key, String value) throws InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Set a user preference to a String value.- Specified by:
setUserPreferenceString
in interfaceConfluenceSoapService
- Parameters:
token
- the token identifying the current userkey
- The user preference keyvalue
- The value- Throws:
InvalidSessionException
- If the rpc token expiredRemoteException
- If any other exception occurred
-
getUserPreferenceString
public String getUserPreferenceString(String token, String username, String key) throws InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Get a user preference as a String value.- Specified by:
getUserPreferenceString
in interfaceConfluenceSoapService
- Parameters:
token
- the token identifying the current userkey
- The user preference key- Throws:
InvalidSessionException
- If the rpc token expiredRemoteException
- If any other exception occurred (including not being able to find the key)
-
hasUser
public boolean hasUser(String token, String username) throws InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Determines whether a user exists- Specified by:
hasUser
in interfaceConfluenceSoapService
- Parameters:
token
- the token identifying the current userusername
- the username to look up- Returns:
- True if the user exists, false otherwise
- Throws:
InvalidSessionException
RemoteException
-
addUser
public void addUser(String token, RemoteUser remoteUser, String password) throws NotPermittedException, InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Adds a user with the given RemoteUser object and password- Specified by:
addUser
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current userremoteUser
- The object containing the user informationpassword
- The password of the user- Throws:
NotPermittedException
- if the current user lacks permissions to create new usersInvalidSessionException
RemoteException
- if a user with the given username cannot be found
-
addUser
public void addUser(String token, RemoteUser remoteUser, String password, boolean notifyUser) throws NotPermittedException, InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Adds a user with the given RemoteUser object and password- Specified by:
addUser
in interfaceConfluenceSoapService
- Parameters:
token
- 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 account- Throws:
NotPermittedException
- if the current user lacks permissions to create new usersInvalidSessionException
RemoteException
- if a user with the given username cannot be found
-
removeUser
public boolean removeUser(String token, String username) throws NotPermittedException, InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Removes a user with the given username- Specified by:
removeUser
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current userusername
- The username of the user to be removed- Returns:
- True if successful, false otherwise
- Throws:
NotPermittedException
- if the current user lacks the permission to remove usersInvalidSessionException
RemoteException
- if the given username cannot be found
-
editUser
public boolean editUser(String token, RemoteUser remoteUser) throws NotPermittedException, InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Edits a user with the values in the given RemoteUser objectCurrently this will only update the user's full name and email
- Specified by:
editUser
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current userremoteUser
- The object containing the user information- Throws:
NotPermittedException
- if the current user cannot administer users or is not the actual userInvalidSessionException
RemoteException
- if a user with the given username cannot be found
-
deactivateUser
public boolean deactivateUser(String token, String username) throws NotPermittedException, InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Deactivates the given user- Specified by:
deactivateUser
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current userusername
- The username of the user to deactivate- Returns:
- True if the user was successfully deactivated, false otherwise
- Throws:
NotPermittedException
- if the current user does not have permissions to perform the actionInvalidSessionException
RemoteException
- if the given username cannot be found
-
reactivateUser
public boolean reactivateUser(String token, String username) throws NotPermittedException, InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Reactivates the given user- Specified by:
reactivateUser
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current userusername
- The username of the user to reactivate- Returns:
- True if the user was successfully reactivated, false otherwise
- Throws:
NotPermittedException
- if the current user does not have permissions to perform the actionInvalidSessionException
RemoteException
- if the given username cannot be found
-
isActiveUser
public boolean isActiveUser(String token, String username) throws NotPermittedException, RemoteException
Description copied from interface:ConfluenceSoapService
Checks if a given user is active.- Specified by:
isActiveUser
in interfaceConfluenceSoapService
username
- The username to check- Returns:
- True if the user is active or does not exist, false otherwise.
- Throws:
RemoteException
- If the username does not existNotPermittedException
-
getActiveUsers
public String[] getActiveUsers(String token, boolean viewAll) throws InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Returns a list of the current system users- Specified by:
getActiveUsers
in interfaceConfluenceSoapService
- Parameters:
token
- 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.- Returns:
- An array of usernames as Strings
- Throws:
InvalidSessionException
NotPermittedException
- if the current user does not have administration permissionsRemoteException
-
setUserInformation
public boolean setUserInformation(String token, RemoteUserInformation userInfo) throws NotPermittedException, InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Updates a user's informationCurrently this will only update a user's "description", stored in the 'content' attribute
- Specified by:
setUserInformation
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current useruserInfo
- A RemoteUserInformation object, containing the username, email, fullname, url and information- Throws:
NotPermittedException
- if the current user cannot administer users or is not the actual userInvalidSessionException
RemoteException
- if there was an error saving the personal information
-
getUserInformation
public RemoteUserInformation getUserInformation(String token, String username) throws InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Retrieves a user's information- Specified by:
getUserInformation
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current userusername
- The name of the user to get information on- Throws:
InvalidSessionException
RemoteException
- if a user with the given username cannot be found
-
changeMyPassword
public boolean changeMyPassword(String token, String oldPass, String newPass) throws InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Change the current user's password- Specified by:
changeMyPassword
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current useroldPass
- The old password of the user, required for security purposesnewPass
- The new password for the user- Throws:
InvalidSessionException
NotPermittedException
- if newPass was incorrectRemoteException
- if oldPass does not match the user's password
-
changeUserPassword
public boolean changeUserPassword(String token, String username, String newPass) throws NotPermittedException, InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Change a user's password- Specified by:
changeUserPassword
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current userusername
- The username of the user we are changing the password fornewPass
- The new password for the user- Throws:
NotPermittedException
- if the current user does not have permission to administer the userInvalidSessionException
RemoteException
- if the user cannot be found
-
addProfilePicture
public boolean addProfilePicture(String token, String userName, String fileName, String mimeType, byte[] pictureData) throws NotPermittedException, InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Add a profile picture to a user's profile- Specified by:
addProfilePicture
in interfaceConfluenceSoapService
userName
- The user name of the profilefileName
- File name of the picturemimeType
- Image mime type (must be from image/*)pictureData
- The image data- Returns:
- true if successful
- Throws:
NotPermittedException
- Principal is not permitted to add pictures to the specified profileInvalidSessionException
RemoteException
- if the user can not be found
-
renameUser
public boolean renameUser(String token, String oldUsername, String newUsername) throws RemoteException
Description copied from interface:ConfluenceSoapService
Change user's username- Specified by:
renameUser
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current useroldUsername
- current username of the usernewUsername
- new username of the user- Returns:
- true if successful
- Throws:
NotPermittedException
- if the current user does not have permissions to perform the actionInvalidSessionException
RemoteException
- if the new username does not meet username requirements
-
renameUsers
public String[] renameUsers(String token, Map<String,String> oldUsernamesToNewUsernames) throws RemoteException
Description copied from interface:ConfluenceSoapService
Change usernames for a set of users- Specified by:
renameUsers
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current useroldUsernamesToNewUsernames
- mapping of current usernames to new usernames of users- Returns:
- empty array if the operation was successful or usernames of users that could not be renamed
- Throws:
NotPermittedException
- if the current user does not have permissions to perform the actionInvalidSessionException
RemoteException
- if a new username does not meet username requirements
-
getLabelsById
public RemoteLabel[] getLabelsById(String token, long objectId) throws InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Returns all labels for the given ContentEntityObject ID.- Specified by:
getLabelsById
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current userobjectId
- The ID of the ContentEntityObject the method will retrieve the labels for- Returns:
- An array of RemoteLabel objects
- Throws:
RemoteException
- if the object cannot be retrieved from the ContentEntityManagerInvalidSessionException
-
getMostPopularLabels
public RemoteLabel[] getMostPopularLabels(String token, int maxCount) throws InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Returns the most popular labels for the Confluence instance, with a specified maximum number of results.- Specified by:
getMostPopularLabels
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current usermaxCount
- The maximum number of labels to return. A maxCount of 0 means there is no limit.- Returns:
- An array of RemoteLabel objects, sorted by descending popularity
- Throws:
InvalidSessionException
RemoteException
-
getMostPopularLabelsInSpace
public RemoteLabel[] getMostPopularLabelsInSpace(String token, String spaceKey, int maxCount) throws InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Returns the most popular labels for the given spaceKey, with a specified maximum number of results.- Specified by:
getMostPopularLabelsInSpace
in interfaceConfluenceSoapService
- Parameters:
token
- 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.- Returns:
- An array of RemoteLabel objects, sorted by descending popularity
- Throws:
RemoteException
- if the space cannot be retrieved from the SpaceManagerNotPermittedException
- if the given user does not have VIEW permissions for the spaceInvalidSessionException
-
getRecentlyUsedLabels
public RemoteLabel[] getRecentlyUsedLabels(String token, int maxResults) throws InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Returns the recently used labels for the Confluence instance, with a specified maximum number of results.- Specified by:
getRecentlyUsedLabels
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current usermaxResults
- The maximum number of labels to return. A value of 0 means the default is used.- Returns:
- An array of RemoteLabel objects, sorted by most recent use
- Throws:
InvalidSessionException
RemoteException
-
getRecentlyUsedLabelsInSpace
public RemoteLabel[] getRecentlyUsedLabelsInSpace(String token, String spaceKey, int maxResults) throws InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Returns the recently used labels for the given spaceKey, with a specified maximum number of results.- Specified by:
getRecentlyUsedLabelsInSpace
in interfaceConfluenceSoapService
- Parameters:
token
- 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.- Returns:
- An array of RemoteLabel objects, sorted by most recent use
- Throws:
RemoteException
- if the space does not exist, or the user lacks permission to view itNotPermittedException
- if the given user does not have VIEW permissions for the spaceInvalidSessionException
-
getSpacesWithLabel
public RemoteSpace[] getSpacesWithLabel(String token, String labelName) throws InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Returns an array of Spaces that have been labelled with labelName- Specified by:
getSpacesWithLabel
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current userlabelName
- The name of the label (namespace prefixes permitted)- Returns:
- An array of RemoteSpace instances
- Throws:
InvalidSessionException
RemoteException
- if labelName is an empty string or null
-
getRelatedLabels
public RemoteLabel[] getRelatedLabels(String token, String labelName, int maxResults) throws InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Returns the labels related to the given label name, with a specified maximum number of results.- Specified by:
getRelatedLabels
in interfaceConfluenceSoapService
- Parameters:
token
- 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.- Returns:
- An array of RemoteLabel objects (sorted by frequency of use)
- Throws:
RemoteException
- if labelName is an empty string or nullInvalidSessionException
-
getRelatedLabelsInSpace
public RemoteLabel[] getRelatedLabelsInSpace(String token, String labelName, String spaceKey, int maxResults) throws InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Returns the labels related to the given label name for the given spaceKey, with a specified maximum number of results.- Specified by:
getRelatedLabelsInSpace
in interfaceConfluenceSoapService
- Parameters:
token
- 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.- Returns:
- An array of RemoteLabel objects (sorted by frequency of use)
- Throws:
RemoteException
- if labelName is an empty string or nullInvalidSessionException
-
getLabelsByDetail
public RemoteLabel[] getLabelsByDetail(String token, String labelName, String namespace, String spaceKey, String owner) throws InvalidSessionException, RemoteException, NotPermittedException
Description copied from interface:ConfluenceSoapService
Retrieves the labels matching the given labelName, namespace or owner.This method can be used to retrieve labels of a specfic type, such as personal labels, by setting the namespace.
Parameters with empty strings are ignored.
- Specified by:
getLabelsByDetail
in interfaceConfluenceSoapService
- Parameters:
token
- 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 labels- Returns:
- an array of matching RemoteLabel objects
- Throws:
InvalidSessionException
RemoteException
- if labelName is an empty string or nullNotPermittedException
- See Also:
Namespace
-
getLabelContentById
public RemoteSearchResult[] getLabelContentById(String token, long labelId) throws InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Returns the content for a given label ID- Specified by:
getLabelContentById
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current userlabelId
- The ID of the label- Returns:
- An array of RemoteSearchResult objects
- Throws:
RemoteException
- if a Label could not be retrieved for the given IDInvalidSessionException
-
getLabelContentByName
public RemoteSearchResult[] getLabelContentByName(String token, String labelName) throws InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Returns the content for a given label name- Specified by:
getLabelContentByName
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current userlabelName
- The name of a label (namespace prefixes permitted)- Returns:
- An array of RemoteSearchResult objects
- Throws:
RemoteException
- if the label name is nullInvalidSessionException
-
getLabelContentByObject
public RemoteSearchResult[] getLabelContentByObject(String token, RemoteLabel labelObject) throws InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Returns the content for a given label object- Specified by:
getLabelContentByObject
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current userlabelObject
- The RemoteLabel object- Returns:
- An array of RemoteSearchResult objects
- Throws:
RemoteException
- if the RemoteLabel object is nullInvalidSessionException
-
getSpacesContainingContentWithLabel
public RemoteSpace[] getSpacesContainingContentWithLabel(String token, String labelName) throws InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Returns all Spaces that have content labelled with labelName- Specified by:
getSpacesContainingContentWithLabel
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current userlabelName
- The label to retrieve the content for (namespace prefixes permitted)- Returns:
- An array of RemoteSpace instances (order undefined)
- Throws:
InvalidSessionException
RemoteException
- if labelName is an empty string or null
-
addLabelByName
public boolean addLabelByName(String token, String labelName, long objectId) throws NotPermittedException, InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Adds a label to the object with the given ContentEntityObject ID.- Specified by:
addLabelByName
in interfaceConfluenceSoapService
- Parameters:
token
- 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 on- Returns:
- True if successfully added, false otherwise.
- Throws:
NotPermittedException
- if the user lacks EDIT permissions for the objectRemoteException
- if the label name is null or an empty StringInvalidSessionException
-
addLabelById
public boolean addLabelById(String token, long labelId, long objectId) throws NotPermittedException, InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Adds a label with the given ID to the object with the given ContentEntityObject ID.- Specified by:
addLabelById
in interfaceConfluenceSoapService
- Parameters:
token
- 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 on- Returns:
- True if successfully added, false otherwise.
- Throws:
NotPermittedException
- if the user lacks EDIT permissions for the objectRemoteException
- if a Label could not be retrieved for the given IDInvalidSessionException
-
addLabelByObject
public boolean addLabelByObject(String token, RemoteLabel labelObject, long objectId) throws NotPermittedException, InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Adds the given label object to the object with the given ContentEntityObject ID.- Specified by:
addLabelByObject
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current userlabelObject
- The label to be added to the ContentEntityObjectobjectId
- The ID of the ContentEntityObject the method will act on- Returns:
- True if successfully added, false otherwise.
- Throws:
NotPermittedException
- if the user lacks EDIT permissions for the objectRemoteException
- if the given RemoteLabel object is nullInvalidSessionException
-
addLabelByNameToSpace
public boolean addLabelByNameToSpace(String token, String labelName, String spaceKey) throws NotPermittedException, InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Adds a label to the object with the given ContentEntityObject ID.- Specified by:
addLabelByNameToSpace
in interfaceConfluenceSoapService
- Parameters:
token
- 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 to- Returns:
- True if successfully added, false otherwise.
- Throws:
NotPermittedException
- if the user does not have permission to add the labelRemoteException
- if the label name is null or an empty StringInvalidSessionException
-
removeLabelByName
public boolean removeLabelByName(String token, String labelName, long objectId) throws NotPermittedException, InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Removes the given label from the object with the given ContentEntityObject ID.- Specified by:
removeLabelByName
in interfaceConfluenceSoapService
- Parameters:
token
- 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 on- Returns:
- True if successfully removed, false otherwise.
- Throws:
NotPermittedException
- if the user lacks EDIT permissions for the objectRemoteException
- if the label name is nullInvalidSessionException
-
removeLabelById
public boolean removeLabelById(String token, long labelId, long objectId) throws NotPermittedException, InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Removes the label with the given ID from the object with the given ContentEntityObject ID.- Specified by:
removeLabelById
in interfaceConfluenceSoapService
- Parameters:
token
- 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 on- Returns:
- True if successfully removed, false otherwise.
- Throws:
NotPermittedException
- if the user lacks EDIT permissions for the objectRemoteException
- if a Label could not be retrieved for the given IDInvalidSessionException
-
removeLabelByObject
public boolean removeLabelByObject(String token, RemoteLabel labelObject, long objectId) throws NotPermittedException, InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Removes the given label object from the object with the given ContentEntityObject ID.- Specified by:
removeLabelByObject
in interfaceConfluenceSoapService
- Parameters:
token
- The token identifying the current userlabelObject
- The label to be removed from the ContentEntityObjectobjectId
- The ID of the ContentEntityObject the method will act on- Returns:
- True if successfully removed, false otherwise.
- Throws:
NotPermittedException
- if the user lacks EDIT permissions for the objectRemoteException
- if the RemoteLabel object is nullInvalidSessionException
-
removeLabelByNameFromSpace
public boolean removeLabelByNameFromSpace(String token, String labelName, String spaceKey) throws NotPermittedException, InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Removes the given label from the given Space- Specified by:
removeLabelByNameFromSpace
in interfaceConfluenceSoapService
- Parameters:
token
- 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 on- Returns:
- True if successfully removed, false otherwise.
- Throws:
NotPermittedException
- if the user lacks EDIT permissions for the SpaceRemoteException
- if the label name is nullInvalidSessionException
-
getContentPermissionSets
public RemoteContentPermissionSet[] getContentPermissionSets(String token, long contentId) throws NotPermittedException, InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Get the content permission sets for a particular piece of content- Specified by:
getContentPermissionSets
in interfaceConfluenceSoapService
- Parameters:
token
- the login token for the current usercontentId
- the content ID of the content to be looked up- Returns:
- an array of the permission sets applied to that content
- Throws:
NotPermittedException
- if the content can not be found, or can not be accessed by the current userInvalidSessionException
- if no login session can be found for the supplied tokenRemoteException
- if something random goes wrong
-
getContentPermissionSet
public RemoteContentPermissionSet getContentPermissionSet(String token, long contentId, String permissionType) throws NotPermittedException, InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Get the content permission set of a certain type for a particular piece of content- Specified by:
getContentPermissionSet
in interfaceConfluenceSoapService
- Parameters:
token
- the login token for the current usercontentId
- the content ID of the content to be looked uppermissionType
- type of content permission- Returns:
- a content permission set of the specified type on the content object to be looked up
- Throws:
NotPermittedException
- if the content can not be found, or can not be accessed by the current userInvalidSessionException
- if no login session can be found for the supplied tokenRemoteException
- if something random goes wrong
-
setContentPermissions
public boolean setContentPermissions(String token, long contentId, String permissionType, RemoteContentPermission[] remoteContentPermissions) throws NotPermittedException, InvalidSessionException, RemoteException
Description copied from interface:ConfluenceSoapService
Set the content permissions for a particular permission type on some content. These permissions will replace any permissions that already exist for that permission type.- Specified by:
setContentPermissions
in interfaceConfluenceSoapService
- Parameters:
token
- the login tokencontentId
- the id of the content to have permissions set on itpermissionType
- the type of the permissions (one of the constants fromContentPermission
)remoteContentPermissions
- the permissions to set- Returns:
- true (because RPC methods can't be void)
- Throws:
NotPermittedException
- if the content can not be found or can not be accessed by the current userInvalidSessionException
- if no login session can be found for the supplied tokenRemoteException
- if something random goes wrong
-
addGlobalPermission
public boolean addGlobalPermission(String token, String permission, String remoteEntityName) throws NotPermittedException, RemoteException
Description copied from interface:ConfluenceSoapService
Add global permissions for a user or group- Specified by:
addGlobalPermission
in interfaceConfluenceSoapService
- Parameters:
token
- the login tokenpermission
- the Space Permission to addremoteEntityName
- the name of the user or group- Returns:
- True if successful, false otherwise
- Throws:
NotPermittedException
- if the user lacks permissions to perform the actionRemoteException
-
addGlobalPermissions
public boolean addGlobalPermissions(String token, String[] permissions, String remoteEntityName) throws NotPermittedException, RemoteException
Description copied from interface:ConfluenceSoapService
Add a global permission for a user or group- Specified by:
addGlobalPermissions
in interfaceConfluenceSoapService
- Parameters:
token
- the login tokenpermissions
- Array of permissions to addremoteEntityName
- the name of the user or group- Returns:
- True if successful, false otherwise
- Throws:
NotPermittedException
- if the user lacks permissions to perform the actionRemoteException
-
removeGlobalPermission
public boolean removeGlobalPermission(String token, String permission, String remoteEntityName) throws RemoteException
Description copied from interface:ConfluenceSoapService
Remove a global permission- Specified by:
removeGlobalPermission
in interfaceConfluenceSoapService
- Parameters:
token
- the login tokenpermission
- the Space Permission to addremoteEntityName
- the name of the user or group- Returns:
- True if successful, false otherwise
- Throws:
NotPermittedException
- if the user lacks permissions to perform the actionRemoteException
-
addAnonymousUsePermission
public boolean addAnonymousUsePermission(String token) throws RemoteException
- Specified by:
addAnonymousUsePermission
in interfaceConfluenceSoapService
- Throws:
RemoteException
-
removeAnonymousUsePermission
public boolean removeAnonymousUsePermission(String token) throws RemoteException
Description copied from interface:ConfluenceSoapService
Remove anonymous use permission. If the anonymous user also has 'view user profile' permission then this will also be removed.- Specified by:
removeAnonymousUsePermission
in interfaceConfluenceSoapService
- Parameters:
token
- the login token- Returns:
- true if successful, false otherwise.
- Throws:
RemoteException
-
addAnonymousViewUserProfilePermission
public boolean addAnonymousViewUserProfilePermission(String token) throws RemoteException
Description copied from interface:ConfluenceSoapService
This permission can only be set if the anonymous user already has 'use' permission. If this is not the case then false will be returned.- Specified by:
addAnonymousViewUserProfilePermission
in interfaceConfluenceSoapService
- Parameters:
token
- the login token- Returns:
- true if successfully set; otherwise false.
- Throws:
RemoteException
-
removeAnonymousViewUserProfilePermission
public boolean removeAnonymousViewUserProfilePermission(String token) throws RemoteException
- Specified by:
removeAnonymousViewUserProfilePermission
in interfaceConfluenceSoapService
- Throws:
RemoteException
-
startActivity
public boolean startActivity(String token, String key, String user) throws RemoteException
Description copied from interface:ConfluenceSoapService
Call startActivity on the heartbeat manager bean- Specified by:
startActivity
in interfaceConfluenceSoapService
- Parameters:
token
- rpc authentication tokenkey
- the activity key to startuser
- the username of the user starting the activity- Returns:
- true if executes startActivity without error.
- Throws:
RemoteException
-
stopActivity
public boolean stopActivity(String token, String key, String user) throws RemoteException
Description copied from interface:ConfluenceSoapService
Call stopActivity on the heartbeat manager bean- Specified by:
stopActivity
in interfaceConfluenceSoapService
- Parameters:
token
- rpc authentication tokenkey
- the activity key to stopuser
- the username of the user stopping the activity- Returns:
- true if executes stopActivity without error.
- Throws:
RemoteException
-
setEnableAnonymousAccess
public boolean setEnableAnonymousAccess(String token, boolean value) throws RemoteException
- Specified by:
setEnableAnonymousAccess
in interfaceConfluenceSoapService
- Throws:
RemoteException
-
isPluginEnabled
public boolean isPluginEnabled(String token, String pluginKey) throws RemoteException
Description copied from interface:ConfluenceSoapService
Returns true if the specified plugin is enabled.- Specified by:
isPluginEnabled
in interfaceConfluenceSoapService
- Throws:
RemoteException
-
isPluginInstalled
public boolean isPluginInstalled(String token, String pluginKey) throws RemoteException
Description copied from interface:ConfluenceSoapService
Returns true if the specified plugin is installed.- Specified by:
isPluginInstalled
in interfaceConfluenceSoapService
- Throws:
RemoteException
-
installPlugin
public boolean installPlugin(String token, String pluginFileName, byte[] pluginData) throws RemoteException
Description copied from interface:ConfluenceSoapService
Installs a plugin.- Specified by:
installPlugin
in interfaceConfluenceSoapService
pluginFileName
- the original filename of the plugin. It should end with the correct file extension .xml or .jar.pluginData
- a byte[] containing the contents of the plugin xml or jar file.- Throws:
RemoteException
-
isDarkFeatureEnabled
public boolean isDarkFeatureEnabled(String token, String key) throws RemoteException
- Specified by:
isDarkFeatureEnabled
in interfaceConfluenceSoapService
- Throws:
RemoteException
-
getTrashContents
public RemoteContentSummaries getTrashContents(String token, String spaceKey, int offset, int count) throws RemoteException
- Specified by:
getTrashContents
in interfaceConfluenceSoapService
- Throws:
RemoteException
-
purgeFromTrash
public Boolean purgeFromTrash(String token, String spaceKey, long pageId) throws RemoteException
- Specified by:
purgeFromTrash
in interfaceConfluenceSoapService
- Throws:
RemoteException
-
emptyTrash
public Boolean emptyTrash(String token, String spaceKey) throws RemoteException
- Specified by:
emptyTrash
in interfaceConfluenceSoapService
- Throws:
RemoteException
-
getSpaceStatus
public String getSpaceStatus(String token, String spaceKey) throws NotPermittedException, InvalidSessionException, RemoteException
- Specified by:
getSpaceStatus
in interfaceConfluenceSoapService
- Throws:
NotPermittedException
InvalidSessionException
RemoteException
-
setSpaceStatus
public Boolean setSpaceStatus(String token, String spaceKey, String status) throws NotPermittedException, InvalidSessionException, RemoteException
- Specified by:
setSpaceStatus
in interfaceConfluenceSoapService
- Throws:
NotPermittedException
InvalidSessionException
RemoteException
-
setXhtmlSoapService
public void setXhtmlSoapService(ConfluenceSoapService soapService)
-
setWikiToXhtmlMigrator
public void setWikiToXhtmlMigrator(ExceptionTolerantMigrator wikiToXhtmlMigrator)
-
setContentEntityObjectDao
public void setContentEntityObjectDao(ContentEntityObjectDao contentEntityObjectDao)
-
setSettingsManager
public void setSettingsManager(SettingsManager settingsManager)
-
-