Package org.bsc.confluence.rest

Class RESTConfluenceService

java.lang.Object

org.bsc.confluence.rest.AbstractRESTConfluenceService

org.bsc.confluence.rest.RESTConfluenceService

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, ConfluenceService, IdHelper

public class RESTConfluenceService
extends AbstractRESTConfluenceService
implements ConfluenceService

Author:

bosrrentino

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RESTConfluenceService.ContentType

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

Fields inherited from interface org.bsc.confluence.ConfluenceService

connectTimeoutInSeconds, readTimeoutInSeconds, writeTimeoutInSeconds

Constructor Summary

Constructors

Constructor	Description
RESTConfluenceService(java.lang.String url, ConfluenceService.Credentials credentials, SSLCertificateInfo sslInfo)

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletableFuture<ConfluenceService.Model.Attachment>	addAttachment(ConfluenceService.Model.Page page, ConfluenceService.Model.Attachment attachment, java.io.InputStream source)
java.util.concurrent.CompletableFuture<ConfluenceService.Model.Blogpost>	addBlogpost(ConfluenceService.Model.Blogpost blogpost)
java.util.concurrent.CompletableFuture<java.lang.Void>	addLabelsByName(ConfluenceService.Model.ID id, java.lang.String[] labels)
void	close()
ConfluenceService.Model.Blogpost	createBlogpost(java.lang.String space, java.lang.String title, ConfluenceService.Storage content, int version)
java.util.concurrent.CompletableFuture<ConfluenceService.Model.Page>	createPage(ConfluenceService.Model.Page parentPage, java.lang.String title, ConfluenceService.Storage content)
java.util.concurrent.CompletableFuture<ConfluenceService.Model.Page>	createPageByTitle(java.lang.String spaceKey, java.lang.String title, ConfluenceService.Storage content)
java.util.concurrent.CompletableFuture<java.util.Optional<ConfluenceService.Model.Attachment>>	getAttachment(ConfluenceService.Model.ID pageId, java.lang.String name, java.lang.String version)
ConfluenceService.Credentials	getCredentials()
java.util.concurrent.CompletableFuture<java.util.List<ConfluenceService.Model.PageSummary>>	getDescendents(ConfluenceService.Model.ID pageId)
java.util.concurrent.CompletableFuture<java.util.Optional<ConfluenceService.Model.Page>>	getPage(java.lang.String spaceKey, java.lang.String pageTitle)
java.util.concurrent.CompletableFuture<java.util.Optional<ConfluenceService.Model.Page>>	getPage(ConfluenceService.Model.ID pageId)
java.util.concurrent.CompletableFuture<java.util.Optional<? extends ConfluenceService.Model.PageSummary>>	getPageByTitle(ConfluenceService.Model.ID parentPageId, java.lang.String title)
javax.json.JsonObjectBuilder	jsonAddBody(javax.json.JsonObjectBuilder builder, ConfluenceService.Storage storage)
javax.json.JsonObjectBuilder	jsonForCreatingContent(RESTConfluenceService.ContentType type, java.lang.String spaceKey, long parentPageId, java.lang.String title, ConfluenceService.Storage content)
javax.json.JsonObjectBuilder	jsonForCreatingContent(RESTConfluenceService.ContentType type, java.lang.String spaceKey, java.lang.String title, ConfluenceService.Storage content)
ConfluenceService.Model.Attachment	newAttachment()
ConfluenceService.Model.Page	newPage(ConfluenceService.Model.ID id, java.lang.String space, java.lang.String title, int version)
java.util.concurrent.CompletableFuture<java.lang.Boolean>	removePage(ConfluenceService.Model.ID pageId)
java.util.concurrent.CompletableFuture<java.lang.Boolean>	removePage(ConfluenceService.Model.Page parentPage, java.lang.String title)
java.util.concurrent.CompletableFuture<ConfluenceService.Model.Page>	storePage(ConfluenceService.Model.Page page)
java.util.concurrent.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 interface org.bsc.confluence.ConfluenceService

addLabelsByName, getConnectTimeout, getOrCreatePage, getReadTimeout, getWriteTimeout, retry, setConnectTimeouts, setReadTimeouts, setWriteTimeouts

Methods inherited from interface org.bsc.confluence.rest.model.IdHelper

getId

Methods inherited from class java.lang.Object

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

Constructor Detail

RESTConfluenceService

public RESTConfluenceService(java.lang.String url,
                             ConfluenceService.Credentials credentials,
                             SSLCertificateInfo sslInfo)

Parameters:

url -

credentials -

sslInfo -

Method Detail

jsonForCreatingContent

public final javax.json.JsonObjectBuilder jsonForCreatingContent(RESTConfluenceService.ContentType type,
                                                                 java.lang.String spaceKey,
                                                                 java.lang.String title,
                                                                 ConfluenceService.Storage content)

jsonForCreatingContent

public final javax.json.JsonObjectBuilder jsonForCreatingContent(RESTConfluenceService.ContentType type,
                                                                 java.lang.String spaceKey,
                                                                 long parentPageId,
                                                                 java.lang.String title,
                                                                 ConfluenceService.Storage content)

jsonAddBody

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

createPageByTitle

public final java.util.concurrent.CompletableFuture<ConfluenceService.Model.Page> createPageByTitle(java.lang.String spaceKey,
                                                                                                    java.lang.String title,
                                                                                                    ConfluenceService.Storage content)

Parameters:

spaceKey -

title -

Returns:

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

newPage

public ConfluenceService.Model.Page newPage(ConfluenceService.Model.ID id,
                                            java.lang.String space,
                                            java.lang.String title,
                                            int version)

Specified by:

newPage in interface ConfluenceService

getPageByTitle

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

Specified by:

getPageByTitle in interface ConfluenceService

getPage

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

Specified by:

getPage in interface ConfluenceService

Parameters:

pageId -

Returns:

Throws:

java.lang.Exception

getPage

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

Specified by:

getPage in interface ConfluenceService

getDescendents

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

Specified by:

getDescendents in interface ConfluenceService

createPage

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

Specified by:

createPage in interface ConfluenceService

storePage

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

Specified by:

storePage in interface ConfluenceService

storePage

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

Specified by:

storePage in interface ConfluenceService

removePage

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

Specified by:

removePage in interface ConfluenceService

removePage

public java.util.concurrent.CompletableFuture<java.lang.Boolean> removePage(ConfluenceService.Model.ID pageId)

Specified by:

removePage in interface ConfluenceService

addLabelsByName

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

Specified by:

addLabelsByName in interface ConfluenceService

newAttachment

public ConfluenceService.Model.Attachment newAttachment()

Specified by:

newAttachment in interface ConfluenceService

getAttachment

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

Specified by:

getAttachment in interface ConfluenceService

addAttachment

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

Specified by:

addAttachment in interface ConfluenceService

createBlogpost

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

Specified by:

createBlogpost in interface ConfluenceService

addBlogpost

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

Specified by:

addBlogpost in interface ConfluenceService

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException