Management API Reference for subsystem=remoting

The configuration of the Remoting subsystem.

Children (5)

Provided Capabilities (2)

Name	Dynamic	Other provider points
org.wildfly.remoting.endpoint	false	none
org.wildfly.remoting.http-listener-registry	false	none

Attributes (18)

auth-realm - The authentication realm to use if no authentication CallbackHandler is specified.

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 authentication realm to use if no authentication CallbackHandler is specified.", "attribute-group" : "endpoint", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

authentication-retries - Specify the number of times a client is allowed to retry authentication before closing the connection.

Type	INT
Default Value	3
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" : "INT" }, "description" : "Specify the number of times a client is allowed to retry authentication before closing the connection.", "attribute-group" : "endpoint", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 3, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

authorize-id - The SASL authorization ID. Used as authentication user name to use if no authentication CallbackHandler is specified and the selected SASL mechanism demands a user name.

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 SASL authorization ID. Used as authentication user name to use if no authentication CallbackHandler is specified and the selected SASL mechanism demands a user name.", "attribute-group" : "endpoint", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

buffer-region-size - The size of allocated buffer regions.

Type	INT
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" : "INT" }, "description" : "The size of allocated buffer regions.", "attribute-group" : "endpoint", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

heartbeat-interval - The interval to use for connection heartbeat, in milliseconds. If the connection is idle in the outbound direction for this amount of time, a ping message will be sent, which will trigger a corresponding reply message.

Type	INT
Default Value	60000
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" : "INT" }, "description" : "The interval to use for connection heartbeat, in milliseconds. If the connection is idle in the outbound direction for this amount of time, a ping message will be sent, which will trigger a corresponding reply message.", "attribute-group" : "endpoint", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 60000, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

max-inbound-channels - The maximum number of inbound channels to support for a connection.

Type	INT
Default Value	400
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" : "INT" }, "description" : "The maximum number of inbound channels to support for a connection.", "attribute-group" : "endpoint", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 400, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

max-inbound-message-size - The maximum inbound message size to be allowed. Messages exceeding this size will cause an exception to be thrown on the reading side as well as the writing side.

Type	LONG
Default Value	9223372036854775807
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" : "LONG" }, "description" : "The maximum inbound message size to be allowed. Messages exceeding this size will cause an exception to be thrown on the reading side as well as the writing side.", "attribute-group" : "endpoint", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 9223372036854775807, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

max-inbound-messages - The maximum number of concurrent inbound messages on a channel.

Type	INT
Default Value	80
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" : "INT" }, "description" : "The maximum number of concurrent inbound messages on a channel.", "attribute-group" : "endpoint", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 80, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

max-outbound-channels - The maximum number of outbound channels to support for a connection.

Type	INT
Default Value	400
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" : "INT" }, "description" : "The maximum number of outbound channels to support for a connection.", "attribute-group" : "endpoint", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 400, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

max-outbound-message-size - The maximum outbound message size to send. No messages larger than this well be transmitted; attempting to do so will cause an exception on the writing side.

Type	LONG
Default Value	9223372036854775807
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" : "LONG" }, "description" : "The maximum outbound message size to send. No messages larger than this well be transmitted; attempting to do so will cause an exception on the writing side.", "attribute-group" : "endpoint", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 9223372036854775807, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

max-outbound-messages - The maximum number of concurrent outbound messages on a channel.

Type	INT
Default Value	65535
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" : "INT" }, "description" : "The maximum number of concurrent outbound messages on a channel.", "attribute-group" : "endpoint", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 65535, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

receive-buffer-size - The size of the largest buffer that this endpoint will accept over a connection.

Type	INT
Default Value	8192
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" : "INT" }, "description" : "The size of the largest buffer that this endpoint will accept over a connection.", "attribute-group" : "endpoint", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 8192, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

receive-window-size - The maximum window size of the receive direction for connection channels, in bytes.

Type	INT
Default Value	131072
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" : "INT" }, "description" : "The maximum window size of the receive direction for connection channels, in bytes.", "attribute-group" : "endpoint", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 131072, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

sasl-protocol - Where a SaslServer or SaslClient are created by default the protocol specified it 'remoting', this can be used to override this.

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" : "Where a SaslServer or SaslClient are created by default the protocol specified it 'remoting', this can be used to override this.", "attribute-group" : "endpoint", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "remote", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

send-buffer-size - The size of the largest buffer that this endpoint will transmit over a connection.

Type	INT
Default Value	8192
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" : "INT" }, "description" : "The size of the largest buffer that this endpoint will transmit over a connection.", "attribute-group" : "endpoint", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 8192, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

server-name - The server side of the connection passes it's name to the client in the initial greeting, by default the name is automatically discovered from the local address of the connection or it can be overridden using this.

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 side of the connection passes it's name to the client in the initial greeting, by default the name is automatically discovered from the local address of the connection or it can be overridden using this.", "attribute-group" : "endpoint", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

transmit-window-size - The maximum window size of the transmit direction for connection channels, in bytes.

Type	INT
Default Value	131072
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" : "INT" }, "description" : "The maximum window size of the transmit direction for connection channels, in bytes.", "attribute-group" : "endpoint", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 131072, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

worker - Worker to use

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" : "Worker to use", "attribute-group" : "endpoint", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.io.worker", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

Operations (2)

