Package hudson.plugins.jira

Class JiraRestService

java.lang.Object

hudson.plugins.jira.JiraRestService

public class JiraRestService
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static String	BASE_API_PATH	Base URI path for a REST API call.
static org.joda.time.format.DateTimeFormatter	DATE_TIME_FORMATTER

Constructor Summary

Constructors

Constructor	Description
JiraRestService(URI uri, ExtendedJiraRestClient jiraRestClient, String token, int timeout)
JiraRestService(URI uri, ExtendedJiraRestClient jiraRestClient, String username, String password)	Deprecated.
JiraRestService(URI uri, ExtendedJiraRestClient jiraRestClient, String username, String password, int timeout)

Method Summary

Modifier and Type	Method	Description
void	addComment(String issueId, String commentBody, String groupVisibility, String roleVisibility)
com.atlassian.jira.rest.client.api.domain.Version	addVersion(String projectKey, String versionName)
com.atlassian.jira.rest.client.api.domain.BasicIssue	createIssue(String projectKey, String description, String assignee, Iterable<String> components, String summary)	Deprecated.
com.atlassian.jira.rest.client.api.domain.BasicIssue	createIssue(String projectKey, String description, String assignee, Iterable<String> components, String summary, Long issueTypeId, Long priorityId)
List<com.atlassian.jira.rest.client.api.domain.Transition>	getAvailableActions(String issueKey)
String	getBaseApiPath()
List<com.atlassian.jira.rest.client.api.domain.Component>	getComponents(String projectKey)
com.atlassian.jira.rest.client.api.domain.Issue	getIssue(String issueKey)
List<com.atlassian.jira.rest.client.api.domain.Issue>	getIssuesFromJqlSearch(String jqlSearch, Integer maxResults)
List<com.atlassian.jira.rest.client.api.domain.IssueType>	getIssueTypes()
com.atlassian.jira.rest.client.api.domain.Permissions	getMyPermissions()	Get User's permissions
List<com.atlassian.jira.rest.client.api.domain.Priority>	getPriorities()
List<String>	getProjectsKeys()
List<com.atlassian.jira.rest.client.api.domain.Status>	getStatuses()
com.atlassian.jira.rest.client.api.domain.User	getUser(String username)
List<ExtendedVersion>	getVersions(String projectKey)
com.atlassian.jira.rest.client.api.domain.Issue	progressWorkflowAction(String issueKey, Integer actionId)
void	releaseVersion(String projectKey, ExtendedVersion version)
void	setIssueFields(String issueKey, List<JiraIssueField> fields)
void	setIssueLabels(String issueKey, List<String> labels)
protected int	timeoutInMilliseconds()
void	updateIssue(String issueKey, List<com.atlassian.jira.rest.client.api.domain.Version> fixVersions)

Methods inherited from class java.lang.Object

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

Field Detail

DATE_TIME_FORMATTER

public static final org.joda.time.format.DateTimeFormatter DATE_TIME_FORMATTER

BASE_API_PATH

public static final String BASE_API_PATH

Base URI path for a REST API call. It must be relative to site's base URI.

See Also:

Constant Field Values

Constructor Detail

JiraRestService

@Deprecated
public JiraRestService(URI uri,
                       ExtendedJiraRestClient jiraRestClient,
                       String username,
                       String password)

Deprecated.

JiraRestService

public JiraRestService(URI uri,
                       ExtendedJiraRestClient jiraRestClient,
                       String username,
                       String password,
                       int timeout)

JiraRestService

public JiraRestService(URI uri,
                       ExtendedJiraRestClient jiraRestClient,
                       String token,
                       int timeout)

Method Detail

addComment

public void addComment(String issueId,
                       String commentBody,
                       String groupVisibility,
                       String roleVisibility)

getIssue

public com.atlassian.jira.rest.client.api.domain.Issue getIssue(String issueKey)

getIssueTypes

public List<com.atlassian.jira.rest.client.api.domain.IssueType> getIssueTypes()

getPriorities

public List<com.atlassian.jira.rest.client.api.domain.Priority> getPriorities()

getProjectsKeys

public List<String> getProjectsKeys()

getIssuesFromJqlSearch

public List<com.atlassian.jira.rest.client.api.domain.Issue> getIssuesFromJqlSearch(String jqlSearch,
                                                                                    Integer maxResults)
                                                                             throws TimeoutException

Throws:

TimeoutException

getVersions

public List<ExtendedVersion> getVersions(String projectKey)

addVersion

public com.atlassian.jira.rest.client.api.domain.Version addVersion(String projectKey,
                                                                    String versionName)

releaseVersion

public void releaseVersion(String projectKey,
                           ExtendedVersion version)

createIssue

@Deprecated
public com.atlassian.jira.rest.client.api.domain.BasicIssue createIssue(String projectKey,
                                                                        String description,
                                                                        String assignee,
                                                                        Iterable<String> components,
                                                                        String summary)

Deprecated.

createIssue

public com.atlassian.jira.rest.client.api.domain.BasicIssue createIssue(String projectKey,
                                                                        String description,
                                                                        String assignee,
                                                                        Iterable<String> components,
                                                                        String summary,
                                                                        @NonNull
                                                                        Long issueTypeId,
                                                                        @Nullable
                                                                        Long priorityId)

getUser

public com.atlassian.jira.rest.client.api.domain.User getUser(String username)

updateIssue

public void updateIssue(String issueKey,
                        List<com.atlassian.jira.rest.client.api.domain.Version> fixVersions)

setIssueLabels

public void setIssueLabels(String issueKey,
                           List<String> labels)

setIssueFields

public void setIssueFields(String issueKey,
                           List<JiraIssueField> fields)

progressWorkflowAction

public com.atlassian.jira.rest.client.api.domain.Issue progressWorkflowAction(String issueKey,
                                                                              Integer actionId)

getAvailableActions

public List<com.atlassian.jira.rest.client.api.domain.Transition> getAvailableActions(String issueKey)

getStatuses

public List<com.atlassian.jira.rest.client.api.domain.Status> getStatuses()

getComponents

public List<com.atlassian.jira.rest.client.api.domain.Component> getComponents(String projectKey)

timeoutInMilliseconds

protected int timeoutInMilliseconds()

getBaseApiPath

public String getBaseApiPath()

getMyPermissions

public com.atlassian.jira.rest.client.api.domain.Permissions getMyPermissions()
                                                                       throws com.atlassian.jira.rest.client.api.RestClientException

Get User's permissions

Throws:

com.atlassian.jira.rest.client.api.RestClientException