camel-jt400-kafka-connector source configuration
Connector Description: Exchanges messages with an IBM i system using data queues, message queues, or program call. IBM i is the replacement for AS/400 and iSeries servers.
When using camel-jt400-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-jt400-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.jt400.CamelJt400SourceConnector
The camel-jt400 source connector supports 37 options, which are listed below.
Name | Description | Default | Priority |
---|---|---|---|
Required Returns the ID of the IBM i user. |
HIGH |
||
Required Returns the password of the IBM i user. |
HIGH |
||
Required Returns the name of the IBM i system. |
HIGH |
||
Required Returns the fully qualified integrated file system path name of the target object of this endpoint. |
HIGH |
||
Required Whether to work with data queues or remote program call One of: [DTAQ] [PGM] [SRVPGM] [MSGQ]. Enum values:
|
HIGH |
||
Sets the CCSID to use for the connection with the IBM i system. |
MEDIUM |
||
Sets the data format for sending messages. One of: [text] [binary]. Enum values:
|
"text" |
MEDIUM |
|
Sets whether IBM i prompting is enabled in the environment running Camel. |
false |
MEDIUM |
|
Whether to use keyed or non-keyed data queues. |
false |
MEDIUM |
|
Search key for keyed data queues. |
MEDIUM |
||
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 |
|
Action to be taken on messages when read from a message queue. Messages can be marked as old (OLD), removed from the queue (REMOVE), or neither (SAME). One of: [OLD] [REMOVE] [SAME]. Enum values:
|
"OLD" |
MEDIUM |
|
Timeout in millis the consumer will wait while trying to read a new message of the data queue. |
30000 |
MEDIUM |
|
Search type such as EQ for equal etc. One of: [EQ] [NE] [LT] [LE] [GT] [GE]. Enum values:
|
"EQ" |
MEDIUM |
|
If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. |
false |
MEDIUM |
|
If true, the consumer endpoint will set the Jt400Constants.MESSAGE_REPLYTO_KEY header of the camel message for any IBM i inquiry messages received. If that message is then routed to a producer endpoint, the action will not be processed as sending a message to the queue, but rather a reply to the specific inquiry message. |
true |
MEDIUM |
|
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. |
MEDIUM |
||
Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut]. Enum values:
|
MEDIUM |
||
A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. |
MEDIUM |
||
The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. |
MEDIUM |
||
The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. |
MEDIUM |
||
To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. |
MEDIUM |
||
Milliseconds before the next poll. |
500L |
MEDIUM |
|
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. |
false |
MEDIUM |
|
Milliseconds before the first poll starts. |
1000L |
MEDIUM |
|
Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. |
0L |
MEDIUM |
|
The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. One of: [TRACE] [DEBUG] [INFO] [WARN] [ERROR] [OFF]. Enum values:
|
"TRACE" |
MEDIUM |
|
Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. |
MEDIUM |
||
To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. |
"none" |
MEDIUM |
|
To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. |
MEDIUM |
||
Whether the scheduler should be auto started. |
true |
MEDIUM |
|
Time unit for initialDelay and delay options. One of: [NANOSECONDS] [MICROSECONDS] [MILLISECONDS] [SECONDS] [MINUTES] [HOURS] [DAYS]. Enum values:
|
"MILLISECONDS" |
MEDIUM |
|
Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. |
true |
MEDIUM |
|
Whether connections to IBM i are secured with SSL. |
false |
MEDIUM |
|
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 |
|
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 |
MEDIUM |
|
Default connection pool used by the component. Note that this pool is lazily initialized. This is because in a scenario where the user always provides a pool, it would be wasteful for Camel to initialize and keep an idle pool. |
MEDIUM |
The camel-jt400 source connector has no converters out of the box.
The camel-jt400 source connector has no transforms out of the box.
The camel-jt400 source connector has no aggregation strategies out of the box.