Management API Reference for service=remote

The Enterprise Beans 3 Remote Service

Stability Level: default

Children (1)

channel-creation-options

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.ejb.remote	false	none

Attributes (5)

cluster - The name of the clustered cache container which will be used to store/access the client-mappings of the Jakarta Enterprise Beans remoting connector's socket-binding on each node, in the cluster

Deprecated Since 10.0.0

The cluster attribute has been superseded by the client-mappings-registry element of the distributable-ejb subsystem and will be removed in a future release.

Type	STRING
Default Value	ejb
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 name of the clustered cache container which will be used to store/access the client-mappings of the Jakarta Enterprise Beans remoting connector's socket-binding on each node, in the cluster", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : "ejb", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "deprecated" : { "since" : "10.0.0", "reason" : "The cluster attribute has been superseded by the client-mappings-registry element of the distributable-ejb subsystem and will be removed in a future release." }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

connector-ref - The name of the connector on which the Enterprise Beans 3 remoting channel is registered.

Deprecated Since 8.0.0

This attribute is deprecated; use connectors instead.

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 name of the connector on which the Enterprise Beans 3 remoting channel is registered.", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["connectors"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "deprecated" : { "since" : "8.0.0", "reason" : "This attribute is deprecated; use connectors instead." }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

connectors - A list of names of connectors on which the Enterprise Beans 3 invocations are received.

Type	LIST
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" : "LIST" }, "description" : "A list of names of connectors on which the Enterprise Beans 3 invocations are received.", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.remoting.connector", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

execute-in-worker - If this is true the Jakarta Enterprise Beans request will be executed in the IO subsystems worker, otherwise it will dispatch to the Jakarta Enterprise Beans thread pool

Type	BOOLEAN
Default Value	true
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" : "BOOLEAN" }, "description" : "If this is true the Jakarta Enterprise Beans request will be executed in the IO subsystems worker, otherwise it will dispatch to the Jakarta Enterprise Beans thread pool", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

thread-pool-name - The name of the thread pool that handles remote invocations

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 name of the thread pool that handles remote invocations", "expressions-allowed" : true, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.threads.executor.ejb3", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

Operations (2)

add - Adds the Enterprise Beans 3 remote service

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
cluster	STRING	false	false	ejb	The name of the clustered cache container which will be used to store/access the client-mappings of the Jakarta Enterprise Beans remoting connector's socket-binding on each node, in the cluster
connector-ref	STRING	false	false		The name of the connector on which the Enterprise Beans 3 remoting channel is registered.
connectors	LIST	true	false		A list of names of connectors on which the Enterprise Beans 3 invocations are received.
execute-in-worker	BOOLEAN	false	true	true	If this is true the Jakarta Enterprise Beans request will be executed in the IO subsystems worker, otherwise it will dispatch to the Jakarta Enterprise Beans thread pool
thread-pool-name	STRING	false	true		The name of the thread pool that handles remote invocations

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds the Enterprise Beans 3 remote service",
    "request-properties" : {
        "cluster" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the clustered cache container which will be used to store/access the client-mappings of the Jakarta Enterprise Beans remoting connector's socket-binding on each node, in the cluster",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "default" : "ejb",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default",
            "deprecated" : {
                "since" : "10.0.0",
                "reason" : "The cluster attribute has been superseded by the client-mappings-registry element of the distributable-ejb subsystem and will be removed in a future release."
            }
        },
        "connector-ref" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the connector on which the Enterprise Beans 3 remoting channel is registered.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["connectors"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default",
            "deprecated" : {
                "since" : "8.0.0",
                "reason" : "This attribute is deprecated; use connectors instead."
            }
        },
        "connectors" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "A list of names of connectors on which the Enterprise Beans 3 invocations are received.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "capability-reference" : "org.wildfly.remoting.connector",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "execute-in-worker" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "If this is true the Jakarta Enterprise Beans request will be executed in the IO subsystems worker, otherwise it will dispatch to the Jakarta Enterprise Beans thread pool",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "thread-pool-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the thread pool that handles remote invocations",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.threads.executor.ejb3",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "all-services",
    "runtime-only" : false
}

remove - Removes the Enterprise Beans 3 remote service

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes the Enterprise Beans 3 remote service",
    "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.ejb3.service.remote

        
<feature spec="subsystem.ejb3.service.remote">
  <param name="cluster" value="{value}"/>
  <param name="connector-ref" value="{value}"/>
  <param name="connectors" value="{value}"/>
  <param name="execute-in-worker" value="{value}"/>
  <param name="thread-pool-name" value="{value}"/>
<feature/>