SupportConsoleDevelopersStart a trialContact

Chapter 30. Jira

Both producer and consumer are supported

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, add comments, change issues, add/remove watchers, add attachment and transition the state of an issue.

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>

30.1. URI format

jira://type[?options]

The Jira type accepts the following operations:

For consumers:

  • newIssues: retrieve only new issues after the route is started
  • newComments: retrieve only new comments after the route is started
  • watchUpdates: retrieve only updated fields/issues based on provided jql

For producers:

  • addIssue: add an issue
  • addComment: add a comment on a given issue
  • attach: add an attachment on a given issue
  • deleteIssue: delete a given issue
  • updateIssue: update fields of a given issue
  • transitionIssue: transition a status of a given issue
  • watchers: add/remove watchers of a given issue

As Jira is fully customizable, you must assure the fields IDs exists for the project and workflow, as they can change between different Jira servers.

30.2. Configuring Options

Camel components are configured on two separate levels:

  • component level
  • endpoint level

30.2.1. Configuring Component Options

The component level is the highest level which holds general and common configurations that are inherited by the endpoints. For example a component may have security settings, credentials for authentication, urls for network connection and so forth.

Some components only have a few options, and others may have many. Because components typically have pre configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.

Configuring components can be done with the Component DSL, in a configuration file (application.properties|yaml), or directly with Java code.

30.2.2. Configuring Endpoint Options

Where you find yourself configuring the most is on endpoints, as endpoints often have many options, which allows you to configure what you need the endpoint to do. The options are also categorized into whether the endpoint is used as consumer (from) or as a producer (to), or used for both.

Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL as a type safe way of configuring endpoints.

A good practice when configuring options is to use Property Placeholders, which allows to not hardcode urls, port numbers, sensitive information, and other settings. In other words placeholders allows to externalize the configuration from your code, and gives more flexibility and reuse.

The following two sections lists all the options, firstly for the component followed by the endpoint.

30.3. Component Options

The Jira component supports 12 options, which are listed below.

NameDescriptionDefaultType

delay (common)

Time in milliseconds to elapse for the next poll.

6000

Integer

jiraUrl (common)

Required The Jira server url, example: .

 

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

lazyStartProducer (producer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

autowiredEnabled (advanced)

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

boolean

configuration (advanced)

To use a shared base jira configuration.

 

JiraConfiguration

accessToken (security)

(OAuth only) The access token generated by the Jira server.

 

String

consumerKey (security)

(OAuth only) The consumer key from Jira settings.

 

String

password (security)

(Basic authentication only) The password to authenticate to the Jira server. Use only if username basic authentication is used.

 

String

privateKey (security)

(OAuth only) The private key generated by the client to encrypt the conversation to the server.

 

String

username (security)

(Basic authentication only) The username to authenticate to the Jira server. Use only if OAuth is not enabled on the Jira server. Do not set the username and OAuth token parameter, if they are both set, the username basic authentication takes precedence.

 

String

verificationCode (security)

(OAuth only) The verification code from Jira generated in the first step of the authorization proccess.

 

String

30.4. Endpoint Options

The Jira endpoint is configured using URI syntax: 

jira:type

with the following path and query parameters:

30.4.1. Path Parameters (1 parameters)

NameDescriptionDefaultType

type (common)

Required Operation to perform. Consumers: NewIssues, NewComments. Producers: AddIssue, AttachFile, DeleteIssue, TransitionIssue, UpdateIssue, Watchers. See this class javadoc description for more information.

Enum values:

  • ADDCOMMENT
  • ADDISSUE
  • ATTACH
  • DELETEISSUE
  • NEWISSUES
  • NEWCOMMENTS
  • WATCHUPDATES
  • UPDATEISSUE
  • TRANSITIONISSUE
  • WATCHERS
  • ADDISSUELINK
  • ADDWORKLOG
  • FETCHISSUE
  • FETCHCOMMENTS
 

JiraType

30.4.2. Query Parameters (16 parameters)

NameDescriptionDefaultType

delay (common)

Time in milliseconds to elapse for the next poll.

6000

Integer

jiraUrl (common)

Required The Jira server url, example: .

 

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

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. It is important to use the RAW() and set the JQL inside it to prevent camel parsing it, example: RAW(project in (MYP, COM) AND resolution = Unresolved).

 

String

maxResults (consumer)

Max number of issues to search for.

50

Integer

sendOnlyUpdatedField (consumer)

Indicator for sending only changed fields in exchange body or issue object. By default consumer sends only changed fields.

true

boolean

watchedFields (consumer)

Comma separated list of fields to watch for changes. Status,Priority are the defaults.

Status,Priority

String

exceptionHandler (consumer (advanced))

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option 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 (advanced))

Sets the exchange pattern when the consumer creates an exchange.

Enum values:

  • InOnly
  • InOut
  • InOptionalOut
 

ExchangePattern

lazyStartProducer (producer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

accessToken (security)

(OAuth only) The access token generated by the Jira server.

 

String

consumerKey (security)

(OAuth only) The consumer key from Jira settings.

 

String

password (security)

(Basic authentication only) The password to authenticate to the Jira server. Use only if username basic authentication is used.

 

String

privateKey (security)

(OAuth only) The private key generated by the client to encrypt the conversation to the server.

 

String

username (security)

(Basic authentication only) The username to authenticate to the Jira server. Use only if OAuth is not enabled on the Jira server. Do not set the username and OAuth token parameter, if they are both set, the username basic authentication takes precedence.

 

String

verificationCode (security)

(OAuth only) The verification code from Jira generated in the first step of the authorization proccess.

 

String

30.5. Client Factory

You can bind the JiraRestClientFactory with name JiraRestClientFactory in the registry to have it automatically set in the Jira endpoint.

30.6. Authentication

Camel-jira supports Basic Authentication and OAuth 3 legged authentication.

We recommend to use OAuth whenever possible, as it provides the best security for your users and system.

30.6.1. Basic authentication requirements:

  • An username and password

30.6.2. OAuth authentication requirements:

Follow the tutorial in Jira OAuth documentation to generate the client private key, consumer key, verification code and access token.

  • a private key, generated locally on your system.
  • A verification code, generated by Jira server.
  • The consumer key, set in the Jira server settings.
  • An access token, generated by Jira server.

30.7. 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://[type]?[required options]&jql=project=[project key]

One important thing to note is that the newIssues consumer will automatically set the JQL as:

  • append ORDER BY key desc to your JQL
  • prepend id > latestIssueId to retrieve issues added after the camel route was started.

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 newComments 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://[type]?[required options]&jql=RAW(project=[project key] AND status in (Open, \"Coding In Progress\") AND \"Number of comments\">0)"

30.8. Operations

See a list of required headers to set when using the Jira operations. The author field for the producers is automatically set to the authenticated user in the Jira side.

If any required field is not set, then an IllegalArgumentException is throw.

There are operations that requires id for fields suchs as: issue type, priority, transition. Check the valid id on your jira project as they may differ on a jira installation and project workflow.

30.9. AddIssue

Required:

Optional:

  • IssueAssignee: the assignee user
  • IssuePriorityId or IssuePriorityName: The priority of the issue, you can see the valid list in http://jira_server/rest/api/2/priority.
  • IssueComponents: A list of string with the valid component names.
  • IssueWatchersAdd: A list of strings with the usernames to add to the watcher list.
  • IssueDescription: The description of the issue.

30.10. AddComment

Required:

  • IssueKey: The issue key identifier.
  • body of the exchange is the description.

30.11. Attach

Only one file should attach per invocation.

Required:

  • IssueKey: The issue key identifier.
  • body of the exchange should be of type File

30.12. DeleteIssue

Required:

  • IssueKey: The issue key identifier.

30.13. TransitionIssue

Required:

  • IssueKey: The issue key identifier.
  • IssueTransitionId: The issue transition id.
  • body of the exchange is the description.

30.14. UpdateIssue

  • IssueKey: The issue key identifier.
  • IssueTypeId or IssueTypeName: The id of the issue type or the name of the issue type, you can see the valid list in http://jira_server/rest/api/2/issue/createmeta?projectKeys=SAMPLE_KEY.
  • IssueSummary: The summary of the issue.
  • IssueAssignee: the assignee user
  • IssuePriorityId or IssuePriorityName: The priority of the issue, you can see the valid list in http://jira_server/rest/api/2/priority.
  • IssueComponents: A list of string with the valid component names.
  • IssueDescription: The description of the issue.

30.15. Watcher

  • IssueKey: The issue key identifier.
  • IssueWatchersAdd: A list of strings with the usernames to add to the watcher list.
  • IssueWatchersRemove: A list of strings with the usernames to remove from the watcher list.

30.16. WatchUpdates (consumer)

  • watchedFields Comma separated list of fields to watch for changes i.e Status,Priority,Assignee,Components etc.
  • sendOnlyUpdatedField By default only changed field is send as the body.

All messages also contain following headers that add additional info about the change:

  • issueKey: Key of the updated issue
  • changed: name of the updated field (i.e Status)
  • watchedIssues: list of all issue keys that are watched in the time of update

30.17. Spring Boot Auto-Configuration

When using jira with Spring Boot make sure to use the following Maven dependency to have support for auto configuration: 

<dependency>
  <groupId>org.apache.camel.springboot</groupId>
  <artifactId>camel-jira-starter</artifactId>
</dependency>

The component supports 13 options, which are listed below.

NameDescriptionDefaultType

camel.component.jira.access-token

(OAuth only) The access token generated by the Jira server.

 

String

camel.component.jira.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

camel.component.jira.bridge-error-handler

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

camel.component.jira.configuration

To use a shared base jira configuration. The option is a org.apache.camel.component.jira.JiraConfiguration type.

 

JiraConfiguration

camel.component.jira.consumer-key

(OAuth only) The consumer key from Jira settings.

 

String

camel.component.jira.delay

Time in milliseconds to elapse for the next poll.

6000

Integer

camel.component.jira.enabled

Whether to enable auto configuration of the jira component. This is enabled by default.

 

Boolean

camel.component.jira.jira-url

The Jira server url, example: http://my_jira.com:8081/.

 

String

camel.component.jira.lazy-start-producer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

Boolean

camel.component.jira.password

(Basic authentication only) The password to authenticate to the Jira server. Use only if username basic authentication is used.

 

String

camel.component.jira.private-key

(OAuth only) The private key generated by the client to encrypt the conversation to the server.

 

String

camel.component.jira.username

(Basic authentication only) The username to authenticate to the Jira server. Use only if OAuth is not enabled on the Jira server. Do not set the username and OAuth token parameter, if they are both set, the username basic authentication takes precedence.

 

String

camel.component.jira.verification-code

(OAuth only) The verification code from Jira generated in the first step of the authorization proccess.

 

String

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.