Management API Reference for connector

The configuration of a Remoting connector.

Children (2)

property
security
- sasl

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.remoting.connector	true	/subsystem=remoting/http-connector=*

Attributes (8)

authentication-provider - The "authentication-provider" element contains the name of the authentication provider to use for incoming 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 \"authentication-provider\" element contains the name of the authentication provider to use for incoming connections.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : {"remoting-security" : {"type" : "remoting"}}}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

protocol - Protocol used in the connection.

Type	STRING
Default Value	remote
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Allowed Values	remote+https remote+tls http-remoting remote https-remoting remote+http
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Protocol used in the connection.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : "remote", "allowed" : [ "remote", "remote+tls", "remote+http", "http-remoting", "https-remoting", "remote+https" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

sasl-authentication-factory - Reference to the SASL authentication factory to secure this connector.

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" : "Reference to the SASL authentication factory to secure this connector.", "expressions-allowed" : false, "required" : false, "nillable" : true, "nil-significant" : true, "capability-reference" : "org.wildfly.security.sasl-authentication-factory", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : {"authentication-factory-ref" : {"type" : "core"}}}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }

sasl-protocol - The protocol to pass into the SASL mechanisms used for authentication.

Type	STRING
Default Value	remote
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" : "STRING" }, "description" : "The protocol to pass into the SASL mechanisms used for authentication.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "remote", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : {"remoting-security" : {"type" : "remoting"}}}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

security-realm - The associated security realm to use for authentication for this connector.

Deprecated Since 6.0.0

Connector security settings should be migrated to a sasl-authentication-factory definition.

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 associated security realm to use for authentication for this connector.", "expressions-allowed" : false, "required" : false, "nillable" : true, "nil-significant" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "deprecated" : { "since" : "6.0.0", "reason" : "Connector security settings should be migrated to a sasl-authentication-factory definition." }, "access-constraints" : {"sensitive" : { "security-realm-ref" : {"type" : "core"}, "remoting-security" : {"type" : "remoting"} }}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

server-name - The server name to send in the initial message exchange and for SASL based authentication.

Type	STRING
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" : "STRING" }, "description" : "The server name to send in the initial message exchange and for SASL based authentication.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : {"remoting-security" : {"type" : "remoting"}}}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

socket-binding - The name of the socket binding to attach to.

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 name of the socket binding to attach to.", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.network.socket-binding", "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" }`

ssl-context - Reference to the SSLContext to use for this connector.

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" : "Reference to the SSLContext to use for this connector.", "expressions-allowed" : false, "required" : false, "nillable" : true, "nil-significant" : true, "capability-reference" : "org.wildfly.security.ssl-context", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : {"ssl-ref" : {"type" : "core"}}}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }

Operations (2)

add - Adds a Remoting connector.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
authentication-provider	STRING	false	false		The "authentication-provider" element contains the name of the authentication provider to use for incoming connections.
protocol	STRING	false	false	remote	Protocol used in the connection.
sasl-authentication-factory	STRING	false	false		Reference to the SASL authentication factory to secure this connector.
sasl-protocol	STRING	false	true	remote	The protocol to pass into the SASL mechanisms used for authentication.
security-realm	STRING	false	false		The associated security realm to use for authentication for this connector.
server-name	STRING	false	true		The server name to send in the initial message exchange and for SASL based authentication.
socket-binding	STRING	true	false		The name of the socket binding to attach to.
ssl-context	STRING	false	false		Reference to the SSLContext to use for this connector.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds a Remoting connector.",
    "request-properties" : {
        "authentication-provider" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The \"authentication-provider\" element contains the name of the authentication provider to use for incoming connections.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "protocol" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Protocol used in the connection.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "default" : "remote",
            "allowed" : [
                "remote",
                "remote+tls",
                "remote+http",
                "http-remoting",
                "https-remoting",
                "remote+https"
            ],
            "stability" : "default"
        },
        "sasl-authentication-factory" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Reference to the SASL authentication factory to secure this connector.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.security.sasl-authentication-factory",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "sasl-protocol" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The protocol to pass into the SASL mechanisms used for authentication.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "remote",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "security-realm" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The associated security realm to use for authentication for this connector.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default",
            "deprecated" : {
                "since" : "6.0.0",
                "reason" : "Connector security settings should be migrated to a sasl-authentication-factory definition."
            }
        },
        "server-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The server name to send in the initial message exchange and for SASL based authentication.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "socket-binding" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the socket binding to attach to.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "capability-reference" : "org.wildfly.network.socket-binding",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "ssl-context" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Reference to the SSLContext to use for this connector.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.security.ssl-context",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Removes a remoting connector.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes a remoting 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.remoting.connector

        
<feature spec="subsystem.remoting.connector">
  <param name="connector" value="{resource name}"/>
  <param name="authentication-provider" value="{value}"/>
  <param name="protocol" value="{value}"/>
  <param name="sasl-authentication-factory" value="{value}"/>
  <param name="sasl-protocol" value="{value}"/>
  <param name="security-realm" value="{value}"/>
  <param name="server-name" value="{value}"/>
  <param name="socket-binding" value="{value}"/>
  <param name="ssl-context" value="{value}"/>
<feature/>