Package org.bsc.confluence

Interface ConfluenceService

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

RESTConfluenceService, XMLRPCConfluenceService

public interface ConfluenceService
extends Closeable

Author:

bsorrentino

Nested Class Summary

Nested Classes

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

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)
default CompletableFuture<Void>	addLabelsByName(ConfluenceService.Model.ID id, List<String> labels)
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)
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)
default CompletableFuture<ConfluenceService.Model.Page>	getOrCreatePage(String spaceKey, String parentPageTitle, String title)
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)
CompletableFuture<Boolean>	removePage(ConfluenceService.Model.ID pageId)
CompletableFuture<Boolean>	removePage(ConfluenceService.Model.Page parentPage, String title)
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()

getPageByTitle

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

removePage

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

removePage

CompletableFuture<Boolean> removePage(ConfluenceService.Model.ID pageId)

createPage

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

getPage

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

getPage

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

addLabelsByName

CompletableFuture<Void> addLabelsByName(ConfluenceService.Model.ID id,
                                        String[] labels)

addLabelsByName

default CompletableFuture<Void> addLabelsByName(ConfluenceService.Model.ID id,
                                                List<String> labels)

storePage

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

storePage

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

getDescendents

CompletableFuture<List<ConfluenceService.Model.PageSummary>> getDescendents(ConfluenceService.Model.ID pageId)

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(ConfluenceService.Model.ID pageId,
                                                                              String name,
                                                                              String version)

Parameters:

pageId -

name -

version -

Returns:

addAttachment

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

Parameters:

page -

attachment -

source -

Returns:

createBlogpost

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

factory method

Parameters:

space - space id

title - post's title

content - post's content

Returns:

addBlogpost

CompletableFuture<ConfluenceService.Model.Blogpost> addBlogpost(ConfluenceService.Model.Blogpost blogpost)

Parameters:

blogpost -

Returns:

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"