rocks.inspectit.releaseplugin

Class ConfluenceAccessTool

java.lang.Object

rocks.inspectit.releaseplugin.ConfluenceAccessTool

public class ConfluenceAccessTool
extends Object

Type encapsulating the REST-API based access to a confluence Server. Allows searching for pages and creating new pages at the moment.

Author:

Jonas Kunz

Constructor Summary

Constructors

Constructor and Description
ConfluenceAccessTool(String url, String user, String password, String proxy) Initializes a new connection with the given connection information.

Method Summary

Modifier and Type	Method and Description
void	createPage(String title, String htmlContent, String space, Long parentPageID) Creates a new page in the given space.
void	destroy() closes the connection.
List<Long>	getPageIDByTitle(String title, String space) Queries all pages wioth the given title in the given space.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfluenceAccessTool

public ConfluenceAccessTool(String url,
                            String user,
                            String password,
                            String proxy)

Initializes a new connection with the given connection information.

Parameters:

url - the url of confluence

user - the username

password - the password

proxy - the proxy to use for building the connection

Method Detail

destroy

public void destroy()

closes the connection.

getPageIDByTitle

public List<Long> getPageIDByTitle(String title,
                                   String space)

Queries all pages wioth the given title in the given space.

Parameters:

title - the title of the pages to look for

space - the key of the space

Returns:

a list of all IDs of the pages having the given title in the given space

createPage

public void createPage(String title,
                       String htmlContent,
                       String space,
                       Long parentPageID)

Creates a new page in the given space.

Parameters:

title - the title of the new page

htmlContent - the html content of the new page

space - the key of the space where the new page shall be placed

parentPageID - the id of the parent page, under which the new page should be inserted as child. If parentPageID is null, the new page will be placed at the spaces root.