Management API Reference for subsystem=datasources

The data-sources subsystem, used to declare JDBC data-sources

Children (3)

Attributes (1)

installed-drivers - List of JDBC drivers that have been installed in the runtime

Type	LIST
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "List of JDBC drivers that have been installed in the runtime", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "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-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" }, "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" }, "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-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" }, "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" }, "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" } }, "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." } }, "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" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "datasource-class-info" : { "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 }

Operations (4)

add - Adds the data-sources subsystem

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds the data-sources subsystem",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

get-installed-driver - Get a description of an installed driver

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
driver-name	STRING	true	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

Reply properties

Type

OBJECT

Value Type


{
    "deployment-name" => {
        "type" => 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-module-name" => {
        "type" => 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"
    },
    "module-slot" => {
        "type" => 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"
    },
    "driver-class-name" => {
        "type" => 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" => 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-xa-datasource-class-name" => {
        "type" => 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"
    },
    "driver-major-version" => {
        "type" => INT,
        "description" => "The driver's major version number",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "stability" => "default"
    },
    "driver-minor-version" => {
        "type" => INT,
        "description" => "The driver's minor version number",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "stability" => "default"
    },
    "jdbc-compliant" => {
        "type" => 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"
        }
    },
    "profile" => {
        "type" => 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."
        }
    },
    "driver-name" => {
        "type" => 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" => true,
        "nillable" => false,
        "min-length" => 1,
        "max-length" => 2147483647,
        "stability" => "default"
    },
    "datasource-class-info" => {
        "type" => 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" => OBJECT
    }
}

Raw DMR model


{
    "operation-name" : "get-installed-driver",
    "description" : "Get a description of an installed driver",
    "request-properties" : {"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" : true,
        "nillable" : false,
        "min-length" : 1,
        "max-length" : 2147483647,
        "stability" : "default"
    }},
    "reply-properties" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "OBJECT"
        },
        "value-type" : {
            "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-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"
            },
            "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"
            },
            "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-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"
            },
            "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"
            },
            "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"
                }
            },
            "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."
                }
            },
            "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" : true,
                "nillable" : false,
                "min-length" : 1,
                "max-length" : 2147483647,
                "stability" : "default"
            },
            "datasource-class-info" : {
                "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"
                }
            }
        }
    },
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : true
}

installed-drivers-list - installed-drivers-list

Reply properties

Type

LIST

Value Type


{
    "deployment-name" => {
        "type" => STRING,
        "description" => "installed-drivers-list",
        "expressions-allowed" => false,
        "required" => false,
        "nillable" => true,
        "min-length" => 1,
        "max-length" => 2147483647,
        "stability" => "default",
        "deprecated" => {
            "since" => "6.0.0",
            "reason" => "installed-drivers-list"
        }
    },
    "driver-module-name" => {
        "type" => STRING,
        "description" => "installed-drivers-list",
        "expressions-allowed" => true,
        "required" => true,
        "nillable" => false,
        "min-length" => 1,
        "max-length" => 2147483647,
        "stability" => "default"
    },
    "module-slot" => {
        "type" => STRING,
        "description" => "installed-drivers-list",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "min-length" => 1,
        "max-length" => 2147483647,
        "stability" => "default"
    },
    "driver-class-name" => {
        "type" => STRING,
        "description" => "installed-drivers-list",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "min-length" => 1,
        "max-length" => 2147483647,
        "stability" => "default"
    },
    "driver-datasource-class-name" => {
        "type" => STRING,
        "description" => "installed-drivers-list",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "min-length" => 1,
        "max-length" => 2147483647,
        "stability" => "default"
    },
    "driver-xa-datasource-class-name" => {
        "type" => STRING,
        "description" => "installed-drivers-list",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "min-length" => 1,
        "max-length" => 2147483647,
        "stability" => "default"
    },
    "driver-major-version" => {
        "type" => INT,
        "description" => "installed-drivers-list",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "stability" => "default"
    },
    "driver-minor-version" => {
        "type" => INT,
        "description" => "installed-drivers-list",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "stability" => "default"
    },
    "jdbc-compliant" => {
        "type" => BOOLEAN,
        "description" => "installed-drivers-list",
        "expressions-allowed" => false,
        "required" => false,
        "nillable" => true,
        "stability" => "default",
        "deprecated" => {
            "since" => "6.0.0",
            "reason" => "installed-drivers-list"
        }
    },
    "profile" => {
        "type" => STRING,
        "description" => "installed-drivers-list",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "min-length" => 1,
        "max-length" => 2147483647,
        "stability" => "default",
        "deprecated" => {
            "since" => "4.0.0",
            "reason" => "installed-drivers-list"
        }
    },
    "driver-name" => {
        "type" => STRING,
        "description" => "installed-drivers-list",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1,
        "max-length" => 2147483647,
        "stability" => "default"
    },
    "datasource-class-info" => {
        "type" => LIST,
        "description" => "installed-drivers-list",
        "expressions-allowed" => false,
        "required" => false,
        "nillable" => true,
        "min-length" => 0,
        "max-length" => 2147483647,
        "stability" => "default",
        "value-type" => OBJECT
    }
}

