com.atlassian.confluence.rpc.soap
Class ConfluenceSoapServiceImpl

java.lang.Object
  com.atlassian.confluence.rpc.soap.ConfluenceSoapServiceImpl

All Implemented Interfaces:

SecureRpc, ConfluenceSoapService

public class ConfluenceSoapServiceImpl
extends java.lang.Object
implements ConfluenceSoapService

Field Summary

static java.util.List	ADMINISTER_PERMISSION_TYPES
static java.util.List	EXPORT_SPACE_PERMISSION_TYPES
static java.util.List	MODIFY_SPACE_PERMISSION_TYPES
static java.util.List	REMOVE_PAGE_PERMISSION_TYPES
static java.util.List	SPACE_ADMIN_PERMISSION_TYPES
static java.util.List	VIEW_SPACE_PERMISSION_TYPES

Fields inherited from interface com.atlassian.confluence.rpc.soap.ConfluenceSoapService

ADMIN_SPACE_PERMISSION, COMMENT_PERMISSION, MODIFY_PERMISSION, VIEW_PERMISSION

Constructor Summary

ConfluenceSoapServiceImpl()

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)
boolean	addAnonymousViewUserProfilePermission(java.lang.String token) This permission can only be set if the anonymous user already has 'use' permission.
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)
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 contentId, java.lang.String fileName, int version) Retrieve information about an attachment.
byte[]	getAttachmentData(java.lang.String token, long contentId, 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 spaceGroupKey)
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	installPlugin(java.lang.String token, java.lang.String pluginFileName, byte[] pluginData) Installs a plugin.
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) Remove anonymous use permission.
boolean	removeAnonymousViewUserProfilePermission(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.
void	setAdminSoapService(AdminSoapService adminSoapService)
void	setAttachmentsSoapService(AttachmentsSoapService attachmentsService)
void	setBlogsSoapService(BlogsSoapService blogsService)
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	setGlobalSoapService(AdminSoapService adminSoapService)
void	setLabelsSoapService(LabelsSoapService labelsSoapService)
void	setPagesSoapService(PagesSoapService pagesService)
void	setSpacesSoapService(SpacesSoapService spacesService)
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
void	setUsersSoapService(UsersSoapService usersService)
RemoteBlogEntry	storeBlogEntry(java.lang.String token, RemoteBlogEntry remoteBlogEntry)
RemotePage	storePage(java.lang.String token, RemotePage rpage)
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

Field Detail

VIEW_SPACE_PERMISSION_TYPES

public static final java.util.List VIEW_SPACE_PERMISSION_TYPES

MODIFY_SPACE_PERMISSION_TYPES

public static final java.util.List MODIFY_SPACE_PERMISSION_TYPES

ADMINISTER_PERMISSION_TYPES

public static final java.util.List ADMINISTER_PERMISSION_TYPES

SPACE_ADMIN_PERMISSION_TYPES

public static final java.util.List SPACE_ADMIN_PERMISSION_TYPES

REMOVE_PAGE_PERMISSION_TYPES

public static final java.util.List REMOVE_PAGE_PERMISSION_TYPES

EXPORT_SPACE_PERMISSION_TYPES

public static final java.util.List EXPORT_SPACE_PERMISSION_TYPES

Constructor Detail

ConfluenceSoapServiceImpl

public ConfluenceSoapServiceImpl()

Method Detail

setSpacesSoapService

public void setSpacesSoapService(SpacesSoapService spacesService)

setPagesSoapService

public void setPagesSoapService(PagesSoapService pagesService)

setUsersSoapService

public void setUsersSoapService(UsersSoapService usersService)

setBlogsSoapService

public void setBlogsSoapService(BlogsSoapService blogsService)

setGlobalSoapService

public void setGlobalSoapService(AdminSoapService adminSoapService)

setAdminSoapService

public void setAdminSoapService(AdminSoapService adminSoapService)

setLabelsSoapService

public void setLabelsSoapService(LabelsSoapService labelsSoapService)

setAttachmentsSoapService

public void setAttachmentsSoapService(AttachmentsSoapService attachmentsService)

login

public java.lang.String login(java.lang.String username,
                              java.lang.String password)
                       throws RemoteException

Specified by:

login in interface SecureRpc

Specified by:

login in interface ConfluenceSoapService

Throws:

RemoteException

logout

public boolean logout(java.lang.String token)

Specified by:

logout in interface SecureRpc

Specified by:

logout in interface ConfluenceSoapService

getSpaces

public RemoteSpaceSummary[] getSpaces(java.lang.String token)
                               throws RemoteException

Specified by:

getSpaces in interface ConfluenceSoapService

Throws:

RemoteException

getSpacesInGroup

public RemoteSpaceSummary[] getSpacesInGroup(java.lang.String token,
                                             java.lang.String spaceGroupKey)
                                      throws RemoteException

Specified by:

getSpacesInGroup in interface ConfluenceSoapService

Throws:

RemoteException

addSpace

public RemoteSpace addSpace(java.lang.String token,
                            RemoteSpace space)
                     throws RemoteException

Specified by:

addSpace in interface ConfluenceSoapService

Throws:

RemoteException

storeSpace

public RemoteSpace storeSpace(java.lang.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 interface ConfluenceSoapService

Returns:

Throws:

RemoteException

addSpaceGroup

public RemoteSpaceGroup addSpaceGroup(java.lang.String token,
                                      RemoteSpaceGroup spaceGroup)
                               throws NotPermittedException,
                                      InvalidSessionException,
                                      AlreadyExistsException,
                                      RemoteException

Description copied from interface: ConfluenceSoapService

Add a space Group to Confluence

Specified by:

addSpaceGroup in interface ConfluenceSoapService

Parameters:

token - the authentication token

spaceGroup - the spacegroup to add

Returns:

Throws:

NotPermittedException - if the user lacks permissions to perform the action

InvalidSessionException

AlreadyExistsException - if a group with the same key already exists

RemoteException

getSpaceGroup

public RemoteSpaceGroup getSpaceGroup(java.lang.String token,
                                      java.lang.String spaceGroupKey)
                               throws NotPermittedException,
                                      InvalidSessionException,
                                      AlreadyExistsException,
                                      RemoteException

Specified by:

getSpaceGroup in interface ConfluenceSoapService

Throws:

NotPermittedException

InvalidSessionException

AlreadyExistsException

RemoteException

getSpaceGroups

public RemoteSpaceGroup[] getSpaceGroups(java.lang.String token)
                                  throws InvalidSessionException,
                                         RemoteException

Specified by:

getSpaceGroups in interface ConfluenceSoapService

Throws:

InvalidSessionException

RemoteException

removeSpaceGroup

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

Description copied from interface: ConfluenceSoapService

Removes a Space Group from Confluence without removeing the space it contains. Currently requires global administration rights

Specified by:

removeSpaceGroup in interface ConfluenceSoapService

Parameters:

token - the authentication token

spaceGroupKey - the id of the spacegroup to be removed

Returns:

Throws:

RemoteException

addPersonalSpace

public RemoteSpace addPersonalSpace(java.lang.String token,
                                    RemoteSpace space,
                                    java.lang.String username)
                             throws RemoteException

Specified by:

addPersonalSpace in interface ConfluenceSoapService

Throws:

RemoteException

convertToPersonalSpace

public boolean convertToPersonalSpace(java.lang.String token,
                                      java.lang.String userName,
                                      java.lang.String spaceKey,
                                      java.lang.String newName,
                                      boolean updateLinks)
                               throws RemoteException

Specified by:

convertToPersonalSpace in interface ConfluenceSoapService

Throws:

RemoteException

removeSpace

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

Specified by:

removeSpace in interface ConfluenceSoapService

Throws:

RemoteException

getSpace

public RemoteSpace getSpace(java.lang.String token,
                            java.lang.String spaceKey)
                     throws RemoteException

Specified by:

getSpace in interface ConfluenceSoapService

Throws:

RemoteException

getPermissions

public java.lang.String[] getPermissions(java.lang.String token,
                                         java.lang.String spaceKey)
                                  throws RemoteException

Specified by:

getPermissions in interface ConfluenceSoapService

Throws:

RemoteException

getPermissionsForUser

public java.lang.String[] getPermissionsForUser(java.lang.String token,
                                                java.lang.String spaceKey,
                                                java.lang.String userName)
                                         throws InvalidSessionException,
                                                RemoteException

Specified by:

getPermissionsForUser in interface ConfluenceSoapService

Throws:

InvalidSessionException

RemoteException

addPermissionToSpace

public boolean addPermissionToSpace(java.lang.String token,
                                    java.lang.String permission,
                                    java.lang.String remoteEntityName,
                                    java.lang.String spaceKey)
                             throws RemoteException

Description copied from interface: ConfluenceSoapService

Add a Space Permission for a user or group

Specified by:

addPermissionToSpace in interface ConfluenceSoapService

Parameters:

token - the authentication token

permission - the Space Permission to add

remoteEntityName - the name of the user or group

spaceKey - the key of the Space affected by this action

Returns:

True if successful, false otherwise

Throws:

RemoteException - if the Space Permission is null

NotPermittedException - if the user lacks permissions to perform the action

addPermissionsToSpace

public boolean addPermissionsToSpace(java.lang.String token,
                                     java.lang.String[] permissions,
                                     java.lang.String remoteEntityName,
                                     java.lang.String spaceKey)
                              throws RemoteException

Description copied from interface: ConfluenceSoapService

Add Space Permissions for a user or group

Specified by:

addPermissionsToSpace in interface ConfluenceSoapService

Parameters:

token - the authentication token

permissions - the Space Permissions to add

remoteEntityName - the name of the user or group

spaceKey - the key of the Space affected by this action

Returns:

True if successful, false otherwise

Throws:

RemoteException - if the Space Permissions array is null

NotPermittedException - if the user lacks permissions to perform the action

removePermissionFromSpace

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

Description copied from interface: ConfluenceSoapService

Removes a Space Permission for a user or group

Specified by:

removePermissionFromSpace in interface ConfluenceSoapService

Parameters:

token - the authentication token

permission - the Space Permission to remove

remoteEntityName - the name of the user or group

spaceKey - 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 action

RemoteException - if the Space does not exist

addGlobalPermission

public boolean addGlobalPermission(java.lang.String token,
                                   java.lang.String permission,
                                   java.lang.String remoteEntityName)
                            throws NotPermittedException,
                                   RemoteException

Description copied from interface: ConfluenceSoapService

Add global permissions for a user or group

Specified by:

addGlobalPermission in interface ConfluenceSoapService

Parameters:

token - the login token

permission - the Space Permission to add

remoteEntityName - the name of the user or group

Returns:

True if successful, false otherwise

Throws:

NotPermittedException - if the user lacks permissions to perform the action

RemoteException

addGlobalPermissions

public boolean addGlobalPermissions(java.lang.String token,
                                    java.lang.String[] permissions,
                                    java.lang.String remoteEntityName)
                             throws NotPermittedException,
                                    RemoteException

Description copied from interface: ConfluenceSoapService

Add a global permission for a user or group

Specified by:

addGlobalPermissions in interface ConfluenceSoapService

Parameters:

token - the login token

permissions - Array of permissions to add

remoteEntityName - the name of the user or group

Returns:

True if successful, false otherwise

Throws:

NotPermittedException - if the user lacks permissions to perform the action

RemoteException

removeGlobalPermission

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

Description copied from interface: ConfluenceSoapService

Remove a global permission

Specified by:

removeGlobalPermission in interface ConfluenceSoapService

Parameters:

token - the login token

permission - the Space Permission to add

remoteEntityName - the name of the user or group

Returns:

True if successful, false otherwise

Throws:

NotPermittedException - if the user lacks permissions to perform the action

RemoteException

addAnonymousUsePermission

public boolean addAnonymousUsePermission(java.lang.String token)
                                  throws RemoteException

Specified by:

addAnonymousUsePermission in interface ConfluenceSoapService

Throws:

RemoteException

removeAnonymousUsePermission

public boolean removeAnonymousUsePermission(java.lang.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 interface ConfluenceSoapService

Parameters:

token - the login token

Returns:

true if successful, false otherwise.

Throws:

RemoteException

addAnonymousViewUserProfilePermission

public boolean addAnonymousViewUserProfilePermission(java.lang.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 interface ConfluenceSoapService

Parameters:

token - the login token

Returns:

true if successfully set; otherwise false.

Throws:

RemoteException

removeAnonymousViewUserProfilePermission

public boolean removeAnonymousViewUserProfilePermission(java.lang.String token)
                                                 throws RemoteException

Specified by:

removeAnonymousViewUserProfilePermission in interface ConfluenceSoapService

Throws:

RemoteException

addAnonymousPermissionToSpace

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

Description copied from interface: ConfluenceSoapService

Add a Space Permission for anonymous users

Specified by:

addAnonymousPermissionToSpace in interface ConfluenceSoapService

Parameters:

token - the authentication token

permission - the Space Permission to add

spaceKey - the key of the Space affected by this action

Returns:

True if successful, false otherwise

Throws:

RemoteException - if the Space Permission is null

NotPermittedException - if the user lacks permissions to perform the action

addAnonymousPermissionsToSpace

public boolean addAnonymousPermissionsToSpace(java.lang.String token,
                                              java.lang.String[] permissions,
                                              java.lang.String spaceKey)
                                       throws RemoteException

Description copied from interface: ConfluenceSoapService

Add Space Permissions for anonymous users

Specified by:

addAnonymousPermissionsToSpace in interface ConfluenceSoapService

Parameters:

token - the authentication token

permissions - the Space Permissions to add

spaceKey - the key of the Space affected by this action

Returns:

True if successful, false otherwise

Throws:

RemoteException - if the Space Permissions array is null

NotPermittedException - if the user lacks permissions to perform the action

removeAnonymousPermissionFromSpace

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

Description copied from interface: ConfluenceSoapService

Removes a Space Permission for anonymous users

Specified by:

removeAnonymousPermissionFromSpace in interface ConfluenceSoapService

Parameters:

token - the authentication token

permission - the Space Permission to remove

spaceKey - 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 action

RemoteException - if the Space does not exist

getSpaceLevelPermissions

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

Specified by:

getSpaceLevelPermissions in interface ConfluenceSoapService

Throws:

RemoteException

getPages

public RemotePageSummary[] getPages(java.lang.String token,
                                    java.lang.String spaceKey)
                             throws 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 interface ConfluenceSoapService

Parameters:

token - the authentication token

spaceKey - the key of the space which pages are to be returned

Throws:

RemoteException

getPage

public RemotePage getPage(java.lang.String token,
                          java.lang.String spaceKey,
                          java.lang.String pageTitle)
                   throws InvalidSessionException,
                          RemoteException

Specified by:

getPage in interface ConfluenceSoapService

Throws:

InvalidSessionException

RemoteException

getPage

public RemotePage getPage(java.lang.String token,
                          long pageId)
                   throws RemoteException

Specified by:

getPage in interface ConfluenceSoapService

Throws:

RemoteException

getComments

public RemoteComment[] getComments(java.lang.String token,
                                   long pageId)
                            throws RemoteException

Description copied from interface: ConfluenceSoapService

Retrieves the comments for a given abstract page

Specified by:

getComments in interface ConfluenceSoapService

Parameters:

token - the authentication token

pageId - 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(java.lang.String token,
                                long commentId)
                         throws InvalidSessionException,
                                RemoteException

Description copied from interface: ConfluenceSoapService

Retrieves a comment with the given ID

Specified by:

getComment in interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

commentId - 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

addComment

public RemoteComment addComment(java.lang.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 interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

comment - The RemoteComment object containing the comment information

Returns:

RemoteComment object

Throws:

InvalidSessionException

NotPermittedException - if the user is unable to post the comment

RemoteException - 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(java.lang.String token,
                                 RemoteComment comment)
                          throws InvalidSessionException,
                                 NotPermittedException,
                                 RemoteException

Description copied from interface: ConfluenceSoapService

Updates a comment

Specified by:

editComment in interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

comment - The RemoteComment object containing the comment information

Returns:

RemoteComment object

Throws:

InvalidSessionException

NotPermittedException - if the user is unable to edit the comment

RemoteException - 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(java.lang.String token,
                             long commentId)
                      throws InvalidSessionException,
                             NotPermittedException,
                             RemoteException

Description copied from interface: ConfluenceSoapService

Removes a comment with the given ID

Specified by:

removeComment in interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

commentId - 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 comment

RemoteException - if the user does not have permission to view the page the comment is on, or it does not exist

getTopLevelPages

public RemotePageSummary[] getTopLevelPages(java.lang.String token,
                                            java.lang.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 interface ConfluenceSoapService

Parameters:

token - the authentication token

spaceKey - the key of the space which pages are to be returned

Throws:

RemoteException

getAncestors

public RemotePageSummary[] getAncestors(java.lang.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 interface ConfluenceSoapService

Parameters:

token - the authentication token

pageId - the id of the page which child pages are to be returned

Throws:

InvalidSessionException

RemoteException

getChildren

public RemotePageSummary[] getChildren(java.lang.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 interface ConfluenceSoapService

Parameters:

token - the authentication token

pageId - the id of the page which child pages are to be returned

Throws:

InvalidSessionException

RemoteException

getDescendents

public RemotePageSummary[] getDescendents(java.lang.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 interface ConfluenceSoapService

Parameters:

token - the authentication token

pageId - the id of the page which child pages are to be returned

Throws:

InvalidSessionException

RemoteException

getAttachments

public RemoteAttachment[] getAttachments(java.lang.String token,
                                         long pageId)
                                  throws RemoteException

Specified by:

getAttachments in interface ConfluenceSoapService

Throws:

RemoteException

getPageHistory

public RemotePageHistory[] getPageHistory(java.lang.String token,
                                          long pageId)
                                   throws RemoteException

Specified by:

getPageHistory in interface ConfluenceSoapService

Throws:

RemoteException

search

public RemoteSearchResult[] search(java.lang.String token,
                                   java.lang.String query,
                                   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. Too large a value will result in this call taking a long time.

Specified by:

search in interface ConfluenceSoapService

Parameters:

token - the authentication token

query - the query term for the search

maxResults - the maximum number of results to be returned.

Returns:

an array of RemoteSearchResults. If there are no results then an empty array will be returned.

Throws:

RemoteException

search

public RemoteSearchResult[] search(java.lang.String token,
                                   java.lang.String query,
                                   java.util.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. See the Bonnie documentation for com.atlassian.bonnie.search.SinceDateQueryFactory for a list of understood representations.

Specified by:

search in interface ConfluenceSoapService

Parameters:

token - the authentication token

query - the query term for the search

params - a Map providing criteria to the search.

maxResults - the maximum number of results to be returned.

Returns:

an array of RemoteSearchResults. If there are no results then an empty array will be returned.

Throws:

RemoteException

getBlogEntryByDayAndTitle

public RemoteBlogEntry getBlogEntryByDayAndTitle(java.lang.String token,
                                                 java.lang.String spaceKey,
                                                 int dayOfMonth,
                                                 java.lang.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 interface ConfluenceSoapService

Parameters:

token - the authentication token

spaceKey - the key of the Space the blog post belongs to

dayOfMonth - the day of the month the blog post was made

postTitle - 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

renderContent

public java.lang.String renderContent(java.lang.String token,
                                      java.lang.String spaceKey,
                                      long pageId,
                                      java.lang.String newContent)
                               throws RemoteException

Specified by:

renderContent in interface ConfluenceSoapService

Throws:

RemoteException

renderContent

public java.lang.String renderContent(java.lang.String token,
                                      java.lang.String spaceKey,
                                      long pageId,
                                      java.lang.String newContent,
                                      java.util.Map renderParameters)
                               throws RemoteException

Specified by:

renderContent in interface ConfluenceSoapService

Throws:

RemoteException

addAttachment

public RemoteAttachment addAttachment(java.lang.String token,
                                      RemoteAttachment attachment,
                                      byte[] attachmentData)
                               throws RemoteException

Specified by:

addAttachment in interface ConfluenceSoapService

Throws:

RemoteException

addAttachment

public RemoteAttachment addAttachment(java.lang.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 interface ConfluenceSoapService

Parameters:

token - the authentication token

contentId - the id of the ContentEntityObject to receive the new attachment.

attachment - RemoteAttachment object containing attachment information

attachmentData - a byte[] continaing the contents of the attachment.

Returns:

the newly created attachment

Throws:

RemoteException

getAttachment

public RemoteAttachment getAttachment(java.lang.String token,
                                      long contentId,
                                      java.lang.String fileName,
                                      int version)
                               throws RemoteException

Description copied from interface: ConfluenceSoapService

Retrieve information about an attachment.

Specified by:

getAttachment in interface ConfluenceSoapService

Parameters:

token - the authentication token.

contentId - the id of the ContentEntityObject the attachemt belongs to.

fileName - the name of the attachment.

version - the version number of the attachment.

Returns:

the attachment

Throws:

RemoteException

getAttachmentData

public byte[] getAttachmentData(java.lang.String token,
                                long contentId,
                                java.lang.String fileName,
                                int version)
                         throws RemoteException

Description copied from interface: ConfluenceSoapService

Retrieve the contents of an attachment.

Specified by:

getAttachmentData in interface ConfluenceSoapService

Parameters:

token - the authentication token.

contentId - the id of the ContentEntityObject the attachemt belongs to.

fileName - the name of the attachment.

version - the version number of the attachment.

Returns:

the attachment's data

Throws:

RemoteException

removeAttachment

public boolean removeAttachment(java.lang.String token,
                                long contentId,
                                java.lang.String fileName)
                         throws RemoteException

Description copied from interface: ConfluenceSoapService

Remove an attachment.

Specified by:

removeAttachment in interface ConfluenceSoapService

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(java.lang.String token,
                              long originalContentId,
                              java.lang.String originalFileName,
                              long newContentId,
                              java.lang.String newFileName)
                       throws RemoteException

Description copied from interface: ConfluenceSoapService

Move or rename an attachment

Specified by:

moveAttachment in interface ConfluenceSoapService

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

movePageToTopLevel

public java.lang.Boolean movePageToTopLevel(java.lang.String token,
                                            long pageId,
                                            java.lang.String targetSpaceKey)
                                     throws RemoteException

Specified by:

movePageToTopLevel in interface ConfluenceSoapService

Throws:

RemoteException

movePage

public java.lang.Boolean movePage(java.lang.String token,
                                  long sourcePageId,
                                  long targetPageId,
                                  java.lang.String position)
                           throws RemoteException

Specified by:

movePage in interface ConfluenceSoapService

Throws:

RemoteException

removePage

public java.lang.Boolean removePage(java.lang.String token,
                                    long pageId)
                             throws RemoteException

Specified by:

removePage in interface ConfluenceSoapService

Throws:

RemoteException

storePage

public RemotePage storePage(java.lang.String token,
                            RemotePage rpage)
                     throws RemoteException

Specified by:

storePage in interface ConfluenceSoapService

Throws:

RemoteException

updatePage

public RemotePage updatePage(java.lang.String token,
                             RemotePage page,
                             RemotePageUpdateOptions options)
                      throws VersionMismatchException,
                             NotPermittedException,
                             InvalidSessionException,
                             RemoteException

Specified by:

updatePage in interface ConfluenceSoapService

Throws:

VersionMismatchException

NotPermittedException

InvalidSessionException

RemoteException

getPagePermissions

public RemotePermission[] getPagePermissions(java.lang.String token,
                                             long pageId)
                                      throws RemoteException

Specified by:

getPagePermissions in interface ConfluenceSoapService

Throws:

RemoteException

getBlogEntry

public RemoteBlogEntry getBlogEntry(java.lang.String token,
                                    long entryId)
                             throws RemoteException

Specified by:

getBlogEntry in interface ConfluenceSoapService

Throws:

RemoteException

getBlogEntries

public RemoteBlogEntrySummary[] getBlogEntries(java.lang.String token,
                                               java.lang.String spaceKey)
                                        throws RemoteException

Specified by:

getBlogEntries in interface ConfluenceSoapService

Throws:

RemoteException

storeBlogEntry

public RemoteBlogEntry storeBlogEntry(java.lang.String token,
                                      RemoteBlogEntry remoteBlogEntry)
                               throws RemoteException

Specified by:

storeBlogEntry in interface ConfluenceSoapService

Throws:

RemoteException

getGroups

public java.lang.String[] getGroups(java.lang.String token)
                             throws RemoteException

Description copied from interface: ConfluenceSoapService

Retrieves a list of user groups

Specified by:

getGroups in interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

Returns:

An array of group names

Throws:

NotPermittedException - if the current user lacks permission to administer

RemoteException

hasGroup

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

Description copied from interface: ConfluenceSoapService

Determines whether a group exists

Specified by:

hasGroup in interface ConfluenceSoapService

Parameters:

token - the token identifying the current user

groupname - the group to look up

Returns:

True if the user exists, false otherwise

Throws:

InvalidSessionException

RemoteException

addGroup

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

Description copied from interface: ConfluenceSoapService

Adds a new group

Specified by:

addGroup in interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

groupname - 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 administer

InvalidSessionException

RemoteException

removeGroup

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

Description copied from interface: ConfluenceSoapService

Removes an existing group

If a valid defaultGroupName is specified, users will be added to the new group (defaultGroupName).

Specified by:

removeGroup in interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

groupname - The name of the group to be removed

defaultGroupName - 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 administer

InvalidSessionException

RemoteException - if the given groupname does not exist

removeAllPermissionsForGroup

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

Description copied from interface: ConfluenceSoapService

Deletes all global and space permissions for the given group

Specified by:

removeAllPermissionsForGroup in interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

groupname - The group to delete permissions for

Returns:

True if successful, false otherwise.

Throws:

NotPermittedException - if the current user lacks permission to administer

RemoteException - if the given groupname does not exist

getUserGroups

public java.lang.String[] getUserGroups(java.lang.String token,
                                        java.lang.String username)
                                 throws RemoteException

Description copied from interface: ConfluenceSoapService

Retrieves the groups that a given user belongs to

Specified by:

getUserGroups in interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

username - The username to retrieve groups for

Returns:

An array of group names as Strings

Throws:

NotPermittedException - if the current user lacks permission to administer

InvalidSessionException

RemoteException - if the given username does not exist

addUserToGroup

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

Specified by:

addUserToGroup in interface ConfluenceSoapService

Returns:

True if successful, false otherwise

Throws:

NotPermittedException - if the current user lacks permission to administer

InvalidSessionException

RemoteException - if the given username does not exist

removeUserFromGroup

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

Description copied from interface: ConfluenceSoapService

Removes the given user from a group

Specified by:

removeUserFromGroup in interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

username - The username to remove from a group

groupname - 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 administer

InvalidSessionException

RemoteException - if the given username does not exist

getUser

public RemoteUser getUser(java.lang.String token,
                          java.lang.String username)
                   throws RemoteException

Description copied from interface: ConfluenceSoapService

Retrieves a user with the given username

Specified by:

getUser in interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

username - The username of the user to be retrieved

Returns:

A RemoteUser object, containing the username, full name, email and URL

Throws:

InvalidSessionException

RemoteException - if a user with the given username cannot be found

hasUser

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

Description copied from interface: ConfluenceSoapService

Determines whether a user exists

Specified by:

hasUser in interface ConfluenceSoapService

Parameters:

token - the token identifying the current user

username - the username to look up

Returns:

True if the user exists, false otherwise

Throws:

InvalidSessionException

RemoteException

addUser

public void addUser(java.lang.String token,
                    RemoteUser remoteUser,
                    java.lang.String password)
             throws RemoteException

Description copied from interface: ConfluenceSoapService

Adds a user with the given RemoteUser object and password

Specified by:

addUser in interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

remoteUser - The object containing the user information

password - The password of the user

Throws:

NotPermittedException - if the current user lacks permissions to create new users

InvalidSessionException

RemoteException - if a user with the given username cannot be found

removeUser

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

Description copied from interface: ConfluenceSoapService

Removes a user with the given username

Specified by:

removeUser in interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

username - The username of the user to be removed

Returns:

True if successful, false otherwise

Throws:

InvalidSessionException

NotPermittedException - if the current user lacks the permission to remove users

RemoteException - if the given username cannot be found

editUser

public boolean editUser(java.lang.String token,
                        RemoteUser remoteUser)
                 throws NotPermittedException,
                        InvalidSessionException,
                        RemoteException

Description copied from interface: ConfluenceSoapService

Edits a user with the values in the given RemoteUser object

Currently this will only update the user's full name and email

Specified by:

editUser in interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

remoteUser - The object containing the user information

Throws:

NotPermittedException - if the current user cannot administer users or is not the actual user

InvalidSessionException

RemoteException - if a user with the given username cannot be found

deactivateUser

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

Description copied from interface: ConfluenceSoapService

Deactivates the given user

Specified by:

deactivateUser in interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

username - 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 action

InvalidSessionException

RemoteException - if the given username cannot be found

reactivateUser

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

Description copied from interface: ConfluenceSoapService

Reactivates the given user

Specified by:

reactivateUser in interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

username - 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 action

InvalidSessionException

RemoteException - if the given username cannot be found

getActiveUsers

public java.lang.String[] getActiveUsers(java.lang.String token,
                                         boolean viewAll)
                                  throws InvalidSessionException,
                                         RemoteException

Description copied from interface: ConfluenceSoapService

Returns a list of the current system users

Specified by:

getActiveUsers in interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

viewAll - Whether all users should be shown. When it is false, all users in the confluence-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 permissions

RemoteException

setUserInformation

public boolean setUserInformation(java.lang.String token,
                                  RemoteUserInformation userInfo)
                           throws NotPermittedException,
                                  InvalidSessionException,
                                  RemoteException

Description copied from interface: ConfluenceSoapService

Updates a user's information

Currently this will only update a user's "description", stored in the 'content' attribute

Specified by:

setUserInformation in interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

userInfo - 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 user

InvalidSessionException

RemoteException - if there was an error saving the personal information

getUserInformation

public RemoteUserInformation getUserInformation(java.lang.String token,
                                                java.lang.String username)
                                         throws InvalidSessionException,
                                                RemoteException

Description copied from interface: ConfluenceSoapService

Retrieves a user's information

Specified by:

getUserInformation in interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

username - 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(java.lang.String token,
                                java.lang.String oldPass,
                                java.lang.String newPass)
                         throws InvalidSessionException,
                                RemoteException

Description copied from interface: ConfluenceSoapService

Change the current user's password

Specified by:

changeMyPassword in interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

oldPass - The old password of the user, required for security purposes

newPass - The new password for the user

Throws:

InvalidSessionException

NotPermittedException - if newPass was incorrect

RemoteException - if oldPass does not match the user's password

changeUserPassword

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

Description copied from interface: ConfluenceSoapService

Change a user's password

Specified by:

changeUserPassword in interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

username - The username of the user we are changing the password for

newPass - The new password for the user

Throws:

NotPermittedException - if the current user does not have permission to administer the user

InvalidSessionException

RemoteException - if the user cannot be found

addProfilePicture

public boolean addProfilePicture(java.lang.String token,
                                 java.lang.String userName,
                                 java.lang.String fileName,
                                 java.lang.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 interface ConfluenceSoapService

userName - The user name of the profile

fileName - File name of the picture

mimeType - 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 profile

InvalidSessionException

RemoteException - if the user can not be found

getServerInfo

public RemoteServerInfo getServerInfo(java.lang.String token)
                               throws RemoteException

Specified by:

getServerInfo in interface ConfluenceSoapService

Throws:

RemoteException

exportSpace

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

Specified by:

exportSpace in interface ConfluenceSoapService

Throws:

RemoteException

exportSpace

public java.lang.String exportSpace(java.lang.String token,
                                    java.lang.String spaceKey,
                                    java.lang.String exportType,
                                    boolean exportAll)
                             throws RemoteException

Specified by:

exportSpace in interface ConfluenceSoapService

Throws:

RemoteException

exportSite

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

Specified by:

exportSite in interface ConfluenceSoapService

Throws:

RemoteException

importSpace

public boolean importSpace(java.lang.String token,
                           byte[] importData)
                    throws RemoteException

Description copied from interface: ConfluenceSoapService

Import a space in a compressed XML format

Specified by:

importSpace in interface ConfluenceSoapService

Parameters:

token - The authentication token

importData - The contents of the Space export file

Returns:

True if successful, otherwise false

Throws:

RemoteException - If the space exists or the export file is invalid

flushIndexQueue

public boolean flushIndexQueue(java.lang.String token)
                        throws RemoteException

Specified by:

flushIndexQueue in interface ConfluenceSoapService

Throws:

RemoteException

clearIndexQueue

public boolean clearIndexQueue(java.lang.String token)
                        throws RemoteException

Specified by:

clearIndexQueue in interface ConfluenceSoapService

Throws:

RemoteException

getClusterInformation

public RemoteClusterInformation getClusterInformation(java.lang.String token)
                                               throws RemoteException

Specified by:

getClusterInformation in interface ConfluenceSoapService

Throws:

RemoteException

getClusterNodeStatuses

public RemoteNodeStatus[] getClusterNodeStatuses(java.lang.String token)
                                          throws RemoteException

Specified by:

getClusterNodeStatuses in interface ConfluenceSoapService

Throws:

RemoteException

getLabelsById

public RemoteLabel[] getLabelsById(java.lang.String token,
                                   long objectId)
                            throws RemoteException

Description copied from interface: ConfluenceSoapService

Returns all labels for the given ContentEntityObject ID.

Specified by:

getLabelsById in interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

objectId - 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 ContentEntityManager

getMostPopularLabels

public RemoteLabel[] getMostPopularLabels(java.lang.String token,
                                          int maxCount)
                                   throws 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 interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

maxCount - 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

getMostPopularLabelsInSpace

public RemoteLabel[] getMostPopularLabelsInSpace(java.lang.String token,
                                                 java.lang.String spaceKey,
                                                 int maxCount)
                                          throws 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 interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

spaceKey - The key of the space to limit the labels to

maxCount - 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 SpaceManager

NotPermittedException - if the given user does not have VIEW permissions for the space

getRecentlyUsedLabels

public RemoteLabel[] getRecentlyUsedLabels(java.lang.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 interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

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 most recent use

Throws:

InvalidSessionException

RemoteException

getRecentlyUsedLabelsInSpace

public RemoteLabel[] getRecentlyUsedLabelsInSpace(java.lang.String token,
                                                  java.lang.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 interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

spaceKey - The key of the space to limit the labels to

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 most recent use

Throws:

RemoteException - if the space does not exist, or the user lacks permission to view it

NotPermittedException - if the given user does not have VIEW permissions for the space

InvalidSessionException

getSpacesWithLabel

public RemoteSpace[] getSpacesWithLabel(java.lang.String token,
                                        java.lang.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 interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

labelName - 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(java.lang.String token,
                                      java.lang.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 interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

labelName - 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 null

InvalidSessionException

getRelatedLabelsInSpace

public RemoteLabel[] getRelatedLabelsInSpace(java.lang.String token,
                                             java.lang.String labelName,
                                             java.lang.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 interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

labelName - The name of the label (namespace prefixes permitted)

spaceKey - The key of the space to limit the labels to

maxResults - 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 null

InvalidSessionException

getLabelsByDetail

public RemoteLabel[] getLabelsByDetail(java.lang.String token,
                                       java.lang.String labelName,
                                       java.lang.String namespace,
                                       java.lang.String spaceKey,
                                       java.lang.String owner)
                                throws InvalidSessionException,
                                       RemoteException,
                                       NotPermittedException

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 interface ConfluenceSoapService

Parameters:

token - the authentication token for the user

labelName - the name of the label to search for (not parsed for prefixes)

namespace - the namespace to restrict by

spaceKey - the key of the space to restrict by

owner - the owner of the labels

Returns:

an array of matching RemoteLabel objects

Throws:

InvalidSessionException

RemoteException - if labelName is an empty string or null

NotPermittedException

See Also:

Namespace

getLabelContentById

public RemoteSearchResult[] getLabelContentById(java.lang.String token,
                                                long labelId)
                                         throws RemoteException

Description copied from interface: ConfluenceSoapService

Returns the content for a given label ID

Specified by:

getLabelContentById in interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

labelId - The ID of the label

Returns:

An array of RemoteSearchResult objects

Throws:

RemoteException - if a Label could not be retrieved for the given ID

getLabelContentByName

public RemoteSearchResult[] getLabelContentByName(java.lang.String token,
                                                  java.lang.String labelName)
                                           throws RemoteException

Description copied from interface: ConfluenceSoapService

Returns the content for a given label name

Specified by:

getLabelContentByName in interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

labelName - The name of a label (namespace prefixes permitted)

Returns:

An array of RemoteSearchResult objects

Throws:

RemoteException - if the label name is null

getLabelContentByObject

public RemoteSearchResult[] getLabelContentByObject(java.lang.String token,
                                                    RemoteLabel labelObject)
                                             throws RemoteException

Description copied from interface: ConfluenceSoapService

Returns the content for a given label object

Specified by:

getLabelContentByObject in interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

labelObject - The RemoteLabel object

Returns:

An array of RemoteSearchResult objects

Throws:

RemoteException - if the RemoteLabel object is null

getSpacesContainingContentWithLabel

public RemoteSpace[] getSpacesContainingContentWithLabel(java.lang.String token,
                                                         java.lang.String labelName)
                                                  throws InvalidSessionException,
                                                         RemoteException

Description copied from interface: ConfluenceSoapService

Returns all Spaces that have content labelled with labelName

Specified by:

getSpacesContainingContentWithLabel in interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

labelName - 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(java.lang.String token,
                              java.lang.String labelName,
                              long objectId)
                       throws NotPermittedException,
                              RemoteException

Description copied from interface: ConfluenceSoapService

Adds a label to the object with the given ContentEntityObject ID.

Specified by:

addLabelByName in interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

labelName - The name of the label(s) to be added to the ContentEntityObject, in the form of a space-separated string

objectId - 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 object

RemoteException - if the label name is null or an empty String

addLabelById

public boolean addLabelById(java.lang.String token,
                            long labelId,
                            long objectId)
                     throws NotPermittedException,
                            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 interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

labelId - The ID of the label to be added to the ContentEntityObject

objectId - 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 object

RemoteException - if a Label could not be retrieved for the given ID

addLabelByObject

public boolean addLabelByObject(java.lang.String token,
                                RemoteLabel labelObject,
                                long objectId)
                         throws NotPermittedException,
                                RemoteException

Description copied from interface: ConfluenceSoapService

Adds the given label object to the object with the given ContentEntityObject ID.

Specified by:

addLabelByObject in interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

labelObject - The label to be added to the ContentEntityObject

objectId - 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 object

RemoteException - if the given RemoteLabel object is null

addLabelByNameToSpace

public boolean addLabelByNameToSpace(java.lang.String token,
                                     java.lang.String labelName,
                                     java.lang.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 interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

labelName - The name of the label(s) to be added to the Space, in the form of a space-separated string

spaceKey - 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 label

RemoteException - if the label name is null or an empty String

InvalidSessionException

removeLabelByName

public boolean removeLabelByName(java.lang.String token,
                                 java.lang.String labelName,
                                 long objectId)
                          throws NotPermittedException,
                                 RemoteException

Description copied from interface: ConfluenceSoapService

Removes the given label from the object with the given ContentEntityObject ID.

Specified by:

removeLabelByName in interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

labelName - The name of the label(s) to be removed from the ContentEntityObject, in the form of a space-separated String

objectId - 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 object

RemoteException - if the label name is null

removeLabelById

public boolean removeLabelById(java.lang.String token,
                               long labelId,
                               long objectId)
                        throws NotPermittedException,
                               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 interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

labelId - The ID of the label to be removed from the ContentEntityObject

objectId - 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 object

RemoteException - if a Label could not be retrieved for the given ID

removeLabelByObject

public boolean removeLabelByObject(java.lang.String token,
                                   RemoteLabel labelObject,
                                   long objectId)
                            throws NotPermittedException,
                                   RemoteException

Description copied from interface: ConfluenceSoapService

Removes the given label object from the object with the given ContentEntityObject ID.

Specified by:

removeLabelByObject in interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

labelObject - The label to be removed from the ContentEntityObject

objectId - 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 object

RemoteException - if the RemoteLabel object is null

removeLabelByNameFromSpace

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

Description copied from interface: ConfluenceSoapService

Removes the given label from the given Space

Specified by:

removeLabelByNameFromSpace in interface ConfluenceSoapService

Parameters:

token - The token identifying the current user

labelName - The name of the label(s) to be removed from the Space, in the form of a space-separated String

spaceKey - The Space the method will act on

Returns:

True if successfully removed, false otherwise.

Throws:

NotPermittedException - if the user lacks EDIT permissions for the Space

RemoteException - if the label name is null

InvalidSessionException

getContentPermissionSets

public RemoteContentPermissionSet[] getContentPermissionSets(java.lang.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 interface ConfluenceSoapService

Parameters:

token - the login token for the current user

contentId - 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 user

InvalidSessionException - if no login session can be found for the supplied token

RemoteException - if something random goes wrong

getContentPermissionSet

public RemoteContentPermissionSet getContentPermissionSet(java.lang.String token,
                                                          long contentId,
                                                          java.lang.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 interface ConfluenceSoapService

Parameters:

token - the login token for the current user

contentId - the content ID of the content to be looked up

permissionType - 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 user

InvalidSessionException - if no login session can be found for the supplied token

RemoteException - if something random goes wrong

setContentPermissions

public boolean setContentPermissions(java.lang.String token,
                                     long contentId,
                                     java.lang.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 interface ConfluenceSoapService

Parameters:

token - the login token

contentId - the id of the content to have permissions set on it

permissionType - the type of the permissions (one of the constants from ContentPermission)

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 user

InvalidSessionException - if no login session can be found for the supplied token

RemoteException - if something random goes wrong

setEnableWysiwyg

public boolean setEnableWysiwyg(java.lang.String token,
                                boolean value)
                         throws RemoteException

Specified by:

setEnableWysiwyg in interface ConfluenceSoapService

Throws:

RemoteException

setEnableAnonymousAccess

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

Specified by:

setEnableAnonymousAccess in interface ConfluenceSoapService

Throws:

RemoteException

isPluginEnabled

public boolean isPluginEnabled(java.lang.String token,
                               java.lang.String pluginKey)

Description copied from interface: ConfluenceSoapService

Returns true if the specified plugin is enabled.

Specified by:

isPluginEnabled in interface ConfluenceSoapService

installPlugin

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

Description copied from interface: ConfluenceSoapService

Installs a plugin.

Specified by:

installPlugin in interface ConfluenceSoapService

pluginFileName - the original filename of the plugin. It should end with the correct file extension .xml or .jar.

pluginData - a byte[] continaing the contents of the plugin xml or jar file.

Throws:

RemoteException