Management API Reference for config-source-provider

Config Source Provider can be used to register new implementation for multiple Config Sources.

Stability Level: default

Attributes (1)

class - Class of the ConfigSourceProvider to load

Type	OBJECT
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" : "OBJECT" }, "description" : "Class of the ConfigSourceProvider to load", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name of the class of the config source to load", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "module" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Module of the config source provider to load", "expressions-allowed" : false, "required" : true, "nillable" : false, "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 Config Source Provider

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
class	OBJECT	false	false		Class of the ConfigSourceProvider to load

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add a Config Source Provider",
    "request-properties" : {"class" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "OBJECT"
        },
        "description" : "Class of the ConfigSourceProvider to load",
        "expressions-allowed" : false,
        "required" : false,
        "nillable" : true,
        "stability" : "default",
        "value-type" : {
            "name" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                },
                "description" : "Name of the class of the config source to load",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "min-length" : 1,
                "max-length" : 2147483647,
                "stability" : "default"
            },
            "module" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                },
                "description" : "Module of the config source provider to load",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "min-length" : 1,
                "max-length" : 2147483647,
                "stability" : "default"
            }
        }
    }},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "all-services",
    "runtime-only" : false
}

remove - Remove the Config Source Provider

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove the Config Source Provider",
    "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.microprofile-config-smallrye.config-source-provider

        
<feature spec="subsystem.microprofile-config-smallrye.config-source-provider">
  <param name="config-source-provider" value="{resource name}"/>
  <param name="class" value="{value}"/>
<feature/>