Management API Reference for configurable-sasl-server-factory

A SaslServerFactory definition that wraps another SaslServerFactory and applies the specified configuration and filtering.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.security.sasl-server-factory	true	/subsystem=elytron/aggregate-sasl-server-factory=* /subsystem=elytron/provider-sasl-server-factory=* /subsystem=elytron/mechanism-provider-filtering-sasl-server-factory=* /subsystem=elytron/service-loader-sasl-server-factory=*

Attributes (6)

available-mechanisms - The SASL mechanisms available from this factory after all filtering has been applied.

Type	LIST
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "The SASL mechanisms available from this factory after all filtering has been applied.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

filters - List of filters to be evaluated sequentially combining the results using 'or'.

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 filters to be evaluated sequentially combining the results using 'or'.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "predefined-filter" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "A predefined filter to use to filter the mechanism name.", "expressions-allowed" : true, "required" : true, "nillable" : true, "alternatives" : ["pattern-filter"], "allowed" : [ "HASH_MD5", "HASH_SHA", "HASH_SHA_256", "HASH_SHA_384", "HASH_SHA_512", "GS2", "SCRAM", "DIGEST", "IEC_ISO_9798", "EAP", "MUTUAL", "BINDING", "RECOMMENDED" ], "stability" : "default" }, "pattern-filter" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "A regular expression based filter of the mechanism name.", "expressions-allowed" : true, "required" : true, "nillable" : true, "alternatives" : ["predefined-filter"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "enabling" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Is this filter enabling or disabling the matched names.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default" } }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

properties - Custom properties to be passed in to the sasl server factory calls.

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" : "Custom properties to be passed in to the sasl server factory calls.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

protocol - The protocol that should be passed into factory when creating the mechanism.

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 protocol that should be passed into factory when creating the mechanism.", "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 }`

sasl-server-factory - The sasl server factory to be wrapped.

Type	STRING
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 sasl server factory to be wrapped.", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.security.sasl-server-factory", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

server-name - The server name that should be passed into factory when creating the mechanism.

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 server name that should be passed into factory when creating the mechanism.", "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 (2)

add - The add operation for the sasl server factory.

Request Parameter	Type	Required	Expressions Allowed	Description
filters	LIST	false	false	List of filters to be evaluated sequentially combining the results using 'or'.
properties	OBJECT	false	true	Custom properties to be passed in to the sasl server factory calls.
protocol	STRING	false	true	The protocol that should be passed into factory when creating the mechanism.
sasl-server-factory	STRING	true	false	The sasl server factory to be wrapped.
server-name	STRING	false	true	The server name that should be passed into factory when creating the mechanism.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "The add operation for the sasl server factory.",
    "request-properties" : {
        "filters" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "List of filters to be evaluated sequentially combining the results using 'or'.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "predefined-filter" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "A predefined filter to use to filter the mechanism name.",
                    "expressions-allowed" : true,
                    "required" : true,
                    "nillable" : true,
                    "alternatives" : ["pattern-filter"],
                    "allowed" : [
                        "HASH_MD5",
                        "HASH_SHA",
                        "HASH_SHA_256",
                        "HASH_SHA_384",
                        "HASH_SHA_512",
                        "GS2",
                        "SCRAM",
                        "DIGEST",
                        "IEC_ISO_9798",
                        "EAP",
                        "MUTUAL",
                        "BINDING",
                        "RECOMMENDED"
                    ],
                    "stability" : "default"
                },
                "pattern-filter" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "A regular expression based filter of the mechanism name.",
                    "expressions-allowed" : true,
                    "required" : true,
                    "nillable" : true,
                    "alternatives" : ["predefined-filter"],
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "enabling" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "BOOLEAN"
                    },
                    "description" : "Is this filter enabling or disabling the matched names.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "default" : true,
                    "stability" : "default"
                }
            }
        },
        "properties" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "Custom properties to be passed in to the sasl server factory calls.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "protocol" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The protocol that should be passed into factory when creating the mechanism.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "sasl-server-factory" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The sasl server factory to be wrapped.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "capability-reference" : "org.wildfly.security.sasl-server-factory",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "server-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The server name that should be passed into factory when creating the mechanism.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

remove - The remove operation for the sasl server factory.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "The remove operation for the sasl server factory.",
    "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.configurable-sasl-server-factory

        
<feature spec="subsystem.elytron.configurable-sasl-server-factory">
  <param name="configurable-sasl-server-factory" value="{resource name}"/>
  <param name="filters" value="{value}"/>
  <param name="properties" value="{value}"/>
  <param name="protocol" value="{value}"/>
  <param name="sasl-server-factory" value="{value}"/>
  <param name="server-name" value="{value}"/>
<feature/>