| Package | Description |
|---|---|
| org.codehaus.swizzle.confluence |
| Modifier and Type | Class and Description |
|---|---|
class |
ConfluenceException
This exception is thrown to signal an error on the server.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
Confluence.addAnonymousPermissionsToSpace(List permissions,
String spaceKey)
Give anonymous users the permissions {{permissions}} on the space with the key {{spaceKey}}.
|
boolean |
Confluence.addAnonymousPermissionToSpace(String permission,
String spaceKey)
Give anonymous users the permission {{permission}} on the space with the key {{spaceKey}}.
|
Attachment |
Confluence.addAttachment(long contentId,
Attachment attachment,
byte[] attachmentData)
add a new attachment to a content entity object.
|
org.codehaus.swizzle.confluence.Comment |
Confluence.addComment(org.codehaus.swizzle.confluence.Comment comment)
adds a comment to the page.
|
void |
Confluence.addGroup(String group)
add a new group
|
boolean |
Confluence.addLabelById(long labelId,
long objectId)
Adds a label with the given ID to the object with the given ContentEntityObject ID.
|
boolean |
Confluence.addLabelByName(String labelName,
long objectId)
Adds a label to the object with the given ContentEntityObject ID.
|
boolean |
Confluence.addLabelByNameToSpace(String labelName,
String spaceKey)
Adds a label to the object with the given ContentEntityObject ID.
|
boolean |
Confluence.addLabelByObject(Label labelObject,
long objectId)
Adds the given label object to the object with the given ContentEntityObject ID.
|
boolean |
Confluence.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 |
Confluence.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}}.
|
org.codehaus.swizzle.confluence.Space |
Confluence.addSpace(org.codehaus.swizzle.confluence.Space space)
create a new space, passing in name, key and description.
|
void |
Confluence.addUser(org.codehaus.swizzle.confluence.User user,
String password)
add a new user with the given password
|
void |
Confluence.addUserToGroup(String username,
String groupname)
add a user to a particular group
|
boolean |
Confluence.changeMyPassword(String oldPass,
String newPass)
changes the current user's password
|
boolean |
Confluence.changeUserPassword(String username,
String newPass)
changes the specified user's password
|
static Confluence |
ConfluenceFactory.createInstanceDetectingVersion(String url,
Confluence.ProxyInfo proxyInfo,
String login,
String password) |
boolean |
Confluence.deactivateUser(String username)
deactivates the specified user
|
boolean |
Confluence.editUser(org.codehaus.swizzle.confluence.User remoteUser)
edits the details of a user
|
String |
Confluence.exportSite(boolean exportAttachments)
exports a Confluence instance and returns a String holding the URL for the download.
|
String |
Confluence.exportSpace(String spaceKey,
String exportType)
exports a space and returns a String holding the URL for the download.
|
List |
Confluence.getActiveUsers(boolean viewAll)
returns all registered users as Strings
|
List |
Confluence.getAncestors(String pageId)
returns all the ancestors (as
PageSummary instances) of this page (parent, parent's parent etc). |
Attachment |
Confluence.getAttachment(String pageId,
String fileName,
String versionNumber)
get information about an attachment.
|
byte[] |
Confluence.getAttachmentData(String pageId,
String fileName,
String versionNumber)
get the contents of an attachment.
|
List |
Confluence.getAttachments(String pageId)
returns all the
Attachments for this page (useful to point users to download them with the full file download URL returned). |
List |
Confluence.getBlogEntries(String spaceKey)
returns all the
BlogEntrySummary instances in the space. |
org.codehaus.swizzle.confluence.BlogEntry |
Confluence.getBlogEntry(String pageId)
returns a single BlogEntry.
|
org.codehaus.swizzle.confluence.BlogEntry |
Confluence.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 |
Confluence.getChildren(String pageId)
returns all the direct children (as
PageSummary instances) of this page. |
org.codehaus.swizzle.confluence.Comment |
Confluence.getComment(String commentId)
returns an individual comment.
|
List |
Confluence.getComments(String pageId)
returns all the
Comments for this page. |
List |
Confluence.getDescendents(String pageId)
returns all the descendents (as
PageSummary instances) of this page (children, children's children etc). |
List |
Confluence.getGroups()
gets all groups as a list of
Strings |
List |
Confluence.getLabelContentById(long labelId)
Returns the content for a given label ID
|
List |
Confluence.getLabelContentByName(String labelName)
Returns the content for a given label name.
|
List |
Confluence.getLabelContentByObject(Label labelObject)
Returns the content for a given Label object.
|
List |
Confluence.getLabelsByDetail(String labelName,
String namespace,
String spaceKey,
String owner)
Retrieves the
Labels matching the given {{labelName}}, {{namespace}}, {{spaceKey}} or {{owner}}. |
List |
Confluence.getLabelsById(long objectId)
Returns all
Labels for the given ContentEntityObject ID |
List |
Confluence.getMostPopularLabels(int maxCount)
Returns the most popular
Labels for the Confluence instance, with a specified maximum number. |
List |
Confluence.getMostPopularLabelsInSpace(String spaceKey,
int maxCount)
Returns the most popular
Labels for the given {{spaceKey}}, with a specified maximum number of results. |
org.codehaus.swizzle.confluence.Page |
Confluence.getPage(org.codehaus.swizzle.confluence.PageSummary summary)
returns a single Page
|
org.codehaus.swizzle.confluence.Page |
Confluence.getPage(String pageId) |
org.codehaus.swizzle.confluence.Page |
Confluence.getPage(String spaceKey,
String pageTitle)
returns a single Page
|
List |
Confluence.getPageHistory(String pageId)
returns all the
PageHistorySummary instances - useful for looking up the previous versions of a page, and who changed them. |
List |
Confluence.getPagePermissions(String pageId)
Returns a List of
Permissions representing the permissions set on the given page. |
List |
Confluence.getPages(String spaceKey)
returns all the
PageSummary instances in the space. |
List |
Confluence.getPermissions(String spaceKey)
Returns a List of
Permissions representing the permissions the current user has for this space (a list of "view", "modify", "comment" and / or "admin"). |
List |
Confluence.getPermissionsForUser(String spaceKey,
String userName)
Returns a List of
Permissions representing the permissions the given user has for this space. |
List |
Confluence.getRecentlyUsedLabels(int maxResults)
Returns the recently used
Labels for the Confluence instance, with a specified maximum number of results. |
List |
Confluence.getRecentlyUsedLabelsInSpace(String spaceKey,
int maxResults)
Returns the recently used
Labels for the given {{spaceKey}}, with a specified maximum number of results. |
List |
Confluence.getRelatedLabels(String labelName,
int maxResults)
Returns the
Labels related to the given label name, with a specified maximum number of results. |
List |
Confluence.getRelatedLabelsInSpace(String labelName,
String spaceKey,
int maxResults)
Returns the
Labels related to the given label name for the given {{spaceKey}}, with a specified maximum number of results. |
org.codehaus.swizzle.confluence.ServerInfo |
Confluence.getServerInfo()
retrieve some basic information about the server being connected to.
|
org.codehaus.swizzle.confluence.Space |
Confluence.getSpace(String spaceKey)
returns a single Space.
|
List |
Confluence.getSpaceLevelPermissions()
returns List of the space level
Permissions which may be granted. |
List |
Confluence.getSpaces()
returns all the
SpaceSummary instances that the current user can see. |
List |
Confluence.getSpacesContainingContentWithLabel(String labelName)
Returns all Spaces that have content labelled with {{labelName}}.
|
List |
Confluence.getSpacesWithLabel(String labelName)
Returns an array of
Spaces that have been labelled with {{labelName}}. |
org.codehaus.swizzle.confluence.User |
Confluence.getUser(String username)
get a single user
|
List |
Confluence.getUserGroups(String username)
get a user's current groups as a list of
Strings |
org.codehaus.swizzle.confluence.UserInformation |
Confluence.getUserInformation(String username)
Retrieves user information
|
boolean |
Confluence.hasGroup(String groupname)
checks if a group exists
|
boolean |
Confluence.hasUser(String username)
checks if a user exists
|
void |
Confluence.login(String username,
String password) |
boolean |
Confluence.logout()
remove this token from the list of logged in tokens.
|
boolean |
Confluence.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 |
Confluence.reactivateUser(String username)
reactivates the specified user
|
boolean |
Confluence.removeAllPermissionsForGroup(String groupname)
Remove all the global and space level permissions for {{groupname}}.
|
boolean |
Confluence.removeAnonymousPermissionFromSpace(String permission,
String spaceKey)
Remove the permission {{permission} from anonymous users on the space with the key {{spaceKey}}.
|
boolean |
Confluence.removeAttachment(String contentId,
String fileName)
remove an attachment from a content entity object.
|
boolean |
Confluence.removeComment(String commentId)
removes a comment from the page.
|
boolean |
Confluence.removeGroup(String groupname,
String defaultGroupName)
remove a group.
|
boolean |
Confluence.removeLabelById(long labelId,
long objectId)
Removes the label with the given ID from the object with the given ContentEntityObject ID.
|
boolean |
Confluence.removeLabelByName(String labelName,
long objectId)
Removes the given label from the object with the given ContentEntityObject ID.
|
boolean |
Confluence.removeLabelByNameFromSpace(String labelName,
String spaceKey)
Removes the given label from the given {{spaceKey}}.
|
boolean |
Confluence.removeLabelByObject(Label labelObject,
long objectId)
Removes the given label object from the object with the given ContentEntityObject ID.
|
void |
Confluence.removePage(String pageId)
remove a page
|
boolean |
Confluence.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 |
Confluence.removeSpace(String spaceKey)
remove a space completely.
|
boolean |
Confluence.removeUser(String username)
delete a user.
|
boolean |
Confluence.removeUserFromGroup(String username,
String groupname)
remove a user from a group.
|
String |
Confluence.renderContent(org.codehaus.swizzle.confluence.PageSummary page) |
String |
Confluence.renderContent(String spaceKey,
String pageId) |
String |
Confluence.renderContent(String spaceKey,
String pageId,
String content)
returns the HTML rendered content for this page.
|
String |
Confluence.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 |
Confluence.search(String query,
int maxResults)
return a list of
SearchResults which match a given search query (including pages and other content types). |
List |
Confluence.search(String query,
Map parameters,
int maxResults)
Returns a list of
SearchResults like the previous search, but you can optionally limit your search by adding parameters to the parameter map. |
boolean |
Confluence.setUserInformation(org.codehaus.swizzle.confluence.UserInformation userInfo)
updates user information
|
org.codehaus.swizzle.confluence.BlogEntry |
Confluence.storeBlogEntry(org.codehaus.swizzle.confluence.BlogEntry entry)
add or update a blog entry.
|
org.codehaus.swizzle.confluence.Page |
Confluence.storePage(org.codehaus.swizzle.confluence.Page page)
add or update a page.
|
Copyright © 2013. All rights reserved.