com.myyearbook.hudson.plugins.confluence

Class ConfluenceSession

java.lang.Object

com.myyearbook.hudson.plugins.confluence.ConfluenceSession

public class ConfluenceSession
extends Object

Connection to Confluence

Author:

Joe Hansche jhansche@myyearbook.com

Method Summary

Modifier and Type	Method and Description
com.atlassian.confluence.api.model.pagination.PageResponse<com.atlassian.confluence.api.model.content.Content>	addAttachment(long pageId, VirtualFile file, String contentType, String comment) Attach the file
boolean	addLabels(long id, String labels) Add's labels to content, removing duplicates.
com.atlassian.confluence.api.model.content.Content	createContent(com.atlassian.confluence.api.model.content.Content content)
List<com.atlassian.confluence.api.model.content.Content>	getAttachments(long pageId) Get all attachments for a page
Optional<com.atlassian.confluence.api.model.content.Content>	getContent(String contentId) Get a PageContent by Page key
Optional<com.atlassian.confluence.api.model.content.Content>	getContent(String spaceKey, String pageTitle, boolean expanded) Get a Content by spaceKey and Page title
com.atlassian.confluence.api.model.people.Person	getCurrentUser()
com.atlassian.confluence.api.model.pagination.PageResponse<com.atlassian.confluence.api.model.content.Label>	getLabels(long id)
com.atlassian.fugue.Option<com.atlassian.confluence.api.model.content.Space>	getSpace(String spaceKey) Get a Space by key name
void	removeAttachment(com.atlassian.confluence.api.model.content.Content attachment) Remove attachment
static com.atlassian.confluence.api.model.Expansion[]	toExpansionsArray(String... expansions)
com.atlassian.confluence.api.model.content.Content	updateContent(com.atlassian.confluence.api.model.content.Content content)

Methods inherited from class java.lang.Object

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

Method Detail

getSpace

public com.atlassian.fugue.Option<com.atlassian.confluence.api.model.content.Space> getSpace(String spaceKey)
                                                                                      throws com.atlassian.confluence.api.service.exceptions.ServiceException

Get a Space by key name

Parameters:

spaceKey -

Returns:

Promise instance

Throws:

com.atlassian.confluence.api.service.exceptions.ServiceException

getContent

public Optional<com.atlassian.confluence.api.model.content.Content> getContent(String contentId)
                                                                        throws com.atlassian.confluence.api.service.exceptions.ServiceException

Get a PageContent by Page key

Parameters:

contentId -

Returns:

Optional instance

Throws:

com.atlassian.confluence.api.service.exceptions.ServiceException

getContent

public Optional<com.atlassian.confluence.api.model.content.Content> getContent(String spaceKey,
                                                                               String pageTitle,
                                                                               boolean expanded)
                                                                        throws com.atlassian.confluence.api.service.exceptions.ServiceException

Get a Content by spaceKey and Page title

Parameters:

spaceKey -

pageTitle -

Returns:

Optional instance

Throws:

com.atlassian.confluence.api.service.exceptions.ServiceException

createContent

public com.atlassian.confluence.api.model.content.Content createContent(com.atlassian.confluence.api.model.content.Content content)
                                                                 throws com.atlassian.confluence.api.service.exceptions.ServiceException

Throws:

com.atlassian.confluence.api.service.exceptions.ServiceException

updateContent

public com.atlassian.confluence.api.model.content.Content updateContent(com.atlassian.confluence.api.model.content.Content content)
                                                                 throws com.atlassian.confluence.api.service.exceptions.ServiceException

Throws:

com.atlassian.confluence.api.service.exceptions.ServiceException

getAttachments

public List<com.atlassian.confluence.api.model.content.Content> getAttachments(long pageId)
                                                                        throws com.atlassian.confluence.api.service.exceptions.ServiceException

Get all attachments for a page

Parameters:

pageId -

Returns:

List of Content

Throws:

com.atlassian.confluence.api.service.exceptions.ServiceException

addAttachment

public com.atlassian.confluence.api.model.pagination.PageResponse<com.atlassian.confluence.api.model.content.Content> addAttachment(long pageId,
                                                                                                                                    VirtualFile file,
                                                                                                                                    String contentType,
                                                                                                                                    String comment)
                                                                                                                             throws com.atlassian.confluence.api.service.exceptions.ServiceException

Attach the file

Parameters:

pageId -

file -

contentType -

comment -

Returns:

PageResponse instance that was created on the server

Throws:

com.atlassian.confluence.api.service.exceptions.ServiceException

removeAttachment

public void removeAttachment(com.atlassian.confluence.api.model.content.Content attachment)
                      throws com.atlassian.confluence.api.service.exceptions.ServiceException

Remove attachment

Parameters:

attachment -

Throws:

com.atlassian.confluence.api.service.exceptions.ServiceException

addLabels

public boolean addLabels(long id,
                         String labels)
                  throws com.atlassian.confluence.api.service.exceptions.ServiceException

Add's labels to content, removing duplicates.

Parameters:

labels - comma separated labels string.

Returns:

boolean success status.

Throws:

com.atlassian.confluence.api.service.exceptions.ServiceException

getLabels

public com.atlassian.confluence.api.model.pagination.PageResponse<com.atlassian.confluence.api.model.content.Label> getLabels(long id)

getCurrentUser

public com.atlassian.confluence.api.model.people.Person getCurrentUser()

toExpansionsArray

public static com.atlassian.confluence.api.model.Expansion[] toExpansionsArray(String... expansions)