|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RemoteJiraRestService
Helper class for making REST calls to JIRA servers.
Nested Class Summary | |
---|---|
static class |
RemoteJiraRestService.RestVersion
|
Method Summary | |
---|---|
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 |
---|
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
applicationLink
- the application link of the JIRA serverissueIdOrKey
- the issue ID or keyrestVersion
- the version of the REST API to invoke
RemoteResponse
containing a RemoteJiraIssue
and properties of the HTTP response
com.atlassian.applinks.api.CredentialsRequiredException
- thrown if authentication is required
com.atlassian.sal.api.net.ResponseException
- thrown if the response cannot be retrievedRemoteResponse<RemoteJiraIssue> getIssue(String baseUri, String issueIdOrKey, RemoteJiraRestService.RestVersion restVersion) throws com.atlassian.applinks.api.CredentialsRequiredException, com.atlassian.sal.api.net.ResponseException
baseUri
- the base URI of the JIRA instanceissueIdOrKey
- the issue ID or keyrestVersion
- the version of the REST API to invoke
RemoteResponse
containing a RemoteJiraIssue
and properties of the HTTP response
com.atlassian.applinks.api.CredentialsRequiredException
- thrown if authentication is required
com.atlassian.sal.api.net.ResponseException
- thrown if the response cannot be retrievedRemoteResponse<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
applicationLink
- the application link of the remote JIRA serverremoteIssueKey
- the issue key of the remote issueissue
- the local issuerelationship
- the relationship for the linkrestVersion
- the version of the REST API to invoke
RemoteResponse
containing a JSONObject
and properties of the HTTP response
com.atlassian.applinks.api.CredentialsRequiredException
- thrown if authentication is required
com.atlassian.sal.api.net.ResponseException
- thrown if the response cannot be retrievedRemoteResponse<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
applicationLink
- the application link of the JIRA serverresourcePath
- the path of the REST resource, e.g. issueparams
- the parameters to add to the requestrestVersion
- the version of the REST API to invoke
RemoteResponse
containing the String
response and properties of the HTTP response
com.atlassian.applinks.api.CredentialsRequiredException
- thrown if authentication is required
com.atlassian.sal.api.net.ResponseException
- thrown if the response cannot be retrievedRemoteResponse<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
applicationLink
- the application link of the JIRA serverurl
- the relative URL to request, from the base URL of the applicationLink, e.g. secure/Dashboard.jspaparams
- the parameters to add to the request
RemoteResponse
containing the String
response and properties of the HTTP response
com.atlassian.applinks.api.CredentialsRequiredException
- thrown if authentication is required
com.atlassian.sal.api.net.ResponseException
- thrown if the response cannot be retrieved
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |