camel-jira-kafka-connector source configuration

Connector description: Interact with JIRA issue tracker.

When using camel-jira-kafka-connector as source make sure to use the following Maven dependency to have support for the connector:

<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>

To use this Source connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.jira.CamelJiraSourceConnector

The camel-jira source connector supports 27 options, which are listed below.

Name Description Default Required 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] [WATCHUPDATES] [UPDATEISSUE] [TRANSITIONISSUE] [WATCHERS] [ADDISSUELINK] [ADDWORKLOG] [FETCHISSUE] [FETCHCOMMENTS]

null

true

HIGH

camel.source.endpoint.delay

Time in milliseconds to elapse for the next poll.

"6000"

false

MEDIUM

camel.source.endpoint.jiraUrl

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

null

true

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

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

false

MEDIUM

camel.source.endpoint.maxResults

Max number of issues to search for

"50"

false

MEDIUM

camel.source.endpoint.sendOnlyUpdatedField

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

true

false

MEDIUM

camel.source.endpoint.watchedFields

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

"Status,Priority"

false

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

false

MEDIUM

camel.source.endpoint.exchangePattern

Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut]

null

false

MEDIUM

camel.source.endpoint.accessToken

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

null

false

MEDIUM

camel.source.endpoint.consumerKey

(OAuth only) The consumer key from Jira settings.

null

false

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

false

MEDIUM

camel.source.endpoint.privateKey

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

null

false

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

false

MEDIUM

camel.source.endpoint.verificationCode

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

null

false

MEDIUM

camel.component.jira.delay

Time in milliseconds to elapse for the next poll.

"6000"

false

MEDIUM

camel.component.jira.jiraUrl

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

null

true

HIGH

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

false

MEDIUM

camel.component.jira.autowiredEnabled

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

false

MEDIUM

camel.component.jira.configuration

To use a shared base jira configuration.

null

false

MEDIUM

camel.component.jira.accessToken

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

null

false

MEDIUM

camel.component.jira.consumerKey

(OAuth only) The consumer key from Jira settings.

null

false

MEDIUM

camel.component.jira.password

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

null

false

MEDIUM

camel.component.jira.privateKey

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

null

false

MEDIUM

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.

null

false

MEDIUM

camel.component.jira.verificationCode

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

null

false

MEDIUM

The camel-jira source connector has no converters out of the box.

The camel-jira source connector has no transforms out of the box.

The camel-jira source connector has no aggregation strategies out of the box.