Nats

To use a shared configuration.

Timeout for connection attempts. (in milliseconds).

Define if we want to flush connection when stopping or not.

Set the flush timeout (in milliseconds).

Sets whether to enable JetStream support for this endpoint.

Sets the name of the JetStream stream to use.

maximum number of pings have not received a response allowed by the client.

Max reconnection attempts.

Turn off echo. If supported by the gnatsd version you are connecting to this flag will prevent the server from echoing messages back to the connection if it has subscriptions on the subject being published to.

Whether or not randomizing the order of servers for the connection attempts.

Whether or not running in pedantic mode (this affects performance).

Ping interval to be aware if connection is still alive (in milliseconds).

Whether or not using reconnection feature.

Waiting time before attempts reconnection (in milliseconds).

Interval to clean up cancelled/timed out requests.

URLs to one or more NAT servers. Use comma to separate URLs when specifying multiple servers.

Whether or not running in verbose mode.

Acknowledgement mode. none = Messages are acknowledged as soon as the server sends them (danger: messages that Camel failed to process is also ack). Clients do not need to ack. all = All messages with a sequence number less than the message acked are also acknowledged. E.g. reading a batch of messages 1..100. Ack on message 100 will acknowledge 1..99 as well. explicit (default) = Each message is acknowledged individually by Camel after the message has been processed, this ensures the message is only ack if success and nack if processing failed due to an exception during routing. Message can be acked out of sequence and create gaps of unacknowledged messages in the consumer.

Enum values:

After a message is delivered to a consumer, the server waits 30 seconds (default) for an acknowledgement. If none arrives (timeout), the message becomes eligible for redelivery.

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.

Sets the name to assign to the JetStream durable consumer. Setting this value makes the consumer durable. The value is used to set the durable() field in the underlying NATS ConsumerConfiguration.Builder.

Whether to allow doing manual acknowledgment via NatsManualAck. If this option is enabled then an instance of NatsManualAck is stored on the org.apache.camel.Exchange message header, which allows end users to access this API and perform manual ack/nak/term operations via the JetStream consumer. When enabled, the automatic acknowledgment on exchange completion is disabled. If the user does not call any ack method, the message remains unacknowledged and NATS will redeliver it after the ackWait timeout expires. This option is only applicable when JetStream is enabled (jetstreamEnabled=true). It has no effect when ackPolicy=None since the server acknowledges messages automatically on delivery.

Maximum number of attempts to deliver a message from Nats to a consumer. Once MaxDeliver is reached, the NATS server stops attempting to deliver that specific message. The message is not deleted, it remains in the stream but is simply skipped. It is recommended to set this option to a sensible value in case a message is poison and can not successfully be processed and would always keep failing.

Stop receiving messages from a topic we are subscribing to after maxMessages.

For negative acknowledgements (NAK), redelivery is delayed by 5 seconds (default). Setting this to 0 or negative makes the redelivery immediately. Be careful as this can cause the consumer to keep re-processing the same message over and over again due to intermediate error that last a while.

Consumer thread pool size (default is 10).

Maximum number of messages to fetch per pull request when using a JetStream Pull Subscription. Only used when \{code pullSubscription=true}.

Maximum time (in milliseconds) to wait for a batch of messages to be available on the server during a single fetch when using a JetStream Pull Subscription. Only used when \{code pullSubscription=true}.

Sets the consumer subscription type for JetStream. Set to true to use a Pull Subscription (consumer explicitly requests messages). Set to false to use a Push Subscription (messages are automatically delivered).

The Queue name if we are using nats for a queue configuration.

Can be used to turn off sending back reply message in the consumer.

Sets a custom ConsumerConfiguration object for the JetStream consumer. This is an advanced option typically used when you need to configure properties not exposed as simple Camel URI parameters. When set, this object will be used to build the final consumer subscription options.

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.

the subject to which subscribers should send response.

Request timeout in milliseconds.

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.

Reference an already instantiated connection to Nats server.

To use a custom header filter strategy.

Sets whether to operate JetStream requests asynchronously.

Whether or not connection trace messages should be printed to standard out for fine grained debugging of connection issues.

If we use useCredentialsFile to true we’ll need to set the credentialsFilePath option. It can be loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems.

Set secure option indicating TLS is required.

To configure security using SSLContextParameters.

Enable usage of global SSL context parameters.

The timestamp of a consumed message.

The SID of a consumed message.

The ReplyTo of a consumed message (may be null).

The Subject of a consumed message.

The Queue name of a consumed message (may be null).

Status message code.

Status message error message.

Number of times this message has been delivered (1 = first, 1 then message has been redelivered).

The manual acknowledgment handle for JetStream messages (only set when manualAck=true).

The payload of the NATS message as a byte array, empty for a message without one: convert or unmarshal it.

Only with exchangePattern=InOut is a core NATS message with a reply subject answered, with the body the route ends with: text, bytes, a stream or a file, and no body sends an empty reply. A Map or a POJO sends no reply, and the requester times out.

What converts to a byte array: text, bytes, a stream or a file. A Map or a POJO is sent as its toString(), and a List or no body fails: marshal it first.

Unchanged for a message that expects no reply (InOnly). A message that expects one (InOut) waits for the reply, up to requestTimeout, and gets its payload as a byte array.