Management API Reference for connector

A connector can be used by a client to define how it connects to a server.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.messaging.activemq.connector	true	/subsystem=messaging-activemq/server=/connector= /subsystem=messaging-activemq/server=/in-vm-connector= /subsystem=messaging-activemq/server=/http-connector= /subsystem=messaging-activemq/server=/remote-connector= /subsystem=messaging-activemq/remote-connector=* /subsystem=messaging-activemq/in-vm-connector=* /subsystem=messaging-activemq/http-connector=*

Attributes (3)

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

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.", "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 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 connector 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 connector will use to create 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 connector will use to create 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 }`

Operations (2)

add - Operation adding a connector

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

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Operation adding a connector",
    "request-properties" : {
        "factory-class" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Class name of the factory class that can instantiate the connector.",
            "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 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 connector will use to create 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 removing a connector

Raw DMR model


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

Galleon Features

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

subsystem.messaging-activemq.connector

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