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. Supported REST API versions are: - 2.0alpha1 - 2

Since:

v5.0

Nested Class Summary

static class

RemoteJiraRestService.RestVersion

Method Summary

RestResponse	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.
RestResponse<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.
RestResponse<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.

Method Detail

getIssue

RestResponse<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 RestResponse 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

getIssue

RestResponse<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 RestResponse 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

createRemoteIssueLink

RestResponse 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 RestResponse 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