Package com.atlassian.greenhopper.confluence.rpc

Class ConfluenceRpcServiceImpl

java.lang.Object

com.atlassian.greenhopper.confluence.rpc.ConfluenceRpcServiceImpl

All Implemented Interfaces:

ConfluenceRpcService

public class ConfluenceRpcServiceImpl
extends Object
implements ConfluenceRpcService

Constructor Summary

Constructors

Constructor	Description
ConfluenceRpcServiceImpl()

Method Summary

Modifier and Type	Method	Description
com.atlassian.jira.plugin.link.applinks.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.
com.atlassian.jira.plugin.link.applinks.RemoteResponse<List<ConfluenceSpace>>	getSpaces(com.atlassian.applinks.api.ApplicationLink applicationLink)	Get the list of spaces for the Confluence instance matching the given ApplicationLink.
com.atlassian.jira.plugin.link.applinks.RemoteResponse<List<ConfluenceSearchResult>>	search(com.atlassian.applinks.api.ApplicationLink applicationLink, String query, int maxResults, String spaceKey)	Search the Confluence instance matching the given ApplicationLink.

Methods inherited from class java.lang.Object

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

Constructor Details

ConfluenceRpcServiceImpl

public ConfluenceRpcServiceImpl()

Method Details

getPage

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

Description copied from interface: ConfluenceRpcService

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

Specified by:

getPage in interface ConfluenceRpcService

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

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

Description copied from interface: ConfluenceRpcService

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

Specified by:

getSpaces in interface ConfluenceRpcService

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

public com.atlassian.jira.plugin.link.applinks.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

Description copied from interface: ConfluenceRpcService

Search the Confluence instance matching the given ApplicationLink.

Specified by:

search in interface ConfluenceRpcService

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