Management API Reference for provider-loader

A definition for a Provider loader.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.security.providers	true	/subsystem=elytron/aggregate-providers=*

Attributes (7)

argument - An argument to be passed into the constructor as the Provider is instantiated.

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" : "An argument to be passed into the constructor as the Provider is instantiated.", "attribute-group" : "configuration", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : [ "path", "configuration" ], "requires" : ["class-names"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

class-names - The fully qualified class names of the providers to load, these are loaded after the service-loader discovered providers and duplicates will be skipped.

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" : "The fully qualified class names of the providers to load, these are loaded after the service-loader discovered providers and duplicates will be skipped.", "attribute-group" : "class-loading", "expressions-allowed" : false, "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 }

configuration - The key/value configuration to be passed to the Provider to initialise it.

Type	OBJECT
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" : "OBJECT" }, "description" : "The key/value configuration to be passed to the Provider to initialise it.", "attribute-group" : "configuration", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : [ "path", "argument" ], "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

loaded-providers - The list of providers loaded by this provider loader.

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 list of providers loaded by this provider loader.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name reported by the provider instance.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "info" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The information reported by the provider instance.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "version" : { "type" : { "TYPE_MODEL_VALUE" : "DOUBLE" }, "description" : "The version reported by the provider instance.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default" }, "services" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "List of services available from this provider.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "type" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The service type.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "algorithm" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The algorithm supported by the service.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "class-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The class name of the implementation of the service SPI.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } } } }, "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

module - The name of the module to load the provider from.

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 module to load the provider from.", "attribute-group" : "class-loading", "expressions-allowed" : false, "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 }`

path - The path of the file to use to initialise the providers.

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 path of the file to use to initialise the providers.", "attribute-group" : "configuration", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : ["configuration"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

relative-to - The base path of the configuration file.

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 base path of the configuration file.", "attribute-group" : "configuration", "expressions-allowed" : false, "required" : false, "nillable" : true, "requires" : ["path"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

Operations (2)

add - Add a new provider loader definition.

Request Parameter	Type	Required	Expressions Allowed	Description
class-names	LIST	false	false	The fully qualified class names of the providers to load, these are loaded after the service-loader discovered providers and duplicates will be skipped.
module	STRING	false	false	The name of the module to load the provider from.
argument	STRING	false	true	An argument to be passed into the constructor as the Provider is instantiated.
configuration	OBJECT	false	true	The key/value configuration to be passed to the Provider to initialise it.
path	STRING	false	true	The path of the file to use to initialise the providers.
relative-to	STRING	false	false	The base path of the configuration file.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add a new provider loader definition.",
    "request-properties" : {
        "class-names" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "The fully qualified class names of the providers to load, these are loaded after the service-loader discovered providers and duplicates will be skipped.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "module" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the module to load the provider from.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "argument" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "An argument to be passed into the constructor as the Provider is instantiated.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "alternatives" : [
                "path",
                "configuration"
            ],
            "requires" : ["class-names"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "configuration" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "The key/value configuration to be passed to the Provider to initialise it.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "alternatives" : [
                "path",
                "argument"
            ],
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "path" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The path of the file to use to initialise the providers.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["configuration"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "relative-to" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The base path of the configuration file.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "requires" : ["path"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

remove - Remove a provider loader definition.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove a provider loader definition.",
    "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.elytron.provider-loader

        
<feature spec="subsystem.elytron.provider-loader">
  <param name="provider-loader" value="{resource name}"/>
  <param name="argument" value="{value}"/>
  <param name="class-names" value="{value}"/>
  <param name="configuration" value="{value}"/>
  <param name="module" value="{value}"/>
  <param name="path" value="{value}"/>
  <param name="relative-to" value="{value}"/>
<feature/>