com.atlassian.jira.plugin.link.confluence.service.rpc
Class ConfluenceRpcServiceImpl
java.lang.Object
com.atlassian.jira.plugin.link.confluence.service.rpc.ConfluenceRpcServiceImpl
- All Implemented Interfaces:
- ConfluenceRpcService
@Component
public class ConfluenceRpcServiceImpl
- extends Object
- implements ConfluenceRpcService
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
ConfluenceRpcServiceImpl
public ConfluenceRpcServiceImpl()
getPage
public 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 serverpageId
- 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 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 ConfluenceSpace
s 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 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 instancequery
- the search termmaxResults
- the maximum number of results to returnspaceKey
- the space to search within, or if null, search all spaces
- Returns:
- a
RemoteResponse
containing a List of ConfluenceSearchResult
s 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
Copyright © 2002-2014 Atlassian. All Rights Reserved.