Management API Reference for in-vm-acceptor

Defines a way in which in-VM connections can be made to the ActiveMQ server.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.messaging.activemq.acceptor	true	/subsystem=messaging-activemq/server=/remote-acceptor= /subsystem=messaging-activemq/server=/acceptor=

Attributes (3)

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

server-id - The server id.

Type	INT
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" : "INT" }, "description" : "The server id.", "expressions-allowed" : true, "required" : true, "nillable" : false, "stability" : "default", "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
params	OBJECT	false	true		A key-value pair understood by the acceptor factory-class and used to configure it.
server-id	INT	true	true		The server id.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Operation adding an acceptor",
    "request-properties" : {
        "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"
            }
        },
        "server-id" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The server id.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "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.in-vm-acceptor

        
<feature spec="subsystem.messaging-activemq.server.in-vm-acceptor">
  <param name="in-vm-acceptor" value="{resource name}"/>
  <param name="server" value="{resource name}"/>
  <param name="params" value="{value}"/>
  <param name="server-id" value="{value}"/>
<feature/>