schema.artemis-configuration.xsd Maven / Gradle / Ivy
Go to download
This artifact provides a single jar that contains all classes required to use remote Jakarta Enterprise Beans and Jakarta Messaging, including
all dependencies. It is intended for use by those not using maven, maven users should just import the Jakarta Enterprise Beans and
Jakarta Messaging BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up
with different versions on classes on the class path).
Node name. If set, it will be used in topology notifications.
If true then the ActiveMQ Artemis Server will make use of any Protocol Managers that are in available on the
classpath. If false then only the core protocol will be available, unless in Embedded mode where users
can inject their own Protocol Managers.
true means that the server will use the file based journal for persistence.
Maximum number of threads to use for the scheduled thread pool
Maximum number of threads to use for the thread pool. -1 means 'no limits'.
true means that graceful shutdown is enabled
how long (in ms) to wait for clients to disconnect before shutting down the server
true means that security is enabled
how long (in ms) to wait before invalidating the security cache
how long (in ms) to wait to acquire a file lock on the journal
true means that the server supports wild card routing
the name of the management address to send management messages to. It is prefixed with "jms.queue" so
that JMS clients can send messages to it.
the name of the address that consumers bind to receive management notifications
Cluster username. It applies to all cluster configurations.
Cluster password. It applies to all cluster configurations.
Class name and its parameters for the Decoder used to decode the masked password. Ignored if
mask-password is false. The format of this property is a full qualified class name optionally followed
by key/value pairs.
This option controls whether passwords in server configuration need be masked. If set to "true" the
passwords are masked.
XXX
true means that the management API is available via JMX
the JMX domain used to registered ActiveMQ Artemis MBeans in the MBeanServer
true means that message counters are enabled
the sample period (in ms) to use for message counters
how many days to keep message counter history
if set, this will override how long (in ms) to keep a connection alive without receiving a ping. -1
disables this setting.
should certain incoming packets on the server be handed off to a thread from the thread pool for
processing or should they be handled on the remoting thread?
how long (in ms) before a transaction can be removed from the resource manager after create time
how often (in ms) to scan for timeout transactions
how often (in ms) to scan for expired messages
the priority of the thread expiring messages
the size of the cache for pre-creating message ID's
true means that ID's are persisted to the journal
a list of <class-name/> elements with the names of classes to use for interceptor incoming
remoting packets
a list of <class-name/> elements with the names of classes to use for interceptor outcoming
remoting packets
True means that the delivery count is persisted before delivery. False means that this only happens
after a message has been cancelled.
a list of remoting connectors configurations to create
a list of remoting acceptors to create
a list of broadcast groups to create
a list of discovery groups to create
a discovery group specification element
a list of diverts to use
a list of pre configured queues to create
address for the queue
whether the queue is durable (persistent)
unique name of this queue
a list of bridges to create
The HA policy of this server
a list of cluster connections
Message Group configuration
the directory to store paged messages in
the directory to store the persisted bindings to
true means that the server will create the bindings directory on start up
The max number of concurrent reads allowed on paging
the directory to store the journal files in
true means that the journal directory will be created
the type of journal to use
The timeout (in nanoseconds) used to flush internal buffers on the journal. The exact default value
depend on whether the journal is ASYNCIO or NIO.
The size of the internal buffer on the journal in KiB.
if true wait for transaction data to be synchronized to the journal before returning response to
client
if true wait for non transaction data to be synced to the journal before returning response to client.
Whether to log messages about the journal write rate
the size (in bytes) of each journal file
how many journal files to pre-create
The percentage of live data on which we consider compacting the journal
The minimal number of data files before we can start compacting
the maximum number of write requests that can be in the AIO queue at any one time. Default is 500 for
AIO and 1 for NIO.
XXX Only meant to be used by project developers
XXX Only meant to be used by project developers
Interval to log server specific information (e.g. memory usage etc)
Percentage of available memory which will trigger a warning log
frequency to sample JVM memory in ms (or -1 to disable memory sampling)
the directory to store large messages
a list of security settings
a permission to add to the matched addresses
the type of permission
a comma-separated list of roles to apply the permission to
regular expression for matching security roles against addresses
a list of address settings
a list of resource limit settings
local bind address that the datagram socket is bound to
local port to which the datagram socket is bound to
multicast address to which the data will be broadcast
UDP port number used for broadcasting
period in milliseconds between consecutive broadcasts
Name of JGroups configuration file. If specified, the server uses JGroups for broadcasting.
Name of JGroups Channel. If specified, the server uses the named channel for broadcasting.
a unique name for the broadcast group
Multicast IP address of the group to listen on
UDP port number of the multi cast group
Name of a JGroups configuration file. If specified, the server uses JGroups for discovery.
Name of a JGroups Channel. If specified, the server uses the named channel for discovery.
Period the discovery group waits after receiving the last broadcast from a particular server before
removing that servers connector pair entry from its list.
time to wait for an initial broadcast to give us at least one node in the cluster
a unique name for the discovery group
unlimited sequence of <class-name/>
the fully qualified name of the interceptor class
Key of a configuration parameter
Value of a configuration parameter
name of queue that this bridge consumes from
address to forward to. If omitted original address is used
whether this bridge supports fail-over
optional name of transformer class
Any message larger than this size is considered a large message (to be sent in
chunks)
The period (in milliseconds) a bridge's client will check if it failed to receive a ping from the
server. -1 disables this check.
how long to keep a connection alive in the absence of any data arriving from the client. This should
be greater than the ping period.
period (in ms) between successive retries
multiplier to apply to successive retry intervals
Limit to the retry-interval growth (due to retry-interval-multiplier)
maximum number of initial connection attempts, -1 means 'no limits'
maximum number of retry attempts, -1 means 'no limits'
should failover be prompted if target server is cleanly shutdown?
should duplicate detection headers be inserted in forwarded messages?
Once the bridge has received this many bytes, it sends a confirmation
username, if unspecified the cluster-user is used
password, if unspecified the cluster-password is used
Upon reconnection this configures the number of time the same node on the topology will be retried
before reseting the server locator and using the initial connectors
name of discovery group used by this bridge
unique name for this bridge
name of the address this cluster connection applies to
Name of the connector reference to use.
The period (in milliseconds) used to check if the cluster connection has failed to receive pings from
another server
how long to keep a connection alive in the absence of any data arriving from the client
Messages larger than this are considered large-messages
How long to wait for a reply
period (in ms) between successive retries
multiplier to apply to the retry-interval
Maximum value for retry-interval
How many attempts should be made to connect initially
How many attempts should be made to reconnect after failure
should duplicate detection headers be inserted in forwarded messages?
DEPRECATED: use message-load-balancing-type instead. Select STRICT to mimic forward-when-no-consumers=true
and ON_DEMAND to mimic forward-when-no-consumers=false.
how should messages be load balanced between servers in a cluster?
maximum number of hops cluster topology is propagated
The size (in bytes) of the window used for confirming data from the server connected to.
How long to wait for a reply if in the middle of a fail-over. -1 means wait forever.
how often the cluster connection will notify the cluster of its existence right after joining the
cluster
how many times this cluster connection will notify the cluster of its existence right after joining
the cluster
The connector to use for scaling down or when as backup in SCALE_DOWN mode
restricts cluster connections to the listed connector-ref's
XXX -- this is a duplicate...
unique name for this cluster connection
an optional class name of a transformer
whether this is an exclusive divert
the routing name for the divert
the address this divert will divert from
the forwarding address for the divert
a unique name for the divert
A live only server with no HA capabilities apart from scale down.
Configuration for a replicated server, either master, slave or colocated.
Configuration for a shared store server, either master, slave or colocated.
A live server configured to replicate.
A backup server configured to replicate.
a replicated lives server that will allow requests to create colocated replicated backup servers.
If true then the server will request a backup on another node
How many times the live server will try to request a backup, -1 means for ever.
How long to wait for retries between attempts to request a backup server.
Whether or not this live server will accept backup requests from other live servers.
The offset to use for the Connectors and Acceptors when creating a new backup server.
the connectors that shouldn't have their ports offset, typically remote connectors or the
connector used in the cluster connection if scalinmg down
The configuration for the live replicated server.
The configuration for any slaves created.
If true then the server will request a backup on another node
How many times the live server will try to request a backup, -1 means for ever.
How long to wait for retries between attempts to request a backup server.
Whether or not this live server will accept backup requests from other live servers.
The offset to use for the Connectors and Acceptors when creating a new backup server.
The configuration for the live shared store server.
The configuration for any shared store backups created.
A shared store live server configuration.
A shared store backup server configuration.
A shared store colocated configuration
The scale down configuration of this live server.
used for replication, if set, (remote) backup servers will only pair with live servers with matching
group-name
Name of the cluster configuration to use for replication. This setting is only necessary in case you
configure multiple cluster connections. It is used by a replicating backups and by live servers that
may attempt fail-back.
Whether to check the cluster for a (live) server using our own server ID when starting
up. This option is only necessary for performing 'fail-back' on replicating
servers. Strictly speaking this setting only applies to live servers and not to
backups.
used for replication, if set, (remote) backup servers will only pair with live servers with matching
group-name
Name of the cluster configuration to use for replication. This setting is only necessary in case you
configure multiple cluster connections. It is used by a replicating backups and by live servers that
may attempt fail-back.
This specifies how many times a replicated backup server can restart after moving its files on start.
Once there are this number of backup journal files the server will stop permanently after if fails
back.
if provided then this backup will scale down rather than becoming live after fail over.
Will this server, if a backup, restart once it has been stopped because of failback or scaling down.
Whether a server will automatically stop when a another places a request to take over
its place. The use case is when a regular server stops and its backup takes over its
duties, later the main server restarts and requests the server (the former backup) to
stop operating.
if we have to start as a replicated server this is the delay to wait before fail-back occurs
used for replication, if set, (remote) backup servers will only pair with live servers with matching
group-name
Name of the cluster configuration to use for replication. This setting is only necessary in case you
configure multiple cluster connections. It is used by a replicating backups and by live servers that
may attempt fail-back.
This specifies how many times a replicated backup server can restart after moving its files on start.
Once there are this number of backup journal files the server will stop permanently after if fails
back.
if provided then this backup will scale down rather than becoming live after fail over.
Will this server, if a backup, restart once it has been stopped because of failback or scaling down.
delay to wait before fail-back occurs on (live's) restart
Will this backup server come live on a normal server shutdown
Whether a server will automatically stop when a another places a request to take over
its place. The use case is when a regular server stops and its backup takes over its
duties, later the main server restarts and requests the server (the former backup) to
stop operating.
delay to wait before fail-back occurs on (live's) restart
Will this backup server come live on a normal server shutdown
if provided then this backup will scale down rather than becoming live after fail over.
Will this server, if a backup, restart once it has been stopped because of failback or scaling down.
If true then the server will request a backup on another node
How many times the live server will try to request a backup, -1 means for ever.
How long to wait for retries between attempts to request a backup server.
Whether or not this live server will accept backup requests from other live servers.
The offset to use for the Connectors and Acceptors when creating a new backup server.
its possible that you only want a server to partake in scale down as a receiver, via a group.
In this case set scale-down to false
The scale down group to scale down to, a server will only scale down to a server within the same group
The discovery group to use for scale down, if not supplied then the scale-down-connectors or first
invm connector will be used
A list of connectors to use for scaling down, if not supplied then the scale-down-discovery-group or
first invm connector will be used
Each cluster should choose 1 node to have a LOCAL grouping handler and all the other nodes should have
REMOTE handlers
A reference to a cluster connection address
How long to wait for a decision
How long a group binding will be used, -1 means for ever. Bindings are removed after this wait
elapses. On the remote node this is used to determine how often you should re-query the main
coordinator in order to update the last time used accordingly.
How often the reaper will be run to check for timed out group bindings. Only valid for LOCAL handlers
A name identifying this grouping-handler
Complex type element to configure an address.
the address to send dead messages to
the address to send expired messages to
Overrides the expiration time for messages using the default value for expiration time. "-1"
disables this setting.
the time (in ms) to wait before redelivering a cancelled message.
multipler to apply to the "redelivery-delay"
Maximum value for the redelivery-delay
how many times to attempt to deliver a message before sending to dead letter address
the maximum size (in bytes) to use in paging for an address (-1 means no limits)
the page size (in bytes) to use for an address
Number of paging files to cache in memory to avoid IO during paging navigation
what happens when an address where "max-size-bytes" is specified becomes full
how many days to keep message counter history for this address
whether to treat the queue as a last value queue
how long (in ms) to wait after the last consumer is closed on a queue before redistributing
messages.
if there are no queues matching this address, whether to forward message to DLA (if it exists for
this address)
The minimum rate of message consumption allowed before a consumer is considered "slow." Measured
in messages-per-second.
what happens when a slow consumer is identified
How often to check for slow consumers on a particular queue. Measured in minutes.
whether or not to automatically create JMS queues when a producer sends or a consumer connects to a
queue
whether or not to delete auto-created JMS queues when the queue has 0 consumers and 0 messages
XXX
Complex type element to configure resource limits for a particular user.
how many connections are allowed by the matched entity (-1 means no limit, default is -1)
how many queues can be created by the matched entity (-1 means no limit, default is -1)
the name of the user to whom the limits should be applied
optional core filter expression (set through attribute)
optional core filter expression
Name of the factory class of the ConnectorService
name of the connector service
© 2015 - 2025 Weber Informatics LLC | Privacy Policy