2 Home
gitea_admin edited this page 2026-03-11 14:41:25 +00:00

Nats

Send and receive messages from NATS messaging system.

Metadata

Property Value
Scheme nats
Support Level Stable
Labels messaging
Version 4.10.2

Maven Dependency

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

Endpoint Properties

Name Type Required Default Description
topic string The name of topic we want to use
connectionTimeout integer 2000 Timeout for connection attempts. (in milliseconds)
flushConnection boolean true Define if we want to flush connection when stopping or not
flushTimeout integer 1000 Set the flush timeout (in milliseconds)
maxPingsOut integer 2 maximum number of pings have not received a response allowed by the client
maxReconnectAttempts integer 60 Max reconnection attempts
noEcho boolean false 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.
noRandomizeServers boolean false Whether or not randomizing the order of servers for the connection attempts
pedantic boolean false Whether or not running in pedantic mode (this affects performance)
pingInterval integer 120000 Ping interval to be aware if connection is still alive (in milliseconds)
reconnect boolean true Whether or not using reconnection feature
reconnectTimeWait integer 2000 Waiting time before attempts reconnection (in milliseconds)
requestCleanupInterval integer 5000 Interval to clean up cancelled/timed out requests.
servers string URLs to one or more NAT servers. Use comma to separate URLs when specifying multiple servers.
verbose boolean false Whether or not running in verbose mode
maxMessages string Stop receiving messages from a topic we are subscribing to after maxMessages
poolSize integer 10 Consumer thread pool size (default is 10)
queueName string The Queue name if we are using nats for a queue configuration
replyToDisabled boolean false Can be used to turn off sending back reply message in the consumer.
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.
replySubject string the subject to which subscribers should send response
requestTimeout integer 20000 Request timeout in milliseconds
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.
connection object Reference an already instantiated connection to Nats server
headerFilterStrategy object Define the header filtering strategy
traceConnection boolean false Whether or not connection trace messages should be printed to standard out for fine grained debugging of connection issues.
credentialsFilePath string 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.
secure boolean false Set secure option indicating TLS is required
sslContextParameters object To configure security using SSLContextParameters