Management API Reference for resource-adapter

The configuration of a resource adapter.

Children (3)

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.resource-adapter	true	/deployment=/subdeployment=/subsystem=resource-adapters/ironjacamar=ironjacamar/resource-adapter=* /deployment=/subsystem=resource-adapters/ironjacamar=ironjacamar/resource-adapter=

Attributes (14)

archive - Specifies the resource adapter archive.

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" : "Specifies the resource adapter archive.", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["module"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

beanvalidationgroups - Specifies the Jakarta Bean Validation groups that should be used.

Type	LIST
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" : "LIST" }, "description" : "Specifies the Jakarta Bean Validation groups that should be used.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

bootstrap-context - Specifies the unique name of the bootstrap context that should be used.

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" : "Specifies the unique name of the bootstrap context that should be used.", "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 }`

module - Specifies the module from which resource adapter will be loaded

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" : "Specifies the module from which resource adapter will be loaded", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["archive"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

statistics-enabled - Define whether runtime statistics are enabled or not.

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?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Define whether runtime statistics are enabled or not.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

transaction-support - Specifies the transaction support level of the resource adapter. This attribute allows expressions, but only simple expressions resolved from environment variables or system properties are supported. Nested expressions and resolution from vaults or credential stores are not supported.

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
Allowed Values	NoTransaction LocalTransaction XATransaction
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Specifies the transaction support level of the resource adapter. This attribute allows expressions, but only simple expressions resolved from environment variables or system properties are supported. Nested expressions and resolution from vaults or credential stores are not supported.", "expressions-allowed" : true, "required" : false, "nillable" : true, "allowed" : [ "NoTransaction", "LocalTransaction", "XATransaction" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

wm-elytron-security-domain - Defines the name of the Elytron security domain that should be used.

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" : "Defines the name of the Elytron security domain that should be used.", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : ["wm-security-domain"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : {"elytron-security-domain-ref" : {"type" : "core"}}}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

wm-security - Toggle on/off wm.security for this resource adapter. In case of false all wm-security-* parameters are ignored, even the defaults.

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?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Toggle on/off wm.security for this resource adapter. In case of false all wm-security-* parameters are ignored, even the defaults.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

wm-security-default-groups - Defines a default groups list that should be added to the used Subject instance.

Type	LIST
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" : "LIST" }, "description" : "Defines a default groups list that should be added to the used Subject instance.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

wm-security-default-principal - Defines a default principal name that should be added to the used Subject instance.

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" : "Defines a default principal name that should be added to the used Subject instance.", "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 }`

wm-security-domain - Defines the name of the PicketBox security domain that should be used.

Deprecated Since 6.1.0

PicketBox security domains are not supported in servers running the current version of the datasources subsystem. Use 'authentication-context' to configure Elytron security

Type	STRING
Default Value	other
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" : "Defines the name of the PicketBox security domain that should be used.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "other", "alternatives" : ["wm-elytron-security-domain"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "deprecated" : { "since" : "6.1.0", "reason" : "PicketBox security domains are not supported in servers running the current version of the datasources subsystem. Use 'authentication-context' to configure Elytron security" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

wm-security-mapping-groups - List of groups mappings.

Type	LIST
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" : "LIST" }, "description" : "List of groups mappings.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "from" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Specify the original value in a mapping pair.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "to" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Specify the mapped value in a mapping pair.", "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 }

wm-security-mapping-required - Defines if a mapping is required for security credentials.

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?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Defines if a mapping is required for security credentials.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

wm-security-mapping-users - List of user mappings.

Type	LIST
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" : "LIST" }, "description" : "List of user mappings.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "from" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Specify the original value in a mapping pair.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "to" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Specify the mapped value in a mapping pair.", "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 }

Operations (3)

activate - Force the resource adapter config activation without server reload.

Raw DMR model


