JT400

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.

Metadata

Property	Value
Scheme	`jt400`
Support Level	Stable
Labels	messaging
Version	4.10.2

Maven Dependency

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-jt400</artifactId>
    <version>4.10.2</version>
</dependency>

Endpoint Properties

Name	Type	Required	Default	Description
`userID`	string	✓		Returns the ID of the IBM i user.
`password`	string	✓		Returns the password of the IBM i user.
`systemName`	string	✓		Returns the name of the IBM i system.
`objectPath`	string	✓		Returns the fully qualified integrated file system path name of the target object of this endpoint.
`type`	object	✓		Whether to work with data queues or remote program call
`ccsid`	integer			Sets the CCSID to use for the connection with the IBM i system.
`format`	object		`text`	Sets the data format for sending messages.
`guiAvailable`	boolean		`false`	Sets whether IBM i prompting is enabled in the environment running Camel.
`keyed`	boolean		`false`	Whether to use keyed or non-keyed data queues.
`searchKey`	string			Search key for keyed data queues.
`messageAction`	object		`OLD`	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).
`readTimeout`	integer		`30000`	Timeout in millis the consumer will wait while trying to read a new message of the data queue.
`searchType`	object		`EQ`	Search type such as EQ for equal etc.
`sendEmptyMessageWhenIdle`	boolean		`false`	If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.
`sendingReply`	boolean		`true`	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.
`bridgeErrorHandler`	boolean		`false`	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.
`exceptionHandler`	object			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.
`exchangePattern`	object			Sets the exchange pattern when the consumer creates an exchange.
`pollStrategy`	object			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.
`outputFieldsIdxArray`	object			Specifies which fields (program parameters) are output parameters.
`outputFieldsLengthArray`	object			Specifies the fields (program parameters) length as in the IBM i program definition.
`procedureName`	string			Procedure name from a service program to call
`lazyStartProducer`	boolean		`false`	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.
`backoffErrorThreshold`	integer			The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
`backoffIdleThreshold`	integer			The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
`backoffMultiplier`	integer			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.
`delay`	integer		`500`	Milliseconds before the next poll.
`greedy`	boolean		`false`	If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
`initialDelay`	integer		`1000`	Milliseconds before the first poll starts.
`repeatCount`	integer		`0`	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.
`runLoggingLevel`	object		`TRACE`	The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
`scheduledExecutorService`	object			Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
`scheduler`	object		`none`	To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler
`schedulerProperties`	object			To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
`startScheduler`	boolean		`true`	Whether the scheduler should be auto started.
`timeUnit`	object		`MILLISECONDS`	Time unit for initialDelay and delay options.
`useFixedDelay`	boolean		`true`	Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
`secured`	boolean		`false`	Whether connections to IBM i are secured with SSL.