org.apache.manifoldcf.crawler.connectors.confluence.v6.client

Class ConfluenceClient

java.lang.Object

org.apache.manifoldcf.crawler.connectors.confluence.v6.client.ConfluenceClient

public class ConfluenceClient
extends java.lang.Object

ConfluenceClient class

This class is intended to be used to interact with Confluence REST API

There are some methods that make use of the Confluence JSON-RPC 2.0 API, but until all the methods are ported to the new REST API, we will have to use them to leverage all the features provided by Confluence

Author:

Julien Massiera & Antonio David Perez Morales;

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	proxyHost
protected java.lang.String	proxyPassword
protected int	proxyPort
protected java.lang.String	proxyProtocol
protected java.lang.String	proxyUsername

Constructor Summary

Constructors

Constructor and Description

ConfluenceClient(java.lang.String protocol, java.lang.String host, java.lang.Integer port, java.lang.String path, java.lang.String username, java.lang.String password, int socketTimeout, int connectionTimeout, java.lang.String proxyUsername, java.lang.String proxyPassword, java.lang.String proxyProtocol, java.lang.String proxyHost, int proxyPort) Creates a new client instance using the given parameters

Method Summary

Modifier and Type	Method and Description
boolean	check() Check method used to test if Confluence instance is up and running
boolean	checkAuth() Check method used to test if Confluence instance is up and running when using Authority connector (JSON-RPC API)
void	close() Close the client.
Attachment	getAttachment(java.lang.String attachmentId) Gets a specific attachment contained in the specific page
java.util.List<Label>	getLabels(java.lang.String pageId) Get the labels of a specific page
Page	getPage(java.lang.String pageId) Get a Confluence page identified by its id
ConfluenceResponse<Attachment>	getPageAttachments(java.lang.String pageId) Get the attachments of the given page
ConfluenceResponse<Attachment>	getPageAttachments(java.lang.String pageId, int start, int limit) Get the attachments of the given page using pagination
ConfluenceResponse<Page>	getPageChilds(int start, int limit, java.lang.String pageId)
ConfluenceRestrictionsResponse<Restrictions>	getPageReadRestrictions(int start, int limit, java.lang.String pageId)
ConfluenceResponse<Page>	getPages(int start, int limit, com.google.common.base.Optional<java.lang.String> space, com.google.common.base.Optional<java.lang.String> pageType) Get a list of Confluence pages using pagination
ConfluenceResponse<Page>	getSpaceRootPages(int start, int limit, java.lang.String space, com.google.common.base.Optional<java.lang.String> pageType)
ConfluenceResponse<Space>	getSpaces(int start, int limit, com.google.common.base.Optional<java.lang.String> spaceType, com.google.common.base.Optional<java.lang.String> spaceStatus)
ConfluenceUser	getUserAuthorities(java.lang.String username)
ConfluenceResponse<Group>	getUserGroups(int start, int limit, java.lang.String username)

Methods inherited from class java.lang.Object

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

Field Detail

proxyUsername

protected java.lang.String proxyUsername

proxyPassword

protected java.lang.String proxyPassword

proxyProtocol

protected java.lang.String proxyProtocol

proxyHost

protected java.lang.String proxyHost

proxyPort

protected int proxyPort

Constructor Detail

ConfluenceClient

public ConfluenceClient(java.lang.String protocol,
                        java.lang.String host,
                        java.lang.Integer port,
                        java.lang.String path,
                        java.lang.String username,
                        java.lang.String password,
                        int socketTimeout,
                        int connectionTimeout,
                        java.lang.String proxyUsername,
                        java.lang.String proxyPassword,
                        java.lang.String proxyProtocol,
                        java.lang.String proxyHost,
                        int proxyPort)
                 throws org.apache.manifoldcf.core.interfaces.ManifoldCFException

Creates a new client instance using the given parameters

Parameters:

protocol - the protocol

host - the host

port - the port

path - the path to Confluence instance

