org.bsc.confluence

Interface ConfluenceService

All Known Implementing Classes:

RESTConfluenceServiceImpl, XMLRPCConfluenceServiceImpl

public interface ConfluenceService

Author:

bsorrentino

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ConfluenceService.Credentials
static interface	ConfluenceService.Model
static class	ConfluenceService.Protocol
static class	ConfluenceService.Storage

Method Summary

Modifier and Type	Method and Description
ConfluenceService.Model.Attachment	addAttachment(ConfluenceService.Model.Page page, ConfluenceService.Model.Attachment attachment, InputStream source)
boolean	addLabelByName(String label, long id)
void	call(rx.functions.Action1<ConfluenceService> task)
ConfluenceService.Model.Attachment	createAttachment() factory method
void	exportPage(String url, String spaceKey, String pageTitle, ExportFormat exfmt, File outputFile)
ConfluenceService.Model.PageSummary	findPageByTitle(String parentPageId, String title)
ConfluenceService.Model.Attachment	getAttachment(String pageId, String name, String version)
ConfluenceService.Credentials	getCredentials()
List<ConfluenceService.Model.PageSummary>	getDescendents(String pageId)
ConfluenceService.Model.Page	getOrCreatePage(ConfluenceService.Model.Page parentPage, String title)
ConfluenceService.Model.Page	getOrCreatePage(String spaceKey, String parentPageTitle, String title)
ConfluenceService.Model.Page	getPage(String pageId)
ConfluenceService.Model.Page	getPage(String spaceKey, String pageTitle)
boolean	removePage(ConfluenceService.Model.Page parentPage, String title)
void	removePage(String pageId)
ConfluenceService.Model.Page	storePage(ConfluenceService.Model.Page page)
ConfluenceService.Model.Page	storePage(ConfluenceService.Model.Page page, ConfluenceService.Storage content)

Method Detail

getCredentials

ConfluenceService.Credentials getCredentials()

findPageByTitle

ConfluenceService.Model.PageSummary findPageByTitle(String parentPageId,
                                                    String title)
                                             throws Exception

Throws:

Exception

removePage

boolean removePage(ConfluenceService.Model.Page parentPage,
                   String title)
            throws Exception

Throws:

Exception

removePage

void removePage(String pageId)
         throws Exception

Throws:

Exception

getOrCreatePage

ConfluenceService.Model.Page getOrCreatePage(String spaceKey,
                                             String parentPageTitle,
                                             String title)
                                      throws Exception

Throws:

Exception

getOrCreatePage

ConfluenceService.Model.Page getOrCreatePage(ConfluenceService.Model.Page parentPage,
                                             String title)
                                      throws Exception

Throws:

Exception

getPage

ConfluenceService.Model.Page getPage(String pageId)
                              throws Exception

Throws:

Exception

getPage

ConfluenceService.Model.Page getPage(String spaceKey,
                                     String pageTitle)
                              throws Exception

Throws:

Exception

addLabelByName

boolean addLabelByName(String label,
                       long id)
                throws Exception

Throws:

Exception

storePage

ConfluenceService.Model.Page storePage(ConfluenceService.Model.Page page,
                                       ConfluenceService.Storage content)
                                throws Exception

Throws:

Exception

storePage

ConfluenceService.Model.Page storePage(ConfluenceService.Model.Page page)
                                throws Exception

Throws:

Exception

getDescendents

List<ConfluenceService.Model.PageSummary> getDescendents(String pageId)
                                                  throws Exception

Throws:

Exception

exportPage

void exportPage(String url,
                String spaceKey,
                String pageTitle,
                ExportFormat exfmt,
                File outputFile)
         throws Exception

Throws:

Exception

call

void call(rx.functions.Action1<ConfluenceService> task)
   throws Exception

Throws:

Exception

createAttachment

ConfluenceService.Model.Attachment createAttachment()

factory method

Returns:

getAttachment

ConfluenceService.Model.Attachment getAttachment(String pageId,
                                                 String name,
                                                 String version)
                                          throws Exception

Throws:

Exception

addAttachment

ConfluenceService.Model.Attachment addAttachment(ConfluenceService.Model.Page page,
                                                 ConfluenceService.Model.Attachment attachment,
                                                 InputStream source)
                                          throws Exception

Throws:

Exception