## 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" : 0,
          "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"],
          "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
      }

- socket-binding - The broadcast 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 broadcast 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 (13)

- 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 | false | false |  | The logical cluster name.
  jgroups-stack | STRING | false | false |  | References the name of a JGroups channel factory.
  socket-binding | STRING | false | false |  | The broadcast group socket binding.

  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" : 0,
                  "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"],
                  "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."
                  }
              },
              "socket-binding" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The broadcast 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
      }

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

- list-add - Add entry to list attribute

  Request Parameter | Type | Required | Expressions Allowed | Default value | 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 | Default value | 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 | Default value | 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 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
      }