Management API Reference for protocol=TCPPING

The configuration of a protocol within a protocol stack.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.clustering.jgroups.protocol	true	/subsystem=jgroups/channel=/fork=/protocol=SYM_ENCRYPT /subsystem=jgroups/stack=/protocol=org.jgroups.protocols.TCPGOSSIP /subsystem=jgroups/stack=/protocol=org.jgroups.protocols.ASYM_ENCRYPT /subsystem=jgroups/stack=/protocol=JDBC_PING /subsystem=jgroups/channel=/fork=/protocol=ASYM_ENCRYPT /subsystem=jgroups/channel=/fork=/protocol=TCPPING /subsystem=jgroups/channel=/fork=/protocol=MPING /subsystem=jgroups/stack=/protocol=org.jgroups.protocols.AUTH /subsystem=jgroups/channel=/fork=/protocol=FD_SOCK /subsystem=jgroups/stack=/protocol=FD_SOCK /subsystem=jgroups/stack=/protocol=MPING /subsystem=jgroups/channel=/fork=/protocol=FD_SOCK2 /subsystem=jgroups/channel=/fork=/protocol=org.jgroups.protocols.TCPGOSSIP /subsystem=jgroups/stack=/protocol= /subsystem=jgroups/channel=/fork=/protocol=AUTH /subsystem=jgroups/channel=/fork=/protocol=org.jgroups.protocols.AUTH /subsystem=jgroups/stack=/protocol=FD_SOCK2 /subsystem=jgroups/stack=/protocol=org.jgroups.protocols.SYM_ENCRYPT /subsystem=jgroups/channel=/fork=/protocol=* /subsystem=jgroups/stack=/protocol=TCPGOSSIP /subsystem=jgroups/channel=/fork=/protocol=org.jgroups.protocols.SYM_ENCRYPT /subsystem=jgroups/stack=/protocol=SYM_ENCRYPT /subsystem=jgroups/channel=/fork=/protocol=org.jgroups.protocols.TCPPING /subsystem=jgroups/channel=/fork=/protocol=org.jgroups.protocols.ASYM_ENCRYPT /subsystem=jgroups/stack=/protocol=org.jgroups.protocols.TCPPING /subsystem=jgroups/stack=/protocol=ASYM_ENCRYPT /subsystem=jgroups/stack=/protocol=AUTH /subsystem=jgroups/channel=/fork=/protocol=JDBC_PING /subsystem=jgroups/channel=/fork=/protocol=TCPGOSSIP /subsystem=jgroups/channel=/fork=/protocol=org.jgroups.protocols.JDBC_PING /subsystem=jgroups/stack=/protocol=org.jgroups.protocols.JDBC_PING

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 }`

socket-bindings - The outbound socket bindings for this protocol.

Type	LIST
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" : "LIST" }, "description" : "The outbound socket bindings for this protocol.", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.network.outbound-socket-binding", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : {"socket-binding-ref" : {"type" : "core"}}}, "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services" }

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 (6)

add - Add a protocol to a protocol stack.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
add-index	INT	false	false		If specified inserts the protocol at the given (zero-based) index. If null it will add at the end.
module	STRING	false	true	org.jgroups	The module with which to resolve the protocol type.
properties	OBJECT	false	true		The properties of this protocol.
socket-bindings	LIST	true	false		The outbound socket bindings for this protocol.
statistics-enabled	BOOLEAN	false	true		Indicates whether or not this protocol will collect statistics overriding stack configuration.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add a protocol to a protocol stack.",
    "request-properties" : {
        "add-index" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "If specified inserts the protocol at the given (zero-based) index. If null it will add at the end.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "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"
            }
        },
        "socket-bindings" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "The outbound socket bindings for this protocol.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "capability-reference" : "org.wildfly.network.outbound-socket-binding",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "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
}

map-clear - Clear all entries from map attribute

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
name	STRING	true	false		Name of list attribute

Raw DMR model


{
    "operation-name" : "map-clear",
    "description" : "Clear all entries from map attribute",
    "request-properties" : {"name" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "Name of list attribute",
        "expressions-allowed" : false,
        "required" : true,
        "nillable" : false,
        "min-length" : 1,
        "max-length" : 2147483647,
        "stability" : "default"
    }},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

map-get - Get entry from map attribute

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
name	STRING	true	false		Name of map attribute
key	STRING	true	false		Key of entry to return

Raw DMR model


{
    "operation-name" : "map-get",
    "description" : "Get entry from map attribute",
    "request-properties" : {
        "name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Name of map attribute",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "key" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Key of entry to return",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : false
}

map-put - Add entry to map attribute

Request Parameter	Type	Required	Expressions Allowed	Description
name	STRING	true	false	Name of map attribute to add entry to
key	STRING	true	false	Key under which value will be added
value	STRING	false	false	Value to be added

Raw DMR model


{
    "operation-name" : "map-put",
    "description" : "Add entry to map attribute",
    "request-properties" : {
        "name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Name of map attribute to add entry to",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "key" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Key under which value will be added",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "value" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Value to be added",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

map-remove - Remove entry from map attribute

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
name	STRING	true	false		Name of map attribute
key	STRING	true	false		Key of entry to remove

Raw DMR model


{
    "operation-name" : "map-remove",
    "description" : "Remove entry from map attribute",
    "request-properties" : {
        "name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Name of map attribute",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "key" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Key of entry to remove",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Remove a protocol from a protocol stack.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove a protocol from a protocol 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.protocol.TCPPING

        
<feature spec="subsystem.jgroups.stack.protocol.TCPPING">
  <param name="stack" value="{resource name}"/>
  <param name="add-index" value="{value}"/>
  <param name="module" value="{value}"/>
  <param name="properties" value="{value}"/>
  <param name="socket-bindings" value="{value}"/>
  <param name="statistics-enabled" value="{value}"/>
<feature/>