Management API Reference for acceptor

Provided Capabilities (1)

Attributes (4)

• factory-class - Class name of the factory class that can instantiate the acceptor.

  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" : "Class name of the factory class that can instantiate the acceptor.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• params - A key-value pair understood by the acceptor factory-class and used to configure it.

  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?	no-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "A key-value pair understood by the acceptor factory-class and used to configure it.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

• socket-binding - The socket binding that the acceptor will use to accept connections.

  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 socket binding that the acceptor will use to accept connections.", "expressions-allowed" : false, "required" : false, "nillable" : true, "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 this acceptor 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 this acceptor is started.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

Operations (4)

• add - Operation adding an acceptor

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  factory-class	STRING	true	false		Class name of the factory class that can instantiate the acceptor.
  params	OBJECT	false	true		A key-value pair understood by the acceptor factory-class and used to configure it.
  socket-binding	STRING	false	false		The socket binding that the acceptor will use to accept connections.

  Raw DMR model

  { "operation-name" : "add", "description" : "Operation adding an acceptor", "request-properties" : { "factory-class" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Class name of the factory class that can instantiate the acceptor.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "params" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "A key-value pair understood by the acceptor factory-class and used to configure it.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } }, "socket-binding" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The socket binding that the acceptor will use to accept connections.", "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 }

• remove - Operation adding an acceptor

  Raw DMR model

  { "operation-name" : "remove", "description" : "Operation adding an acceptor", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "restart-required" : "all-services", "runtime-only" : false }

• start - Starts the acceptor.

  Raw DMR model

  { "operation-name" : "start", "description" : "Starts the acceptor.", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : true }

• stop - Stops the acceptor.

  Raw DMR model

  { "operation-name" : "stop", "description" : "Stops the acceptor.", "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.acceptor

          
  <feature spec="subsystem.messaging-activemq.server.acceptor">
    <param name="acceptor" value="{resource name}"/>
    <param name="server" value="{resource name}"/>
    <param name="factory-class" value="{value}"/>
    <param name="params" value="{value}"/>
    <param name="socket-binding" value="{value}"/>
  <feature/>
          
        

  📋