Management API Reference for context-service

A context service

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.ee.concurrent.context.service	true	none

Attributes (2)

jndi-name - The JNDI Name to lookup the context service.

Type	STRING
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The JNDI Name to lookup the context service.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

use-transaction-setup-provider - Flag which indicates if the transaction setup provider should be used.

Deprecated Since 6.0.0

Has no effect in a server running the current version. A Context Service configured via the server configuration uses the default ContextServiceDefinition configuration, which is cleared = Transaction (equivalent to use-transaction-setup-provider=true, i.e. any tx in the thread is suspended before and resumed after), propagated = All Remaining, unchanged = none. To use a different ContextService you need to define it on the deployment, through XML or the ContextServiceDefinition annotation.

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Flag which indicates if the transaction setup provider should be used.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "deprecated" : { "since" : "6.0.0", "reason" : "Has no effect in a server running the current version. A Context Service configured via the server configuration uses the default ContextServiceDefinition configuration, which is cleared = Transaction (equivalent to use-transaction-setup-provider=true, i.e. any tx in the thread is suspended before and resumed after), propagated = All Remaining, unchanged = none. To use a different ContextService you need to define it on the deployment, through XML or the ContextServiceDefinition annotation." }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }

Operations (2)

add - Adds a context service

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
jndi-name	STRING	true	true		The JNDI Name to lookup the context service.
use-transaction-setup-provider	BOOLEAN	false	true	false	Flag which indicates if the transaction setup provider should be used.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds a context service",
    "request-properties" : {
        "jndi-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The JNDI Name to lookup the context service.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "use-transaction-setup-provider" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Flag which indicates if the transaction setup provider should be used.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default",
            "deprecated" : {
                "since" : "6.0.0",
                "reason" : "Has no effect in a server running the current version. A Context Service configured via the server configuration uses the default ContextServiceDefinition configuration, which is cleared = Transaction (equivalent to use-transaction-setup-provider=true, i.e. any tx in the thread is suspended before and resumed after), propagated = All Remaining, unchanged = none. To use a different ContextService you need to define it on the deployment, through XML or the ContextServiceDefinition annotation."
            }
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Removes a context service

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes a context 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.ee.context-service

        
<feature spec="subsystem.ee.context-service">
  <param name="context-service" value="{resource name}"/>
  <param name="jndi-name" value="{value}"/>
  <param name="use-transaction-setup-provider" value="{value}"/>
<feature/>