Package org.bsc.confluence.xmlrpc

Class XMLRPCConfluenceService

java.lang.Object

org.bsc.confluence.xmlrpc.XMLRPCConfluenceService

All Implemented Interfaces:

Closeable, AutoCloseable, ConfluenceService

public class XMLRPCConfluenceService
extends Object
implements ConfluenceService

Author:

bsorrentino

Nested Class Summary

Nested classes/interfaces inherited from interface org.bsc.confluence.ConfluenceService

ConfluenceService.Credentials, ConfluenceService.Model, ConfluenceService.Protocol, ConfluenceService.Storage

Field Summary

Fields

Modifier and Type	Field	Description
org.bsc.confluence.xmlrpc.Confluence	connection
ConfluenceService.Credentials	credentials

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	XMLRPCConfluenceService(org.bsc.confluence.xmlrpc.Confluence confluence, ConfluenceService.Credentials credentials)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<ConfluenceService.Model.Attachment>	addAttachment(ConfluenceService.Model.Page page, ConfluenceService.Model.Attachment attachment, InputStream source)
CompletableFuture<ConfluenceService.Model.Blogpost>	addBlogpost(ConfluenceService.Model.Blogpost blogpost)
CompletableFuture<Void>	addLabelsByName(ConfluenceService.Model.ID id, String[] labels)
void	close()
ConfluenceService.Model.Attachment	createAttachment()	factory method
ConfluenceService.Model.Blogpost	createBlogpost(String space, String title, ConfluenceService.Storage content, int version)	factory method
static XMLRPCConfluenceService	createInstanceDetectingVersion(String url, ConfluenceService.Credentials credentials, ConfluenceProxy proxyInfo, SSLCertificateInfo sslInfo)
CompletableFuture<ConfluenceService.Model.Page>	createPage(ConfluenceService.Model.Page parentPage, String title, ConfluenceService.Storage content)
void	exportPage(String url, String spaceKey, String pageTitle, ExportFormat exfmt, File outputFile)
CompletableFuture<Optional<ConfluenceService.Model.Attachment>>	getAttachment(ConfluenceService.Model.ID pageId, String name, String version)
ConfluenceService.Credentials	getCredentials()
CompletableFuture<List<ConfluenceService.Model.PageSummary>>	getDescendents(ConfluenceService.Model.ID pageId)
CompletableFuture<Optional<ConfluenceService.Model.Page>>	getPage(String spaceKey, String pageTitle)
CompletableFuture<Optional<ConfluenceService.Model.Page>>	getPage(ConfluenceService.Model.ID pageId)
CompletableFuture<Optional<? extends ConfluenceService.Model.PageSummary>>	getPageByTitle(ConfluenceService.Model.ID parentPageId, String title)
boolean	logout()
CompletableFuture<Boolean>	removePage(ConfluenceService.Model.ID pageId)
CompletableFuture<Boolean>	removePage(ConfluenceService.Model.Page parentPage, String title)
CompletableFuture<ConfluenceService.Model.Page>	storePage(ConfluenceService.Model.Page page)
CompletableFuture<ConfluenceService.Model.Page>	storePage(ConfluenceService.Model.Page page, ConfluenceService.Storage content)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bsc.confluence.ConfluenceService

addLabelsByName, getOrCreatePage, retry

Field Detail

connection

public final org.bsc.confluence.xmlrpc.Confluence connection

credentials

public final ConfluenceService.Credentials credentials

Constructor Detail

XMLRPCConfluenceService

protected XMLRPCConfluenceService(org.bsc.confluence.xmlrpc.Confluence confluence,
                                  ConfluenceService.Credentials credentials)

Parameters:

confluence -

Method Detail

createInstanceDetectingVersion

public static XMLRPCConfluenceService createInstanceDetectingVersion(String url,
                                                                     ConfluenceService.Credentials credentials,
                                                                     ConfluenceProxy proxyInfo,
                                                                     SSLCertificateInfo sslInfo)
                                                              throws Exception

