rocks.inspectit.releaseplugin

Class JIRAAccessTool

java.lang.Object

rocks.inspectit.releaseplugin.JIRAAccessTool

public class JIRAAccessTool
extends Object

Tool encapsulating the access to a JIRA Server using the REST-API.

Author:

Jonas Kunz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JIRAAccessTool.BuildingLambda<B> Lambda used for building stuff (like tickets or version).

Constructor Summary

Constructors

Constructor and Description
JIRAAccessTool(String url, String user, String password, String proxy, String projectKey, String jenkinsCredentialsId) Establishes an connection to JIRA using the given credentials.

Method Summary

Modifier and Type	Method and Description
com.atlassian.jira.rest.client.api.domain.BasicIssue	addTicket(JIRAAccessTool.BuildingLambda<com.atlassian.jira.rest.client.api.domain.input.IssueInputBuilder> buildingFunction, com.atlassian.jira.rest.client.api.domain.IssueType type) Publishes a new ticket on JIRA.
String	buildReleaseNotesHTML(List<com.atlassian.jira.rest.client.api.domain.Issue> issuesToShow) Builds a html page listing all the given Tickets (including links to JIRA).
com.atlassian.jira.rest.client.api.domain.Version	createUpdateVersion(String versionName, JIRAAccessTool.BuildingLambda<com.atlassian.jira.rest.client.api.domain.input.VersionInputBuilder> buildingLambda) Marks the given version as released.
void	destroy() Closes the connection.
List<FieldMetadata>	getAvailableFields() Receives all available Fields.
List<String>	getAvailableIssuePriorities()
List<String>	getAvailableIssueStatuses()
List<String>	getAvailableIssueTypes()
Iterable<com.atlassian.jira.rest.client.api.domain.Transition>	getAvailableTransitions(com.atlassian.jira.rest.client.api.domain.Issue issue) Lists all transitions available from the view of the user for the given ticket.
List<String>	getAvailableVersions()
com.atlassian.jira.rest.client.api.domain.BasicPriority	getIssuePriorityByName(String priorityName) Scans for an issue priority on JIRA with the given name.
com.atlassian.jira.rest.client.api.domain.IssueType	getIssueTypeByName(String typeName) Scans for an issue type on JIRA with the given name.
String	getJenkinsCredentialsId()
com.atlassian.jira.rest.client.api.domain.Issue	getTicketByKey(String ticketKey) Fetches an Issue object using the key of the issue.
List<com.atlassian.jira.rest.client.api.domain.Issue>	getTicketsByJQL(String jqlQuery) Finds all Tickets matching the given JQL Query.
List<com.atlassian.jira.rest.client.api.domain.Issue>	getTicketsByVersion(com.atlassian.jira.rest.client.api.domain.Version version) Finds all Tickets which have the given version as their affected version.
com.atlassian.jira.rest.client.api.domain.Version	getVersionByName(String versionName) Returns a Version-object corresponding the version on JIRA with the given name.
void	performTransition(com.atlassian.jira.rest.client.api.domain.Issue issue, com.atlassian.jira.rest.client.api.domain.input.TransitionInput transition) Performs a transition on the given ticket.
void	updateTicket(String ticketKey, JIRAAccessTool.BuildingLambda<IssueUpdateBuilder> updatingFunction) Performs an update on the given ticket.

Methods inherited from class java.lang.Object

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

Constructor Detail

JIRAAccessTool

public JIRAAccessTool(String url,
                      String user,
                      String password,
                      String proxy,
                      String projectKey,
                      String jenkinsCredentialsId)

Establishes an connection to JIRA using the given credentials.

Parameters:

url - the url used for access

user - the username used for access

password - the password used for access

proxy - the proxy to use (can be null)

projectKey - the key of the project

jenkinsCredentialsId - the id of the jenkins crednetials used for this jira

Method Detail

getJenkinsCredentialsId

public String getJenkinsCredentialsId()

getAvailableIssueTypes

public List<String> getAvailableIssueTypes()

Returns:

A list of the names of all Issue types.

getAvailableIssuePriorities

public List<String> getAvailableIssuePriorities()

Returns:

A List of all names of the available Issue priorities

getAvailableIssueStatuses

public List<String> getAvailableIssueStatuses()

Returns:

A List of the names of all available issue statuses.

getAvailableVersions

public List<String> getAvailableVersions()

Returns:

A List of the names of all existing versions.

createUpdateVersion

public com.atlassian.jira.rest.client.api.domain.Version createUpdateVersion(String versionName,
                                                                             JIRAAccessTool.BuildingLambda<com.atlassian.jira.rest.client.api.domain.input.VersionInputBuilder> buildingLambda)

Marks the given version as released. If the version does not exist yet, a new version if the given name is created and then marked as released.

Parameters:

versionName - the name of the version

buildingLambda - buildingLambda the lambda providing the information about the new version

Returns:

The released version.

getVersionByName

public com.atlassian.jira.rest.client.api.domain.Version getVersionByName(String versionName)

Returns a Version-object corresponding the version on JIRA with the given name.

Parameters:

versionName - the name of the version to look for (e.g. 1.0)

Returns:

an instance representing the given version or null if no such version exists.

getTicketsByVersion

public List<com.atlassian.jira.rest.client.api.domain.Issue> getTicketsByVersion(com.atlassian.jira.rest.client.api.domain.Version version)

Finds all Tickets which have the given version as their affected version. Limits the search to the project this connector was constructed with.

Parameters:

version - the version to filter for

Returns:

a list of all issues with this version as affected version.

getTicketsByJQL

public List<com.atlassian.jira.rest.client.api.domain.Issue> getTicketsByJQL(String jqlQuery)

Finds all Tickets matching the given JQL Query. Limits the search to the project this tool was constructed with.

Parameters:

jqlQuery - the query to filter for

Returns:

a list of all issues with this version as affected version.

buildReleaseNotesHTML

public String buildReleaseNotesHTML(List<com.atlassian.jira.rest.client.api.domain.Issue> issuesToShow)

Builds a html page listing all the given Tickets (including links to JIRA).

Parameters:

issuesToShow - the issues to list on the html page

Returns:

a String containing the html code

addTicket

public com.atlassian.jira.rest.client.api.domain.BasicIssue addTicket(JIRAAccessTool.BuildingLambda<com.atlassian.jira.rest.client.api.domain.input.IssueInputBuilder> buildingFunction,
                                                                      com.atlassian.jira.rest.client.api.domain.IssueType type)

Publishes a new ticket on JIRA.

Parameters:

buildingFunction - the lambda providing the information of the new ticket.

type - the issue type (e.g. Task, bug, etc)

Returns:

the created issue

updateTicket

public void updateTicket(String ticketKey,
                         JIRAAccessTool.BuildingLambda<IssueUpdateBuilder> updatingFunction)

Performs an update on the given ticket.

Parameters:

ticketKey - the id of the ticket to update

updatingFunction - the lambda for building the update

getIssueTypeByName

public com.atlassian.jira.rest.client.api.domain.IssueType getIssueTypeByName(String typeName)

Scans for an issue type on JIRA with the given name.

Parameters:

typeName - the name of the type to scan for, e.g. task, bug, etc

Returns:

an IssueType instance representing the given issue type.

getIssuePriorityByName

public com.atlassian.jira.rest.client.api.domain.BasicPriority getIssuePriorityByName(String priorityName)

Scans for an issue priority on JIRA with the given name.

Parameters:

priorityName - the name of the priority to scan for, e.g. high, medium, etc

Returns:

an BasicPriority instance representing the given issue priority.

destroy

public void destroy()

Closes the connection.

getTicketByKey

public com.atlassian.jira.rest.client.api.domain.Issue getTicketByKey(String ticketKey)

Fetches an Issue object using the key of the issue.

Parameters:

ticketKey - the key of the issue to fetch.

Returns:

the corresponding ticket.

getAvailableTransitions

public Iterable<com.atlassian.jira.rest.client.api.domain.Transition> getAvailableTransitions(com.atlassian.jira.rest.client.api.domain.Issue issue)

Lists all transitions available from the view of the user for the given ticket.

Parameters:

issue - the issue whose transitions shall be fetched.

Returns:

a list of possible transitions.

performTransition

public void performTransition(com.atlassian.jira.rest.client.api.domain.Issue issue,
                              com.atlassian.jira.rest.client.api.domain.input.TransitionInput transition)

Performs a transition on the given ticket.

Parameters:

issue - the issue on which the transition shall be performed.

transition - the transition to be performed

getAvailableFields

public List<FieldMetadata> getAvailableFields()

Receives all available Fields.

Returns:

a List of the field metadata.