Management API Reference for connector-service

A connector service allows you to integrate external components with Apache ActiveMQ Artemis to send and receive messages.

Stability Level: default

Attributes (2)

factory-class - Class name of the factory class that can instantiate the connector service.

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 connector service.", "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 connector service's factory-class

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 connector service's factory-class", "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 }`

Operations (2)

add - Operation adding a connector service

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
factory-class	STRING	true	false		Class name of the factory class that can instantiate the connector service.
params	OBJECT	false	true		A key/value pair understood by the connector service's factory-class

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Operation adding a connector service",
    "request-properties" : {
        "factory-class" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Class name of the factory class that can instantiate the connector service.",
            "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 connector service's factory-class",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Operation removing a connector service

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Operation removing a connector service",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

Galleon Features

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

subsystem.messaging-activemq.server.connector-service

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