Management API Reference for channel

A JGroups channel.

Children (1)

fork

Provided Capabilities (7)

Name	Dynamic	Other provider points
org.wildfly.clustering.jgroups.channel-configuration	true	/subsystem=jgroups/channel=/fork=
org.wildfly.clustering.server.command-dispatcher-factory	true	/subsystem=infinispan/cache-container=/transport=none /subsystem=infinispan/cache-container=/transport=jgroups /subsystem=infinispan
org.wildfly.clustering.group	true	none
org.wildfly.clustering.jgroups.channel	true	/subsystem=jgroups/channel=/fork=
org.wildfly.clustering.command-dispatcher-factory	true	none
org.wildfly.clustering.server.group	true	/subsystem=infinispan/cache-container=/transport=none /subsystem=infinispan/cache-container=/transport=jgroups /subsystem=infinispan
org.wildfly.clustering.jgroups.channel-factory	true	/subsystem=jgroups/channel=/fork= /subsystem=jgroups/stack=*

Attributes (14)

address - The IP address of the channel.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The IP address of the channel.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

address-as-uuid - The address of the channel as a UUID.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The address of the channel as a UUID.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

cluster - The cluster name of the JGroups channel. If undefined, the name of the channel will be used.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The cluster name of the JGroups channel. If undefined, the name of the channel will be used.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

discard-own-messages - If true, do not receive messages sent by this node (ourself).

Type	BOOLEAN
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If true, do not receive messages sent by this node (ourself).", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

module - The module from which to load channel services

Type	STRING
Default Value	org.wildfly.clustering.server
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The module from which to load channel services", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "org.wildfly.clustering.server", "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

received-bytes - The number of bytes received by this channel.

Type	LONG
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The number of bytes received by this channel.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

received-messages - The number of messages received by this channel.

Type	LONG
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The number of messages received by this channel.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

sent-bytes - The number of bytes sent by this channel.

Type	LONG
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The number of bytes sent by this channel.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

sent-messages - The number of messages sent by this channel.

Type	LONG
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The number of messages sent by this channel.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

stack - The protocol stack of the JGroups channel

Type	STRING
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The protocol stack of the JGroups channel", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.clustering.jgroups.channel-factory", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services" }`

state - The state of the channel (OPEN, CONNECTING, CONNECTED, CLOSED).

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The state of the channel (OPEN, CONNECTING, CONNECTED, CLOSED).", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

statistics-enabled - If enabled, collect channel statistics.

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If enabled, collect channel statistics.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

version - The JGroups software version.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The JGroups software version.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

view - The channel's view of group membership.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The channel's view of group membership.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

Operations (2)

add - Add a JGroups channel

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
cluster	STRING	false	true		The cluster name of the JGroups channel. If undefined, the name of the channel will be used.
module	STRING	false	true	org.wildfly.clustering.server	The module from which to load channel services
stack	STRING	true	false		The protocol stack of the JGroups channel
statistics-enabled	BOOLEAN	false	true	false	If enabled, collect channel statistics.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add a JGroups channel",
    "request-properties" : {
        "cluster" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The cluster name of the JGroups channel. If undefined, the name of the channel will be used.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "module" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The module from which to load channel services",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "org.wildfly.clustering.server",
            "stability" : "default"
        },
        "stack" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The protocol stack of the JGroups channel",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "capability-reference" : "org.wildfly.clustering.jgroups.channel-factory",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "statistics-enabled" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "If enabled, collect channel statistics.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Remove a JGroups channel

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove a JGroups channel",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

Galleon Features

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

subsystem.jgroups.channel

        
<feature spec="subsystem.jgroups.channel">
  <param name="channel" value="{resource name}"/>
  <param name="cluster" value="{value}"/>
  <param name="module" value="{value}"/>
  <param name="stack" value="{value}"/>
  <param name="statistics-enabled" value="{value}"/>
<feature/>