Book Image

JIRA Development Cookbook

Book Image

JIRA Development Cookbook

Overview of this book

JIRA provides issue tracking and project tracking for software development teams to improve code quality and the speed of development.This book is your one-stop resource to master JIRA extension and customization. You will learn how to create your own JIRA plugins, customize the look and feel of your JIRA UI, work with Workflows, Issues, Custom Fields, and much more.The book starts with recipes on simplifying the Plugin development process followed by a complete chapter dedicated to the Plugin Framework to master Plugins in JIRA.Then we will move on to writing custom field plugins to create new field types or custom searchers. We then learn how to program and customize Workflows to transform JIRA into a user-friendly system. Reporting support in an application like JIRA is inevitable! With so much data spanning across different projects, issues, etc and a lot of project planning done on it, we will cover how to work on reports and gadgets to get customized data according to our needs. We will then look at customizing the various searching aspects of JIRA such as JQL, searching in plugins, managing filters, and so on. Then the book steers towards programming Issues, i.e. creating/editing/deleting issues, creating new issue operations, managing the various other operations available on issues via the JIRA APIs etc. In the latter half of the book, you will learn how to customize JIRA by adding new tabs, menus, and web items, communicate with JIRA via the REST, SOAP or XML/RPC interfaces, and work with the JIRA database.The book ends with a chapter on useful and general JIRA recipes.
Table of Contents (19 chapters)
JIRA Development Cookbook
About the Author
About the Reviewers

Searching in plugins

With the invention of JQL, JIRA Search APIs have changed drastically from 3.x versions. Searching in plugins is now done using APIs supporting JQL. In this recipe, we will see how to search for issues within our plugins using those APIs.

How to do it...

For the sake of concentrating on the search APIs, we will look at writing a simple method, getIssues(), that returns a list of issue objects based on some search criteria.

The essence of searching is to build a Query object using JqlQueryBuilder. A Query object will have a where clause and an order by clause, which are built using the JqlClauseBuilder. We can also incorporate conditions in between clauses using ConditionBuilders.

For now, let us assume we want to find all the issues in a particular project (project ID: 10000, Key: DEMO) and assigned to the current user within our plugin. The JQL equivalent for this is:

project = "DEMO" and assignee = currentUser()

The following are the steps to do this programmatically:

  1. Create...