Package org.rogatio.circlead.control.synchronizer.atlassian

Class ConfluenceClient

java.lang.Object

org.rogatio.circlead.control.synchronizer.atlassian.HttpClient

org.rogatio.circlead.control.synchronizer.atlassian.ConfluenceClient

public class ConfluenceClient
extends HttpClient

The Class ConfluenceClient.

Author:

Matthias Wegner CLOUD

Constructor Summary

Constructors

Constructor	Description
ConfluenceClient()	Instantiates a new confluence client.
ConfluenceClient(java.lang.String baseUrl, java.lang.String user, java.lang.String password, boolean server)	Authentification is enabled with basic auth.

Method Summary

Modifier and Type	Method	Description
SynchronizerResult	addLabel(int pageId, java.lang.String label)	Adds the label.
SynchronizerResult	addLabel(java.lang.String pageId, java.lang.String label)	Adds the label.
SynchronizerResult	addMetadata(int pageId, java.lang.String key, java.lang.String value)	Adds the metadata.
SynchronizerResult	browseContent()	Browse content.
SynchronizerResult	deleteMetadata(int pageId, java.lang.String key)	Delete metadata.
SynchronizerResult	deletePage(int pageId)	Delete page.
SynchronizerResult	deleteVersion(int pageId, int version)	Delete version.
SynchronizerResult	getContentVersions(int id)	Gets the content versions.
SynchronizerResult	getCurrentUser()	Gets the current user.
SynchronizerResult	getMetadata(int pageId)	Gets the metadata.
SynchronizerResult	getPage(int id)	Gets the page.
SynchronizerResult	getPageContent(int id)	Gets the page content.
SynchronizerResult	getPageHistory(int id)	Gets the page history.
SynchronizerResult	getPageSpace(int id)	Gets the page space.
SynchronizerResult	getPageVersion(int id)	Gets the page version.
java.lang.String	getRestPrefix()	Gets the rest prefix.
SynchronizerResult	getSysteminfo()	Gets the systeminfo.
void	loadAttachment(int pageId, java.lang.String filename, java.lang.String targetPath)	Load attachment.
SynchronizerResult	newPage()	New page.
SynchronizerResult	newPage(java.lang.String title, java.lang.String spaceKey, java.lang.String content)	New page.
SynchronizerResult	purgePage(int pageId)	Purge page.
SynchronizerResult	search(java.lang.String cql)	Search for content in confluence.
SynchronizerResult	updateMetadata(int pageId, java.lang.String key, java.lang.String value, int versionNumber, boolean minorEdit)	Update metadata.

Methods inherited from class org.rogatio.circlead.control.synchronizer.atlassian.HttpClient

createCredentials, delete, get, post, put

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfluenceClient

public ConfluenceClient(java.lang.String baseUrl,
                        java.lang.String user,
                        java.lang.String password,
                        boolean server)

Authentification is enabled with basic auth. Check "curl -v http://url-to-atlassian?os_authType=basic If basic auth enabled, the "WWW-Authenticate: Basic realm="protected-area" is returned

Parameters:

baseUrl - Url to the server, could be http or https

user - Plain-Text of user to log in

password - Plain text of password

server - true if dedicated server, false if cloud server

ConfluenceClient

public ConfluenceClient()

Instantiates a new confluence client.

Method Detail

deleteVersion

public SynchronizerResult deleteVersion(int pageId,
                                        int version)

Delete version.

Parameters:

pageId - the page id

version - the version

Returns:

the synchronizer result

loadAttachment

public void loadAttachment(int pageId,
                           java.lang.String filename,
                           java.lang.String targetPath)

Load attachment.

Parameters:

pageId - the page id

filename - the filename

targetPath - the target path

getContentVersions

public SynchronizerResult getContentVersions(int id)

Gets the content versions.

Parameters:

id - the id

Returns:

the content versions

getPageSpace

public SynchronizerResult getPageSpace(int id)

Gets the page space.

Parameters:

id - the id

Returns:

the page space

getPageVersion

public SynchronizerResult getPageVersion(int id)

Gets the page version.

Parameters:

id - the id

Returns:

the page version

getPageHistory

public SynchronizerResult getPageHistory(int id)

Gets the page history.

Parameters:

id - the id

Returns:

the page history

getPage

public SynchronizerResult getPage(int id)

Gets the page.

Parameters:

id - the id

Returns:

the page

getPageContent

public SynchronizerResult getPageContent(int id)

Gets the page content.

Parameters:

id - the id

Returns:

the page content

getCurrentUser

public SynchronizerResult getCurrentUser()

Gets the current user.

Returns:

the current user

getSysteminfo

public SynchronizerResult getSysteminfo()

Gets the systeminfo.

Returns:

the systeminfo

getMetadata

public SynchronizerResult getMetadata(int pageId)

Gets the metadata.

Parameters:

pageId - the page id

Returns:

the metadata

getRestPrefix

public java.lang.String getRestPrefix()

Gets the rest prefix.

Returns:

the rest prefix

purgePage

public SynchronizerResult purgePage(int pageId)

Purge page.

Parameters:

pageId - the page id

Returns:

the synchronizer result

deletePage

public SynchronizerResult deletePage(int pageId)

Delete page.

Parameters:

pageId - the page id

Returns:

the synchronizer result

deleteMetadata

public SynchronizerResult deleteMetadata(int pageId,
                                         java.lang.String key)

Delete metadata.

Parameters:

pageId - the page id

key - the key

Returns:

the synchronizer result

addLabel

public SynchronizerResult addLabel(java.lang.String pageId,
                                   java.lang.String label)

Adds the label.

Parameters:

pageId - the page id

label - the label

Returns:

the synchronizer result

addLabel

public SynchronizerResult addLabel(int pageId,
                                   java.lang.String label)

Adds the label.

Parameters:

pageId - the page id

label - the label

Returns:

the synchronizer result

updateMetadata

public SynchronizerResult updateMetadata(int pageId,
                                         java.lang.String key,
                                         java.lang.String value,
                                         int versionNumber,
                                         boolean minorEdit)

Update metadata.

Parameters:

pageId - the page id

key - the key

value - the value

versionNumber - the version number

minorEdit - the minor edit

Returns:

the synchronizer result

addMetadata

public SynchronizerResult addMetadata(int pageId,
                                      java.lang.String key,
                                      java.lang.String value)

Adds the metadata.

Parameters:

pageId - the page id

key - the key

value - the value

Returns:

the synchronizer result

search

public SynchronizerResult search(java.lang.String cql)

Search for content in confluence.

Parameters:

cql - the cql

Returns:

the synchronizer result

browseContent

public SynchronizerResult browseContent()

Browse content.

Returns:

the synchronizer result

newPage

public SynchronizerResult newPage()

New page.

Returns:

the synchronizer result

newPage

public SynchronizerResult newPage(java.lang.String title,
                                  java.lang.String spaceKey,
                                  java.lang.String content)

New page.

Parameters:

title - the title

spaceKey - the space key

content - the content

Returns:

the synchronizer result