Jira

Interact with JIRA issue tracker.

What’s inside

Jira component, URI syntax: jira:type

Please refer to the above links for usage and configuration details.

Maven coordinates

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

Spring Boot Auto-Configuration

The starter supports 15 options, which are listed below.

Name	Description	Default	Type
camel.component.jira.access-token	(OAuth or Personal Access Token authentication) 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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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.health-check-consumer-enabled	Used for enabling or disabling all consumer based health checks from this component	true	Boolean
camel.component.jira.health-check-producer-enabled	Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true.	true	Boolean
camel.component.jira.jira-url	The Jira server url, for 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 or the API Token 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

Name

Description

Default

Type

camel.component.jira.access-token

(OAuth or Personal Access Token authentication) 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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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.health-check-consumer-enabled

Used for enabling or disabling all consumer based health checks from this component

true

Boolean

camel.component.jira.health-check-producer-enabled

Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true.

true

Boolean

camel.component.jira.jira-url

The Jira server url, for 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 or the API Token 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