| // kafka-connector options: START |
| [[camel-jira-kafka-connector-source]] |
| = camel-jira-kafka-connector source configuration |
| |
| When using camel-jira-kafka-connector as source make sure to use the following Maven dependency to have support for the connector: |
| |
| [source,xml] |
| ---- |
| <dependency> |
| <groupId>org.apache.camel.kafkaconnector</groupId> |
| <artifactId>camel-jira-kafka-connector</artifactId> |
| <version>x.x.x</version> |
| <!-- use the same version as your Camel Kafka connector version --> |
| </dependency> |
| ---- |
| |
| |
| The camel-jira source connector supports 19 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | Name | Description | Default | Priority |
| | *camel.source.path.type* | Operation to perform. Consumers: NewIssues, NewComments. Producers: AddIssue, AttachFile, DeleteIssue, TransitionIssue, UpdateIssue, Watchers. See this class javadoc description for more information. One of: [ADDCOMMENT] [ADDISSUE] [ATTACH] [DELETEISSUE] [NEWISSUES] [NEWCOMMENTS] [UPDATEISSUE] [TRANSITIONISSUE] [WATCHERS] [ADDISSUELINK] [ADDWORKLOG] [FETCHISSUE] [FETCHCOMMENTS] | null | HIGH |
| | *camel.source.endpoint.delay* | Time in milliseconds to elapse for the next poll. | "6000" | MEDIUM |
| | *camel.source.endpoint.jiraUrl* | The Jira server url, example: \http://my_jira.com:8081 | null | HIGH |
| | *camel.source.endpoint.bridgeErrorHandler* | 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 | MEDIUM |
| | *camel.source.endpoint.jql* | 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) | null | MEDIUM |
| | *camel.source.endpoint.maxResults* | Max number of issues to search for | "50" | MEDIUM |
| | *camel.source.endpoint.exceptionHandler* | 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. | null | MEDIUM |
| | *camel.source.endpoint.exchangePattern* | Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut] | null | MEDIUM |
| | *camel.source.endpoint.basicPropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM |
| | *camel.source.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | MEDIUM |
| | *camel.source.endpoint.accessToken* | (OAuth only) The access token generated by the Jira server. | null | MEDIUM |
| | *camel.source.endpoint.consumerKey* | (OAuth only) The consumer key from Jira settings. | null | MEDIUM |
| | *camel.source.endpoint.password* | (Basic authentication only) The password to authenticate to the Jira server. Use only if username basic authentication is used. | null | MEDIUM |
| | *camel.source.endpoint.privateKey* | (OAuth only) The private key generated by the client to encrypt the conversation to the server. | null | MEDIUM |
| | *camel.source.endpoint.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. | null | MEDIUM |
| | *camel.source.endpoint.verificationCode* | (OAuth only) The verification code from Jira generated in the first step of the authorization proccess. | null | MEDIUM |
| | *camel.component.jira.bridgeErrorHandler* | 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 | MEDIUM |
| | *camel.component.jira.basicPropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM |
| | *camel.component.jira.configuration* | To use a shared base jira configuration. | null | MEDIUM |
| |=== |
| // kafka-connector options: END |
