Package org.bsc.confluence.rest

Class RESTConfluenceService

java.lang.Object

org.bsc.confluence.rest.AbstractRESTConfluenceService

org.bsc.confluence.rest.RESTConfluenceService

All Implemented Interfaces:

Closeable, 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

Constructor Summary

Constructors

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

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
CompletableFuture<ConfluenceService.Model.Page>	createPage(ConfluenceService.Model.Page parentPage, String title, ConfluenceService.Storage content)
CompletableFuture<ConfluenceService.Model.Page>	createPageByTitle(String spaceKey, 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)
javax.json.JsonObjectBuilder	jsonAddBody(javax.json.JsonObjectBuilder builder, ConfluenceService.Storage storage)
javax.json.JsonObjectBuilder	jsonForCreatingContent(RESTConfluenceService.ContentType type, String spaceKey, long parentPageId, String title, ConfluenceService.Storage content)
javax.json.JsonObjectBuilder	jsonForCreatingContent(RESTConfluenceService.ContentType type, String spaceKey, String title, ConfluenceService.Storage content)
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)
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

addLabelsByName, getOrCreatePage, retry

Constructor Detail

RESTConfluenceService

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

Parameters:

url -

credentials -

sslInfo -

Method Detail

jsonForCreatingContent

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

jsonForCreatingContent

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

jsonAddBody

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

createPageByTitle

public final CompletableFuture<ConfluenceService.Model.Page> createPageByTitle(String spaceKey,
                                                                               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

getPageByTitle

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

Specified by:

getPageByTitle in interface ConfluenceService

getPage

public CompletableFuture<Optional<ConfluenceService.Model.Page>> getPage(ConfluenceService.Model.ID 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 CompletableFuture<List<ConfluenceService.Model.PageSummary>> getDescendents(ConfluenceService.Model.ID pageId)

Specified by:

getDescendents in interface ConfluenceService

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,
                                                                 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

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

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(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:

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException