Management API Reference for jgroups-broadcast-group

A broadcast group is the means by which a server broadcasts connectors over the network.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.messaging.activemq.jgroups-broadcast-group	true	none

Attributes (6)

broadcast-period - The period in milliseconds between consecutive broadcasts.

Type	LONG
Default Value	2000
Unit	MILLISECONDS
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The period in milliseconds between consecutive broadcasts.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 2000, "unit" : "MILLISECONDS", "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

connectors - Specifies the names of connectors that will be broadcast.

Type	LIST
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "Specifies the names of connectors that will be broadcast.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

jgroups-channel - References the name of a JGroups channel. If undefined, the default channel will be used.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "References the name of a JGroups channel. If undefined, the default channel will be used.", "expressions-allowed" : false, "required" : false, "nillable" : true, "requires" : ["jgroups-cluster"], "capability-reference" : "org.wildfly.clustering.server.command-dispatcher-factory", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }

jgroups-cluster - The logical cluster name.

Type	STRING
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The logical cluster name.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

jgroups-stack - References the name of a JGroups channel factory.

Deprecated Since 3.0.0

Deprecated. Use jgroups-channel instead.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "References the name of a JGroups channel factory.", "expressions-allowed" : false, "required" : false, "nillable" : true, "requires" : ["jgroups-cluster"], "capability-reference" : "org.wildfly.clustering.jgroups.channel-factory", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "deprecated" : { "since" : "3.0.0", "reason" : "Deprecated. Use jgroups-channel instead." }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }

started - Whether the broadcast group is started.

Type	BOOLEAN
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether the broadcast group is started.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

Operations (5)

add - Add a broadcast group.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
broadcast-period	LONG	false	true	2000	The period in milliseconds between consecutive broadcasts.
connectors	LIST	true	false		Specifies the names of connectors that will be broadcast.
jgroups-channel	STRING	false	false		References the name of a JGroups channel. If undefined, the default channel will be used.
jgroups-cluster	STRING	true	false		The logical cluster name.
jgroups-stack	STRING	false	false		References the name of a JGroups channel factory.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add a broadcast group.",
    "request-properties" : {
        "broadcast-period" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "The period in milliseconds between consecutive broadcasts.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 2000,
            "unit" : "MILLISECONDS",
            "stability" : "default"
        },
        "connectors" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "Specifies the names of connectors that will be broadcast.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "jgroups-channel" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "References the name of a JGroups channel.  If undefined, the default channel will be used.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "requires" : ["jgroups-cluster"],
            "capability-reference" : "org.wildfly.clustering.server.command-dispatcher-factory",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "jgroups-cluster" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The logical cluster name.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "jgroups-stack" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "References the name of a JGroups channel factory.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "requires" : ["jgroups-cluster"],
            "capability-reference" : "org.wildfly.clustering.jgroups.channel-factory",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default",
            "deprecated" : {
                "since" : "3.0.0",
                "reason" : "Deprecated. Use jgroups-channel instead."
            }
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

get-connector-pairs-as-json - Returns the pairs of live-backup connectors that are broadcasted by this broadcast group using JSON serialization.

Reply properties

Type: STRING

Raw DMR model


{
    "operation-name" : "get-connector-pairs-as-json",
    "description" : "Returns the pairs of live-backup connectors that are broadcasted by this broadcast group using JSON serialization.",
    "request-properties" : {},
    "reply-properties" : {"type" : {
        "TYPE_MODEL_VALUE" : "STRING"
    }},
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : true
}

remove - Remove a broadcast group.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove a broadcast group.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "all-services",
    "runtime-only" : false
}

start - Starts the broadcast group.

Raw DMR model


{
    "operation-name" : "start",
    "description" : "Starts the broadcast group.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

stop - Stops the broadcast group.

Raw DMR model


{
    "operation-name" : "stop",
    "description" : "Stops the broadcast group.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

subsystem.messaging-activemq.server.jgroups-broadcast-group

        
<feature spec="subsystem.messaging-activemq.server.jgroups-broadcast-group">
  <param name="jgroups-broadcast-group" value="{resource name}"/>
  <param name="server" value="{resource name}"/>
  <param name="broadcast-period" value="{value}"/>
  <param name="connectors" value="{value}"/>
  <param name="jgroups-channel" value="{value}"/>
  <param name="jgroups-cluster" value="{value}"/>
  <param name="jgroups-stack" value="{value}"/>
<feature/>