org.bsc.confluence

Interface ConfluenceService

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

RESTConfluenceServiceImpl, ScrollVersionsRESTConfluenceService, XMLRPCConfluenceServiceImpl

public interface ConfluenceService
extends Closeable

Author:

bsorrentino

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ConfluenceService.Credentials
static interface	ConfluenceService.Model
static class	ConfluenceService.Protocol
static class	ConfluenceService.Storage

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)
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)
default 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)
default void	removePage(String pageId) Deprecated.
CompletableFuture<Boolean>	removePageAsync(String pageId)
default <T> CompletableFuture<T>	retry(int times, long delay, TimeUnit timeUnit, Optional<CompletableFuture<T>> resultHandler, java.util.function.Supplier<CompletableFuture<T>> action)
CompletableFuture<ConfluenceService.Model.Page>	storePage(ConfluenceService.Model.Page page)
CompletableFuture<ConfluenceService.Model.Page>	storePage(ConfluenceService.Model.Page page, ConfluenceService.Storage content)

Methods inherited from interface java.io.Closeable

close

Method Detail

getCredentials

ConfluenceService.Credentials getCredentials()

findPageByTitle

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

Throws:

Exception

removePage

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

removePageAsync

CompletableFuture<Boolean> removePageAsync(String pageId)

removePage

@Deprecated
default void removePage(String pageId)
                             throws Exception

Deprecated.

Throws:

Exception

createPage

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

getPage

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

getPage

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

addLabelByName

boolean addLabelByName(String label,
                       long id)
                throws Exception

Throws:

Exception

storePage

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

storePage

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

getDescendents

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

Throws:

Exception

exportPage

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

Throws:

Exception

createAttachment

ConfluenceService.Model.Attachment createAttachment()

factory method

Returns:

getAttachment

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

addAttachment

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

getOrCreatePage

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

Parameters:

spaceKey -

parentPageTitle -

title -

Returns:

retry

default <T> CompletableFuture<T> retry(int times,
                                       long delay,
                                       TimeUnit timeUnit,
                                       Optional<CompletableFuture<T>> resultHandler,
                                       java.util.function.Supplier<CompletableFuture<T>> action)

Type Parameters:

T -

Parameters:

times -

delay -

timeUnit -

resultHandler -

action -

Returns:

See Also:

https://gist.github.com/gitplaneta/5065bbba980b2858a55f