Modifier and Type | Field and Description |
---|---|
protected boolean |
sendRawData |
Constructor and Description |
---|
Confluence(String endpoint) |
Modifier and Type | Method and Description |
---|---|
boolean |
addAnonymousPermissionsToSpace(List permissions,
String spaceKey)
Give anonymous users the permissions {{permissions}} on the space with the key {{spaceKey}}.
|
boolean |
addAnonymousPermissionToSpace(String permission,
String spaceKey)
Give anonymous users the permission {{permission}} on the space with the key {{spaceKey}}.
|
Attachment |
addAttachment(long contentId,
Attachment attachment,
byte[] attachmentData)
add a new attachment to a content entity object.
|
Comment |
addComment(Comment comment)
adds a comment to the page.
|
void |
addGroup(String group)
add a new group
|
boolean |
addLabelById(long labelId,
long objectId)
Adds a label with the given ID to the object with the given ContentEntityObject ID.
|
boolean |
addLabelByName(String labelName,
long objectId)
Adds a label to the object with the given ContentEntityObject ID.
|
boolean |
addLabelByNameToSpace(String labelName,
String spaceKey)
Adds a label to the object with the given ContentEntityObject ID.
|
boolean |
addLabelByObject(Label labelObject,
long objectId)
Adds the given label object to the object with the given ContentEntityObject ID.
|
boolean |
addPermissionsToSpace(List permissions,
String remoteEntityName,
String spaceKey)
Give the entity named {{remoteEntityName}} (either a group or a user) the permissions {{permissions}} on the space with the key {{spaceKey}}.
|
boolean |
addPermissionToSpace(String permission,
String remoteEntityName,
String spaceKey)
Give the entity named {{remoteEntityName}} (either a group or a user) the permission {{permission}} on the space with the key {{spaceKey}}.
|
Space |
addSpace(Space space)
create a new space, passing in name, key and description.
|
void |
addUser(User user,
String password)
add a new user with the given password
|
void |
addUserToGroup(String username,
String groupname)
add a user to a particular group
|
boolean |
changeMyPassword(String oldPass,
String newPass)
changes the current user's password
|
boolean |
changeUserPassword(String username,
String newPass)
changes the specified user's password
|
boolean |
deactivateUser(String username)
deactivates the specified user
|
boolean |
editUser(User remoteUser)
edits the details of a user
|
String |
exportSite(boolean exportAttachments)
exports a Confluence instance and returns a String holding the URL for the download.
|
String |
exportSpace(String spaceKey,
String exportType)
exports a space and returns a String holding the URL for the download.
|
List |
getActiveUsers(boolean viewAll)
returns all registered users as Strings
|
List |
getAncestors(String pageId)
returns all the ancestors (as
PageSummary instances) of this page (parent, parent's parent etc). |
Attachment |
getAttachment(String pageId,
String fileName,
String versionNumber)
get information about an attachment.
|
byte[] |
getAttachmentData(String pageId,
String fileName,
String versionNumber)
get the contents of an attachment.
|
List |
getAttachments(String pageId)
returns all the
Attachment s for this page (useful to point users to download them with the full file download URL returned). |
List |
getBlogEntries(String spaceKey)
returns all the
BlogEntrySummary instances in the space. |
BlogEntry |
getBlogEntry(String pageId)
returns a single BlogEntry.
|
BlogEntry |
getBlogEntryByDayAndTitle(String spaceKey,
int dayOfMonth,
String postTitle)
Retrieves a blog post in the Space with the given spaceKey, with the title 'postTitle' and posted on the day 'dayOfMonth'.
|
List |
getChildren(String pageId)
returns all the direct children (as
PageSummary instances) of this page. |
Comment |
getComment(String commentId)
returns an individual comment.
|
List |
getComments(String pageId)
returns all the
Comment s for this page. |
List |
getDescendents(String pageId)
returns all the descendents (as
PageSummary instances) of this page (children, children's children etc). |
List |
getGroups()
gets all groups as a list of
String s |
List |
getLabelContentById(long labelId)
Returns the content for a given label ID
|
List |
getLabelContentByName(String labelName)
Returns the content for a given label name.
|
List |
getLabelContentByObject(Label labelObject)
Returns the content for a given Label object.
|
List |
getLabelsByDetail(String labelName,
String namespace,
String spaceKey,
String owner)
Retrieves the
Label s matching the given {{labelName}}, {{namespace}}, {{spaceKey}} or {{owner}}. |
List |
getLabelsById(long objectId)
Returns all
Label s for the given ContentEntityObject ID |
List |
getMostPopularLabels(int maxCount)
Returns the most popular
Label s for the Confluence instance, with a specified maximum number. |
List |
getMostPopularLabelsInSpace(String spaceKey,
int maxCount)
Returns the most popular
Label s for the given {{spaceKey}}, with a specified maximum number of results. |
Page |
getPage(PageSummary summary)
returns a single Page
|
Page |
getPage(String pageId) |
Page |
getPage(String spaceKey,
String pageTitle)
returns a single Page
|
List |
getPageHistory(String pageId)
returns all the
PageHistorySummary instances - useful for looking up the previous versions of a page, and who changed them. |
List |
getPagePermissions(String pageId)
Returns a List of
Permission s representing the permissions set on the given page. |
List |
getPages(String spaceKey)
returns all the
PageSummary instances in the space. |
List |
getPermissions(String spaceKey)
Returns a List of
Permission s representing the permissions the current user has for this space (a list of "view", "modify", "comment" and / or "admin"). |
List |
getPermissionsForUser(String spaceKey,
String userName)
Returns a List of
Permission s representing the permissions the given user has for this space. |
List |
getRecentlyUsedLabels(int maxResults)
Returns the recently used
Label s for the Confluence instance, with a specified maximum number of results. |
List |
getRecentlyUsedLabelsInSpace(String spaceKey,
int maxResults)
Returns the recently used
Label s for the given {{spaceKey}}, with a specified maximum number of results. |
List |
getRelatedLabels(String labelName,
int maxResults)
Returns the
Label s related to the given label name, with a specified maximum number of results. |
List |
getRelatedLabelsInSpace(String labelName,
String spaceKey,
int maxResults)
Returns the
Label s related to the given label name for the given {{spaceKey}}, with a specified maximum number of results. |
ServerInfo |
getServerInfo()
retrieve some basic information about the server being connected to.
|
Space |
getSpace(String spaceKey)
returns a single Space.
|
List |
getSpaceLevelPermissions()
returns List of the space level
Permission s which may be granted. |
List |
getSpaces()
returns all the
SpaceSummary instances that the current user can see. |
List |
getSpacesContainingContentWithLabel(String labelName)
Returns all Spaces that have content labelled with {{labelName}}.
|
List |
getSpacesWithLabel(String labelName)
Returns an array of
Space s that have been labelled with {{labelName}}. |
User |
getUser(String username)
get a single user
|
List |
getUserGroups(String username)
get a user's current groups as a list of
String s |
UserInformation |
getUserInformation(String username)
Retrieves user information
|
boolean |
hasGroup(String groupname)
checks if a group exists
|
boolean |
hasUser(String username)
checks if a user exists
|
void |
login(String username,
String password) |
boolean |
logout()
remove this token from the list of logged in tokens.
|
boolean |
moveAttachment(String originalContentId,
String originalName,
String newContentEntityId,
String newName)
move an attachment to a different content entity object and/or give it a new name.
|
boolean |
reactivateUser(String username)
reactivates the specified user
|
boolean |
removeAllPermissionsForGroup(String groupname)
Remove all the global and space level permissions for {{groupname}}.
|
boolean |
removeAnonymousPermissionFromSpace(String permission,
String spaceKey)
Remove the permission {{permission} from anonymous users on the space with the key {{spaceKey}}.
|
boolean |
removeAttachment(String contentId,
String fileName)
remove an attachment from a content entity object.
|
boolean |
removeComment(String commentId)
removes a comment from the page.
|
boolean |
removeGroup(String groupname,
String defaultGroupName)
remove a group.
|
boolean |
removeLabelById(long labelId,
long objectId)
Removes the label with the given ID from the object with the given ContentEntityObject ID.
|
boolean |
removeLabelByName(String labelName,
long objectId)
Removes the given label from the object with the given ContentEntityObject ID.
|
boolean |
removeLabelByNameFromSpace(String labelName,
String spaceKey)
Removes the given label from the given {{spaceKey}}.
|
boolean |
removeLabelByObject(Label labelObject,
long objectId)
Removes the given label object from the object with the given ContentEntityObject ID.
|
void |
removePage(String pageId)
remove a page
|
boolean |
removePermissionFromSpace(String permission,
String remoteEntityName,
String spaceKey)
Remove the permission {{permission} from the entity named {{remoteEntityName}} (either a group or a user) on the space with the key {{spaceKey}}.
|
Boolean |
removeSpace(String spaceKey)
remove a space completely.
|
boolean |
removeUser(String username)
delete a user.
|
boolean |
removeUserFromGroup(String username,
String groupname)
remove a user from a group.
|
String |
renderContent(PageSummary page) |
String |
renderContent(String spaceKey,
String pageId) |
String |
renderContent(String spaceKey,
String pageId,
String content)
returns the HTML rendered content for this page.
|
String |
renderContent(String spaceKey,
String pageId,
String content,
Map parameters)
Like the above renderContent(), but you can supply an optional hash (map, dictionary, etc) containing additional instructions for the renderer.
|
List |
search(String query,
int maxResults)
return a list of
SearchResult s which match a given search query (including pages and other content types). |
List |
search(String query,
Map parameters,
int maxResults)
Returns a list of
SearchResult s like the previous search, but you can optionally limit your search by adding parameters to the parameter map. |
void |
sendRawData(boolean sendRawData) |
boolean |
setUserInformation(UserInformation userInfo)
updates user information
|
BlogEntry |
storeBlogEntry(BlogEntry entry)
add or update a blog entry.
|
Page |
storePage(Page page)
add or update a page.
|
boolean |
willSendRawData() |
public Confluence(String endpoint) throws MalformedURLException
MalformedURLException
public boolean willSendRawData()
public void sendRawData(boolean sendRawData)
public void login(String username, String password) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public boolean logout() throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public String exportSite(boolean exportAttachments) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public ServerInfo getServerInfo() throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public List getSpaces() throws SwizzleException, ConfluenceException
SpaceSummary
instances that the current user can see.SwizzleException
ConfluenceException
public Space getSpace(String spaceKey) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public String exportSpace(String spaceKey, String exportType) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public Space addSpace(Space space) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public Boolean removeSpace(String spaceKey) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public List getPages(String spaceKey) throws SwizzleException, ConfluenceException
PageSummary
instances in the space. Doesn't include pages which are in the Trash. Equivalent to calling {{Space.getCurrentPages()}}.SwizzleException
ConfluenceException
public Page getPage(PageSummary summary) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public Page getPage(String pageId) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public Page getPage(String spaceKey, String pageTitle) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public List getPageHistory(String pageId) throws SwizzleException, ConfluenceException
PageHistorySummary
instances - useful for looking up the previous versions of a page, and who changed them.SwizzleException
ConfluenceException
public List getAttachments(String pageId) throws SwizzleException, ConfluenceException
Attachment
s for this page (useful to point users to download them with the full file download URL returned).SwizzleException
ConfluenceException
public List getAncestors(String pageId) throws SwizzleException, ConfluenceException
PageSummary
instances) of this page (parent, parent's parent etc).SwizzleException
ConfluenceException
public List getChildren(String pageId) throws SwizzleException, ConfluenceException
PageSummary
instances) of this page.SwizzleException
ConfluenceException
public List getDescendents(String pageId) throws SwizzleException, ConfluenceException
PageSummary
instances) of this page (children, children's children etc).SwizzleException
ConfluenceException
public List getComments(String pageId) throws SwizzleException, ConfluenceException
Comment
s for this page.SwizzleException
ConfluenceException
public Comment getComment(String commentId) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public Comment addComment(Comment comment) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public boolean removeComment(String commentId) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public Page storePage(Page page) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public String renderContent(String spaceKey, String pageId, String content) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public String renderContent(String spaceKey, String pageId) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public String renderContent(PageSummary page) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public String renderContent(String spaceKey, String pageId, String content, Map parameters) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public void removePage(String pageId) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public Attachment getAttachment(String pageId, String fileName, String versionNumber) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public byte[] getAttachmentData(String pageId, String fileName, String versionNumber) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public Attachment addAttachment(long contentId, Attachment attachment, byte[] attachmentData) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public boolean removeAttachment(String contentId, String fileName) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public boolean moveAttachment(String originalContentId, String originalName, String newContentEntityId, String newName) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public List getBlogEntries(String spaceKey) throws SwizzleException, ConfluenceException
BlogEntrySummary
instances in the space.SwizzleException
ConfluenceException
public BlogEntry getBlogEntry(String pageId) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public BlogEntry storeBlogEntry(BlogEntry entry) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public BlogEntry getBlogEntryByDayAndTitle(String spaceKey, int dayOfMonth, String postTitle) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public List search(String query, int maxResults) throws SwizzleException, ConfluenceException
SearchResult
s which match a given search query (including pages and other content types). This is the same as a performing a parameterised search (see below) with an
empty parameter map.SwizzleException
ConfluenceException
public List search(String query, Map parameters, int maxResults) throws SwizzleException, ConfluenceException
SearchResult
s like the previous search, but you can optionally limit your search by adding parameters to the parameter map. If you do not include a parameter, the
default is used instead.SwizzleException
ConfluenceException
public List getPermissions(String spaceKey) throws SwizzleException, ConfluenceException
Permission
s representing the permissions the current user has for this space (a list of "view", "modify", "comment" and / or "admin").SwizzleException
ConfluenceException
public List getPermissionsForUser(String spaceKey, String userName) throws SwizzleException, ConfluenceException
Permission
s representing the permissions the given user has for this space. (since 2.1.4)SwizzleException
ConfluenceException
public List getPagePermissions(String pageId) throws SwizzleException, ConfluenceException
Permission
s representing the permissions set on the given page.SwizzleException
ConfluenceException
public List getSpaceLevelPermissions() throws SwizzleException, ConfluenceException
Permission
s which may be granted. This is a list of possible permissions to use with {{addPermissionToSpace}}, below, not a list of current permissions
on a Space.SwizzleException
ConfluenceException
public boolean addPermissionToSpace(String permission, String remoteEntityName, String spaceKey) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public boolean addPermissionsToSpace(List permissions, String remoteEntityName, String spaceKey) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public boolean removePermissionFromSpace(String permission, String remoteEntityName, String spaceKey) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public boolean addAnonymousPermissionToSpace(String permission, String spaceKey) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public boolean addAnonymousPermissionsToSpace(List permissions, String spaceKey) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public boolean removeAnonymousPermissionFromSpace(String permission, String spaceKey) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public boolean removeAllPermissionsForGroup(String groupname) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public User getUser(String username) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public void addUser(User user, String password) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public void addGroup(String group) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public List getUserGroups(String username) throws SwizzleException, ConfluenceException
String
sSwizzleException
ConfluenceException
public void addUserToGroup(String username, String groupname) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public boolean removeUserFromGroup(String username, String groupname) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public boolean removeUser(String username) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public boolean removeGroup(String groupname, String defaultGroupName) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public List getGroups() throws SwizzleException, ConfluenceException
String
sSwizzleException
ConfluenceException
public boolean hasUser(String username) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public boolean hasGroup(String groupname) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public boolean editUser(User remoteUser) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public boolean deactivateUser(String username) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public boolean reactivateUser(String username) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public List getActiveUsers(boolean viewAll) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public boolean setUserInformation(UserInformation userInfo) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public UserInformation getUserInformation(String username) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public boolean changeMyPassword(String oldPass, String newPass) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public boolean changeUserPassword(String username, String newPass) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public List getLabelsById(long objectId) throws SwizzleException, ConfluenceException
Label
s for the given ContentEntityObject IDSwizzleException
ConfluenceException
public List getMostPopularLabels(int maxCount) throws SwizzleException, ConfluenceException
Label
s for the Confluence instance, with a specified maximum number.SwizzleException
ConfluenceException
public List getMostPopularLabelsInSpace(String spaceKey, int maxCount) throws SwizzleException, ConfluenceException
Label
s for the given {{spaceKey}}, with a specified maximum number of results.SwizzleException
ConfluenceException
public List getRecentlyUsedLabels(int maxResults) throws SwizzleException, ConfluenceException
Label
s for the Confluence instance, with a specified maximum number of results.SwizzleException
ConfluenceException
public List getRecentlyUsedLabelsInSpace(String spaceKey, int maxResults) throws SwizzleException, ConfluenceException
Label
s for the given {{spaceKey}}, with a specified maximum number of results.SwizzleException
ConfluenceException
public List getSpacesWithLabel(String labelName) throws SwizzleException, ConfluenceException
Space
s that have been labelled with {{labelName}}.SwizzleException
ConfluenceException
public List getRelatedLabels(String labelName, int maxResults) throws SwizzleException, ConfluenceException
Label
s related to the given label name, with a specified maximum number of results.SwizzleException
ConfluenceException
public List getRelatedLabelsInSpace(String labelName, String spaceKey, int maxResults) throws SwizzleException, ConfluenceException
Label
s related to the given label name for the given {{spaceKey}}, with a specified maximum number of results.SwizzleException
ConfluenceException
public List getLabelsByDetail(String labelName, String namespace, String spaceKey, String owner) throws SwizzleException, ConfluenceException
Label
s matching the given {{labelName}}, {{namespace}}, {{spaceKey}} or {{owner}}.SwizzleException
ConfluenceException
public List getLabelContentById(long labelId) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public List getLabelContentByName(String labelName) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public List getLabelContentByObject(Label labelObject) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public List getSpacesContainingContentWithLabel(String labelName) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public boolean addLabelByName(String labelName, long objectId) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public boolean addLabelById(long labelId, long objectId) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public boolean addLabelByObject(Label labelObject, long objectId) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public boolean addLabelByNameToSpace(String labelName, String spaceKey) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public boolean removeLabelByName(String labelName, long objectId) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public boolean removeLabelById(long labelId, long objectId) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public boolean removeLabelByObject(Label labelObject, long objectId) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
public boolean removeLabelByNameFromSpace(String labelName, String spaceKey) throws SwizzleException, ConfluenceException
SwizzleException
ConfluenceException
Copyright © 2015 The Codehaus Foundation. All rights reserved.