Red Hat Summit Red Hat SummitApoyoConsolaDesarrolladoresIniciar una pruebaContacto

Este contenido no está disponible en el idioma seleccionado.

Chapter 83. JIRA

JIRA component
Copiar enlace

Available as of Camel 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>
Copy to Clipboard Toggle word wrap

URI format
Copiar enlace

jira://endpoint[?options]
Copy to Clipboard Toggle word wrap

Mandatory Options:
Copiar enlace

Note that these can be configured directly through the endpoint.
Expand
Option
Description
serverUrl JIRA host server URL
username
JIRA username
password
JIRA password

Consumer Endpoints:
Copiar enlace

Expand
Endpoint
Context
Body Type
newIssue
polling
com.atlassian.jira.rest.client.domain.BasicIssue
newComment
polling
com.atlassian.jira.rest.client.domain.Comment

Producer Endpoints:
Copiar enlace

Expand
Endpoint
Body
Required Message Headers
pullRequestComment
String (issue description)
  • ProjectKey (String): The project key
  • IssueTypeId (long): The issue type id (ex: "Bug" is typically 1 in most default configs)
  • IssueSummary (String): The issue summary (title)

URI Options:
Copiar enlace

Expand
Name
Default Value
Description
delay
60
in seconds
jql Used by the consumer endpoints. More info below.

JQL:
Copiar enlace

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]
Copy to Clipboard Toggle word wrap
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)"
Copy to Clipboard Toggle word wrap
Volver arriba
Red Hat logoGithubredditYoutubeTwitter

Aprender

Pruebe, compre y venda

Comunidades

Acerca de la documentación de Red Hat

Ayudamos a los usuarios de Red Hat a innovar y alcanzar sus objetivos con nuestros productos y servicios con contenido en el que pueden confiar. Explore nuestras recientes actualizaciones.

Hacer que el código abierto sea más inclusivo

Red Hat se compromete a reemplazar el lenguaje problemático en nuestro código, documentación y propiedades web. Para más detalles, consulte el Blog de Red Hat.

Acerca de Red Hat

Ofrecemos soluciones reforzadas que facilitan a las empresas trabajar en plataformas y entornos, desde el centro de datos central hasta el perímetro de la red.

Theme

© 2025 Red Hat