com.atlassian.jira.plugin.link.confluence.service.rpc
Interface ConfluenceRpcService

All Known Implementing Classes:

ConfluenceRpcServiceImpl

public interface ConfluenceRpcService

Helper class for making XMLRPC calls to Confluence servers.

Since:

v5.0

Method Summary

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

Method Detail

getPage

RemoteResponse<ConfluencePage> getPage(com.atlassian.applinks.api.ApplicationLink applicationLink,
                                       String pageId)
                                       throws com.atlassian.applinks.api.CredentialsRequiredException,
                                              com.atlassian.sal.api.net.ResponseException

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:

a RemoteResponse containing a ConfluencePage and properties of the HTTP response

Throws:

com.atlassian.applinks.api.CredentialsRequiredException - thrown if authentication is required

com.atlassian.sal.api.net.ResponseException - thrown if the response cannot be retrieved

getSpaces

RemoteResponse<List<ConfluenceSpace>> getSpaces(com.atlassian.applinks.api.ApplicationLink applicationLink)
                                                throws com.atlassian.applinks.api.CredentialsRequiredException,
                                                       com.atlassian.sal.api.net.ResponseException

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

Parameters:

applicationLink - the link to the Confluence instance

Returns:

a RemoteResponse containing a List of ConfluenceSpaces and properties of the HTTP response

Throws:

com.atlassian.applinks.api.CredentialsRequiredException - thrown if authentication is required

com.atlassian.sal.api.net.ResponseException - thrown if the response cannot be retrieved

search

RemoteResponse<List<ConfluenceSearchResult>> search(com.atlassian.applinks.api.ApplicationLink applicationLink,
                                                    String query,
                                                    int maxResults,
                                                    @Nullable
                                                    String spaceKey)
                                                    throws com.atlassian.applinks.api.CredentialsRequiredException,
                                                           com.atlassian.sal.api.net.ResponseException

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:

a RemoteResponse containing a List of ConfluenceSearchResults and properties of the HTTP response

Throws:

com.atlassian.applinks.api.CredentialsRequiredException - thrown if authentication is required

com.atlassian.sal.api.net.ResponseException - thrown if the response cannot be retrieved