org.bsc.confluence.rest.scrollversions

Class ScrollVersionsRESTConfluenceService

java.lang.Object

org.bsc.confluence.rest.scrollversions.ScrollVersionsRESTConfluenceService

All Implemented Interfaces:

Closeable, AutoCloseable, ConfluenceService

public class ScrollVersionsRESTConfluenceService
extends Object
implements ConfluenceService

Implements a ConfluenceService with Scroll Versions support via REST APIs.

Author:

Nicola Lagnena

See Also:

Scroll Versions API resources

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ScrollVersionsRESTConfluenceService.ScrollVersionsException

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 and Description
static String	CHANGE_TYPE_MODIFY_QUERY_PARAM

Constructor Summary

Constructors

Constructor and Description
ScrollVersionsRESTConfluenceService(String confluenceUrl, String scrollVersionName, ConfluenceService.Credentials credentials, SSLCertificateInfo sslCertificateInfo)

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<ConfluenceService.Model.Page>	getOrCreatePage(String spaceKey, String parentPageTitle, String title)
CompletableFuture<Optional<ConfluenceService.Model.Page>>	getPage(String pageId)
CompletableFuture<Optional<ConfluenceService.Model.Page>>	getPage(String spaceKey, String pageTitle)
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)

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

removePage, retry

Field Detail

CHANGE_TYPE_MODIFY_QUERY_PARAM

public static final String CHANGE_TYPE_MODIFY_QUERY_PARAM

See Also:

Constant Field Values

Constructor Detail

ScrollVersionsRESTConfluenceService

public ScrollVersionsRESTConfluenceService(String confluenceUrl,
                                           String scrollVersionName,
                                           ConfluenceService.Credentials credentials,
                                           SSLCertificateInfo sslCertificateInfo)

Method Detail

getCredentials

public ConfluenceService.Credentials getCredentials()

Specified by:

getCredentials in interface ConfluenceService

findPageByTitle

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

Specified by:

findPageByTitle in interface ConfluenceService

Throws:

Exception

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

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

getPage

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

Specified by:

getPage in interface ConfluenceService

addLabelByName

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

Specified by:

addLabelByName 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

getDescendents

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

Specified by:

getDescendents 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

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

getOrCreatePage

public CompletableFuture<ConfluenceService.Model.Page> getOrCreatePage(String spaceKey,
                                                                       String parentPageTitle,
                                                                       String title)

Specified by:

getOrCreatePage in interface ConfluenceService

Returns: