| // spring-boot-auto-configure options: START |
| :page-partial: |
| :doctitle: Camel Spring Boot Starter for jira |
| |
| == Spring Boot Auto-Configuration |
| |
| When using jira with Spring Boot make sure to use the following Maven dependency to have support for auto configuration: |
| |
| [source,xml] |
| ---- |
| <dependency> |
| <groupId>org.apache.camel.springboot</groupId> |
| <artifactId>camel-jira-starter</artifactId> |
| <version>x.x.x</version> |
| <!-- use the same version as your Camel core version --> |
| </dependency> |
| ---- |
| |
| |
| The component supports 13 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | Name | Description | Default | Type |
| | *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 |
| |=== |
| // spring-boot-auto-configure options: END |