com.github.crob1140.confluence

Class ConfluenceClient

java.lang.Object

com.github.crob1140.confluence.ConfluenceClient

public class ConfluenceClient
extends java.lang.Object

This class sends requests to a Confluence Cloud server.

Constructor Summary

Constructors

Constructor and Description
ConfluenceClient(javax.ws.rs.client.WebTarget wikiTarget) This constructor creates a client that can send requests to the Confluence Cloud server located at the given target.
ConfluenceClient(javax.ws.rs.client.WebTarget wikiTarget, AuthMethod authMethod) This constructor creates a client that can send requests to the Confluence Cloud server located at the given target.

Method Summary

Modifier and Type	Method and Description
Content	createContent(CreateContentRequest request) This method sends a request to the Confluence Cloud server to create the content defined in the given CreateContentRequest.
java.util.List<Content>	getContent(GetContentRequest request) This method sends a request to the Confluence Cloud server to retrieve content matching the conditions set in the given GetContentRequest.
Content	updateContent(UpdateContentRequest request) This method sends a request to the Confluence Cloud server to update content the content as defined in the given UpdateContentRequest.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfluenceClient

public ConfluenceClient(javax.ws.rs.client.WebTarget wikiTarget)

This constructor creates a client that can send requests to the Confluence Cloud server located at the given target.

The requests generated by a client created through this constructor do not include any authorisation, and can therefore only be used to access publicly available content.

Parameters:

wikiTarget - The resource target pointing to the location of the Confluence Cloud server.

ConfluenceClient

public ConfluenceClient(javax.ws.rs.client.WebTarget wikiTarget,
                        AuthMethod authMethod)

This constructor creates a client that can send requests to the Confluence Cloud server located at the given target.

The requests generated by a client created through this constructor will use the credentials defined by the given AuthMethod, and are therefore subject to the permissions given to the user that corresponds to these credentials.

Parameters:

wikiTarget - The resource target pointing to the location of the Confluence Cloud server.

authMethod - The authorization method to use for all requests generated by this client.

Method Detail

getContent

public java.util.List<Content> getContent(GetContentRequest request)
                                   throws ConfluenceRequestException

This method sends a request to the Confluence Cloud server to retrieve content matching the conditions set in the given GetContentRequest.

Parameters:

request - The request defining the conditions for the Content that should be returned.

Returns:

The content in the Conflucnce Cloud server that matches the conditions set in the given GetContentRequest.

Throws:

ConfluenceRequestException - if an error response is returned from the server

updateContent

public Content updateContent(UpdateContentRequest request)
                      throws ConfluenceRequestException

This method sends a request to the Confluence Cloud server to update content the content as defined in the given UpdateContentRequest.

Parameters:

request - The request defining what updates to apply, and which content to apply them to.

Returns:

The new state of the content after the updates in the given UpdateContentRequest were applied.

Throws:

ConfluenceRequestException - if an error response is returned from the server

createContent

public Content createContent(CreateContentRequest request)
                      throws ConfluenceRequestException

This method sends a request to the Confluence Cloud server to create the content defined in the given CreateContentRequest.

Parameters:

request - The request defining the content that should be created, and what fields should be returned in the response.

Returns:

The content that was created

Throws:

ConfluenceRequestException - If the server responses with an error status code