Management API Reference for remote-outbound-connection

Remoting outbound connection.

Children (1)

property

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.remoting.outbound-connection	true	/subsystem=remoting/local-outbound-connection=* /subsystem=remoting/outbound-connection=*

Attributes (5)

authentication-context - Reference to the authentication context instance containing the configuration for outbound connections.

Type	STRING
Is the attribute nillable?	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" : "STRING" }, "description" : "Reference to the authentication context instance containing the configuration for outbound connections.", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : [ "username", "security-realm", "protocol" ], "capability-reference" : "org.wildfly.security.authentication-context", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : {"authentication-client-ref" : {"type" : "core"}}}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services" }

outbound-socket-binding-ref - Name of the outbound-socket-binding which will be used to determine the destination address and port for the connection.

Type	STRING
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" : "Name of the outbound-socket-binding which will be used to determine the destination address and port for the connection.", "expressions-allowed" : true, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.network.outbound-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" }

protocol - The protocol to use for the remote connection.

Deprecated Since 4.0.0

Outbound security settings should be migrated to an authentication-context definition.

Type	STRING
Default Value	http-remoting
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
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" : "The protocol to use for the remote connection.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "http-remoting", "alternatives" : ["authentication-context"], "allowed" : [ "remote", "remote+tls", "remote+http", "http-remoting", "https-remoting", "remote+https" ], "stability" : "default", "deprecated" : { "since" : "4.0.0", "reason" : "Outbound security settings should be migrated to an authentication-context definition." }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

security-realm - Reference to the security realm to use to obtain the password and SSL configuration.

Deprecated Since 4.0.0

Outbound security settings should be migrated to an authentication-context definition.

Type	STRING
Is the attribute nillable?	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" : "STRING" }, "description" : "Reference to the security realm to use to obtain the password and SSL configuration.", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["authentication-context"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "deprecated" : { "since" : "4.0.0", "reason" : "Outbound security settings should be migrated to an authentication-context definition." }, "access-constraints" : {"sensitive" : { "security-realm-ref" : {"type" : "core"}, "remoting-security" : {"type" : "remoting"} }}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

username - The user name to use when authenticating against the remote server.

Deprecated Since 4.0.0

Outbound security settings should be migrated to an authentication-context definition.

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?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The user name to use when authenticating against the remote server.", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : ["authentication-context"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "deprecated" : { "since" : "4.0.0", "reason" : "Outbound security settings should be migrated to an authentication-context definition." }, "access-constraints" : {"sensitive" : { "credential" : {"type" : "core"}, "remoting-security" : {"type" : "remoting"} }}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

Operations (2)

add - Adds an outbound connection.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
authentication-context	STRING	false	false		Reference to the authentication context instance containing the configuration for outbound connections.
outbound-socket-binding-ref	STRING	true	true		Name of the outbound-socket-binding which will be used to determine the destination address and port for the connection.
protocol	STRING	false	true	http-remoting	The protocol to use for the remote connection.
security-realm	STRING	false	false		Reference to the security realm to use to obtain the password and SSL configuration.
username	STRING	false	true		The user name to use when authenticating against the remote server.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds an outbound connection.",
    "request-properties" : {
        "authentication-context" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Reference to the authentication context instance containing the configuration for outbound connections.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "alternatives" : [
                "username",
                "security-realm",
                "protocol"
            ],
            "capability-reference" : "org.wildfly.security.authentication-context",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "outbound-socket-binding-ref" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Name of the outbound-socket-binding which will be used to determine the destination address and port for the connection.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "capability-reference" : "org.wildfly.network.outbound-socket-binding",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "protocol" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The protocol to use for the remote connection.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "http-remoting",
            "alternatives" : ["authentication-context"],
            "allowed" : [
                "remote",
                "remote+tls",
                "remote+http",
                "http-remoting",
                "https-remoting",
                "remote+https"
            ],
            "stability" : "default",
            "deprecated" : {
                "since" : "4.0.0",
                "reason" : "Outbound security settings should be migrated to an authentication-context definition."
            }
        },
        "security-realm" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Reference to the security realm to use to obtain the password and SSL configuration.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["authentication-context"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default",
            "deprecated" : {
                "since" : "4.0.0",
                "reason" : "Outbound security settings should be migrated to an authentication-context definition."
            }
        },
        "username" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The user name to use when authenticating against the remote server.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["authentication-context"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default",
            "deprecated" : {
                "since" : "4.0.0",
                "reason" : "Outbound security settings should be migrated to an authentication-context definition."
            }
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Removes an outbound connection.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes an outbound connection.",
    "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.remote-outbound-connection

        
<feature spec="subsystem.remoting.remote-outbound-connection">
  <param name="remote-outbound-connection" value="{resource name}"/>
  <param name="authentication-context" value="{value}"/>
  <param name="outbound-socket-binding-ref" value="{value}"/>
  <param name="protocol" value="{value}"/>
  <param name="security-realm" value="{value}"/>
  <param name="username" value="{value}"/>
<feature/>