|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.atlassian.confluence.rpc.soap.ConfluenceSoapServiceDelegator
public class ConfluenceSoapServiceDelegator
| Field Summary |
|---|
| Fields inherited from interface com.atlassian.confluence.rpc.soap.ConfluenceSoapService |
|---|
ADMIN_SPACE_PERMISSION, COMMENT_PERMISSION, MODIFY_PERMISSION, VIEW_PERMISSION |
| Constructor Summary | |
|---|---|
ConfluenceSoapServiceDelegator()
|
|
| Method Summary | |
|---|---|
boolean |
addAnonymousPermissionsToSpace(java.lang.String token,
java.lang.String[] permissions,
java.lang.String spaceKey)
Add Space Permissions for anonymous users |
boolean |
addAnonymousPermissionToSpace(java.lang.String token,
java.lang.String permission,
java.lang.String spaceKey)
Add a Space Permission for anonymous users |
boolean |
addAnonymousUsePermission(java.lang.String token)
|
RemoteAttachment |
addAttachment(java.lang.String token,
long contentId,
RemoteAttachment attachment,
byte[] attachmentData)
Add a new attachment to a ContentEntityObject. |
RemoteAttachment |
addAttachment(java.lang.String token,
RemoteAttachment attachment,
byte[] attachmentData)
Deprecated. available for backward compatibility. |
RemoteComment |
addComment(java.lang.String token,
RemoteComment comment)
Adds a comment to a page or blog post |
boolean |
addGlobalPermission(java.lang.String token,
java.lang.String permission,
java.lang.String remoteEntityName)
Add global permissions for a user or group |
boolean |
addGlobalPermissions(java.lang.String token,
java.lang.String[] permissions,
java.lang.String remoteEntityName)
Add a global permission for a user or group |
boolean |
addGroup(java.lang.String token,
java.lang.String groupname)
Adds a new group |
boolean |
addLabelById(java.lang.String token,
long labelId,
long objectId)
Adds a label with the given ID to the object with the given ContentEntityObject ID. |
boolean |
addLabelByName(java.lang.String token,
java.lang.String labelName,
long objectId)
Adds a label to the object with the given ContentEntityObject ID. |
boolean |
addLabelByNameToSpace(java.lang.String token,
java.lang.String labelName,
java.lang.String spaceKey)
Adds a label to the object with the given ContentEntityObject ID. |
boolean |
addLabelByObject(java.lang.String token,
RemoteLabel labelObject,
long objectId)
Adds the given label object to the object with the given ContentEntityObject ID. |
boolean |
addPermissionsToSpace(java.lang.String token,
java.lang.String[] permissions,
java.lang.String remoteEntityName,
java.lang.String spaceKey)
Add Space Permissions for a user or group |
boolean |
addPermissionToSpace(java.lang.String token,
java.lang.String permission,
java.lang.String remoteEntityName,
java.lang.String spaceKey)
Add a Space Permission for a user or group |
RemoteSpace |
addPersonalSpace(java.lang.String token,
RemoteSpace space,
java.lang.String username)
|
boolean |
addProfilePicture(java.lang.String token,
java.lang.String userName,
java.lang.String fileName,
java.lang.String mimeType,
byte[] pictureData)
Add a profile picture to a user's profile |
RemoteSpace |
addSpace(java.lang.String token,
RemoteSpace space)
|
RemoteSpaceGroup |
addSpaceGroup(java.lang.String token,
RemoteSpaceGroup spaceGroup)
Add a space Group to Confluence |
void |
addUser(java.lang.String token,
RemoteUser remoteUser,
java.lang.String password)
Adds a user with the given RemoteUser object and password |
boolean |
addUserToGroup(java.lang.String token,
java.lang.String username,
java.lang.String groupname)
|
boolean |
changeMyPassword(java.lang.String token,
java.lang.String oldPass,
java.lang.String newPass)
Change the current user's password |
boolean |
changeUserPassword(java.lang.String token,
java.lang.String username,
java.lang.String newPass)
Change a user's password |
boolean |
clearIndexQueue(java.lang.String token)
|
boolean |
convertToPersonalSpace(java.lang.String token,
java.lang.String userName,
java.lang.String spaceKey,
java.lang.String newName,
boolean updateLinks)
|
boolean |
deactivateUser(java.lang.String token,
java.lang.String username)
Deactivates the given user |
RemoteComment |
editComment(java.lang.String token,
RemoteComment comment)
Updates a comment |
boolean |
editUser(java.lang.String token,
RemoteUser remoteUser)
Edits a user with the values in the given RemoteUser object Currently this will only update the user's full name and email |
java.lang.String |
exportSite(java.lang.String token,
boolean exportAttachments)
|
java.lang.String |
exportSpace(java.lang.String token,
java.lang.String spaceKey,
java.lang.String exportType)
|
java.lang.String |
exportSpace(java.lang.String token,
java.lang.String spaceKey,
java.lang.String exportType,
boolean exportAll)
|
boolean |
flushIndexQueue(java.lang.String token)
|
java.lang.String[] |
getActiveUsers(java.lang.String token,
boolean viewAll)
Returns a list of the current system users |
RemotePageSummary[] |
getAncestors(java.lang.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(java.lang.String token,
long entityId,
java.lang.String fileName,
int version)
Retrieve information about an attachment. |
byte[] |
getAttachmentData(java.lang.String token,
long entityId,
java.lang.String fileName,
int version)
Retrieve the contents of an attachment. |
RemoteAttachment[] |
getAttachments(java.lang.String token,
long pageId)
|
RemoteBlogEntrySummary[] |
getBlogEntries(java.lang.String token,
java.lang.String spaceKey)
|
RemoteBlogEntry |
getBlogEntry(java.lang.String token,
long entryId)
|
RemoteBlogEntry |
getBlogEntryByDayAndTitle(java.lang.String token,
java.lang.String spaceKey,
int dayOfMonth,
java.lang.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(java.lang.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(java.lang.String token)
|
RemoteNodeStatus[] |
getClusterNodeStatuses(java.lang.String token)
|
RemoteComment |
getComment(java.lang.String token,
long commentId)
Retrieves a comment with the given ID |
RemoteComment[] |
getComments(java.lang.String token,
long pageId)
Retrieves the comments for a given abstract page |
RemoteContentPermissionSet |
getContentPermissionSet(java.lang.String token,
long contentId,
java.lang.String permissionType)
Get the content permission set of a certain type for a particular piece of content |
RemoteContentPermissionSet[] |
getContentPermissionSets(java.lang.String token,
long contentId)
Get the content permission sets for a particular piece of content |
RemotePageSummary[] |
getDescendents(java.lang.String token,
long pageId)
Returns all descendent pages of the page with the given pageId the user authenticated by token is allowed to view. |
java.lang.String[] |
getGroups(java.lang.String token)
Retrieves a list of user groups |
RemoteSearchResult[] |
getLabelContentById(java.lang.String token,
long labelId)
Returns the content for a given label ID |
RemoteSearchResult[] |
getLabelContentByName(java.lang.String token,
java.lang.String labelName)
Returns the content for a given label name |
RemoteSearchResult[] |
getLabelContentByObject(java.lang.String token,
RemoteLabel labelObject)
Returns the content for a given label object |
RemoteLabel[] |
getLabelsByDetail(java.lang.String token,
java.lang.String labelName,
java.lang.String namespace,
java.lang.String spaceKey,
java.lang.String owner)
Retrieves the labels matching the given labelName, namespace or owner. |
RemoteLabel[] |
getLabelsById(java.lang.String token,
long objectId)
Returns all labels for the given ContentEntityObject ID. |
RemoteLabel[] |
getMostPopularLabels(java.lang.String token,
int maxCount)
Returns the most popular labels for the Confluence instance, with a specified maximum number of results. |
RemoteLabel[] |
getMostPopularLabelsInSpace(java.lang.String token,
java.lang.String spaceKey,
int maxCount)
Returns the most popular labels for the given spaceKey, with a specified maximum number of results. |
RemotePage |
getPage(java.lang.String token,
long pageId)
|
RemotePage |
getPage(java.lang.String token,
java.lang.String spaceKey,
java.lang.String pageTitle)
|
RemotePageHistory[] |
getPageHistory(java.lang.String token,
long pageId)
|
RemotePermission[] |
getPagePermissions(java.lang.String token,
long pageId)
|
RemotePageSummary[] |
getPages(java.lang.String token,
java.lang.String spaceKey)
Returns all pages of the space with the given spaceKey the user authenticated by token is allowed to view. |
java.lang.String[] |
getPermissions(java.lang.String token,
java.lang.String spaceKey)
|
java.lang.String[] |
getPermissionsForUser(java.lang.String token,
java.lang.String spaceKey,
java.lang.String userName)
|
RemoteLabel[] |
getRecentlyUsedLabels(java.lang.String token,
int maxResults)
Returns the recently used labels for the Confluence instance, with a specified maximum number of results. |
RemoteLabel[] |
getRecentlyUsedLabelsInSpace(java.lang.String token,
java.lang.String spaceKey,
int maxResults)
Returns the recently used labels for the given spaceKey, with a specified maximum number of results. |
RemoteLabel[] |
getRelatedLabels(java.lang.String token,
java.lang.String labelName,
int maxResults)
Returns the labels related to the given label name, with a specified maximum number of results. |
RemoteLabel[] |
getRelatedLabelsInSpace(java.lang.String token,
java.lang.String labelName,
java.lang.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(java.lang.String token)
|
RemoteSpace |
getSpace(java.lang.String token,
java.lang.String spaceKey)
|
RemoteSpaceGroup |
getSpaceGroup(java.lang.String token,
java.lang.String spaceGroup)
|
RemoteSpaceGroup[] |
getSpaceGroups(java.lang.String token)
|
java.lang.String[] |
getSpaceLevelPermissions(java.lang.String token)
|
RemoteSpaceSummary[] |
getSpaces(java.lang.String token)
|
RemoteSpace[] |
getSpacesContainingContentWithLabel(java.lang.String token,
java.lang.String labelName)
Returns all Spaces that have content labelled with labelName |
RemoteSpaceSummary[] |
getSpacesInGroup(java.lang.String token,
java.lang.String spaceGroupKey)
|
RemoteSpace[] |
getSpacesWithLabel(java.lang.String token,
java.lang.String labelName)
Returns an array of Spaces that have been labelled with labelName |
RemotePageSummary[] |
getTopLevelPages(java.lang.String token,
java.lang.String spaceKey)
Returns all top level pages of the space with the given spaceKey the user authenticated by token is allowed to view. |
RemoteUser |
getUser(java.lang.String token,
java.lang.String username)
Retrieves a user with the given username |
java.lang.String[] |
getUserGroups(java.lang.String token,
java.lang.String username)
Retrieves the groups that a given user belongs to |
RemoteUserInformation |
getUserInformation(java.lang.String token,
java.lang.String username)
Retrieves a user's information |
boolean |
hasGroup(java.lang.String token,
java.lang.String groupname)
Determines whether a group exists |
boolean |
hasUser(java.lang.String token,
java.lang.String username)
Determines whether a user exists |
boolean |
importSpace(java.lang.String token,
byte[] importData)
Import a space in a compressed XML format |
boolean |
isPluginEnabled(java.lang.String token,
java.lang.String pluginKey)
Returns true if the specified plugin is enabled. |
java.lang.String |
login(java.lang.String username,
java.lang.String password)
|
boolean |
logout(java.lang.String token)
|
boolean |
moveAttachment(java.lang.String token,
long originalContentId,
java.lang.String originalFileName,
long newContentId,
java.lang.String newFileName)
Move or rename an attachment |
java.lang.Boolean |
movePage(java.lang.String token,
long sourcePageId,
long targetPageId,
java.lang.String position)
|
java.lang.Boolean |
movePageToTopLevel(java.lang.String token,
long pageId,
java.lang.String targetSpaceKey)
|
boolean |
reactivateUser(java.lang.String token,
java.lang.String username)
Reactivates the given user |
boolean |
removeAllPermissionsForGroup(java.lang.String token,
java.lang.String groupname)
Deletes all global and space permissions for the given group |
boolean |
removeAnonymousPermissionFromSpace(java.lang.String token,
java.lang.String permission,
java.lang.String spaceKey)
Removes a Space Permission for anonymous users |
boolean |
removeAnonymousUsePermission(java.lang.String token)
|
boolean |
removeAttachment(java.lang.String token,
long contentId,
java.lang.String fileName)
Remove an attachment. |
boolean |
removeComment(java.lang.String token,
long commentId)
Removes a comment with the given ID |
boolean |
removeGlobalPermission(java.lang.String token,
java.lang.String permission,
java.lang.String remoteEntityName)
Remove a global permission |
boolean |
removeGroup(java.lang.String token,
java.lang.String groupname,
java.lang.String defaultGroupName)
Removes an existing group If a valid defaultGroupName is specified, users will be added to the new group (defaultGroupName). |
boolean |
removeLabelById(java.lang.String token,
long labelId,
long objectId)
Removes the label with the given ID from the object with the given ContentEntityObject ID. |
boolean |
removeLabelByName(java.lang.String token,
java.lang.String labelName,
long objectId)
Removes the given label from the object with the given ContentEntityObject ID. |
boolean |
removeLabelByNameFromSpace(java.lang.String token,
java.lang.String labelName,
java.lang.String spaceKey)
Removes the given label from the given Space |
boolean |
removeLabelByObject(java.lang.String token,
RemoteLabel labelObject,
long objectId)
Removes the given label object from the object with the given ContentEntityObject ID. |
java.lang.Boolean |
removePage(java.lang.String token,
long pageId)
|
boolean |
removePermissionFromSpace(java.lang.String token,
java.lang.String permission,
java.lang.String remoteEntityName,
java.lang.String spaceKey)
Removes a Space Permission for a user or group |
java.lang.Boolean |
removeSpace(java.lang.String token,
java.lang.String spaceKey)
|
boolean |
removeSpaceGroup(java.lang.String token,
java.lang.String spaceGroupKey)
Removes a Space Group from Confluence without removeing the space it contains. |
boolean |
removeUser(java.lang.String token,
java.lang.String username)
Removes a user with the given username |
boolean |
removeUserFromGroup(java.lang.String token,
java.lang.String username,
java.lang.String groupname)
Removes the given user from a group |
java.lang.String |
renderContent(java.lang.String token,
java.lang.String spaceKey,
long pageId,
java.lang.String newContent)
|
java.lang.String |
renderContent(java.lang.String token,
java.lang.String spaceKey,
long pageId,
java.lang.String newContent,
java.util.Map renderParameters)
|
RemoteSearchResult[] |
search(java.lang.String token,
java.lang.String query,
int maxResults)
Search Confluence for the supplied query String. |
RemoteSearchResult[] |
search(java.lang.String token,
java.lang.String query,
java.util.Map params,
int maxResults)
Search Confluence for the supplied query String. |
boolean |
setContentPermissions(java.lang.String token,
long contentId,
java.lang.String permissionType,
RemoteContentPermission[] remoteContentPermissions)
Set the content permissions for a particular permission type on some content. |
boolean |
setEnableAnonymousAccess(java.lang.String token,
boolean value)
|
boolean |
setEnableWysiwyg(java.lang.String token,
boolean value)
|
void |
setSoapServiceDelegator(ConfluenceSoapService soapServiceDelegator)
|
boolean |
setUserInformation(java.lang.String token,
RemoteUserInformation userInfo)
Updates a user's information Currently this will only update a user's "description", stored in the 'content' attribute |
RemoteBlogEntry |
storeBlogEntry(java.lang.String token,
RemoteBlogEntry blogEntry)
|
RemotePage |
storePage(java.lang.String token,
RemotePage page)
|
RemoteSpace |
storeSpace(java.lang.String token,
RemoteSpace remoteSpace)
Allows for modifying space details via the remote API. |
RemotePage |
updatePage(java.lang.String token,
RemotePage page,
RemotePageUpdateOptions options)
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public ConfluenceSoapServiceDelegator()
| Method Detail |
|---|
public java.lang.String login(java.lang.String username,
java.lang.String password)
throws AuthenticationFailedException,
RemoteException
login in interface SecureRpclogin in interface ConfluenceSoapServiceAuthenticationFailedException
RemoteException
public boolean logout(java.lang.String token)
throws RemoteException
logout in interface SecureRpclogout in interface ConfluenceSoapServiceRemoteException
public RemoteSpaceSummary[] getSpaces(java.lang.String token)
throws InvalidSessionException,
RemoteException
getSpaces in interface ConfluenceSoapServiceInvalidSessionException
RemoteException
public RemoteSpaceSummary[] getSpacesInGroup(java.lang.String token,
java.lang.String spaceGroupKey)
throws RemoteException
getSpacesInGroup in interface ConfluenceSoapServiceRemoteException
public RemoteSpace addSpace(java.lang.String token,
RemoteSpace space)
throws NotPermittedException,
InvalidSessionException,
AlreadyExistsException,
RemoteException
addSpace in interface ConfluenceSoapServiceNotPermittedException
InvalidSessionException
AlreadyExistsException
RemoteException
public RemoteSpace storeSpace(java.lang.String token,
RemoteSpace remoteSpace)
throws RemoteException
ConfluenceSoapService
storeSpace in interface ConfluenceSoapServiceRemoteException
public RemoteSpaceGroup addSpaceGroup(java.lang.String token,
RemoteSpaceGroup spaceGroup)
throws NotPermittedException,
InvalidSessionException,
AlreadyExistsException,
RemoteException
ConfluenceSoapService
addSpaceGroup in interface ConfluenceSoapServicetoken - the authentication tokenspaceGroup - the spacegroup to add
NotPermittedException - if the user lacks permissions to perform the action
InvalidSessionException
AlreadyExistsException - if a group with the same key already exists
RemoteException
public RemoteSpaceGroup getSpaceGroup(java.lang.String token,
java.lang.String spaceGroup)
throws NotPermittedException,
InvalidSessionException,
AlreadyExistsException,
RemoteException
getSpaceGroup in interface ConfluenceSoapServiceNotPermittedException
InvalidSessionException
AlreadyExistsException
RemoteException
public RemoteSpaceGroup[] getSpaceGroups(java.lang.String token)
throws InvalidSessionException,
RemoteException
getSpaceGroups in interface ConfluenceSoapServiceInvalidSessionException
RemoteException
public boolean removeSpaceGroup(java.lang.String token,
java.lang.String spaceGroupKey)
throws RemoteException
ConfluenceSoapService
removeSpaceGroup in interface ConfluenceSoapServicetoken - the authentication tokenspaceGroupKey - the id of the spacegroup to be removed
RemoteException
public RemoteSpace addPersonalSpace(java.lang.String token,
RemoteSpace space,
java.lang.String username)
throws NotPermittedException,
InvalidSessionException,
AlreadyExistsException,
RemoteException
addPersonalSpace in interface ConfluenceSoapServiceNotPermittedException
InvalidSessionException
AlreadyExistsException
RemoteException
public boolean convertToPersonalSpace(java.lang.String token,
java.lang.String userName,
java.lang.String spaceKey,
java.lang.String newName,
boolean updateLinks)
throws RemoteException
convertToPersonalSpace in interface ConfluenceSoapServiceRemoteException
public java.lang.Boolean removeSpace(java.lang.String token,
java.lang.String spaceKey)
throws NotPermittedException,
InvalidSessionException,
RemoteException
removeSpace in interface ConfluenceSoapServiceNotPermittedException
InvalidSessionException
RemoteException
public RemoteSpace getSpace(java.lang.String token,
java.lang.String spaceKey)
throws InvalidSessionException,
RemoteException
getSpace in interface ConfluenceSoapServiceInvalidSessionException
RemoteException
public java.lang.String[] getPermissions(java.lang.String token,
java.lang.String spaceKey)
throws InvalidSessionException,
RemoteException
getPermissions in interface ConfluenceSoapServiceInvalidSessionException
RemoteException
public java.lang.String[] getPermissionsForUser(java.lang.String token,
java.lang.String spaceKey,
java.lang.String userName)
throws InvalidSessionException,
RemoteException
getPermissionsForUser in interface ConfluenceSoapServiceInvalidSessionException
RemoteException
public boolean addPermissionToSpace(java.lang.String token,
java.lang.String permission,
java.lang.String remoteEntityName,
java.lang.String spaceKey)
throws RemoteException
ConfluenceSoapService
addPermissionToSpace in interface ConfluenceSoapServicetoken - the authentication tokenpermission - the Space Permission to addremoteEntityName - the name of the user or groupspaceKey - the key of the Space affected by this action
RemoteException - if the Space Permission is null
NotPermittedException - if the user lacks permissions to perform the action
public boolean addPermissionsToSpace(java.lang.String token,
java.lang.String[] permissions,
java.lang.String remoteEntityName,
java.lang.String spaceKey)
throws RemoteException
ConfluenceSoapService
addPermissionsToSpace in interface ConfluenceSoapServicetoken - the authentication tokenpermissions - the Space Permissions to addremoteEntityName - the name of the user or groupspaceKey - the key of the Space affected by this action
RemoteException - if the Space Permissions array is null
NotPermittedException - if the user lacks permissions to perform the action
public boolean removePermissionFromSpace(java.lang.String token,
java.lang.String permission,
java.lang.String remoteEntityName,
java.lang.String spaceKey)
throws NotPermittedException,
RemoteException
ConfluenceSoapService
removePermissionFromSpace in interface ConfluenceSoapServicetoken - the authentication tokenpermission - the Space Permission to removeremoteEntityName - the name of the user or groupspaceKey - the key of the Space affected by this action
NotPermittedException - if the user lacks permissions to perform the action
RemoteException - if the Space does not exist
public boolean addAnonymousPermissionToSpace(java.lang.String token,
java.lang.String permission,
java.lang.String spaceKey)
throws RemoteException
ConfluenceSoapService
addAnonymousPermissionToSpace in interface ConfluenceSoapServicetoken - the authentication tokenpermission - the Space Permission to addspaceKey - the key of the Space affected by this action
RemoteException - if the Space Permission is null
NotPermittedException - if the user lacks permissions to perform the action
public boolean addAnonymousPermissionsToSpace(java.lang.String token,
java.lang.String[] permissions,
java.lang.String spaceKey)
throws RemoteException
ConfluenceSoapService
addAnonymousPermissionsToSpace in interface ConfluenceSoapServicetoken - the authentication tokenpermissions - the Space Permissions to addspaceKey - the key of the Space affected by this action
RemoteException - if the Space Permissions array is null
NotPermittedException - if the user lacks permissions to perform the action
public boolean removeAnonymousPermissionFromSpace(java.lang.String token,
java.lang.String permission,
java.lang.String spaceKey)
throws NotPermittedException,
RemoteException
ConfluenceSoapService
removeAnonymousPermissionFromSpace in interface ConfluenceSoapServicetoken - the authentication tokenpermission - the Space Permission to removespaceKey - the key of the Space affected by this action
NotPermittedException - if the user lacks permissions to perform the action
RemoteException - if the Space does not exist
public java.lang.String[] getSpaceLevelPermissions(java.lang.String token)
throws RemoteException
getSpaceLevelPermissions in interface ConfluenceSoapServiceRemoteExceptionpublic RemotePageSummary[] getPages(java.lang.String&