Parameters:

url -

credentials -

proxyInfo -

sslInfo -

Returns:

Throws:

Exception

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

getCredentials

public ConfluenceService.Credentials getCredentials()

Specified by:

getCredentials in interface ConfluenceService

getPageByTitle

public CompletableFuture<Optional<? extends ConfluenceService.Model.PageSummary>> getPageByTitle(ConfluenceService.Model.ID parentPageId,
                                                                                                 String title)

Specified by:

getPageByTitle in interface ConfluenceService

Parameters:

parentPageId -

title -

Returns:

Throws:

Exception

createPage

public CompletableFuture<ConfluenceService.Model.Page> createPage(ConfluenceService.Model.Page parentPage,
                                                                  String title,
                                                                  ConfluenceService.Storage content)

Specified by:

createPage in interface ConfluenceService

storePage

public CompletableFuture<ConfluenceService.Model.Page> storePage(ConfluenceService.Model.Page page)

Specified by:

storePage in interface ConfluenceService

storePage

public CompletableFuture<ConfluenceService.Model.Page> storePage(ConfluenceService.Model.Page page,
                                                                 ConfluenceService.Storage content)

Specified by:

storePage in interface ConfluenceService

getPage

public CompletableFuture<Optional<ConfluenceService.Model.Page>> getPage(String spaceKey,
                                                                         String pageTitle)

Specified by:

getPage in interface ConfluenceService

getPage

public CompletableFuture<Optional<ConfluenceService.Model.Page>> getPage(ConfluenceService.Model.ID pageId)

Specified by:

getPage in interface ConfluenceService

getDescendents

public CompletableFuture<List<ConfluenceService.Model.PageSummary>> getDescendents(ConfluenceService.Model.ID pageId)

Specified by:

getDescendents in interface ConfluenceService

removePage

public CompletableFuture<Boolean> removePage(ConfluenceService.Model.Page parentPage,
                                             String title)

Specified by:

removePage in interface ConfluenceService

removePage

public CompletableFuture<Boolean> removePage(ConfluenceService.Model.ID pageId)

Specified by:

removePage in interface ConfluenceService

addLabelsByName

public CompletableFuture<Void> addLabelsByName(ConfluenceService.Model.ID id,
                                               String[] labels)

Specified by:

addLabelsByName in interface ConfluenceService

Parameters:

id -

labels -

Returns:

createAttachment

public ConfluenceService.Model.Attachment createAttachment()

Description copied from interface: ConfluenceService

factory method

Specified by:

createAttachment in interface ConfluenceService

Returns:

getAttachment

public CompletableFuture<Optional<ConfluenceService.Model.Attachment>> getAttachment(ConfluenceService.Model.ID pageId,
                                                                                     String name,
                                                                                     String version)

Specified by:

getAttachment in interface ConfluenceService

Returns:

addAttachment

public CompletableFuture<ConfluenceService.Model.Attachment> addAttachment(ConfluenceService.Model.Page page,
                                                                           ConfluenceService.Model.Attachment attachment,
                                                                           InputStream source)

Specified by:

addAttachment in interface ConfluenceService

Returns:

createBlogpost

public ConfluenceService.Model.Blogpost createBlogpost(String space,
                                                       String title,
                                                       ConfluenceService.Storage content,
                                                       int version)

Description copied from interface: ConfluenceService

factory method

Specified by:

createBlogpost in interface ConfluenceService

Parameters:

space - space id

title - post's title

content - post's content

Returns:

addBlogpost

public CompletableFuture<ConfluenceService.Model.Blogpost> addBlogpost(ConfluenceService.Model.Blogpost blogpost)

Specified by:

addBlogpost in interface ConfluenceService

Returns:

logout

public boolean logout()

Returns:

exportPage

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

Specified by:

exportPage in interface ConfluenceService

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Object