com.atlassian.confluence.rpc.xmlrpc
Class ConfluenceXmlRpcHandlerImpl
java.lang.Object
com.atlassian.confluence.rpc.xmlrpc.ConfluenceXmlRpcHandlerImpl
- All Implemented Interfaces:
- SecureRpc, ConfluenceXmlRpcHandler
public class ConfluenceXmlRpcHandlerImpl
- extends Object
- implements ConfluenceXmlRpcHandler
An implementation of XML RPC that effectively delegates to an underlying SOAP implementation.
Responsible for converting inputs into a form that is suitable for the underyling SOAP API.
Also responsible for converting what is returned by the underlying SOAP API into a form that is appropriate to return to XML RPC clients.
Method Summary |
boolean |
addAnonymousPermissionsToSpace(String token,
Vector permissions,
String spaceKey)
|
boolean |
addAnonymousPermissionToSpace(String token,
String permission,
String spaceKey)
|
boolean |
addAnonymousUsePermission(String token)
|
boolean |
addAnonymousViewUserProfilePermission(String token)
|
Hashtable |
addAttachment(String token,
String contentId,
Hashtable attachment,
byte[] attachmentData)
|
Hashtable |
addComment(String token,
Hashtable comment)
|
boolean |
addGlobalPermission(String token,
String permission,
String remoteEntityName)
|
boolean |
addGlobalPermissions(String token,
Vector permissions,
String remoteEntityName)
|
boolean |
addGroup(String token,
String groupname)
|
boolean |
addLabelById(String token,
String labelId,
String objectId)
|
boolean |
addLabelByName(String token,
String labelName,
String objectId)
|
boolean |
addLabelByNameToSpace(String token,
String labelName,
String spaceKey)
|
boolean |
addLabelByObject(String token,
Hashtable labelObject,
String objectId)
|
boolean |
addPermissionsToSpace(String token,
Vector permissions,
String remoteEntityName,
String spaceKey)
|
boolean |
addPermissionToSpace(String token,
String permission,
String remoteEntityName,
String spaceKey)
|
Hashtable |
addPersonalSpace(String token,
Hashtable space,
String username)
|
boolean |
addProfilePicture(String token,
String userName,
String fileName,
String mimeType,
byte[] pictureData)
|
Hashtable |
addSpace(String token,
Hashtable space)
|
Hashtable |
addSpaceGroup(String token,
Hashtable spaceGroup)
|
boolean |
addUser(String token,
Hashtable remoteUser,
String password)
|
boolean |
addUserToGroup(String token,
String username,
String groupname)
|
boolean |
changeMyPassword(String token,
String oldPass,
String newPass)
|
boolean |
changeUserPassword(String token,
String username,
String newPass)
|
boolean |
clearIndexQueue(String token)
|
String |
convertWikiToStorageFormat(String token,
String wiki)
|
boolean |
deactivateUser(String token,
String username)
|
Hashtable |
editComment(String token,
Hashtable comment)
|
boolean |
editUser(String token,
Hashtable remoteUser)
|
Boolean |
emptyTrash(String token,
String spaceKey)
|
String |
exportSite(String token,
boolean exportAttachments)
|
String |
exportSpace(String token,
String spaceKey,
String exportType)
|
boolean |
flushIndexQueue(String token)
|
Vector |
getActiveUsers(String token,
boolean viewAll)
|
Vector |
getAncestors(String token,
String pageId)
|
Hashtable |
getAttachment(String token,
String contentId,
String fileName,
String version)
|
byte[] |
getAttachmentData(String token,
String contentId,
String fileName,
String version)
|
Vector |
getAttachments(String token,
String pageId)
|
Vector |
getBlogEntries(String token,
String spaceKey)
|
Hashtable |
getBlogEntry(String token,
String blogEntryId)
|
Hashtable |
getBlogEntryByDateAndTitle(String token,
String spaceKey,
int year,
int month,
int dayOfMonth,
String postTitle)
|
Hashtable |
getBlogEntryByDayAndTitle(String token,
String spaceKey,
int dayOfMonth,
String postTitle)
|
Vector |
getChildren(String token,
String pageId)
|
Hashtable |
getClusterInformation(String token)
|
Vector |
getClusterNodeStatuses(String token)
|
Hashtable |
getComment(String token,
String commentId)
|
Vector |
getComments(String token,
String pageId)
|
Vector |
getContentPermissions(String token,
String contentId)
|
Hashtable |
getContentPermissionSet(String token,
String contentId,
String permissionType)
|
Vector |
getContentPermissionSets(String token,
String contentId)
|
Vector |
getDescendents(String token,
String pageId)
|
Vector |
getGroups(String token)
|
Vector |
getLabelContentById(String token,
String labelId)
|
Vector |
getLabelContentByName(String token,
String labelName)
|
Vector |
getLabelContentByObject(String token,
Hashtable labelObject)
|
Vector |
getLabelsByDetail(String token,
String labelName,
String namespace,
String spaceKey,
String owner)
|
Vector |
getLabelsById(String token,
String objectId)
|
Vector |
getMostPopularLabels(String token,
int maxCount)
|
Vector |
getMostPopularLabelsInSpace(String token,
String spaceKey,
int maxCount)
|
Hashtable |
getPage(String token,
String pageId)
|
Hashtable |
getPage(String token,
String spaceKey,
String pageTitle)
|
Vector |
getPageHistory(String token,
String pageId)
|
Vector |
getPagePermissions(String token,
String pageId)
|
Vector |
getPages(String token,
String spaceKey)
|
Hashtable |
getPageSummary(String token,
String pageId)
|
Hashtable |
getPageSummary(String token,
String spaceKey,
String pageTitle)
|
Vector |
getPermissions(String token,
String spaceKey)
|
Vector |
getPermissionsForUser(String token,
String spaceKey,
String userName)
|
Vector |
getRecentlyUsedLabels(String token,
int maxResults)
|
Vector |
getRecentlyUsedLabelsInSpace(String token,
String spaceKey,
int maxResults)
|
Vector |
getRelatedLabels(String token,
String labelName,
int maxResults)
|
Vector |
getRelatedLabelsInSpace(String token,
String labelName,
String spaceKey,
int maxResults)
|
Hashtable |
getServerInfo(String token)
|
Hashtable |
getSpace(String token,
String spaceKey)
|
Hashtable |
getSpaceGroup(String token,
String spaceGroupKey)
|
Vector |
getSpaceGroups(String token)
|
String[] |
getSpaceLevelPermissions(String token)
|
Vector |
getSpaces(String token)
|
Vector |
getSpacesContainingContentWithLabel(String token,
String labelName)
|
Vector |
getSpacesInGroup(String token,
String spaceGroupKey)
|
Vector |
getSpacesWithLabel(String token,
String labelName)
|
Vector |
getTopLevelPages(String token,
String spaceKey)
|
Hashtable |
getTrashContents(String token,
String spaceKey,
int offset,
int maxResults)
|
Hashtable |
getUser(String token,
String username)
|
Vector |
getUserGroups(String token,
String username)
|
Hashtable |
getUserInformation(String token,
String username)
|
boolean |
getUserPreferenceBoolean(String token,
String username,
String key)
|
String |
getUserPreferenceLong(String token,
String username,
String key)
|
String |
getUserPreferenceString(String token,
String username,
String key)
|
Vector |
getWatchersForPage(String token,
String pageId)
|
Vector |
getWatchersForSpace(String token,
String spaceKey)
|
boolean |
hasGroup(String token,
String groupname)
|
boolean |
hasUser(String token,
String username)
|
boolean |
importSpace(String token,
byte[] importData)
Import a space in a compressed XML format |
boolean |
installPlugin(String token,
String pluginFileName,
byte[] pluginData)
|
boolean |
isActiveUser(String token,
String username)
|
boolean |
isPluginEnabled(String token,
String pluginKey)
|
boolean |
isPluginInstalled(String token,
String pluginKey)
|
boolean |
isWatchingPage(String token,
String pageId,
String username)
|
boolean |
isWatchingSpace(String token,
String spaceKey,
String username)
|
boolean |
isWatchingSpaceForType(String token,
String spaceKey,
String contentType,
String username)
|
String |
login(String username,
String password)
|
boolean |
logout(String token)
|
boolean |
moveAttachment(String token,
String originalContentId,
String originalFileName,
String newContentId,
String newFileName)
|
Boolean |
movePage(String token,
String sourcePageId,
String targetPageId,
String position)
|
Boolean |
movePageToTopLevel(String token,
String pageId,
String targetSpaceKey)
|
Boolean |
purgeFromTrash(String token,
String spaceKey,
String pageId)
|
boolean |
reactivateUser(String token,
String username)
|
boolean |
removeAllPermissionsForGroup(String token,
String groupname)
|
boolean |
removeAnonymousPermissionFromSpace(String token,
String permission,
String spaceKey)
|
boolean |
removeAnonymousUsePermission(String token)
|
boolean |
removeAnonymousViewUserProfilePermission(String token)
|
boolean |
removeAttachment(String token,
String contentId,
String fileName)
|
boolean |
removeComment(String token,
String commentId)
|
boolean |
removeGlobalPermission(String token,
String permission,
String remoteEntityName)
|
boolean |
removeGroup(String token,
String groupname,
String defaultGroupName)
|
boolean |
removeLabelById(String token,
String labelId,
String objectId)
|
boolean |
removeLabelByName(String token,
String labelName,
String objectId)
|
boolean |
removeLabelByNameFromSpace(String token,
String labelName,
String spaceKey)
|
boolean |
removeLabelByObject(String token,
Hashtable labelObject,
String objectId)
|
Boolean |
removePage(String token,
String pageId)
|
boolean |
removePageWatch(String token,
String pageId)
|
boolean |
removePageWatchForUser(String token,
String pageId,
String username)
|
boolean |
removePermissionFromSpace(String token,
String permission,
String remoteEntityName,
String spaceKey)
|
Boolean |
removeSpace(String token,
String spaceKey)
|
boolean |
removeSpaceGroup(String token,
String spaceGroupKey)
|
boolean |
removeSpaceWatch(String token,
String spaceKey)
|
boolean |
removeUser(String token,
String username)
|
boolean |
removeUserFromGroup(String token,
String username,
String groupname)
|
String |
renderContent(String token,
String spaceKey,
String pageId,
String newContent)
|
String |
renderContent(String token,
String spaceKey,
String pageId,
String newContent,
Hashtable renderParameters)
|
Vector |
search(String token,
String query,
Hashtable params,
int maxResults)
|
Vector |
search(String token,
String query,
int maxResults)
|
Boolean |
setContentPermissions(String token,
String contentId,
String permissionType,
Vector permissions)
|
boolean |
setEnableAnonymousAccess(String token,
String value)
|
boolean |
setEnableWysiwyg(String token,
String value)
Deprecated. since 4.0. You can no longer disable the wysiwyg editor. |
void |
setSoapServiceDelegator(ConfluenceSoapService soapServiceDelegator)
|
boolean |
setUserInformation(String token,
Hashtable userInfo)
|
boolean |
setUserPreferenceBoolean(String token,
String username,
String key,
boolean value)
|
boolean |
setUserPreferenceLong(String token,
String username,
String key,
String value)
|
boolean |
setUserPreferenceString(String token,
String username,
String key,
String value)
|
Hashtable |
storeBlogEntry(String token,
Hashtable blogEntryStruct)
|
Hashtable |
storePage(String token,
Hashtable pageStruct)
|
Hashtable |
storeSpace(String token,
Hashtable remoteSpace)
|
Hashtable |
updatePage(String token,
Hashtable pageStruct,
Hashtable editOptionsStruct)
|
boolean |
watchPage(String token,
String pageId)
|
boolean |
watchPageForUser(String token,
String pageId,
String username)
|
boolean |
watchSpace(String token,
String spaceKey)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
ConfluenceXmlRpcHandlerImpl
public ConfluenceXmlRpcHandlerImpl()
setSoapServiceDelegator
public void setSoapServiceDelegator(ConfluenceSoapService soapServiceDelegator)
login
public String login(String username,
String password)
throws RemoteException
- Specified by:
login
in interface SecureRpc
- Specified by:
login
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
logout
public boolean logout(String token)
throws RemoteException
- Specified by:
logout
in interface SecureRpc
- Specified by:
logout
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getSpaces
public Vector getSpaces(String token)
throws RemoteException
- Specified by:
getSpaces
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getSpacesInGroup
public Vector getSpacesInGroup(String token,
String spaceGroupKey)
throws RemoteException
- Specified by:
getSpacesInGroup
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getBlogEntries
public Vector getBlogEntries(String token,
String spaceKey)
throws RemoteException
- Specified by:
getBlogEntries
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getBlogEntryByDayAndTitle
public Hashtable getBlogEntryByDayAndTitle(String token,
String spaceKey,
int dayOfMonth,
String postTitle)
throws RemoteException
- Specified by:
getBlogEntryByDayAndTitle
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getBlogEntryByDateAndTitle
public Hashtable getBlogEntryByDateAndTitle(String token,
String spaceKey,
int year,
int month,
int dayOfMonth,
String postTitle)
throws RemoteException
- Specified by:
getBlogEntryByDateAndTitle
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getComments
public Vector getComments(String token,
String pageId)
throws RemoteException
- Specified by:
getComments
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getComment
public Hashtable getComment(String token,
String commentId)
throws InvalidSessionException,
RemoteException
- Specified by:
getComment
in interface ConfluenceXmlRpcHandler
- Throws:
InvalidSessionException
RemoteException
addComment
public Hashtable addComment(String token,
Hashtable comment)
throws InvalidSessionException,
NotPermittedException,
RemoteException
- Specified by:
addComment
in interface ConfluenceXmlRpcHandler
- Throws:
InvalidSessionException
NotPermittedException
RemoteException
editComment
public Hashtable editComment(String token,
Hashtable comment)
throws InvalidSessionException,
NotPermittedException,
RemoteException
- Specified by:
editComment
in interface ConfluenceXmlRpcHandler
- Throws:
InvalidSessionException
NotPermittedException
RemoteException
removeComment
public boolean removeComment(String token,
String commentId)
throws InvalidSessionException,
NotPermittedException,
RemoteException
- Specified by:
removeComment
in interface ConfluenceXmlRpcHandler
- Throws:
InvalidSessionException
NotPermittedException
RemoteException
getTopLevelPages
public Vector getTopLevelPages(String token,
String spaceKey)
throws RemoteException
- Specified by:
getTopLevelPages
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getAncestors
public Vector getAncestors(String token,
String pageId)
throws RemoteException
- Specified by:
getAncestors
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getChildren
public Vector getChildren(String token,
String pageId)
throws RemoteException
- Specified by:
getChildren
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getDescendents
public Vector getDescendents(String token,
String pageId)
throws RemoteException
- Specified by:
getDescendents
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getAttachments
public Vector getAttachments(String token,
String pageId)
throws RemoteException
- Specified by:
getAttachments
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
convertWikiToStorageFormat
public String convertWikiToStorageFormat(String token,
String wiki)
throws RemoteException
- Specified by:
convertWikiToStorageFormat
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
watchPage
public boolean watchPage(String token,
String pageId)
throws RemoteException
- Specified by:
watchPage
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
watchSpace
public boolean watchSpace(String token,
String spaceKey)
throws RemoteException
- Specified by:
watchSpace
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
watchPageForUser
public boolean watchPageForUser(String token,
String pageId,
String username)
throws RemoteException
- Specified by:
watchPageForUser
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
removePageWatch
public boolean removePageWatch(String token,
String pageId)
throws RemoteException
- Specified by:
removePageWatch
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
removeSpaceWatch
public boolean removeSpaceWatch(String token,
String spaceKey)
throws RemoteException
- Specified by:
removeSpaceWatch
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
removePageWatchForUser
public boolean removePageWatchForUser(String token,
String pageId,
String username)
throws RemoteException
- Specified by:
removePageWatchForUser
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
isWatchingPage
public boolean isWatchingPage(String token,
String pageId,
String username)
throws RemoteException
- Specified by:
isWatchingPage
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
isWatchingSpace
public boolean isWatchingSpace(String token,
String spaceKey,
String username)
throws RemoteException
- Specified by:
isWatchingSpace
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
isWatchingSpaceForType
public boolean isWatchingSpaceForType(String token,
String spaceKey,
String contentType,
String username)
throws RemoteException
- Specified by:
isWatchingSpaceForType
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getWatchersForPage
public Vector getWatchersForPage(String token,
String pageId)
throws RemoteException
- Specified by:
getWatchersForPage
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getWatchersForSpace
public Vector getWatchersForSpace(String token,
String spaceKey)
throws RemoteException
- Specified by:
getWatchersForSpace
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getBlogEntry
public Hashtable getBlogEntry(String token,
String blogEntryId)
throws RemoteException
- Specified by:
getBlogEntry
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getPages
public Vector getPages(String token,
String spaceKey)
throws RemoteException
- Specified by:
getPages
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getPage
public Hashtable getPage(String token,
String pageId)
throws RemoteException
- Specified by:
getPage
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getPageSummary
public Hashtable getPageSummary(String token,
String pageId)
throws RemoteException
- Specified by:
getPageSummary
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getPage
public Hashtable getPage(String token,
String spaceKey,
String pageTitle)
throws RemoteException
- Specified by:
getPage
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getPageSummary
public Hashtable getPageSummary(String token,
String spaceKey,
String pageTitle)
throws RemoteException
- Specified by:
getPageSummary
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getContentPermissionSets
public Vector getContentPermissionSets(String token,
String contentId)
throws RemoteException
- Specified by:
getContentPermissionSets
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getContentPermissionSet
public Hashtable getContentPermissionSet(String token,
String contentId,
String permissionType)
throws RemoteException
- Specified by:
getContentPermissionSet
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getContentPermissions
public Vector getContentPermissions(String token,
String contentId)
throws RemoteException
- Specified by:
getContentPermissions
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
setContentPermissions
public Boolean setContentPermissions(String token,
String contentId,
String permissionType,
Vector permissions)
throws RemoteException
- Specified by:
setContentPermissions
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getPageHistory
public Vector getPageHistory(String token,
String pageId)
throws RemoteException
- Specified by:
getPageHistory
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getSpace
public Hashtable getSpace(String token,
String spaceKey)
throws RemoteException
- Specified by:
getSpace
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getPermissions
public Vector getPermissions(String token,
String spaceKey)
throws RemoteException
- Specified by:
getPermissions
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getPermissionsForUser
public Vector getPermissionsForUser(String token,
String spaceKey,
String userName)
throws RemoteException
- Specified by:
getPermissionsForUser
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getPagePermissions
public Vector getPagePermissions(String token,
String pageId)
throws RemoteException
- Specified by:
getPagePermissions
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
renderContent
public String renderContent(String token,
String spaceKey,
String pageId,
String newContent)
throws RemoteException
- Specified by:
renderContent
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
renderContent
public String renderContent(String token,
String spaceKey,
String pageId,
String newContent,
Hashtable renderParameters)
throws RemoteException
- Specified by:
renderContent
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
movePageToTopLevel
public Boolean movePageToTopLevel(String token,
String pageId,
String targetSpaceKey)
throws RemoteException
- Specified by:
movePageToTopLevel
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
movePage
public Boolean movePage(String token,
String sourcePageId,
String targetPageId,
String position)
throws RemoteException
- Specified by:
movePage
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
removePage
public Boolean removePage(String token,
String pageId)
throws RemoteException
- Specified by:
removePage
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getTrashContents
public Hashtable getTrashContents(String token,
String spaceKey,
int offset,
int maxResults)
throws RemoteException
- Specified by:
getTrashContents
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
purgeFromTrash
public Boolean purgeFromTrash(String token,
String spaceKey,
String pageId)
throws RemoteException
- Specified by:
purgeFromTrash
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
emptyTrash
public Boolean emptyTrash(String token,
String spaceKey)
throws RemoteException
- Specified by:
emptyTrash
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
search
public Vector search(String token,
String query,
int maxResults)
throws RemoteException
- Specified by:
search
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
search
public Vector search(String token,
String query,
Hashtable params,
int maxResults)
throws RemoteException
- Specified by:
search
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
storeBlogEntry
public Hashtable storeBlogEntry(String token,
Hashtable blogEntryStruct)
throws RemoteException
- Specified by:
storeBlogEntry
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
storePage
public Hashtable storePage(String token,
Hashtable pageStruct)
throws RemoteException
- Specified by:
storePage
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
updatePage
public Hashtable updatePage(String token,
Hashtable pageStruct,
Hashtable editOptionsStruct)
throws RemoteException
- Specified by:
updatePage
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
addAttachment
public Hashtable addAttachment(String token,
String contentId,
Hashtable attachment,
byte[] attachmentData)
throws RemoteException
- Specified by:
addAttachment
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getAttachment
public Hashtable getAttachment(String token,
String contentId,
String fileName,
String version)
throws RemoteException
- Specified by:
getAttachment
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getAttachmentData
public byte[] getAttachmentData(String token,
String contentId,
String fileName,
String version)
throws RemoteException
- Specified by:
getAttachmentData
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
removeAttachment
public boolean removeAttachment(String token,
String contentId,
String fileName)
throws RemoteException,
NotPermittedException
- Specified by:
removeAttachment
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
NotPermittedException
moveAttachment
public boolean moveAttachment(String token,
String originalContentId,
String originalFileName,
String newContentId,
String newFileName)
throws RemoteException,
NotPermittedException
- Specified by:
moveAttachment
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
NotPermittedException
addSpaceGroup
public Hashtable addSpaceGroup(String token,
Hashtable spaceGroup)
throws RemoteException
- Specified by:
addSpaceGroup
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getSpaceGroup
public Hashtable getSpaceGroup(String token,
String spaceGroupKey)
throws RemoteException
- Specified by:
getSpaceGroup
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getSpaceGroups
public Vector getSpaceGroups(String token)
throws RemoteException
- Specified by:
getSpaceGroups
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
removeSpaceGroup
public boolean removeSpaceGroup(String token,
String spaceGroupKey)
throws RemoteException
- Specified by:
removeSpaceGroup
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
addSpace
public Hashtable addSpace(String token,
Hashtable space)
throws RemoteException
- Specified by:
addSpace
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
storeSpace
public Hashtable storeSpace(String token,
Hashtable remoteSpace)
throws RemoteException
- Specified by:
storeSpace
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
addPersonalSpace
public Hashtable addPersonalSpace(String token,
Hashtable space,
String username)
throws RemoteException
- Specified by:
addPersonalSpace
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
removeSpace
public Boolean removeSpace(String token,
String spaceKey)
throws RemoteException
- Specified by:
removeSpace
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
exportSpace
public String exportSpace(String token,
String spaceKey,
String exportType)
throws RemoteException
- Specified by:
exportSpace
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
importSpace
public boolean importSpace(String token,
byte[] importData)
throws RemoteException
- Description copied from interface:
ConfluenceXmlRpcHandler
- Import a space in a compressed XML format
- Specified by:
importSpace
in interface ConfluenceXmlRpcHandler
- Parameters:
token
- The authentication tokenimportData
- The contents of the Space export file
- Returns:
- True if successful, otherwise false
- Throws:
RemoteException
- If the space exists or the export file is invalid
addPermissionToSpace
public boolean addPermissionToSpace(String token,
String permission,
String remoteEntityName,
String spaceKey)
throws RemoteException
- Specified by:
addPermissionToSpace
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
addPermissionsToSpace
public boolean addPermissionsToSpace(String token,
Vector permissions,
String remoteEntityName,
String spaceKey)
throws RemoteException
- Specified by:
addPermissionsToSpace
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
addGlobalPermissions
public boolean addGlobalPermissions(String token,
Vector permissions,
String remoteEntityName)
throws RemoteException
- Specified by:
addGlobalPermissions
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
addGlobalPermission
public boolean addGlobalPermission(String token,
String permission,
String remoteEntityName)
throws RemoteException
- Specified by:
addGlobalPermission
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
removeGlobalPermission
public boolean removeGlobalPermission(String token,
String permission,
String remoteEntityName)
throws RemoteException
- Specified by:
removeGlobalPermission
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
addAnonymousUsePermission
public boolean addAnonymousUsePermission(String token)
throws RemoteException
- Specified by:
addAnonymousUsePermission
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
removeAnonymousUsePermission
public boolean removeAnonymousUsePermission(String token)
throws RemoteException
- Specified by:
removeAnonymousUsePermission
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
addAnonymousViewUserProfilePermission
public boolean addAnonymousViewUserProfilePermission(String token)
throws RemoteException
- Specified by:
addAnonymousViewUserProfilePermission
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
removeAnonymousViewUserProfilePermission
public boolean removeAnonymousViewUserProfilePermission(String token)
throws RemoteException
- Specified by:
removeAnonymousViewUserProfilePermission
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
removePermissionFromSpace
public boolean removePermissionFromSpace(String token,
String permission,
String remoteEntityName,
String spaceKey)
throws NotPermittedException,
RemoteException
- Specified by:
removePermissionFromSpace
in interface ConfluenceXmlRpcHandler
- Throws:
NotPermittedException
RemoteException
addAnonymousPermissionToSpace
public boolean addAnonymousPermissionToSpace(String token,
String permission,
String spaceKey)
throws RemoteException
- Specified by:
addAnonymousPermissionToSpace
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
addAnonymousPermissionsToSpace
public boolean addAnonymousPermissionsToSpace(String token,
Vector permissions,
String spaceKey)
throws RemoteException
- Specified by:
addAnonymousPermissionsToSpace
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
removeAnonymousPermissionFromSpace
public boolean removeAnonymousPermissionFromSpace(String token,
String permission,
String spaceKey)
throws NotPermittedException,
RemoteException
- Specified by:
removeAnonymousPermissionFromSpace
in interface ConfluenceXmlRpcHandler
- Throws:
NotPermittedException
RemoteException
getSpaceLevelPermissions
public String[] getSpaceLevelPermissions(String token)
throws RemoteException
- Specified by:
getSpaceLevelPermissions
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getServerInfo
public Hashtable getServerInfo(String token)
throws RemoteException
- Specified by:
getServerInfo
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
exportSite
public String exportSite(String token,
boolean exportAttachments)
throws RemoteException
- Specified by:
exportSite
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
flushIndexQueue
public boolean flushIndexQueue(String token)
throws RemoteException
- Specified by:
flushIndexQueue
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
clearIndexQueue
public boolean clearIndexQueue(String token)
throws RemoteException
- Specified by:
clearIndexQueue
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getClusterInformation
public Hashtable getClusterInformation(String token)
throws RemoteException
- Specified by:
getClusterInformation
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getClusterNodeStatuses
public Vector getClusterNodeStatuses(String token)
throws RemoteException
- Specified by:
getClusterNodeStatuses
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getGroups
public Vector getGroups(String token)
throws RemoteException
- Specified by:
getGroups
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
hasGroup
public boolean hasGroup(String token,
String groupname)
throws InvalidSessionException,
RemoteException
- Specified by:
hasGroup
in interface ConfluenceXmlRpcHandler
- Throws:
InvalidSessionException
RemoteException
addGroup
public boolean addGroup(String token,
String groupname)
throws RemoteException
- Specified by:
addGroup
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
removeGroup
public boolean removeGroup(String token,
String groupname,
String defaultGroupName)
throws RemoteException
- Specified by:
removeGroup
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getUserGroups
public Vector getUserGroups(String token,
String username)
throws RemoteException
- Specified by:
getUserGroups
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
addUserToGroup
public boolean addUserToGroup(String token,
String username,
String groupname)
throws RemoteException
- Specified by:
addUserToGroup
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
removeAllPermissionsForGroup
public boolean removeAllPermissionsForGroup(String token,
String groupname)
throws RemoteException
- Specified by:
removeAllPermissionsForGroup
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
removeUserFromGroup
public boolean removeUserFromGroup(String token,
String username,
String groupname)
throws RemoteException
- Specified by:
removeUserFromGroup
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
getUser
public Hashtable getUser(String token,
String username)
throws RemoteException
- Specified by:
getUser
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
hasUser
public boolean hasUser(String token,
String username)
throws InvalidSessionException,
RemoteException
- Specified by:
hasUser
in interface ConfluenceXmlRpcHandler
- Throws:
InvalidSessionException
RemoteException
addUser
public boolean addUser(String token,
Hashtable remoteUser,
String password)
throws RemoteException
- Specified by:
addUser
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
removeUser
public boolean removeUser(String token,
String username)
throws RemoteException
- Specified by:
removeUser
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
editUser
public boolean editUser(String token,
Hashtable remoteUser)
throws NotPermittedException,
InvalidSessionException,
RemoteException
- Specified by:
editUser
in interface ConfluenceXmlRpcHandler
- Throws:
NotPermittedException
InvalidSessionException
RemoteException
deactivateUser
public boolean deactivateUser(String token,
String username)
throws NotPermittedException,
InvalidSessionException,
RemoteException
- Specified by:
deactivateUser
in interface ConfluenceXmlRpcHandler
- Throws:
NotPermittedException
InvalidSessionException
RemoteException
reactivateUser
public boolean reactivateUser(String token,
String username)
throws NotPermittedException,
InvalidSessionException,
RemoteException
- Specified by:
reactivateUser
in interface ConfluenceXmlRpcHandler
- Throws:
NotPermittedException
InvalidSessionException
RemoteException
isActiveUser
public boolean isActiveUser(String token,
String username)
throws NotPermittedException,
RemoteException
- Specified by:
isActiveUser
in interface ConfluenceXmlRpcHandler
- Throws:
NotPermittedException
RemoteException
getActiveUsers
public Vector getActiveUsers(String token,
boolean viewAll)
throws InvalidSessionException,
RemoteException
- Specified by:
getActiveUsers
in interface ConfluenceXmlRpcHandler
- Throws:
InvalidSessionException
RemoteException
setUserInformation
public boolean setUserInformation(String token,
Hashtable userInfo)
throws NotPermittedException,
InvalidSessionException,
RemoteException
- Specified by:
setUserInformation
in interface ConfluenceXmlRpcHandler
- Throws:
NotPermittedException
InvalidSessionException
RemoteException
getUserInformation
public Hashtable getUserInformation(String token,
String username)
throws InvalidSessionException,
RemoteException
- Specified by:
getUserInformation
in interface ConfluenceXmlRpcHandler
- Throws:
InvalidSessionException
RemoteException
changeMyPassword
public boolean changeMyPassword(String token,
String oldPass,
String newPass)
throws InvalidSessionException,
RemoteException
- Specified by:
changeMyPassword
in interface ConfluenceXmlRpcHandler
- Throws:
InvalidSessionException
RemoteException
changeUserPassword
public boolean changeUserPassword(String token,
String username,
String newPass)
throws NotPermittedException,
InvalidSessionException,
RemoteException
- Specified by:
changeUserPassword
in interface ConfluenceXmlRpcHandler
- Throws:
NotPermittedException
InvalidSessionException
RemoteException
addProfilePicture
public boolean addProfilePicture(String token,
String userName,
String fileName,
String mimeType,
byte[] pictureData)
throws RemoteException
- Specified by:
addProfilePicture
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
setUserPreferenceBoolean
public boolean setUserPreferenceBoolean(String token,
String username,
String key,
boolean value)
throws InvalidSessionException,
RemoteException
- Specified by:
setUserPreferenceBoolean
in interface ConfluenceXmlRpcHandler
- Throws:
InvalidSessionException
RemoteException
getUserPreferenceBoolean
public boolean getUserPreferenceBoolean(String token,
String username,
String key)
throws InvalidSessionException,
RemoteException
- Specified by:
getUserPreferenceBoolean
in interface ConfluenceXmlRpcHandler
- Throws:
InvalidSessionException
RemoteException
setUserPreferenceLong
public boolean setUserPreferenceLong(String token,
String username,
String key,
String value)
throws InvalidSessionException,
RemoteException
- Specified by:
setUserPreferenceLong
in interface ConfluenceXmlRpcHandler
- Throws:
InvalidSessionException
RemoteException
getUserPreferenceLong
public String getUserPreferenceLong(String token,
String username,
String key)
throws InvalidSessionException,
RemoteException
- Specified by:
getUserPreferenceLong
in interface ConfluenceXmlRpcHandler
- Throws:
InvalidSessionException
RemoteException
setUserPreferenceString
public boolean setUserPreferenceString(String token,
String username,
String key,
String value)
throws InvalidSessionException,
RemoteException
- Specified by:
setUserPreferenceString
in interface ConfluenceXmlRpcHandler
- Throws:
InvalidSessionException
RemoteException
getUserPreferenceString
public String getUserPreferenceString(String token,
String username,
String key)
throws InvalidSessionException,
RemoteException
- Specified by:
getUserPreferenceString
in interface ConfluenceXmlRpcHandler
- Throws:
InvalidSessionException
RemoteException
getLabelsById
public Vector getLabelsById(String token,
String objectId)
throws NotPermittedException,
RemoteException
- Specified by:
getLabelsById
in interface ConfluenceXmlRpcHandler
- Throws:
NotPermittedException
RemoteException
getMostPopularLabels
public Vector getMostPopularLabels(String token,
int maxCount)
throws NotPermittedException,
RemoteException
- Specified by:
getMostPopularLabels
in interface ConfluenceXmlRpcHandler
- Throws:
NotPermittedException
RemoteException
getMostPopularLabelsInSpace
public Vector getMostPopularLabelsInSpace(String token,
String spaceKey,
int maxCount)
throws NotPermittedException,
RemoteException
- Specified by:
getMostPopularLabelsInSpace
in interface ConfluenceXmlRpcHandler
- Throws:
NotPermittedException
RemoteException
getLabelContentById
public Vector getLabelContentById(String token,
String labelId)
throws NotPermittedException,
RemoteException
- Specified by:
getLabelContentById
in interface ConfluenceXmlRpcHandler
- Throws:
NotPermittedException
RemoteException
getLabelContentByName
public Vector getLabelContentByName(String token,
String labelName)
throws NotPermittedException,
RemoteException
- Specified by:
getLabelContentByName
in interface ConfluenceXmlRpcHandler
- Throws:
NotPermittedException
RemoteException
getLabelContentByObject
public Vector getLabelContentByObject(String token,
Hashtable labelObject)
throws NotPermittedException,
RemoteException
- Specified by:
getLabelContentByObject
in interface ConfluenceXmlRpcHandler
- Throws:
NotPermittedException
RemoteException
getRecentlyUsedLabels
public Vector getRecentlyUsedLabels(String token,
int maxResults)
throws InvalidSessionException,
RemoteException
- Specified by:
getRecentlyUsedLabels
in interface ConfluenceXmlRpcHandler
- Throws:
InvalidSessionException
RemoteException
getRecentlyUsedLabelsInSpace
public Vector getRecentlyUsedLabelsInSpace(String token,
String spaceKey,
int maxResults)
throws InvalidSessionException,
RemoteException
- Specified by:
getRecentlyUsedLabelsInSpace
in interface ConfluenceXmlRpcHandler
- Throws:
InvalidSessionException
RemoteException
getSpacesWithLabel
public Vector getSpacesWithLabel(String token,
String labelName)
throws InvalidSessionException,
RemoteException
- Specified by:
getSpacesWithLabel
in interface ConfluenceXmlRpcHandler
- Throws:
InvalidSessionException
RemoteException
getRelatedLabels
public Vector getRelatedLabels(String token,
String labelName,
int maxResults)
throws InvalidSessionException,
RemoteException
- Specified by:
getRelatedLabels
in interface ConfluenceXmlRpcHandler
- Throws:
InvalidSessionException
RemoteException
getRelatedLabelsInSpace
public Vector getRelatedLabelsInSpace(String token,
String labelName,
String spaceKey,
int maxResults)
throws InvalidSessionException,
RemoteException
- Specified by:
getRelatedLabelsInSpace
in interface ConfluenceXmlRpcHandler
- Throws:
InvalidSessionException
RemoteException
getLabelsByDetail
public Vector getLabelsByDetail(String token,
String labelName,
String namespace,
String spaceKey,
String owner)
throws InvalidSessionException,
RemoteException,
NotPermittedException
- Specified by:
getLabelsByDetail
in interface ConfluenceXmlRpcHandler
- Throws:
InvalidSessionException
RemoteException
NotPermittedException
getSpacesContainingContentWithLabel
public Vector getSpacesContainingContentWithLabel(String token,
String labelName)
throws InvalidSessionException,
RemoteException
- Specified by:
getSpacesContainingContentWithLabel
in interface ConfluenceXmlRpcHandler
- Throws:
InvalidSessionException
RemoteException
addLabelByName
public boolean addLabelByName(String token,
String labelName,
String objectId)
throws NotPermittedException,
RemoteException
- Specified by:
addLabelByName
in interface ConfluenceXmlRpcHandler
- Throws:
NotPermittedException
RemoteException
addLabelById
public boolean addLabelById(String token,
String labelId,
String objectId)
throws NotPermittedException,
RemoteException
- Specified by:
addLabelById
in interface ConfluenceXmlRpcHandler
- Throws:
NotPermittedException
RemoteException
addLabelByObject
public boolean addLabelByObject(String token,
Hashtable labelObject,
String objectId)
throws NotPermittedException,
RemoteException
- Specified by:
addLabelByObject
in interface ConfluenceXmlRpcHandler
- Throws:
NotPermittedException
RemoteException
addLabelByNameToSpace
public boolean addLabelByNameToSpace(String token,
String labelName,
String spaceKey)
throws NotPermittedException,
InvalidSessionException,
RemoteException
- Specified by:
addLabelByNameToSpace
in interface ConfluenceXmlRpcHandler
- Throws:
NotPermittedException
InvalidSessionException
RemoteException
removeLabelByName
public boolean removeLabelByName(String token,
String labelName,
String objectId)
throws NotPermittedException,
RemoteException
- Specified by:
removeLabelByName
in interface ConfluenceXmlRpcHandler
- Throws:
NotPermittedException
RemoteException
removeLabelById
public boolean removeLabelById(String token,
String labelId,
String objectId)
throws NotPermittedException,
RemoteException
- Specified by:
removeLabelById
in interface ConfluenceXmlRpcHandler
- Throws:
NotPermittedException
RemoteException
removeLabelByObject
public boolean removeLabelByObject(String token,
Hashtable labelObject,
String objectId)
throws NotPermittedException,
RemoteException
- Specified by:
removeLabelByObject
in interface ConfluenceXmlRpcHandler
- Throws:
NotPermittedException
RemoteException
removeLabelByNameFromSpace
public boolean removeLabelByNameFromSpace(String token,
String labelName,
String spaceKey)
throws NotPermittedException,
InvalidSessionException,
RemoteException
- Specified by:
removeLabelByNameFromSpace
in interface ConfluenceXmlRpcHandler
- Throws:
NotPermittedException
InvalidSessionException
RemoteException
setEnableWysiwyg
@Deprecated
public boolean setEnableWysiwyg(String token,
String value)
throws RemoteException
- Deprecated. since 4.0. You can no longer disable the wysiwyg editor.
- Specified by:
setEnableWysiwyg
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
setEnableAnonymousAccess
public boolean setEnableAnonymousAccess(String token,
String value)
throws RemoteException
- Specified by:
setEnableAnonymousAccess
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
isPluginEnabled
public boolean isPluginEnabled(String token,
String pluginKey)
throws RemoteException
- Specified by:
isPluginEnabled
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
isPluginInstalled
public boolean isPluginInstalled(String token,
String pluginKey)
throws RemoteException
- Specified by:
isPluginInstalled
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
installPlugin
public boolean installPlugin(String token,
String pluginFileName,
byte[] pluginData)
throws RemoteException
- Specified by:
installPlugin
in interface ConfluenceXmlRpcHandler
- Throws:
RemoteException
Copyright © 2003-2012 Atlassian. All Rights Reserved.