{
    "operation-name" : "activate",
    "description" : "Force the resource adapter config activation without server reload.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

add - Add a new resource adapter. At least one of ARCHIVE or MODULE is required.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
archive	STRING	false	false		Specifies the resource adapter archive.
beanvalidationgroups	LIST	false	true		Specifies the Jakarta Bean Validation groups that should be used.
bootstrap-context	STRING	false	true		Specifies the unique name of the bootstrap context that should be used.
module	STRING	false	false		Specifies the module from which resource adapter will be loaded
statistics-enabled	BOOLEAN	false	true	false	Define whether runtime statistics are enabled or not.
transaction-support	STRING	false	true		Specifies the transaction support level of the resource adapter. This attribute allows expressions, but only simple expressions resolved from environment variables or system properties are supported. Nested expressions and resolution from vaults or credential stores are not supported.
wm-elytron-security-domain	STRING	false	true		Defines the name of the Elytron security domain that should be used.
wm-security	BOOLEAN	false	true	false	Toggle on/off wm.security for this resource adapter. In case of false all wm-security-* parameters are ignored, even the defaults.
wm-security-default-groups	LIST	false	true		Defines a default groups list that should be added to the used Subject instance.
wm-security-default-principal	STRING	false	true		Defines a default principal name that should be added to the used Subject instance.
wm-security-domain	STRING	false	true	other	Defines the name of the PicketBox security domain that should be used.
wm-security-mapping-groups	LIST	false	false		List of groups mappings.
wm-security-mapping-required	BOOLEAN	false	true	false	Defines if a mapping is required for security credentials.
wm-security-mapping-users	LIST	false	false		List of user mappings.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add a new resource adapter. At least one of ARCHIVE or MODULE is required.",
    "request-properties" : {
        "archive" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Specifies the resource adapter archive.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["module"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "beanvalidationgroups" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "Specifies the Jakarta Bean Validation groups that should be used.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "bootstrap-context" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Specifies the unique name of the bootstrap context that should be used.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "module" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Specifies the module from which resource adapter will be loaded",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["archive"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "statistics-enabled" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Define whether runtime statistics are enabled or not.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "transaction-support" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Specifies the transaction support level of the resource adapter. This attribute allows expressions, but only simple expressions resolved from environment variables or system properties are supported. Nested expressions and resolution from vaults or credential stores are not supported.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "allowed" : [
                "NoTransaction",
                "LocalTransaction",
                "XATransaction"
            ],
            "stability" : "default"
        },
        "wm-elytron-security-domain" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Defines the name of the Elytron security domain that should be used.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["wm-security-domain"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "wm-security" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Toggle on/off wm.security for this resource adapter. In case of false all wm-security-* parameters are ignored, even the defaults.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "wm-security-default-groups" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "Defines a default groups list that should be added to the used Subject instance.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "wm-security-default-principal" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Defines a default principal name that should be added to the used Subject instance.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "wm-security-domain" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Defines the name of the PicketBox security domain that should be used.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "other",
            "alternatives" : ["wm-elytron-security-domain"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default",
            "deprecated" : {
                "since" : "6.1.0",
                "reason" : "PicketBox security domains are not supported in servers running the current version of the datasources subsystem. Use 'authentication-context' to configure Elytron security"
            }
        },
        "wm-security-mapping-groups" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "List of groups mappings.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "from" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Specify the original value in a mapping pair.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "to" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Specify the mapped value in a mapping pair.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                }
            }
        },
        "wm-security-mapping-required" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Defines if a mapping is required for security credentials.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "wm-security-mapping-users" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "List of user mappings.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "from" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Specify the original value in a mapping pair.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "to" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Specify the mapped value in a mapping pair.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                }
            }
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Remove the resource adapter.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove the resource adapter.",
    "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.resource-adapters.resource-adapter

        
<feature spec="subsystem.resource-adapters.resource-adapter">
  <param name="resource-adapter" value="{resource name}"/>
  <param name="archive" value="{value}"/>
  <param name="beanvalidationgroups" value="{value}"/>
  <param name="bootstrap-context" value="{value}"/>
  <param name="module" value="{value}"/>
  <param name="statistics-enabled" value="{value}"/>
  <param name="transaction-support" value="{value}"/>
  <param name="wm-elytron-security-domain" value="{value}"/>
  <param name="wm-security" value="{value}"/>
  <param name="wm-security-default-groups" value="{value}"/>
  <param name="wm-security-default-principal" value="{value}"/>
  <param name="wm-security-domain" value="{value}"/>
  <param name="wm-security-mapping-groups" value="{value}"/>
  <param name="wm-security-mapping-required" value="{value}"/>
  <param name="wm-security-mapping-users" value="{value}"/>
<feature/>