username - the username used to make the requests. Null or empty to use anonymous user

password - the password

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

Method Detail

close

public void close()

Close the client. No further requests can be done

check

public boolean check()
              throws java.lang.Exception

Check method used to test if Confluence instance is up and running

Returns:

a Boolean indicating whether the Confluence instance is alive or not

Throws:

java.lang.Exception

checkAuth

public boolean checkAuth()
                  throws java.lang.Exception

Check method used to test if Confluence instance is up and running when using Authority connector (JSON-RPC API)

This method will be deleted when all JSON-RPC methods are available through the REST API

Returns:

a Boolean indicating whether the Confluence instance is alive or not

Throws:

java.lang.Exception

getSpaceRootPages

public ConfluenceResponse<Page> getSpaceRootPages(int start,
                                                  int limit,
                                                  java.lang.String space,
                                                  com.google.common.base.Optional<java.lang.String> pageType)
                                           throws java.lang.Exception

Parameters:

start -

limit -

space -

pageType -

Returns:

Throws:

java.lang.Exception

getPageChilds

public ConfluenceResponse<Page> getPageChilds(int start,
                                              int limit,
                                              java.lang.String pageId)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getPages

public ConfluenceResponse<Page> getPages(int start,
                                         int limit,
                                         com.google.common.base.Optional<java.lang.String> space,
                                         com.google.common.base.Optional<java.lang.String> pageType)
                                  throws java.lang.Exception

Get a list of Confluence pages using pagination

Parameters:

start - The start value to get pages from

limit - The number of pages to get from start

Returns:

a ConfluenceResponse containing the result pages and some pagination values

Throws:

java.lang.Exception

getPageAttachments

public ConfluenceResponse<Attachment> getPageAttachments(java.lang.String pageId)
                                                  throws java.lang.Exception

Get the attachments of the given page

Parameters:

pageId - the page id

Returns:

a ConfluenceResponse instance containing the attachment results and some pagination values

Throws:

java.lang.Exception

getPageAttachments

public ConfluenceResponse<Attachment> getPageAttachments(java.lang.String pageId,
                                                         int start,
                                                         int limit)
                                                  throws java.lang.Exception

Get the attachments of the given page using pagination

Parameters:

pageId - the page id

start - The start value to get attachments from

limit - The number of attachments to get from start

Returns:

a ConfluenceResponse instance containing the attachment results and some pagination values

Throws:

java.lang.Exception

getAttachment

public Attachment getAttachment(java.lang.String attachmentId)
                         throws java.lang.Exception

Gets a specific attachment contained in the specific page

Parameters:

attachmentId -

Returns:

the Attachment instance

Throws:

java.lang.Exception

getPage

public Page getPage(java.lang.String pageId)
             throws java.lang.Exception

Get a Confluence page identified by its id

Parameters:

pageId - the page id

Returns:

the Confluence page

Throws:

java.lang.Exception

getPageReadRestrictions

public ConfluenceRestrictionsResponse<Restrictions> getPageReadRestrictions(int start,
                                                                            int limit,
                                                                            java.lang.String pageId)
                                                                     throws java.lang.Exception

Throws:

java.lang.Exception

getLabels

public java.util.List<Label> getLabels(java.lang.String pageId)

Get the labels of a specific page

Parameters:

pageId - The pageId to get the labels

Returns:

a List<Label> of labels

getUserAuthorities

public ConfluenceUser getUserAuthorities(java.lang.String username)
                                  throws java.lang.Exception

Parameters:

username -

Returns:

Throws:

java.lang.Exception

getUserGroups

public ConfluenceResponse<Group> getUserGroups(int start,
                                               int limit,
                                               java.lang.String username)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getSpaces

public ConfluenceResponse<Space> getSpaces(int start,
                                           int limit,
                                           com.google.common.base.Optional<java.lang.String> spaceType,
                                           com.google.common.base.Optional<java.lang.String> spaceStatus)
                                    throws java.lang.Exception

Throws:

java.lang.Exception