com.atlassian.jira.plugin.link.remotejira

Interface RemoteJiraRestService

All Known Implementing Classes:

RemoteJiraRestServiceImpl

public interface RemoteJiraRestService

Helper class for making REST calls to JIRA servers.

Since:

v5.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RemoteJiraRestService.RestVersion

Method Summary

Modifier and Type	Method and Description
RemoteResponse<JSONObject>	createRemoteIssueLink(com.atlassian.applinks.api.ApplicationLink applicationLink, String remoteIssueKey, Issue issue, String relationship, RemoteJiraRestService.RestVersion restVersion) Creates a remote issue link between the given remote issue and the given local issue.
RemoteResponse<RemoteJiraIssue>	getIssue(com.atlassian.applinks.api.ApplicationLink applicationLink, String issueIdOrKey, RemoteJiraRestService.RestVersion restVersion) Gets the issue with the given key, on the JIRA server given by the application link.
RemoteResponse<RemoteJiraIssue>	getIssue(String baseUri, String issueIdOrKey, RemoteJiraRestService.RestVersion restVersion) Gets the issue with the given key, on the JIRA server given by the application link.
RemoteResponse<String>	requestResource(com.atlassian.applinks.api.ApplicationLink applicationLink, String resourcePath, Map<String,String> params, RemoteJiraRestService.RestVersion restVersion) Request the given REST resource on the given JIRA server with the given params.
RemoteResponse<String>	requestURL(com.atlassian.applinks.api.ApplicationLink applicationLink, String url, Map<String,String> params) Request the given URL on the given JIRA server with the given params.

Method Detail

getIssue

RemoteResponse<RemoteJiraIssue> getIssue(com.atlassian.applinks.api.ApplicationLink applicationLink,
                                         String issueIdOrKey,
                                         RemoteJiraRestService.RestVersion restVersion)
                                  throws com.atlassian.applinks.api.CredentialsRequiredException,
                                         com.atlassian.sal.api.net.ResponseException

Gets the issue with the given key, on the JIRA server given by the application link.

Parameters:

applicationLink - the application link of the JIRA server

issueIdOrKey - the issue ID or key

restVersion - the version of the REST API to invoke

Returns:

an RemoteResponse containing a RemoteJiraIssue 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

getIssue

RemoteResponse<RemoteJiraIssue> getIssue(String baseUri,
                                         String issueIdOrKey,
                                         RemoteJiraRestService.RestVersion restVersion)
                                  throws com.atlassian.applinks.api.CredentialsRequiredException,
                                         com.atlassian.sal.api.net.ResponseException

Gets the issue with the given key, on the JIRA server given by the application link.

Parameters:

baseUri - the base URI of the JIRA instance

issueIdOrKey - the issue ID or key

restVersion - the version of the REST API to invoke

Returns:

an RemoteResponse containing a RemoteJiraIssue 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

createRemoteIssueLink

RemoteResponse<JSONObject> createRemoteIssueLink(com.atlassian.applinks.api.ApplicationLink applicationLink,
                                                 String remoteIssueKey,
                                                 Issue issue,
                                                 String relationship,
                                                 RemoteJiraRestService.RestVersion restVersion)
                                          throws com.atlassian.applinks.api.CredentialsRequiredException,
                                                 com.atlassian.sal.api.net.ResponseException

Creates a remote issue link between the given remote issue and the given local issue.

Parameters:

applicationLink - the application link of the remote JIRA server

remoteIssueKey - the issue key of the remote issue

issue - the local issue

relationship - the relationship for the link

restVersion - the version of the REST API to invoke

Returns:

an RemoteResponse containing a JSONObject 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

requestResource

RemoteResponse<String> requestResource(com.atlassian.applinks.api.ApplicationLink applicationLink,
                                       String resourcePath,
                                       Map<String,String> params,
                                       RemoteJiraRestService.RestVersion restVersion)
                                throws com.atlassian.applinks.api.CredentialsRequiredException,
                                       com.atlassian.sal.api.net.ResponseException

Request the given REST resource on the given JIRA server with the given params.

Parameters:

applicationLink - the application link of the JIRA server

resourcePath - the path of the REST resource, e.g. issue

params - the parameters to add to the request

restVersion - the version of the REST API to invoke

Returns:

an RemoteResponse containing the String response 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

requestURL

RemoteResponse<String> requestURL(com.atlassian.applinks.api.ApplicationLink applicationLink,
                                  String url,
                                  Map<String,String> params)
                           throws com.atlassian.applinks.api.CredentialsRequiredException,
                                  com.atlassian.sal.api.net.ResponseException

Request the given URL on the given JIRA server with the given params. The URL does not need to be a REST resource.

Parameters:

applicationLink - the application link of the JIRA server

url - the relative URL to request, from the base URL of the applicationLink, e.g. secure/Dashboard.jspa

params - the parameters to add to the request

Returns:

an RemoteResponse containing the String response 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