com.atlassian.confluence.it.rpc
Class ConfluenceRpc

java.lang.Object
  com.atlassian.confluence.it.rpc.ConfluenceRpc

public class ConfluenceRpc
extends java.lang.Object

Constructor Summary

ConfluenceRpc(java.lang.String baseUrl)

Method Summary

void	addLabel(java.lang.String label, Page page)
void	changePageModificationDate(long pageId, java.util.Date modificationDate)
java.lang.String	convertWikiMarkupToXhtml(java.lang.String wikiMarkup, long pageId)
java.lang.String	convertXhtmlToWikiMarkup(java.lang.String xhtml, long pageId)
long	createAttachment(Attachment attachment)
long	createBlogPost(BlogPost blogPost)
long	createComment(Comment comment)
long	createComment(Comment comment, long parentCommentId)
void	createGroup(java.lang.String groupname)
void	createJohnsonEvent(java.lang.String message)
long	createPage(Page page)
java.util.Map<java.lang.String,java.lang.String>	createPage(java.lang.String spaceKey, java.lang.String title, java.lang.String content, long parentPageId)
Space	createPersonalSpace(User user)
Space	createSpace(Space space)
Space	createSpace(java.lang.String key, java.lang.String name, java.lang.String description)
void	createUser(User user)
java.lang.String	exportSite(boolean exportAttachments) Returns the URL of the downloadable export.
java.lang.String	exportSpace(Space space, java.lang.String exportType) Returns the URL of the downloadable export.
void	flushIndexQueue()
long	getAttachmentId(long contentId, java.lang.String fileName)
java.lang.String	getConfiguredThemeForSpace(java.lang.String spaceKey)
Page	getExistingPage(Space space, java.lang.String pageTitle) Retrieve the fully populated Page object for a page, known to exist in confluence.
java.lang.String	getGlobalConfiguredTheme()
java.lang.String	getPageContent(long pageId)
long	getPageId(Page page)
long	getPageId(java.lang.String spaceKey, java.lang.String title)
java.util.List<java.lang.Long>	getPageIdsInSpace(Space space)
void	grantAnonymousPermission(SpacePermission permission, Space space)
void	grantAnonymousUsePermission()
void	grantPermission(GlobalPermission permission, User user)
void	grantPermission(SpacePermission permission, Space space, User user)
void	grantPermissions(Space space, User user, SpacePermission... permissions)
boolean	isPluginEnabled(java.lang.String pluginKey)
void	logIn(java.lang.String token)
void	logIn(User user) Set the current user logged into this rpc client.
void	logOut()
void	movePage(long sourcePageId, long targetPageId, java.lang.String position)
void	pauseJob(java.lang.String jobName)
void	removeAllGroupsAndUsers()
void	removeAllJohnsonEvents()
void	removeAllSpaces()
void	removeDrafts(User user)
void	removeGroup(java.lang.String groupname, java.lang.String defaultGroupName)
void	removeSpace(java.lang.String spaceKey) Removes the space if it exists, otherwise does nothing.
void	removeUser(java.lang.String username) Removes the user if it exists, otherwise does nothing.
void	removeUser(User user)
void	resumeJob(java.lang.String jobName)
void	revokeAnonymousPermission(SpacePermission permission, Space space)
void	revokeAnonymousUsePermission()
void	revokePermission(SpacePermission permission, Space space, User user)
long	saveBlogPost(BlogPost blogPost)
long	saveComment(Comment comment)
long	savePage(Page page)
java.util.List<java.util.Hashtable>	search(java.lang.String queryString, int maxMatches) Search for the supplied query String.
void	setCaptchaMode(boolean enable)
void	setPageRestriction(Page page, ContentPermission type, User user) Restrict page to single given user.
void	setUserLocale(User user, java.util.Locale locale)
long	updatePage(Page page, boolean minorEdit)
void	useAnonymously() Indicate that further rpc calls should be made anonymously, rather than as a specific user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfluenceRpc

public ConfluenceRpc(java.lang.String baseUrl)

Method Detail

logIn

public void logIn(User user)

Set the current user logged into this rpc client. Creates a user token for the given user by calling the remote login method. All further methods called on the client will be performed using this token until logOut() or useAnonymously() are called.

logIn

public void logIn(java.lang.String token)

useAnonymously

public void useAnonymously()

Indicate that further rpc calls should be made anonymously, rather than as a specific user. This will last until logIn(com.atlassian.confluence.it.User) or logOut() are called.

logOut

public void logOut()

getPageId

public long getPageId(Page page)

getPageId

public long getPageId(java.lang.String spaceKey,
                      java.lang.String title)

getPageIdsInSpace

public java.util.List<java.lang.Long> getPageIdsInSpace(Space space)

getPageContent

public java.lang.String getPageContent(long pageId)

convertWikiMarkupToXhtml

public java.lang.String convertWikiMarkupToXhtml(java.lang.String wikiMarkup,
                                                 long pageId)

convertXhtmlToWikiMarkup

public java.lang.String convertXhtmlToWikiMarkup(java.lang.String xhtml,
                                                 long pageId)

createPage

public java.util.Map<java.lang.String,java.lang.String> createPage(java.lang.String spaceKey,
                                                                   java.lang.String title,
                                                                   java.lang.String content,
                                                                   long parentPageId)

createPage

public long createPage(Page page)

getExistingPage

public Page getExistingPage(Space space,
                            java.lang.String pageTitle)

Retrieve the fully populated Page object for a page, known to exist in confluence.

savePage

public long savePage(Page page)

updatePage

public long updatePage(Page page,
                       boolean minorEdit)

setPageRestriction

public void setPageRestriction(Page page,
                               ContentPermission type,
                               User user)

Restrict page to single given user. This will wipe any other restrictions.

createBlogPost

public long createBlogPost(BlogPost blogPost)

saveBlogPost

public long saveBlogPost(BlogPost blogPost)

createComment

public long createComment(Comment comment)

createComment

public long createComment(Comment comment,
                          long parentCommentId)

saveComment

public long saveComment(Comment comment)

createAttachment

public long createAttachment(Attachment attachment)

getAttachmentId

public long getAttachmentId(long contentId,
                            java.lang.String fileName)

movePage

public void movePage(long sourcePageId,
                     long targetPageId,
                     java.lang.String position)

addLabel

public void addLabel(java.lang.String label,
                     Page page)

createSpace

public Space createSpace(Space space)

createSpace

public Space createSpace(java.lang.String key,
                         java.lang.String name,
                         java.lang.String description)

createPersonalSpace

public Space createPersonalSpace(User user)

removeSpace

public void removeSpace(java.lang.String spaceKey)

Removes the space if it exists, otherwise does nothing.

createUser

public void createUser(User user)

removeUser

public void removeUser(User user)

removeUser

public void removeUser(java.lang.String username)

Removes the user if it exists, otherwise does nothing.

createGroup

public void createGroup(java.lang.String groupname)

removeGroup

public void removeGroup(java.lang.String groupname,
                        java.lang.String defaultGroupName)

exportSpace

public java.lang.String exportSpace(Space space,
                                    java.lang.String exportType)

Returns the URL of the downloadable export.

exportSite

public java.lang.String exportSite(boolean exportAttachments)

Returns the URL of the downloadable export.

grantPermission

public void grantPermission(SpacePermission permission,
                            Space space,
                            User user)

grantPermissions

public void grantPermissions(Space space,
                             User user,
                             SpacePermission... permissions)

grantAnonymousPermission

public void grantAnonymousPermission(SpacePermission permission,
                                     Space space)

revokePermission

public void revokePermission(SpacePermission permission,
                             Space space,
                             User user)

revokeAnonymousPermission

public void revokeAnonymousPermission(SpacePermission permission,
                                      Space space)

grantPermission

public void grantPermission(GlobalPermission permission,
                            User user)

grantAnonymousUsePermission

public void grantAnonymousUsePermission()

revokeAnonymousUsePermission

public void revokeAnonymousUsePermission()

flushIndexQueue

public void flushIndexQueue()

isPluginEnabled

public boolean isPluginEnabled(java.lang.String pluginKey)

setUserLocale

public void setUserLocale(User user,
                          java.util.Locale locale)

removeDrafts

public void removeDrafts(User user)

removeAllGroupsAndUsers

public void removeAllGroupsAndUsers()

removeAllSpaces

public void removeAllSpaces()

changePageModificationDate

public void changePageModificationDate(long pageId,
                                       java.util.Date modificationDate)

pauseJob

public void pauseJob(java.lang.String jobName)

resumeJob

public void resumeJob(java.lang.String jobName)

getGlobalConfiguredTheme

public java.lang.String getGlobalConfiguredTheme()

getConfiguredThemeForSpace

public java.lang.String getConfiguredThemeForSpace(java.lang.String spaceKey)

createJohnsonEvent

public void createJohnsonEvent(java.lang.String message)

removeAllJohnsonEvents

public void removeAllJohnsonEvents()

setCaptchaMode

public void setCaptchaMode(boolean enable)

search

public java.util.List<java.util.Hashtable> search(java.lang.String queryString,
                                                  int maxMatches)

Search for the supplied query String.

Parameters:

queryString - the query

maxMatches - the maximum number of matches to be returned

Returns:

a List of Hashtables representing SearchResults or the empty list if there are no matches.