Raw DMR model


{
    "operation-name" : "installed-drivers-list",
    "description" : "installed-drivers-list",
    "request-properties" : {},
    "reply-properties" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "LIST"
        },
        "value-type" : {
            "deployment-name" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                },
                "description" : "installed-drivers-list",
                "expressions-allowed" : false,
                "required" : false,
                "nillable" : true,
                "min-length" : 1,
                "max-length" : 2147483647,
                "stability" : "default",
                "deprecated" : {
                    "since" : "6.0.0",
                    "reason" : "installed-drivers-list"
                }
            },
            "driver-module-name" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                },
                "description" : "installed-drivers-list",
                "expressions-allowed" : true,
                "required" : true,
                "nillable" : false,
                "min-length" : 1,
                "max-length" : 2147483647,
                "stability" : "default"
            },
            "module-slot" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                },
                "description" : "installed-drivers-list",
                "expressions-allowed" : true,
                "required" : false,
                "nillable" : true,
                "min-length" : 1,
                "max-length" : 2147483647,
                "stability" : "default"
            },
            "driver-class-name" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                },
                "description" : "installed-drivers-list",
                "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" : "installed-drivers-list",
                "expressions-allowed" : true,
                "required" : false,
                "nillable" : true,
                "min-length" : 1,
                "max-length" : 2147483647,
                "stability" : "default"
            },
            "driver-xa-datasource-class-name" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                },
                "description" : "installed-drivers-list",
                "expressions-allowed" : true,
                "required" : false,
                "nillable" : true,
                "min-length" : 1,
                "max-length" : 2147483647,
                "stability" : "default"
            },
            "driver-major-version" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "INT"
                },
                "description" : "installed-drivers-list",
                "expressions-allowed" : true,
                "required" : false,
                "nillable" : true,
                "stability" : "default"
            },
            "driver-minor-version" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "INT"
                },
                "description" : "installed-drivers-list",
                "expressions-allowed" : true,
                "required" : false,
                "nillable" : true,
                "stability" : "default"
            },
            "jdbc-compliant" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "BOOLEAN"
                },
                "description" : "installed-drivers-list",
                "expressions-allowed" : false,
                "required" : false,
                "nillable" : true,
                "stability" : "default",
                "deprecated" : {
                    "since" : "6.0.0",
                    "reason" : "installed-drivers-list"
                }
            },
            "profile" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                },
                "description" : "installed-drivers-list",
                "expressions-allowed" : true,
                "required" : false,
                "nillable" : true,
                "min-length" : 1,
                "max-length" : 2147483647,
                "stability" : "default",
                "deprecated" : {
                    "since" : "4.0.0",
                    "reason" : "installed-drivers-list"
                }
            },
            "driver-name" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                },
                "description" : "installed-drivers-list",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "min-length" : 1,
                "max-length" : 2147483647,
                "stability" : "default"
            },
            "datasource-class-info" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "LIST"
                },
                "description" : "installed-drivers-list",
                "expressions-allowed" : false,
                "required" : false,
                "nillable" : true,
                "min-length" : 0,
                "max-length" : 2147483647,
                "stability" : "default",
                "value-type" : {
                    "TYPE_MODEL_VALUE" : "OBJECT"
                }
            }
        }
    },
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : true
}

remove - Removes the data-sources subsystem

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes the data-sources 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.datasources

        
<feature spec="subsystem.datasources">
<feature/>