add - Adds the Remoting subsystem.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
auth-realm	STRING	false	true		The authentication realm to use if no authentication CallbackHandler is specified.
authentication-retries	INT	false	true	3	Specify the number of times a client is allowed to retry authentication before closing the connection.
authorize-id	STRING	false	true		The SASL authorization ID. Used as authentication user name to use if no authentication CallbackHandler is specified and the selected SASL mechanism demands a user name.
buffer-region-size	INT	false	true		The size of allocated buffer regions.
heartbeat-interval	INT	false	true	60000	The interval to use for connection heartbeat, in milliseconds. If the connection is idle in the outbound direction for this amount of time, a ping message will be sent, which will trigger a corresponding reply message.
max-inbound-channels	INT	false	true	400	The maximum number of inbound channels to support for a connection.
max-inbound-message-size	LONG	false	true	9223372036854775807	The maximum inbound message size to be allowed. Messages exceeding this size will cause an exception to be thrown on the reading side as well as the writing side.
max-inbound-messages	INT	false	true	80	The maximum number of concurrent inbound messages on a channel.
max-outbound-channels	INT	false	true	400	The maximum number of outbound channels to support for a connection.
max-outbound-message-size	LONG	false	true	9223372036854775807	The maximum outbound message size to send. No messages larger than this well be transmitted; attempting to do so will cause an exception on the writing side.
max-outbound-messages	INT	false	true	65535	The maximum number of concurrent outbound messages on a channel.
receive-buffer-size	INT	false	true	8192	The size of the largest buffer that this endpoint will accept over a connection.
receive-window-size	INT	false	true	131072	The maximum window size of the receive direction for connection channels, in bytes.
sasl-protocol	STRING	false	true	remote	Where a SaslServer or SaslClient are created by default the protocol specified it 'remoting', this can be used to override this.
send-buffer-size	INT	false	true	8192	The size of the largest buffer that this endpoint will transmit over a connection.
server-name	STRING	false	true		The server side of the connection passes it's name to the client in the initial greeting, by default the name is automatically discovered from the local address of the connection or it can be overridden using this.
transmit-window-size	INT	false	true	131072	The maximum window size of the transmit direction for connection channels, in bytes.
worker	STRING	false	false		Worker to use

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds the Remoting subsystem.",
    "request-properties" : {
        "auth-realm" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The authentication realm to use if no authentication CallbackHandler is specified.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "authentication-retries" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "Specify the number of times a client is allowed to retry authentication before closing the connection.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 3,
            "stability" : "default"
        },
        "authorize-id" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The SASL authorization ID.  Used as authentication user name to use if no authentication CallbackHandler is specified and the selected SASL mechanism demands a user name.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "buffer-region-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The size of allocated buffer regions.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "heartbeat-interval" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The interval to use for connection heartbeat, in milliseconds.  If the connection is idle in the outbound direction for this amount of time, a ping message will be sent, which will trigger a corresponding reply message.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 60000,
            "stability" : "default"
        },
        "max-inbound-channels" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The maximum number of inbound channels to support for a connection.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 400,
            "stability" : "default"
        },
        "max-inbound-message-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "The maximum inbound message size to be allowed.  Messages exceeding this size will cause an exception to be thrown on the reading side as well as the writing side.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 9223372036854775807,
            "stability" : "default"
        },
        "max-inbound-messages" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The maximum number of concurrent inbound messages on a channel.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 80,
            "stability" : "default"
        },
        "max-outbound-channels" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The maximum number of outbound channels to support for a connection.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 400,
            "stability" : "default"
        },
        "max-outbound-message-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "The maximum outbound message size to send.  No messages larger than this well be transmitted; attempting to do so will cause an exception on the writing side.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 9223372036854775807,
            "stability" : "default"
        },
        "max-outbound-messages" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The maximum number of concurrent outbound messages on a channel.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 65535,
            "stability" : "default"
        },
        "receive-buffer-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The size of the largest buffer that this endpoint will accept over a connection.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 8192,
            "stability" : "default"
        },
        "receive-window-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The maximum window size of the receive direction for connection channels, in bytes.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 131072,
            "stability" : "default"
        },
        "sasl-protocol" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Where a SaslServer or SaslClient are created by default the protocol specified it 'remoting', this can be used to override this.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "remote",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "send-buffer-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The size of the largest buffer that this endpoint will transmit over a connection.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 8192,
            "stability" : "default"
        },
        "server-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The server side of the connection passes it's name to the client in the initial greeting, by default the name is automatically discovered from the local address of the connection or it can be overridden using this.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "transmit-window-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The maximum window size of the transmit direction for connection channels, in bytes.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 131072,
            "stability" : "default"
        },
        "worker" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Worker to use",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.io.worker",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Removes the Remoting subsystem.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes the Remoting subsystem.",
    "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

        
<feature spec="subsystem.remoting">
  <param name="auth-realm" value="{value}"/>
  <param name="authentication-retries" value="{value}"/>
  <param name="authorize-id" value="{value}"/>
  <param name="buffer-region-size" value="{value}"/>
  <param name="heartbeat-interval" value="{value}"/>
  <param name="max-inbound-channels" value="{value}"/>
  <param name="max-inbound-message-size" value="{value}"/>
  <param name="max-inbound-messages" value="{value}"/>
  <param name="max-outbound-channels" value="{value}"/>
  <param name="max-outbound-message-size" value="{value}"/>
  <param name="max-outbound-messages" value="{value}"/>
  <param name="receive-buffer-size" value="{value}"/>
  <param name="receive-window-size" value="{value}"/>
  <param name="sasl-protocol" value="{value}"/>
  <param name="send-buffer-size" value="{value}"/>
  <param name="server-name" value="{value}"/>
  <param name="transmit-window-size" value="{value}"/>
  <param name="worker" value="{value}"/>
<feature/>