Management API Reference for jdbc-driver

Service that makes a JDBC driver available for use in the runtime

Attributes (12)

datasource-class-info - The available properties for the datasource-class, and xa-datasource-class for the jdbc-driver

Type	LIST
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "The available properties for the datasource-class, and xa-datasource-class for the jdbc-driver", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

deployment-name - The name of the deployment unit from which the driver was loaded

Deprecated Since 6.0.0

This attribute is no longer used

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the deployment unit from which the driver was loaded", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "deprecated" : { "since" : "6.0.0", "reason" : "This attribute is no longer used" }, "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }`

driver-class-name - The fully qualified class name of the java.sql.Driver implementation

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The fully qualified class name of the java.sql.Driver implementation", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }`

driver-datasource-class-name - The fully qualified class name of the javax.sql.DataSource implementation

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The fully qualified class name of the javax.sql.DataSource implementation", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }`

driver-major-version - The driver's major version number

Type	INT
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The driver's major version number", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }`

driver-minor-version - The driver's minor version number

Type	INT
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The driver's minor version number", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }`

driver-module-name - The name of the module from which the driver was loaded, if it was loaded from the module path

Type	STRING
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the module from which the driver was loaded, if it was loaded from the module path", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }`

driver-name - Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as a jar, the name is the name of the deployment unit

Deprecated Since 7.0.0

This attribute is no longer used

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-only
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as a jar, the name is the name of the deployment unit", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "deprecated" : { "since" : "7.0.0", "reason" : "This attribute is no longer used" }, "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }

driver-xa-datasource-class-name - The fully qualified class name of the javax.sql.XADataSource implementation

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The fully qualified class name of the javax.sql.XADataSource implementation", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }`

jdbc-compliant - Whether or not the driver is JDBC compliant

Deprecated Since 6.0.0

This attribute is no longer used

Type	BOOLEAN
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether or not the driver is JDBC compliant", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "deprecated" : { "since" : "6.0.0", "reason" : "This attribute is no longer used" }, "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }`

module-slot - The slot of the module from which the driver was loaded, if it was loaded from the module path

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The slot of the module from which the driver was loaded, if it was loaded from the module path", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }`

profile - Domain Profile in which driver is defined. Null in case of standalone server

Deprecated Since 4.0.0

The server's profile can be determined by the profile-name attribute on the server's root resource.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-only
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Domain Profile in which driver is defined. Null in case of standalone server", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "deprecated" : { "since" : "4.0.0", "reason" : "The server's profile can be determined by the profile-name attribute on the server's root resource." }, "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }

Operations (2)

add - Add a new JDBC driver

Request Parameter	Type	Required	Expressions Allowed	Description
deployment-name	STRING	false	false	The name of the deployment unit from which the driver was loaded
driver-class-name	STRING	false	true	The fully qualified class name of the java.sql.Driver implementation
driver-datasource-class-name	STRING	false	true	The fully qualified class name of the javax.sql.DataSource implementation
driver-major-version	INT	false	true	The driver's major version number
driver-minor-version	INT	false	true	The driver's minor version number
driver-module-name	STRING	true	true	The name of the module from which the driver was loaded, if it was loaded from the module path
driver-name	STRING	false	false	Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as a jar, the name is the name of the deployment unit
driver-xa-datasource-class-name	STRING	false	true	The fully qualified class name of the javax.sql.XADataSource implementation
jdbc-compliant	BOOLEAN	false	false	Whether or not the driver is JDBC compliant
module-slot	STRING	false	true	The slot of the module from which the driver was loaded, if it was loaded from the module path
profile	STRING	false	true	Domain Profile in which driver is defined. Null in case of standalone server

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add a new JDBC driver",
    "request-properties" : {
        "deployment-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the deployment unit from which the driver was loaded",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default",
            "deprecated" : {
                "since" : "6.0.0",
                "reason" : "This attribute is no longer used"
            }
        },
        "driver-class-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The fully qualified class name of the java.sql.Driver implementation",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "driver-datasource-class-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The fully qualified class name of the javax.sql.DataSource implementation",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "driver-major-version" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The driver's major version number",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "driver-minor-version" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The driver's minor version number",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "driver-module-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the module from which the driver was loaded, if it was loaded from the module path",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "driver-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as a jar, the name is the name of the deployment unit",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default",
            "deprecated" : {
                "since" : "7.0.0",
                "reason" : "This attribute is no longer used"
            }
        },
        "driver-xa-datasource-class-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The fully qualified class name of the javax.sql.XADataSource implementation",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "jdbc-compliant" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether or not the driver is JDBC compliant",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "deprecated" : {
                "since" : "6.0.0",
                "reason" : "This attribute is no longer used"
            }
        },
        "module-slot" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The slot of the module from which the driver was loaded, if it was loaded from the module path",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "profile" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Domain Profile in which driver is defined. Null in case of standalone server",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default",
            "deprecated" : {
                "since" : "4.0.0",
                "reason" : "The server's profile can be determined by the profile-name attribute on the server's root resource."
            }
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Remove a JDBC driver

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove a JDBC driver",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

subsystem.datasources.jdbc-driver

        
<feature spec="subsystem.datasources.jdbc-driver">
  <param name="jdbc-driver" value="{resource name}"/>
  <param name="deployment-name" value="{value}"/>
  <param name="driver-class-name" value="{value}"/>
  <param name="driver-datasource-class-name" value="{value}"/>
  <param name="driver-major-version" value="{value}"/>
  <param name="driver-minor-version" value="{value}"/>
  <param name="driver-module-name" value="{value}"/>
  <param name="driver-name" value="{value}"/>
  <param name="driver-xa-datasource-class-name" value="{value}"/>
  <param name="jdbc-compliant" value="{value}"/>
  <param name="module-slot" value="{value}"/>
  <param name="profile-feature" value="{value}"/>
<feature/>