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

Index and de-index programmatically

As we have seen in the JIRA architecture explained in Chapter 2, Understanding Plugin Framework, searching in JIRA is based on Apache Lucene. The Lucene indexes are stored in the File System and are used as the basis for the search queries executed in JIRA. Whenever an issue is updated, more records are created or existing records are updated for that particular issue in the filesystem.

It is possible to programmatically index selected or all issues or de-index an issue. Also, we can switch OFF or ON indexing selectively in our plugins if needed. In this recipe, we will see both of these.

How to do it...

Most of the indexing operations can be done with the help of IssueIndexManager. An instance of IssueIndexManager can be created either by injecting in the constructor or as follows:

IssueIndexManager indexManager = ComponentManager.getInstance().getIndexManager();

The following are the important operations supported by IssueIndexManager:

  • reIndexAll() – Indexes...