Book Image

JIRA 5.x Development Cookbook

Book Image

JIRA 5.x 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. "JIRA 5.x Development Cookbook" is a one stop resource to master extensions and customizations in JIRA. 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. "JIRA 5.x Development Cookbook" 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, and so on, and a lot of planning done for the project, 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. "JIRA 5.x Development Cookbook" steers towards programming issues, such as creating, editing, and deleting issues, creating new issue operations, managing the various other operations available on issues via the JIRA APIs, and so on. In the latter half of "JIRA 5.x Development Cookbook", 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 5.x Development Cookbook
Credits
About the Author
Acknowledgement
About the Reviewers
www.PacktPub.com
Preface
Index

Parsing JQL queries in plugins


In the previous recipe, we saw how to build a query to search within JIRA. In this recipe, we will see searching again, but without building a query using the APIs. We will instead use the JQL query as it is written in the Issue Navigator in advanced mode and search using the same.

How to do it…

Suppose we know the query that we want to execute. Let us assume it is the same as we saw in the previous recipe:

project = "DEMO" AND assignee = currentUser()

The following is how we can use the JQL query for searching:

  1. Parse the JQL query:

    String jqlQuery = "project = \"DEMO\" and assignee = currentUser()";
    SearchService.ParseResult parseResult = searchService.parseQuery(user, jqlQuery);
  2. Check if the parsed result is valid or not:

    if (parseResult.isValid()){
       // Carry On
    } else {
      // Log the error and exit!
    }
  3. If the result is valid, get the Query object from the parsed result:

    Query query = parseResult.getQuery()
  4. Search for the issues and retrieve the search results...