Configuration Reference

Version:3.0.0

Nats Config Properties

Table 1. Configuration Properties for ClusterNatsConnectionFactoryConfig
Property	Type	Description
`nats.servers.*.addresses`	java.util.List	The list of addresses
`nats.servers.*.username`	java.lang.String	the username
`nats.servers.*.password`	java.lang.String	the password
`nats.servers.*.token`	java.lang.String	the token
`nats.servers.*.max-reconnect`	int	times to try reconnect
`nats.servers.*.reconnect-wait`	java.time.Duration	time to wait
`nats.servers.*.connection-timeout`	java.time.Duration	maximumTime for inital connection
`nats.servers.*.ping-interval`	java.time.Duration	time between server pings
`nats.servers.*.reconnect-buffer-size`	long	size of the buffer, in bytes, used to store publish messages during reconnect
`nats.servers.*.inbox-prefix`	java.lang.String	custom prefix for request/reply inboxes
`nats.servers.*.no-echo`	boolean	enable or disable echo messages, messages that are sent by this connection back to this connection
`nats.servers.*.utf8-support`	boolean	whether or not the client should support for UTF8 subject names
`nats.servers.*.credentials`	java.lang.String	path to the credentials file to use for authentication with an account enabled server

Table 2. Configuration Properties for DefaultTlsConfiguration
Property	Type	Description
`nats.servers.*.tls`	NatsConnectionFactoryConfig$TLS	The tls configuration
`nats.servers.*.tls.trust-store-path`	java.lang.String	file path for the trust store
`nats.servers.*.tls.trust-store-password`	java.lang.String	used to unlock the trust store
`nats.servers.*.tls.trust-store-type`	java.lang.String	generally the default, but available for special trust store formats/types
`nats.servers.*.tls.certificate-path`	java.lang.String	the path to the certificate

Table 3. Configuration Properties for SingleNatsConnectionFactoryConfig
Property	Type	Description
`nats.addresses`	java.util.List	The list of addresses
`nats.username`	java.lang.String	the username
`nats.password`	java.lang.String	the password
`nats.token`	java.lang.String	the token
`nats.max-reconnect`	int	times to try reconnect
`nats.reconnect-wait`	java.time.Duration	time to wait
`nats.connection-timeout`	java.time.Duration	maximumTime for inital connection
`nats.ping-interval`	java.time.Duration	time between server pings
`nats.reconnect-buffer-size`	long	size of the buffer, in bytes, used to store publish messages during reconnect
`nats.inbox-prefix`	java.lang.String	custom prefix for request/reply inboxes
`nats.no-echo`	boolean	enable or disable echo messages, messages that are sent by this connection back to this connection
`nats.utf8-support`	boolean	whether or not the client should support for UTF8 subject names
`nats.credentials`	java.lang.String	path to the credentials file to use for authentication with an account enabled server

Table 4. Configuration Properties for DefaultTlsConfiguration
Property	Type	Description
`nats.tls`	NatsConnectionFactoryConfig$TLS	The tls configuration
`nats.tls.trust-store-path`	java.lang.String	file path for the trust store
`nats.tls.trust-store-password`	java.lang.String	used to unlock the trust store
`nats.tls.trust-store-type`	java.lang.String	generally the default, but available for special trust store formats/types
`nats.tls.certificate-path`	java.lang.String	the path to the certificate