public interface

ConfluenceRpcService

com.atlassian.jira.plugin.link.confluence.service.rpc.ConfluenceRpcService
Known Indirect Subclasses

Class Overview

Helper class for making XMLRPC calls to Confluence servers.

Summary

Public Methods
RemoteResponse<ConfluencePage> getPage(ApplicationLink applicationLink, String pageId)
Gets the page with the given id, on the Confluence server given by the application link.
RemoteResponse<List<ConfluenceSpace>> getSpaces(ApplicationLink applicationLink)
Get the list of spaces for the Confluence instance matching the given ApplicationLink.
RemoteResponse<List<ConfluenceSearchResult>> search(ApplicationLink applicationLink, String query, int maxResults, String spaceKey)
Search the Confluence instance matching the given ApplicationLink.

Public Methods

public RemoteResponse<ConfluencePage> getPage (ApplicationLink applicationLink, String pageId)

Gets the page with the given id, on the Confluence server given by the application link.

Parameters
applicationLink the application link of the Confluence server
pageId the page id
Returns
Throws
CredentialsRequiredException thrown if authentication is required
ResponseException thrown if the response cannot be retrieved

public RemoteResponse<List<ConfluenceSpace>> getSpaces (ApplicationLink applicationLink)

Get the list of spaces for the Confluence instance matching the given ApplicationLink.

Parameters
applicationLink the link to the Confluence instance
Returns
Throws
CredentialsRequiredException thrown if authentication is required
ResponseException thrown if the response cannot be retrieved

public RemoteResponse<List<ConfluenceSearchResult>> search (ApplicationLink applicationLink, String query, int maxResults, String spaceKey)

Search the Confluence instance matching the given ApplicationLink.

Parameters
applicationLink the link to the Confluence instance
query the search term
maxResults the maximum number of results to return
spaceKey the space to search within, or if null, search all spaces
Returns
Throws
CredentialsRequiredException thrown if authentication is required
ResponseException thrown if the response cannot be retrieved