WildFly 37 Model Reference

A messaging resource that allows you to configure High Availability for the ActiveMQ server (the value of ha-policy can be live-only, replication-master, replication-slave, replication-colocated, shared-store-master, shared-store-slave, or shared-store-colocated).

Attributes (13)

  • allow-failback 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.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default
  • cluster-name Name of the cluster used for replication. If it is undefined, the name of the first cluster connection defined in the configuration will be used.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default
  • group-name If set, backup servers will only pair with live servers with matching group-name.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default
  • initial-replication-sync-timeout How long to wait until the initiation replication is synchronized.
    • Attribute Value
    Default Value 30000
    Type LONG
    Nillable true
    Expressions Allowed true
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default
  • max-saved-replicated-journal-size 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.
    • Attribute Value
    Default Value 2
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default
  • restart-backup Will this server, if a backup, restart once it has been stopped because of failback or scaling down.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default
  • scale-down Configure whether this server send its messages to another live server in the scale-down cluster when it is shutdown cleanly.
    • Attribute Value
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default
  • scale-down-cluster-name Name of the cluster used to scale down.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default
  • scale-down-commit-interval The batch size for committing the messages being moved on scale down.
    • Attribute Value
    Default Value -1
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default
  • scale-down-connectors List of connectors used to form the scale-down cluster.
    • Attribute Value
    Type LIST
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default
  • scale-down-discovery-group Name of the discovery group used to build the scale-down cluster
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default
  • scale-down-group-name Name of the group used to scale down.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default
  • synchronized-with-live The replication synchronization process with the live server is complete.
    • Attribute Value
    Type BOOLEAN
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type read-only
    Stability default

Operations (2)

  • add Add an HA Policy to configure high availability for this ActiveMQ server.
    Request Parameter Type Required Expressions Allowed Default value Description
    allow-failback BOOLEAN false true true 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.
    cluster-name STRING false true Name of the cluster used for replication. If it is undefined, the name of the first cluster connection defined in the configuration will be used.
    group-name STRING false true If set, backup servers will only pair with live servers with matching group-name.
    initial-replication-sync-timeout LONG false true 30000 How long to wait until the initiation replication is synchronized.
    max-saved-replicated-journal-size INT false true 2 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.
    restart-backup BOOLEAN false true true Will this server, if a backup, restart once it has been stopped because of failback or scaling down.
    scale-down BOOLEAN false true Configure whether this server send its messages to another live server in the scale-down cluster when it is shutdown cleanly.
    scale-down-cluster-name STRING false true Name of the cluster used to scale down.
    scale-down-commit-interval INT false true -1 The batch size for committing the messages being moved on scale down.
    scale-down-connectors LIST false false List of connectors used to form the scale-down cluster.
    scale-down-discovery-group STRING false false Name of the discovery group used to build the scale-down cluster
    scale-down-group-name STRING false true Name of the group used to scale down.
  • remove Remove the HA Policy.