com.atlassian.jira.plugin.link.confluence.rest

Class ConfluenceResource

java.lang.Object

com.atlassian.jira.plugin.link.confluence.rest.ConfluenceResource

public class ConfluenceResource
extends Object

A REST resource to access Confluence's remote API. This is needed to perform authenticated requests.

Since:

v5.0

Constructor Summary

Constructors

Constructor and Description
ConfluenceResource(ConfluenceRemoteServiceStrategyFactory confluenceRemoteServiceStrategyFactory, com.atlassian.applinks.api.ApplicationLinkService applicationLinkService, JiraBaseUrls jiraBaseUrls, I18nHelper i18nBean)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getApplicationLinks()
javax.ws.rs.core.Response	getSiteSearch(String query, String spaceKey, Long startAt, Integer maxResults, String appId) Returns all matching content from a remote Confluence instance.
javax.ws.rs.core.Response	getSpaces(String query, Long startAt, Integer maxResults, String appId) Returns all spaces from a remote Confluence instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfluenceResource

@Autowired
public ConfluenceResource(ConfluenceRemoteServiceStrategyFactory confluenceRemoteServiceStrategyFactory,
                                     com.atlassian.applinks.api.ApplicationLinkService applicationLinkService,
                                     JiraBaseUrls jiraBaseUrls,
                                     I18nHelper i18nBean)

Method Detail

getSpaces

public javax.ws.rs.core.Response getSpaces(String query,
                                           Long startAt,
                                           Integer maxResults,
                                           String appId)

Returns all spaces from a remote Confluence instance. Results are paginated.

Parameters:

query - a string of text to search for in Confluence Space titles and descriptions.

appId - the applink id for the remote Confluence instance.

startAt - the page offset, if not specified then defaults to 0.

maxResults - how many results on the page should be included. Defaults to CONF_DEFAULT_MAX.

Returns:

the relevant Confluence Spaces.

getSiteSearch

public javax.ws.rs.core.Response getSiteSearch(String query,
                                               String spaceKey,
                                               Long startAt,
                                               Integer maxResults,
                                               String appId)

Returns all matching content from a remote Confluence instance. Results are paginated.

Parameters:

query - a string of text to search for anywhere in a piece of Confluence content.

spaceKey - if provided, will restrict the search to a single Space in Confluence.

appId - the applink id for the remote Confluence instance.

startAt - the page offset, if not specified then defaults to 0.

maxResults - how many results on the page should be included. Defaults to CONF_DEFAULT_MAX.

Returns:

Confluence content that matched the search query and was in the search's scope.

getApplicationLinks

public javax.ws.rs.core.Response getApplicationLinks()