Management API Reference for socket-broadcast-group

Provided Capabilities (1)

Attributes (4)

• 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" : 1, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• socket-binding - The broadcast group socket binding.

  Type	STRING
  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" : true, "nillable" : false, "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 }

• started - Whether the broadcast group is started.

  Type	BOOLEAN
  Where is the attribute stored?	runtime
  Access Type	read-only
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether the broadcast group is started.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

Operations (5)

• 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.
  socket-binding	STRING	true	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" : 1, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } }, "socket-binding" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The broadcast group socket binding.", "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 }

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

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

Galleon Features

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

• subsystem.messaging-activemq.server.socket-broadcast-group

          
  <feature spec="subsystem.messaging-activemq.server.socket-broadcast-group">
    <param name="server" value="{resource name}"/>
    <param name="socket-broadcast-group" value="{resource name}"/>
    <param name="broadcast-period" value="{value}"/>
    <param name="connectors" value="{value}"/>
    <param name="socket-binding" value="{value}"/>
  <feature/>
          
        

  📋