org.bsc.confluence.rest

Class RESTConfluenceServiceImpl

java.lang.Object

org.bsc.confluence.rest.AbstractRESTConfluenceService

org.bsc.confluence.rest.RESTConfluenceServiceImpl

All Implemented Interfaces:

Closeable, AutoCloseable, ConfluenceService

public class RESTConfluenceServiceImpl
extends AbstractRESTConfluenceService
implements ConfluenceService

Author:

bosrrentino

See Also:

https://docs.atlassian.com/confluence/REST/latest/

Nested Class Summary

Nested classes/interfaces inherited from class org.bsc.confluence.rest.AbstractRESTConfluenceService

AbstractRESTConfluenceService.ServiceException

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

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

Field Summary

Fields inherited from class org.bsc.confluence.rest.AbstractRESTConfluenceService

client

Constructor Summary

Constructors

Constructor and Description
RESTConfluenceServiceImpl(String url, ConfluenceService.Credentials credentials, SSLCertificateInfo sslInfo)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<ConfluenceService.Model.Attachment>	addAttachment(ConfluenceService.Model.Page page, ConfluenceService.Model.Attachment attachment, InputStream source)
boolean	addLabelByName(String label, long id)
void	close()
ConfluenceService.Model.Attachment	createAttachment() factory method
CompletableFuture<ConfluenceService.Model.Page>	createPage(ConfluenceService.Model.Page parentPage, String title)
void	exportPage(String url, String spaceKey, String pageTitle, ExportFormat exfmt, File outputFile)
ConfluenceService.Model.PageSummary	findPageByTitle(String parentPageId, String title)
CompletableFuture<Optional<ConfluenceService.Model.Attachment>>	getAttachment(String pageId, String name, String version)
ConfluenceService.Credentials	getCredentials()
List<ConfluenceService.Model.PageSummary>	getDescendents(String pageId)
CompletableFuture<Optional<ConfluenceService.Model.Page>>	getPage(String pageId)
CompletableFuture<Optional<ConfluenceService.Model.Page>>	getPage(String spaceKey, String pageTitle)
javax.json.JsonObjectBuilder	jsonAddBody(javax.json.JsonObjectBuilder builder, ConfluenceService.Storage storage)
javax.json.JsonObjectBuilder	jsonForCreatingPage(String spaceKey, int parentPageId, String title)
javax.json.JsonObjectBuilder	jsonForCreatingPage(String spaceKey, String title)
CompletableFuture<Boolean>	removePage(ConfluenceService.Model.Page parentPage, String title)
CompletableFuture<Boolean>	removePageAsync(String pageId)
CompletableFuture<ConfluenceService.Model.Page>	storePage(ConfluenceService.Model.Page page)
CompletableFuture<ConfluenceService.Model.Page>	storePage(ConfluenceService.Model.Page page, ConfluenceService.Storage content)
protected okhttp3.HttpUrl.Builder	urlBuilder()

Methods inherited from class org.bsc.confluence.rest.AbstractRESTConfluenceService

addAttachment, addLabels, childrenPages, createPage, debugBody, deletePageById, descendantPages, findPage, findPageById, findPages, fromRequest, fromRequestAsync, fromUrlDELETE, fromUrlGET, fromUrlPOST, fromUrlPUT, getAttachment, getAttachments, mapToObject, mapToStream, updatePage

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bsc.confluence.ConfluenceService

getOrCreatePage, removePage, retry

Constructor Detail

RESTConfluenceServiceImpl

public RESTConfluenceServiceImpl(String url,
                                 ConfluenceService.Credentials credentials,
                                 SSLCertificateInfo sslInfo)

Parameters:

url -

credentials -

sslInfo -

Method Detail

jsonForCreatingPage

public final javax.json.JsonObjectBuilder jsonForCreatingPage(String spaceKey,
                                                              String title)

jsonForCreatingPage

public final javax.json.JsonObjectBuilder jsonForCreatingPage(String spaceKey,
                                                              int parentPageId,
                                                              String title)

jsonAddBody

public final javax.json.JsonObjectBuilder jsonAddBody(javax.json.JsonObjectBuilder builder,
                                                      ConfluenceService.Storage storage)

urlBuilder

protected okhttp3.HttpUrl.Builder urlBuilder()

Specified by:

urlBuilder in class AbstractRESTConfluenceService

Returns:

getCredentials

public ConfluenceService.Credentials getCredentials()

Specified by:

getCredentials in interface ConfluenceService

Specified by:

getCredentials in class AbstractRESTConfluenceService

findPageByTitle

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

Specified by:

findPageByTitle in interface ConfluenceService

Throws:

Exception

createPage

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

Specified by:

createPage in interface ConfluenceService

getPage

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

Specified by:

getPage in interface ConfluenceService

Parameters:

pageId -

Returns:

Throws:

Exception

getPage

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

Specified by:

getPage in interface ConfluenceService

getDescendents

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

Specified by:

getDescendents in interface ConfluenceService

Throws:

Exception

storePage

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

Specified by:

storePage in interface ConfluenceService

storePage

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

Specified by:

storePage in interface ConfluenceService

addLabelByName

public boolean addLabelByName(String label,
                              long id)
                       throws Exception

Specified by:

addLabelByName in interface ConfluenceService

Throws:

Exception

exportPage

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

Specified by:

exportPage in interface ConfluenceService

Throws:

Exception

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(String pageId,
                                                                                     String name,
                                                                                     String version)

Specified by:

getAttachment in interface ConfluenceService

addAttachment

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

Specified by:

addAttachment in interface ConfluenceService

removePage

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

Specified by:

removePage in interface ConfluenceService

removePageAsync

public CompletableFuture<Boolean> removePageAsync(String pageId)

Specified by:

removePageAsync in interface ConfluenceService

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException