Management API Reference for discovery-group

Multicast group to listen to receive broadcast from other servers announcing their connectors.

Deprecated Since 9.0.0

Use instead a socket-discovery-group or a jgroups-discovery-group to create a discovery-group.

Attributes (6)

initial-wait-timeout - Period, in ms, to wait for an initial broadcast to give us at least one node in the cluster.

Type	LONG
Default Value	10000
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" : "Period, in ms, to wait for an initial broadcast to give us at least one node in the cluster.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 10000, "unit" : "MILLISECONDS", "stability" : "default", "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"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

jgroups-cluster - The logical cluster name.

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" : "The logical cluster name.", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["socket-binding"], "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"], "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", "capability-reference" : null }

refresh-timeout - Period the discovery group waits after receiving the last broadcast from a particular server before removing that server's connector pair entry from its list.

Type	LONG
Default Value	10000
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" : "Period the discovery group waits after receiving the last broadcast from a particular server before removing that server's connector pair entry from its list.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 10000, "unit" : "MILLISECONDS", "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

socket-binding - The discovery group socket binding.

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" : "The discovery group socket binding.", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["jgroups-cluster"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : {"socket-binding-ref" : {"type" : "core"}}}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

Operations (10)

add - Add a discovery group.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
initial-wait-timeout	LONG	false	true	10000	Period, in ms, to wait for an initial broadcast to give us at least one node in the cluster.
jgroups-channel	STRING	false	false		References the name of a JGroups channel. If undefined, the default channel will be used.
jgroups-cluster	STRING	false	false		The logical cluster name.
jgroups-stack	STRING	false	false		References the name of a JGroups channel factory.
refresh-timeout	LONG	false	true	10000	Period the discovery group waits after receiving the last broadcast from a particular server before removing that server's connector pair entry from its list.
socket-binding	STRING	false	false		The discovery group socket binding.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add a discovery group.",
    "request-properties" : {
        "initial-wait-timeout" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "Period, in ms, to wait for an initial broadcast to give us at least one node in the cluster.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 10000,
            "unit" : "MILLISECONDS",
            "stability" : "default"
        },
        "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"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "jgroups-cluster" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The logical cluster name.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["socket-binding"],
            "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"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default",
            "deprecated" : {
                "since" : "3.0.0",
                "reason" : "Deprecated. Use jgroups-channel instead."
            }
        },
        "refresh-timeout" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "Period the discovery group waits after receiving the last broadcast from a particular server before removing that server's connector pair entry from its list.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 10000,
            "unit" : "MILLISECONDS",
            "stability" : "default"
        },
        "socket-binding" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The discovery group socket binding.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["jgroups-cluster"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

list-add - Add entry to list attribute

Request Parameter	Type	Required	Expressions Allowed	Description
name	STRING	true	false	Name of list attribute to add entry to
value	STRING	false	false	Value to add to list
index	INT	false	false	Optional 0 based index where to insert value to

Raw DMR model


{
    "operation-name" : "list-add",
    "description" : "Add entry to list attribute",
    "request-properties" : {
        "name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Name of list attribute to add entry to",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "value" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Value to add to list",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "index" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "Optional 0 based index where to insert value to",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

list-clear - Clear all entries from list attribute

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

Raw DMR model


{
    "operation-name" : "list-clear",
    "description" : "Clear all entries from list 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
}

list-get - Get entry from list attribute

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
name	STRING	true	false		Name of list attribute
index	INT	false	false		Index entry to get

Raw DMR model


{
    "operation-name" : "list-get",
    "description" : "Get entry from list 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"
        },
        "index" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "Index entry to get",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : false
}

list-remove - Remove entry from list attribute

Request Parameter	Type	Required	Expressions Allowed	Description
name	STRING	true	false	Name of list attribute to remove entry from
value	STRING	false	false	Value remove from list
index	INT	false	false	Optional 0 based index to tell what element to remove

Raw DMR model


{
    "operation-name" : "list-remove",
    "description" : "Remove entry from list attribute",
    "request-properties" : {
        "name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Name of list attribute to remove entry from",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "value" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Value remove from list",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "index" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "Optional 0 based index to tell what element to remove",
            "expressions-allowed" : false,
            "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 discovery group.

Raw DMR model


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