Micronaut JMS Configuration Reference

Every documented configuration property of Micronaut JMS, with types, descriptions, and defaults.

Micronaut JMS documentation

20 properties across 4 sections

Micronaut Jms Activemq Artemis Config Properties

Configuration properties for ActiveMqArtemisConfigurationProperties

PropertyTypeDescription
micronaut.jms.activemq.artemis.enabledbooleanWhether ActiveMQ Artemis is active.
micronaut.jms.activemq.artemis.connection-stringjava.lang.StringThe connection string to identify the broker URL, e.g. vm://localhost or tcp://my-activemq-cluster:61616.
micronaut.jms.activemq.artemis.usernamejava.lang.StringThe username.
micronaut.jms.activemq.artemis.passwordjava.lang.StringThe password.

Micronaut Jms Activemq Classic Config Properties

Configuration properties for ActiveMqClassicConfigurationProperties

PropertyTypeDescription
micronaut.jms.activemq.classic.enabledbooleanWhether ActiveMQ Classic is active.
micronaut.jms.activemq.classic.connection-stringjava.lang.StringThe connection string to identify the broker URL, e.g. vm://localhost or tcp://my-activemq-cluster:61616.
micronaut.jms.activemq.classic.usernamejava.lang.StringThe username.
micronaut.jms.activemq.classic.passwordjava.lang.StringThe password.

Micronaut Jms Core Config Properties

Configuration properties for JMSConfigurationProperties

PropertyTypeDescriptionDefault
micronaut.jms.initial-pool-sizejava.lang.IntegerThe initial size of the JMSConnectionPool , SessionPool , and MessageProducerPool .1
micronaut.jms.max-pool-sizejava.lang.IntegerThe maximum size of the JMSConnectionPool , SessionPool , and MessageProducerPool .50

Configuration properties for JMSListenerRecoveryConfiguration

PropertyTypeDescriptionDefault
micronaut.jms.listener-recovery.enabledbooleanWhether listeners recreate a session that the JMS provider reports as failed. Defaults to {@code true}.true
micronaut.jms.listener-recovery.warn-attemptsintThe number of failed attempts to recreate a session that are logged as warnings. Later attempts are logged as errors, and continue until one succeeds or the listener shuts down. Defaults to 10.10
micronaut.jms.listener-recovery.initial-delayjava.time.DurationHow long a consumer waits after a failed attempt before the next one. The wait doubles after each attempt, up to {@link #getMaxDelay()}. It must be positive. Defaults to 1 second.PT1S
micronaut.jms.listener-recovery.max-delayjava.time.DurationThe longest wait between two attempts, which every attempt waits once the doubling reaches it. It must not be shorter than {@link #getInitialDelay()}. Defaults to 1 minute.PT1M

Configuration properties for JMSProducerSessionConfiguration

PropertyTypeDescriptionDefault
micronaut.jms.producer-sessions.enabledbooleanWhether producer methods reuse sessions, on one connection of each connection factory. When disabled, each send takes a connection from the pool and opens a session. Defaults to {@code true}.true
micronaut.jms.producer-sessions.max-idleintThe maximum number of idle sessions kept for each connection factory and session mode. While sends wait for a session, released sessions are kept for them up to {@link #getMaxActive()}; the idle sessions above this number are closed once no send waits. Defaults to 8.8
micronaut.jms.producer-sessions.max-activeintThe maximum number of sessions of each connection factory that sends use at once, of all session modes. When all of them are borrowed, a send waits up to {@link #getMaxWait()} for one to be released. Defaults to 32.32
micronaut.jms.producer-sessions.max-waitjava.time.DurationHow long a send waits for a session when {@link #getMaxActive()} sessions are borrowed, after which the send fails. Defaults to 10 seconds.10s

Micronaut Jms Sqs Config Properties

Configuration properties for SqsConfigurationProperties

PropertyTypeDescriptionDefault
micronaut.jms.sqs.enabledbooleanWhether SQS is active.
micronaut.jms.sqs.number-of-messages-to-prefetchjava.lang.IntegerNumber of messages to prefetch for better receive turnaround times.0