Chapter 169. JIRA Component

Available as of Camel version 2.15

The JIRA component interacts with the JIRA API by encapsulating Atlassian’s REST Java Client for JIRA. It currently provides polling for new issues and new comments.  It is also able to create new issues.

Rather than webhooks, this endpoint relies on simple polling. Reasons include:

  • Concern for reliability/stability
  • The types of payloads we’re polling aren’t typically large (plus, paging is available in the API)
  • The need to support apps running somewhere not publicly accessible where a webhook would fail

Note that the JIRA API is fairly expansive.  Therefore, this component could be easily expanded to provide additional interactions.

Maven users will need to add the following dependency to their pom.xml for this component:

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-jira</artifactId>
    <version>${camel-version}</version>
</dependency>

169.1. URI format

jira://endpoint[?options]

169.2. JIRA Options

The JIRA component has no options.

The JIRA endpoint is configured using URI syntax:

jira:type

with the following path and query parameters:

169.2.1. Path Parameters (1 parameters):

NameDescriptionDefaultType

type

Required Operation to perform such as create a new issue or a new comment

 

JIRAType

169.2.2. Query Parameters (9 parameters):

NameDescriptionDefaultType

password (common)

Password for login

 

String

serverUrl (common)

Required URL to the JIRA server

 

String

username (common)

Username for login

 

String

bridgeErrorHandler (consumer)

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.

false

boolean

delay (consumer)

Delay in seconds when querying JIRA using the consumer.

6000

int

jql (consumer)

JQL is the query language from JIRA which allows you to retrieve the data you want. For example jql=project=MyProject Where MyProject is the product key in Jira.

 

String

exceptionHandler (consumer)

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.

 

ExceptionHandler

exchangePattern (consumer)

Sets the exchange pattern when the consumer creates an exchange.

 

ExchangePattern

synchronous (advanced)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

boolean

169.3. JQL:

The JQL URI option is used by both consumer endpoints.  Theoretically, items like "project key", etc. could be URI options themselves.  However, by requiring the use of JQL, the consumers become much more flexible and powerful.

At the bare minimum, the consumers will require the following:

jira://[endpoint]?[required options]&jql=project=[project key]

One important thing to note is that the newIssue consumer will automatically append "ORDER BY key desc" to your JQL.  This is in order to optimize startup processing, rather than having to index every single issue in the project.

Another note is that, similarly, the newComment consumer will have to index every single issue and comment in the project.  Therefore, for large projects, it’s vital to optimize the JQL expression as much as possible.  For example, the JIRA Toolkit Plugin includes a "Number of comments" custom field — use '"Number of comments" > 0' in your query. Also try to minimize based on state (status=Open), increase the polling delay, etc.  Example:

jira://[endpoint]?[required options]&jql=RAW(project=[project key] AND status in (Open, \"Coding In Progress\") AND \"Number of comments\">0)"