Appendix G. Broker Properties The following is a list of AMQ Broker properties which can be applied directly to the internal java configuration bean instead of using the XML configuration. criticalAnalyzerCheckPeriod Type: long Default: 0 XML name: critical-analyzer-check-period Description: The period defaults to half the critical-analyzer-timeout and is calculated at runtime. pageMaxConcurrentIO Type: int Default: 5 XML name: page-max-concurrent-io Description: The maximum number of concurrent reads allowed during paging. messageCounterSamplePeriod Type: long Default: 10000 XML name: message-counter-sample-period Description: The sample period (in ms) to use for message counters. networkCheckNIC Type: String Default: XML name: network-check-nic Description: The network interface card name to be used to validate the address. globalMaxSize Type: long Default: -1 XML name: global-max-size Description: Size (in bytes) before all addresses will enter into their Full Policy configured upon messages being produced. Supports byte notation like "K", "Mb", "MiB", "GB", etc. journalFileSize Type: int Default: 10485760 XML name: journal-file-size Description: The size (in bytes) of each journal file. Supports byte notation, for example: "K", "Mb", "MiB", "GB". configurationFileRefreshPeriod Type: long Default: 5000 XML name: configuration-file-refresh-period Description: The frequency (in ms) to check the configuration file for modifications. diskScanPeriod Type: int Default: 5000 XML name: disk-scan-period Description: The frequency, in milliseconds, to scan the disks for full disks. journalRetentionDirectory Type: String Default: XML name: journal-retention-directory Description: The directory in which to store journal-retention messages and the retention configuration. networkCheckPeriod Type: long Default: 10000 XML name: network-check-period Description: The frequency, in milliseconds, at which to check if the network is up. journalBufferSize_AIO Type: int Default: 501760 XML name: journal-buffer-size Description: The size, in bytes, of the internal buffer on the journal. Supports byte notation, for example, "K", "Mb", "MiB", "GB". networkCheckURLList Type: String Default: XML name: network-check-URL-list Description: A comma separated list of URLs to use to validate if the broker should be kept up. networkCheckTimeout Type: int Default: 1000 XML name: network-check-timeout Description: The timeout, in milliseconds, to be used on the ping. pageSyncTimeout Type: int Default: XML name: page-sync-timeout Description: The timeout, in nanoseconds, used to sync pages. The exact default value depend on whether the journal is ASYNCIO or NIO. journalPoolFiles Type: int Default: -1 XML name: journal-pool-files Description: The number of journal files to pre-create. criticalAnalyzer Type: boolean Default: true XML name: critical-analyzer Description: Should analyze response time on critical paths and decide for broker log, shutdown or halt. readWholePage Type: boolean Default: false XML name: read-whole-page Description: Specifies whether the whole page is read while getting message after page cache is evicted. maxDiskUsage Type: int Default: 90 XML name: max-disk-usage Description: The maximum percentage of disk usage before the system blocks or fails clients. globalMaxMessages Type: long Default: -1 XML name: global-max-messages Description: Number of messages before all addresses will enter into their address full policy configured. It works in conjunction with global-max-size, with the configured address fully policy being executed when either limit is reached. internalNamingPrefix Type: String Default: XML name: internal-naming-prefix Description: Artemis uses internal queues and addresses to implement certain behaviors. These queues and addresses are prefixed by default with "USD.activemq.internal" to avoid naming clashes with user namespacing. This can be overridden by setting this value to a valid Artemis address. journalFileOpenTimeout Type: int Default: 5 XML name: journal-file-open-timeout Description: The time, in seconds, to wait when opening a new Journal file before timing out and failing. journalCompactPercentage Type: int Default: 30 XML name: journal-compact-percentage Description: The percentage of live data on which to consider compacting the journal. createBindingsDir Type: boolean Default: true XML name: create-bindings-dir Description: A value of true causes the server to create the bindings directory at startup. suppressSessionNotifications Type: boolean Default: false XML name: suppress-session-notifications Description: Whether or not to suppress SESSION_CREATED and SESSION_CLOSED notifications. Set to true to reduce notification overhead. However, these are required to enforce unique client ID utilization in a cluster for MQTT clients. journalBufferTimeout_AIO Type: int Default: XML name: journal-buffer-timeout Description: The timeout,in nanoseconds, used to flush internal buffers on the journal. The exact default value depends on whether the journal is ASYNCIO or NIO. journalType Type: JournalType Default: ASYNCIO XML name: journal-type Description: The type of journal to use. name Type: String Default: XML name: name Description: Node name. If set, it is used in topology notifications. networkCheckPingCommand Type: String Default: XML name: network-check-ping-command Description: The ping command used to ping IPV4 addresses. temporaryQueueNamespace Type: String Default: XML name: temporary-queue-namespace Description: The namespace to use for looking up address settings for temporary queues. pagingDirectory Type: String Default: data/paging XML name: paging-directory Description: The directory in which to store paged messages. journalDirectory Type: String Default: data/journal XML name: journal-directory Description: The directory in which store the journal files. journalBufferSize_NIO Type: int Default: 501760 XML name: journal-buffer-size Description: The size, in bytes, of the internal buffer on the journal. Supports byte notation, for example: "K", "Mb", "MiB", "GB". journalDeviceBlockSize Type: Integer Default: XML name: journal-device-block-size Description: The size, in bytes, used by the device. This is usually translated as fstat/st_blksize and this is a way to bypass the value returned as st_blksize. nodeManagerLockDirectory Type: String Default: XML name: node-manager-lock-directory Description: The directory in which to store the node manager lock file. messageCounterMaxDayHistory Type: int Default: 10 XML name: message-counter-max-day-history Description: The number of days to keep message counter history. largeMessagesDirectory Type: String Default: data/largemessages XML name: large-messages-directory Description: The directory in which to store large messages. networkCheckPing6Command Type: String Default: XML name: network-check-ping6-command Description: The ping command used to ping IPV6 addresses. memoryWarningThreshold Type: int Default: 25 XML name: memory-warning-threshold Description: Percentage of available memory at which a warning is generated. mqttSessionScanInterval Type: long Default: 5000 XML name: mqtt-session-scan-interval Description: The frequency, in milliseconds, at which to scan for expired MQTT sessions. journalMaxAtticFiles Type: int Default: XML name: journal-max-attic-files Description: journalSyncTransactional Type: boolean Default: true XML name: journal-sync-transactional Description: If set to true , waits for transaction data to be synchronized to the journal before returning a response to client. logJournalWriteRate Type: boolean Default: false XML name: log-journal-write-rate Description: Specifies whether to log messages related to the journal write-rate. journalMaxIO_AIO Type: int Default: XML name: journal-max-io Description: The maximum number of write requests that can be in the AIO queue at any one time. The default is 500 for AIO and 1 for NIO. messageExpiryScanPeriod Type: long Default: 30000 XML name: message-expiry-scan-period Description: The frequency, in milliseconds, to scan for expired messages. criticalAnalyzerTimeout Type: long Default: 120000 XML name: critical-analyzer-timeout Description: The default timeout used to analyze timeouts on the critical path. messageCounterEnabled Type: boolean Default: false XML name: message-counter-enabled Description: A value of true means that message counters are enabled. journalCompactMinFiles Type: int Default: 10 XML name: journal-compact-min-files Description: The minimum number of data files before the broker starts to compact files. createJournalDir Type: boolean Default: true XML name: create-journal-dir Description: A value of true means that the journal directory is created. addressQueueScanPeriod Type: long Default: 30000 XML name: address-queue-scan-period Description: The frequency, in milliseconds, to scan for addresses and queues that need to be deleted. memoryMeasureInterval Type: long Default: -1 XML name: memory-measure-interval Description: The frequency, in milliseconds, to sample JVM memory. A value of -1 disables memory sampling. journalSyncNonTransactional Type: boolean Default: true XML name: journal-sync-non-transactional Description: If true , waits for non transaction data to be synced to the journal before returning a response to the client. connectionTtlCheckInterval Type: long Default: 2000 XML name: connection-ttl-check-interval Description: The frequency, in milliseconds, to check connections for ttl violations. rejectEmptyValidatedUser Type: boolean Default: false XML name: reject-empty-validated-user Description: If true , the server does not allow any message that does not have a validated user. In JMS, this is JMSXUserID . journalMaxIO_NIO Type: int Default: XML name: journal-max-io Description: The maximum number of write requests that can be in the AIO queue at any one time. The default is 500 for AIO and 1 for NIO. Currently, broker properties only support using an integer and measures in bytes. transactionTimeoutScanPeriod Type: long Default: 1000 XML name: transaction-timeout-scan-period Description: The frequency, in milliseconds, to scan for timeout transactions. systemPropertyPrefix Type: String Default: XML name: system-property-prefix Description: The prefix used to parse system properties for the configuration. transactionTimeout Type: long Default: 300000 XML name: transaction-timeout Description: The duration, in milliseconds, before a transaction can be removed from the resource manager after the create time. journalLockAcquisitionTimeout Type: long Default: -1 XML name: journal-lock-acquisition-timeout Description: The frequency, in milliseconds, to wait to acquire a file lock on the journal. journalBufferTimeout_NIO Type: int Default: XML name: journal-buffer-timeout Description: The timeout, in nanoseconds, used to flush internal buffers on the journal. The exact default value depends on whether the journal is ASYNCIO or NIO. journalMinFiles Type: int Default: 2 XML name: journal-min-files Description: The number of journal files to pre-create. G.1. bridgeConfigurations bridgeConfigurations.< name >.retryIntervalMultiplier Type: double Default: 1 XML name: retry-interval-multiplier Description: The multiplier to apply to successive retry intervals. bridgeConfigurations.< name >.maxRetryInterval Type: long Default: 2000 XML name: max-retry-interval Description: The limit to the retry-interval growth, due to retry-interval-multiplier. bridgeConfigurations.< name >.filterString Type: String Default: XML name: filter-string Description: bridgeConfigurations.< name >.connectionTTL Type: long Default: 60000 XML name: connection-ttl Description: The duration to keep a connection alive if no data is received from the client. The duration should be greater than the ping period. bridgeConfigurations.< name >.confirmationWindowSize Type: int Default: 1048576 XML name: confirmation-window-size Description: The number of bytes received after which the bridge sends a confirmation. Supports byte notation, for example, "K", "Mb", "MiB", "GB". bridgeConfigurations.< name >.staticConnectors Type: List Default: XML name: static-connectors Description: bridgeConfigurations.< name >.reconnectAttemptsOnSameNode Type: int Default: XML name: reconnect-attempts-on-same-node Description: bridgeConfigurations.< name >.concurrency Type: int Default: 1 XML name: concurrency Description: The number of concurrent workers. More workers can help increase throughput on high latency networks. The default is 1 . bridgeConfigurations.< name >.transformerConfiguration Type: TransformerConfiguration Default: XML name: transformer-configuration Description: bridgeConfigurations.< name >.transformerConfiguration.className Type: String Default: XML name: class-name Description: bridgeConfigurations.< name >.transformerConfiguration.properties Type: Map Default: XML name: property Description: A KEY/VALUE pair to set on the transformer, for example, properties.MY_PROPERTY=MY_VALUE bridgeConfigurations.< name >.password Type: String Default: XML name: password Description: If unspecified, the cluster-password is used. bridgeConfigurations.< name >.queueName Type: String Default: XML name: queue-name Description: The name of the queue from which this bridge consumes. bridgeConfigurations.< name >.forwardingAddress Type: String Default: XML name: forwarding-address Description: Address to forward to. If omitted, the original address is used. bridgeConfigurations.< name >.routingType Type: ComponentConfigurationRoutingType Default: PASS XML name: routing-type Description: How the routing-type on the bridged messages is set. bridgeConfigurations.< name >.name Type: String Default: XML name: name Description: A unique name for this bridge. bridgeConfigurations.< name >.ha Type: boolean Default: false XML name: ha Description: Specifies whether this bridge supports fail-over. bridgeConfigurations.< name >.initialConnectAttempts Type: int Default: -1 XML name: initial-connect-attempts Description: The maximum number of initial connection attempts. The default value of -1 means there is no limit. bridgeConfigurations.< name >.retryInterval Type: long Default: 2000 XML name: retry-interval Description: The interval, in milliseconds, between successive retries. bridgeConfigurations.< name >.producerWindowSize Type: int Default: 1048576 XML name: producer-window-size Description: Producer flow control. Supports byte notation, for example: "K", "Mb", "MiB", "GB". bridgeConfigurations.< name >.clientFailureCheckPeriod Type: long Default: 30000 XML name: check-period Description: The interval, in milliseconds, at which a bridge's client checks if it failed to receive a ping from the server. Specify a value of -1 to disable this check. bridgeConfigurations.< name >.discoveryGroupName Type: String Default: XML name: discovery-group-ref Description: bridgeConfigurations.< name >.user Type: String Default: XML name: user Description: Username. If unspecified, the cluster-user is used. bridgeConfigurations.< name >.useDuplicateDetection Type: boolean Default: true XML name: use-duplicate-detection Description: Specifies whether duplicate detection headers are inserted in forwarded messages. bridgeConfigurations.< name >.minLargeMessageSize Type: int Default: 102400 XML name: min-large-message-size Description: The size, in bytes, above which a message is considered a large message. Large messages are sent over the network in multiple segments. Supports byte notation, for example, "K", "Mb", "MiB", "GB". G.2. AMQPConnections AMQPConnections.< name >.reconnectAttempts Type: int Default: -1 XML name: reconnect-attempts Description: The number of reconnection attempts after a failure. AMQPConnections.< name >.password Type: String Default: XML name: password Description: The password used to connect. If not specified, an anonymous connection is attempted. AMQPConnections.< name >.retryInterval Type: int Default: 5000 XML name: retry-interval Description: The interval, in milliseconds, between successive retries. AMQPConnections.< name >.connectionElements Type: AMQPMirrorBrokerConnectionElement Default: XML name: amqp-connection Description: An AMQP Broker Connection supports 4 types: 1. Mirrors - The broker uses an AMQP connection to another broker and duplicates messages and sends acknowledgments over the wire. 2. Senders - Messages received on specific queues are transferred to another endpoint. 3. Receivers - The broker pulls messages from another endpoint. 4. Peers - The broker creates both senders and receivers on another endpoint that knows how to handle them. This is currently implemented by Apache Qpid Dispatch. Currently, only mirror type is supported. AMQPConnections.< name >.connectionElements.< name >.messageAcknowledgments Type: boolean Default: XML name: message-acknowledgments Description: If true , message acknowledgments are mirrored. AMQPConnections.< name >.connectionElements.< name >.queueRemoval Type: boolean Default: XML name: queue-removal Description: Specifies whether the mirror queue deletes events for addresses and queues. AMQPConnections.< name >.connectionElements.< name >.addressFilter Type: String Default: XML name: address-filter Description: Specifies a filter that the mirror uses to determine which events are forwarded towards to the target server based on source address. AMQPConnections.< name >.connectionElements.< name >.queueCreation Type: boolean Default: XML name: queue-creation Description: Specifies whether the mirror queue creates events for addresses and queues. AMQPConnections.< name >.autostart Type: boolean Default: true XML name: auto-start Description: Specifies whether the broker connection is started when the server is started. AMQPConnections.< name >.user Type: String Default: XML name: user Description: User name used to connect. If not specified, an anonymous connection is attempted. AMQPConnections.< name >.uri Type: String Default: XML name: uri Description: The URI of the AMQP connection. G.3. divertConfiguration divertConfiguration.transformerConfiguration Type: TransformerConfiguration Default: XML name: transformer-configuration Description: divertConfiguration.transformerConfiguration.className Type: String Default: XML name: class-name Description: divertConfiguration.transformerConfiguration.properties Type: Map Default: XML name: property Description: A KEY/VALUE pair to set on the transformer, for example, ... properties.MY_PROPERTY=MY_VALUE. divertConfiguration.filterString Type: String Default: XML name: filter-string Description: divertConfiguration.routingName Type: String Default: XML name: routing-name Description: The routing name for the divert. divertConfiguration.address Type: String Default: XML name: address Description: The address this divert will divert from. divertConfiguration.forwardingAddress Type: String Default: XML name: forwarding-address Description: The forwarding address for the divert. divertConfiguration.routingType Type: ComponentConfigurationRoutingType( MULTICAST ANYCAST STRIP PASS ) Default: XML name: routing-type Description: How the routing-type on the diverted messages is set. divertConfiguration.exclusive Type: boolean Default: false XML name: exclusive Description: Specifies whether this is an exclusive divert. G.4. addressSettings addressSettings.< address >.configDeleteDiverts Type: DeletionPolicy( OFF FORCE ) Default: XML name: config-delete-addresses Description: addressSettings.< address >.expiryQueuePrefix Type: SimpleString Default: XML name: expiry-queue-prefix Description: addressSettings.< address >.defaultConsumerWindowSize Type: int Default: XML name: default-consumer-window-size Description: addressSettings.< address >.maxReadPageBytes Type: int Default: XML name: max-read-page-bytes Description: addressSettings.< address >.deadLetterQueuePrefix Type: SimpleString Default: XML name: dead-letter-queue-prefix Description: addressSettings.< address >.defaultGroupRebalancePauseDispatch Type: boolean Default: XML name: default-group-rebalance-pause-dispatch Description: addressSettings.< address >.autoCreateAddresses Type: Boolean Default: XML name: auto-create-addresses Description: addressSettings.< address >.slowConsumerThreshold Type: long Default: XML name: slow-consumer-threshold Description: addressSettings.< address >.managementMessageAttributeSizeLimit Type: int Default: XML name: management-message-attribute-size-limit Description: addressSettings.< address >.autoCreateExpiryResources Type: boolean Default: XML name: auto-create-expiry-resources Description: addressSettings.< address >.pageSizeBytes Type: int Default: XML name: page-size-bytes Description: addressSettings.< address >.minExpiryDelay Type: Long Default: XML name: min-expiry-delay Description: addressSettings.< address >.defaultConsumersBeforeDispatch Type: Integer Default: XML name: default-consumers-before-dispatch Description: addressSettings.< address >.expiryQueueSuffix Type: SimpleString Default: XML name: expiry-queue-suffix Description: addressSettings.< address >.configDeleteQueues Type: DeletionPolicy( OFF FORCE ) Default: XML name: config-delete-queues Description: addressSettings.< address >.enableIngressTimestamp Type: boolean Default: XML name: enable-ingress-timestamp Description: addressSettings.< address >.autoDeleteCreatedQueues Type: Boolean Default: XML name: auto-delete-created-queues Description: addressSettings.< address >.expiryAddress Type: SimpleString Default: XML name: expiry-address Description: addressSettings.< address >.managementBrowsePageSize Type: int Default: XML name: management-browse-page-size Description: addressSettings.< address >.autoDeleteQueues Type: Boolean Default: XML name: auto-delete-queues Description: addressSettings.< address >.retroactiveMessageCount Type: long Default: XML name: retroactive-message-count Description: addressSettings.< address >.maxExpiryDelay Type: Long Default: XML name: max-expiry-delay Description: addressSettings.< address >.maxDeliveryAttempts Type: int Default: XML name: max-delivery-attempts Description: addressSettings.< address >.defaultGroupFirstKey Type: SimpleString Default: XML name: default-group-first-key Description: addressSettings.< address >.slowConsumerCheckPeriod Type: long Default: XML name: slow-consumer-check-period Description: addressSettings.< address >.defaultPurgeOnNoConsumers Type: Boolean Default: XML name: default-purge-on-no-consumers Description: addressSettings.< address >.defaultLastValueKey Type: SimpleString Default: XML name: default-last-value-key Description: addressSettings.< address >.autoCreateQueues Type: Boolean Default: XML name: auto-create-queues Description: addressSettings.< address >.defaultExclusiveQueue Type: Boolean Default: XML name: default-exclusive-queue Description: addressSettings.< address >.defaultMaxConsumers Type: Integer Default: XML name: default-max-consumers Description: addressSettings.< address >.defaultQueueRoutingType Type: RoutingType( MULTICAST ANYCAST ) Default: XML name: default-queue-routing-type Description: addressSettings.< address >.messageCounterHistoryDayLimit Type: int Default: XML name: message-counter-history-day-limit Description: addressSettings.< address >.defaultGroupRebalance Type: boolean Default: XML name: default-group-rebalance Description: addressSettings.< address >.defaultAddressRoutingType Type: RoutingType( MULTICAST ANYCAST ) Default: XML name: default-address-routing-type Description: addressSettings.< address >.maxSizeBytesRejectThreshold Type: long Default: XML name: max-size-bytes-reject-threshold Description: addressSettings.< address >.pageCacheMaxSize Type: int Default: XML name: page-cache-max-size Description: addressSettings.< address >.autoCreateDeadLetterResources Type: boolean Default: XML name: auto-create-dead-letter-resources Description: addressSettings.< address >.maxRedeliveryDelay Type: long Default: XML name: max-redelivery-delay Description: addressSettings.< address >.configDeleteAddresses Type: DeletionPolicy Default: XML name: config-delete-addresses Description: addressSettings.< address >.deadLetterAddress Type: SimpleString Default: XML name: dead-letter-address Description: addressSettings.< address >.autoDeleteQueuesMessageCount Type: long Default: XML name: auto-delete-queues-message-count Description: addressSettings.< address >.autoDeleteAddresses Type: Boolean Default: XML name: auto-delete-addresses Description: addressSettings.< address >.addressFullMessagePolicy Type: AddressFullMessagePolicy Default: XML name: address-full-message-policy Description: addressSettings.< address >.maxSizeBytes Type: long Default: XML name: max-size-bytes Description: addressSettings.< address >.defaultDelayBeforeDispatch Type: Long Default: XML name: default-delay-before-dispatch Description: addressSettings.< address >.redistributionDelay Type: long Default: XML name: redistribution-delay Description: addressSettings.< address >.maxSizeMessages Type: long Default: XML name: max-size-messages Description: addressSettings.< address >.redeliveryMultiplier Type: double Default: XML name: redelivery-multiplier Description: addressSettings.< address >.defaultRingSize Type: long Default: XML name: default-ring-size Description: addressSettings.< address >.defaultLastValueQueue Type: boolean Default: XML name: default-last-value-queue Description: addressSettings.< address >.slowConsumerPolicy Type: SlowConsumerPolicy( KILL NOTIFY ) Default: XML name: slow-consumer-policy Description: addressSettings.< address >.redeliveryCollisionAvoidanceFactor Type: double Default: XML name: redelivery-collision-avoidance-factor Description: addressSettings.< address >.autoDeleteQueuesDelay Type: long Default: XML name: auto-delete-queues-delay Description: addressSettings.< address >.autoDeleteAddressesDelay Type: long Default: XML name: auto-delete-addresses-delay Description: addressSettings.< address >.expiryDelay Type: Long Default: XML name: expiry-delay Description: addressSettings.< address >.enableMetrics Type: boolean Default: XML name: enable-metrics Description: addressSettings.< address >.sendToDLAOnNoRoute Type: boolean Default: XML name: send-to-d-l-a-on-no-route Description: addressSettings.< address >.slowConsumerThresholdMeasurementUnit Type: SlowConsumerThresholdMeasurementUnit( MESSAGES_PER_SECOND MESSAGES_PER_MINUTE MESSAGES_PER_HOUR MESSAGES_PER_DAY ) Default: XML name: slow-consumer-threshold-measurement-unit Description: addressSettings.< address >.redeliveryDelay Type: long Default: XML name: redelivery-delay Description: addressSettings.< address >.deadLetterQueueSuffix Type: SimpleString Default: XML name: dead-letter-queue-suffix Description: addressSettings.< address >.defaultNonDestructive Type: boolean Default: XML name: default-non-destructive Description: G.5. federationConfigurations federationConfigurations.< name >.transformerConfigurations Type: FederationTransformerConfiguration Default: XML name: transformer Description: Optional transformer configuration. federationConfigurations.< name >.transformerConfigurations.< name >.transformerConfiguration Type: TransformerConfiguration Default: XML name: transformer Description: Allows the addition of a custom transformer to amend the message. federationConfigurations.< name >.transformerConfigurations.< name >.transformerConfiguration.< name >.className Type: String Default: XML name: class-name Description: The class name of the Transformer implementation. federationConfigurations.< name >.transformerConfigurations.< name >.transformerConfiguration.< name >.properties Type: Map Default: XML name: property Description: A KEY/VALUE pair to set on the transformer, for example, ... properties.MY_PROPERTY=MY_VALUE. federationConfigurations.< name >.queuePolicies Type: FederationQueuePolicyConfiguration Default: XML name: queue-policy Description: federationConfigurations.< name >.queuePolicies.< name >.priorityAdjustment Type: Integer Default: XML name: priority-adjustment Description: When a consumer attaches, its priority is used to create the upstream consumer, but with an adjustment so that local consumers are load balanced before remote consumers. federationConfigurations.< name >.queuePolicies.< name >.excludes Type: Matcher Default: XML name: exclude Description: A list of queue matches to exclude. federationConfigurations.< name >.queuePolicies.< name >.excludes.< name >.queueMatch Type: String Default: XML name: queue-match Description: A queue match pattern to apply. If none are present, all queues are matched. federationConfigurations.< name >.queuePolicies.< name >.transformerRef Type: String Default: XML name: transformer-ref Description: The ref name for a transformer that you want to configure to transform the message on federation transfer. federationConfigurations.< name >.queuePolicies.< name >.includes Type: Matcher Default: XML name: queue-match Description: federationConfigurations.< name >.queuePolicies.< name >.excludes.< name >.queueMatch Type: String Default: XML name: queue-match Description: A queue match pattern to apply. If none are present, all queues are matched. federationConfigurations.< name >.queuePolicies.< name >.includeFederated Type: boolean Default: XML name: include-federated Description: When the value is set to false , the configuration does not re-federate an already-federated consumer,that is, a consumer on a federated queue. This avoids a situation where, in a symmetric or closed-loop topology, there are no non-federated consumers and messages flow endlessly around the system. federationConfigurations.< name >.upstreamConfigurations Type: FederationUpstreamConfiguration Default: XML name: upstream Description: federationConfigurations.< name >.upstreamConfigurations.< name >.connectionConfiguration Type: FederationConnectionConfiguration Default: XML name: connection-configuration Description: The streams connection configuration. federationConfigurations.< name >.upstreamConfigurations.< name >.connectionConfiguration.priorityAdjustment Type: int Default: XML name: priority-adjustment Description: federationConfigurations.< name >.upstreamConfigurations.< name >.connectionConfiguration.retryIntervalMultiplier Type: double Default: 1 XML name: retry-interval-multiplier Description: The multiplier to apply to the retry-interval. federationConfigurations.< name >.upstreamConfigurations.< name >.connectionConfiguration.shareConnection Type: boolean Default: false XML name: share-connection Description: If set to true , the same connection is shared if there is a downstream and upstream connection configured for the same broker. federationConfigurations.< name >.upstreamConfigurations.< name >.connectionConfiguration.maxRetryInterval Type: long Default: 2000 XML name: max-retry-interval Description: The maximum value for retry-interval. federationConfigurations.< name >.upstreamConfigurations.< name >.connectionConfiguration.connectionTTL Type: long Default: XML name: connection-t-t-l Description: federationConfigurations.< name >.upstreamConfigurations.< name >.connectionConfiguration.circuitBreakerTimeout Type: long Default: 30000 XML name: circuit-breaker-timeout Description: Specifies if this connection supports fail-over. federationConfigurations.< name >.upstreamConfigurations.< name >.connectionConfiguration.callTimeout Type: long Default: 30000 XML name: call-timeout Description: The duration to wait for a reply. federationConfigurations.< name >.upstreamConfigurations.< name >.connectionConfiguration.staticConnectors Type: List Default: XML name: static-connectors Description: A list of connector references configured via connectors. federationConfigurations.< name >.upstreamConfigurations.< name >.connectionConfiguration.reconnectAttempts Type: int Default: -1 XML name: reconnect-attempts Description: The number of reconnection attempts after a failure. federationConfigurations.< name >.upstreamConfigurations.< name >.connectionConfiguration.password Type: String Default: XML name: password Description: A password. If not specified, the federated password is used. federationConfigurations.< name >.upstreamConfigurations.< name >.connectionConfiguration.callFailoverTimeout Type: long Default: -1 XML name: call-failover-timeout Description: The duration to wait for a reply during a fail-over. A value of -1 means there is no limit. federationConfigurations.< name >.upstreamConfigurations.< name >.connectionConfiguration.hA Type: boolean Default: XML name: h-a Description: federationConfigurations.< name >.upstreamConfigurations.< name >.connectionConfiguration.initialConnectAttempts Type: int Default: -1 XML name: initial-connect-attempts Description: The number of initial attempts to connect. federationConfigurations.< name >.upstreamConfigurations.< name >.connectionConfiguration.retryInterval Type: long Default: 500 XML name: retry-interval Description: The interval, in milliseconds, between successive retries. federationConfigurations.< name >.upstreamConfigurations.< name >.connectionConfiguration.clientFailureCheckPeriod Type: long Default: XML name: client-failure-check-period Description: federationConfigurations.< name >.upstreamConfigurations.< name >.connectionConfiguration.username Type: String Default: XML name: username Description: federationConfigurations.< name >.upstreamConfigurations.< name >.policyRefs Type: Collection Default: XML name: policy-refs Description: federationConfigurations.< name >.upstreamConfigurations.< name >.staticConnectors Type: List Default: XML name: static-connectors Description: A list of connector references configured via connectors. federationConfigurations.< name >.downstreamConfigurations Type: FederationDownstreamConfiguration Default: XML name: downstream Description: federationConfigurations.< name >.downstreamConfigurations.< name >.connectionConfiguration Type: FederationConnectionConfiguration Default: XML name: connection-configuration Description: The streams connection configuration. federationConfigurations.< name >.downstreamConfigurations.< name >.connectionConfiguration.priorityAdjustment Type: int Default: XML name: priority-adjustment Description: federationConfigurations.< name >.downstreamConfigurations.< name >.connectionConfiguration.retryIntervalMultiplier Type: double Default: 1 XML name: retry-interval-multiplier Description: The multiplier to apply to the retry-interval. federationConfigurations.< name >.downstreamConfigurations.< name >.connectionConfiguration.shareConnection Type: boolean Default: false XML name: share-connection Description: If set to true , the same connection is shared if there is a downstream and upstream connection configured for the same broker. federationConfigurations.< name >.downstreamConfigurations.< name >.connectionConfiguration.maxRetryInterval Type: long Default: 2000 XML name: max-retry-interval Description: The maximum value for the retry-interval. federationConfigurations.< name >.downstreamConfigurations.< name >.connectionConfiguration.connectionTTL Type: long Default: XML name: connection-t-t-l Description: federationConfigurations.< name >.downstreamConfigurations.< name >.connectionConfiguration.circuitBreakerTimeout Type: long Default: 30000 XML name: circuit-breaker-timeout Description: Specifies whether this connection supports fail-over. federationConfigurations.< name >.downstreamConfigurations.< name >.connectionConfiguration.callTimeout Type: long Default: 30000 XML name: call-timeout Description: The duration to wait for a reply. federationConfigurations.< name >.downstreamConfigurations.< name >.connectionConfiguration.staticConnectors Type: List Default: XML name: static-connectors Description: A list of connector references configured via connectors. federationConfigurations.< name >.downstreamConfigurations.< name >.connectionConfiguration.reconnectAttempts Type: int Default: -1 XML name: reconnect-attempts Description: The number of reconnection attempts after a failure. federationConfigurations.< name >.downstreamConfigurations.< name >.connectionConfiguration.password Type: String Default: XML name: password Description: A password. If not specified, the federated password is used. federationConfigurations.< name >.downstreamConfigurations.< name >.connectionConfiguration.callFailoverTimeout Type: long Default: -1 XML name: call-failover-timeout Description: The duration to wait for a reply during a fail-over. A value of -1 means there is no limit. federationConfigurations.< name >.downstreamConfigurations.< name >.connectionConfiguration.hA Type: boolean Default: XML name: h-a Description: federationConfigurations.< name >.downstreamConfigurations.< name >.connectionConfiguration.initialConnectAttempts Type: int Default: -1 XML name: initial-connect-attempts Description: The number of initial attempts to connect. federationConfigurations.< name >.downstreamConfigurations.< name >.connectionConfiguration.retryInterval Type: long Default: 500 XML name: retry-interval Description: The period, in milliseconds, between successive retries. federationConfigurations.< name >.downstreamConfigurations.< name >.connectionConfiguration.clientFailureCheckPeriod Type: long Default: XML name: client-failure-check-period Description: federationConfigurations.< name >.downstreamConfigurations.< name >.connectionConfiguration.username Type: String Default: XML name: username Description: federationConfigurations.< name >.downstreamConfigurations.< name >.policyRefs Type: Collection Default: XML name: policy-refs Description: federationConfigurations.< name >.downstreamConfigurations.< name >.staticConnectors Type: List Default: XML name: static-connectors Description: A list of connector references configured via connectors. federationConfigurations.< name >.federationPolicys Type: FederationPolicy Default: XML name: policy-set Description: federationConfigurations.< name >.addressPolicies Type: FederationAddressPolicyConfiguration Default: XML name: address-policy Description: federationConfigurations.< name >.addressPolicies.< name >.autoDeleteMessageCount Type: Long Default: XML name: auto-delete-message-count Description: The maximum number of messages that can still be in a dynamically-created remote queue before that queue is eligible to be automatically deleted. federationConfigurations.< name >.addressPolicies.< name >.enableDivertBindings Type: Boolean Default: XML name: enable-divert-bindings Description: Setting to true enables divert bindings to be listened-to for demand. If there is a divert binding with an address that matches the included addresses for the address policy, then any queue bindings that match the forwarding address of the divert will create demand. The default value is false . federationConfigurations.< name >.addressPolicies.< name >.includes.{NAME}.addressMatch Type: Matcher Default: XML name: include Description: federationConfigurations.< name >.addressPolicies.< name >.maxHops Type: int Default: XML name: max-hops Description: The number of hops that a message can make for it to be federated. federationConfigurations.< name >.addressPolicies.< name >.transformerRef Type: String Default: XML name: transformer-ref Description: The ref name for a transformer that you want to configure to transform the message on federation transfer. federationConfigurations.< name >.addressPolicies.< name >.autoDeleteDelay Type: Long Default: XML name: auto-delete-delay Description: The duration, in milliseconds, after the downstream broker disconnects before the upstream queue can be automatically deleted. federationConfigurations.< name >.addressPolicies.< name >.autoDelete Type: Boolean Default: XML name: auto-delete Description: For address federation, the downstream dynamically creates a durable queue on the upstream address. Specifies if the upstream queue is deleted once the downstream disconnects and the delay and message count parameters are met. federationConfigurations.< name >.addressPolicies.< name >.excludes.{NAME}.addressMatch Type: Matcher Default: XML name: include Description: G.6. clusterConfigurations clusterConfigurations.< name >.retryIntervalMultiplier Type: double Default: 1 XML name: retry-interval-multiplier Description: The multiplier to apply to the retry-interval. clusterConfigurations.< name >.maxRetryInterval Type: long Default: 2000 XML name: max-retry-interval Description: The maximum value for retry-interval. clusterConfigurations.< name >.address Type: String Default: XML name: address Description: The name of the address to which this cluster connection applies. clusterConfigurations.< name >.maxHops Type: int Default: 1 XML name: max-hops Description: The maximum number of hops to which the cluster topology is propagated. clusterConfigurations.< name >.connectionTTL Type: long Default: 60000 XML name: connection-ttl Description: The duration to keep a connection alive if no data is received from the client. clusterConfigurations.< name >.clusterNotificationInterval Type: long Default: 1000 XML name: notification-interval Description: The interval at which the cluster connection notifies the cluster of its existence. clusterConfigurations.< name >.confirmationWindowSize Type: int Default: 1048576 XML name: confirmation-window-size Description: The size, in bytes, of the window used for confirming data from the server. Supports byte notation, for example, "K", "Mb", "MiB", "GB". clusterConfigurations.< name >.callTimeout Type: long Default: 30000 XML name: call-timeout Description: The duration to wait for a reply. clusterConfigurations.< name >.staticConnectors Type: List Default: XML name: static-connectors Description: A list of connectors references names. clusterConfigurations.< name >.clusterNotificationAttempts Type: int Default: 2 XML name: notification-attempts Description: The number of times this cluster connection attempts to notify the cluster of its existence. clusterConfigurations.< name >.allowDirectConnectionsOnly Type: boolean Default: false XML name: allow-direct-connections-only Description: Restricts cluster connections to the listed connector-refs. clusterConfigurations.< name >.reconnectAttempts Type: int Default: -1 XML name: reconnect-attempts Description: The number of reconnection attempts after a failure. clusterConfigurations.< name >.duplicateDetection Type: boolean Default: true XML name: use-duplicate-detection Description: Specifies if duplicate detection headers are inserted in forwarded messages. clusterConfigurations.< name >.callFailoverTimeout Type: long Default: -1 XML name: call-failover-timeout Description: The duration to wait for a reply during a fail-over. A value of -1 means there is no limit. clusterConfigurations.< name >.messageLoadBalancingType Type: MessageLoadBalancingType( OFF STRICT ON_DEMAND OFF_WITH_REDISTRIBUTION ) Default: XML name: message-load-balancing-type Description: clusterConfigurations.< name >.initialConnectAttempts Type: int Default: -1 XML name: initial-connect-attempts Description: The number of initial attempts to connect. clusterConfigurations.< name >.connectorName Type: String Default: XML name: connector-ref Description: The name of the connector reference to use. clusterConfigurations.< name >.retryInterval Type: long Default: 500 XML name: retry-interval Description: The interval, in milliseconds, between successive retries. clusterConfigurations.< name >.producerWindowSize Type: int Default: 1048576 XML name: producer-window-size Description: Producer flow control. Supports byte notation, for example, "K", "Mb", "MiB", "GB". clusterConfigurations.< name >.clientFailureCheckPeriod Type: long Default: XML name: client-failure-check-period Description: clusterConfigurations.< name >.discoveryGroupName Type: String Default: XML name: discovery-group-name Description: The name of the discovery group used by this cluster-connection. clusterConfigurations.< name >.minLargeMessageSize Type: int Default: XML name: min-large-message-size Description: The size, in bytes, above which a message is considered a large message. Large messages are sent over the network in multiple segments. Supports byte notation, for example, "K", "Mb", "MiB", "GB". G.7. connectionRouters connectionRouters.< name >.cacheConfiguration Type: CacheConfiguration Default: XML name: cache Description: Controls if the cache entries are persisted and how often a cache removes its entries. connectionRouters.< name >.cacheConfiguration.persisted Type: boolean Default: false XML name: persisted Description: A value of true means that the cache entries are persisted. connectionRouters.< name >.cacheConfiguration.timeout Type: int Default: -1 XML name: timeout Description: The timeout, in milliseconds, before cache entries are removed. connectionRouters.< name >.keyFilter Type: String Default: XML name: key-filter Description: A filter for the target key. connectionRouters.< name >.keyType Type: KeyType( CLIENT_ID SNI_HOST SOURCE_IP USER_NAME ROLE_NAME ) Default: XML name: key-type Description: The optional target key. connectionRouters.< name >.localTargetFilter Type: String Default: XML name: local-target-filter Description: A filter to find the local target. connectionRouters.< name >.poolConfiguration Type: PoolConfiguration Default: XML name: pool Description: The pool configuration. connectionRouters.< name >.poolConfiguration.quorumTimeout Type: int Default: 3000 XML name: quorum-timeout Description: The timeout, in milliseconds, used to get the minimum number of ready targets. connectionRouters.< name >.poolConfiguration.password Type: String Default: XML name: password Description: The password to access the targets. connectionRouters.< name >.poolConfiguration.localTargetEnabled Type: boolean Default: false XML name: local-target-enabled Description: A value of true means that the local target is enabled. connectionRouters.< name >.poolConfiguration.checkPeriod Type: int Default: 5000 XML name: check-period Description: The period, in milliseconds, used to check if a target is ready. connectionRouters.< name >.poolConfiguration.quorumSize Type: int Default: 1 XML name: quorum-size Description: The minimum number of ready targets. connectionRouters.< name >.poolConfiguration.staticConnectors Type: List Default: XML name: static-connectors Description: A list of connector references configured via connectors. connectionRouters.< name >.poolConfiguration.discoveryGroupName Type: String Default: XML name: discovery-group-name Description: The name of a discovery group used by this bridge. connectionRouters.< name >.poolConfiguration.clusterConnection Type: String Default: XML name: cluster-connection Description: The name of a cluster connection. connectionRouters.< name >.poolConfiguration.username Type: String Default: XML name: username Description: The username to access the targets. connectionRouters.< name >.policyConfiguration Type: NamedPropertyConfiguration Default: XML name: policy-configuration Description: connectionRouters.< name >..properties.{PROPERTY} Type: Properties Default: XML name: property Description: A set of Key value pairs specific to each named property. Revised on 2024-06-10 15:29:14 UTC

Commands: