Management API Reference for relay=relay.RELAY2

The configuration of a RELAY protocol

Stability Level: default

Children (1)

remote-site

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.clustering.jgroups.relay	true	none

Attributes (4)

module - The module with which to resolve the protocol type.

Type	STRING
Default Value	org.jgroups
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 with which to resolve the protocol type.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "org.jgroups", "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

properties - The properties of this protocol.

Type	OBJECT
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" : "OBJECT" }, "description" : "The properties of this protocol.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

site - The name of the local site.

Type	STRING
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 name of the local site.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

statistics-enabled - Indicates whether or not this protocol will collect statistics overriding stack configuration.

Type	BOOLEAN
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" : "Indicates whether or not this protocol will collect statistics overriding stack configuration.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

Operations (2)

add - Adds a RELAY protocol to this stack

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
module	STRING	false	true	org.jgroups	The module with which to resolve the protocol type.
properties	OBJECT	false	true		The properties of this protocol.
site	STRING	true	true		The name of the local site.
statistics-enabled	BOOLEAN	false	true		Indicates whether or not this protocol will collect statistics overriding stack configuration.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds a RELAY protocol to this stack",
    "request-properties" : {
        "module" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The module with which to resolve the protocol type.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "org.jgroups",
            "stability" : "default"
        },
        "properties" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "The properties of this protocol.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "site" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the local site.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "statistics-enabled" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Indicates whether or not this protocol will collect statistics overriding stack configuration.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Removes the RELAY protocol from this stack

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes the RELAY protocol from this stack",
    "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.stack.relay.relay.RELAY2

        
<feature spec="subsystem.jgroups.stack.relay.relay.RELAY2">
  <param name="stack" value="{resource name}"/>
  <param name="module" value="{value}"/>
  <param name="properties" value="{value}"/>
  <param name="site" value="{value}"/>
  <param name="statistics-enabled" value="{value}"/>
<feature/>