Management API Reference for regex-validating-principal-transformer

A regular expression based principal transformer which uses the regular expression to validate the name.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.security.principal-transformer	true	/subsystem=elytron/constant-principal-decoder=* /subsystem=elytron/x500-attribute-principal-decoder=* /subsystem=elytron/chained-principal-transformer=* /subsystem=elytron/custom-principal-transformer=* /subsystem=elytron/aggregate-principal-transformer=* /subsystem=elytron/regex-principal-transformer=* /subsystem=elytron/constant-principal-transformer=* /subsystem=elytron/case-principal-transformer=* /subsystem=elytron/concatenating-principal-decoder=*

Attributes (2)

match - If set to true, the name must match the given pattern to make validation successful. If set to false, the name must not match the given pattern to make validation successful.

Type	BOOLEAN
Default Value	true
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" : "BOOLEAN" }, "description" : "If set to true, the name must match the given pattern to make validation successful. If set to false, the name must not match the given pattern to make validation successful.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

pattern - The regular expression to use for the principal transformer.

Type	STRING
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 regular expression to use for the principal transformer.", "expressions-allowed" : true, "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 - The add operation for the principal transformer.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
match	BOOLEAN	false	true	true	If set to true, the name must match the given pattern to make validation successful. If set to false, the name must not match the given pattern to make validation successful.
pattern	STRING	true	true		The regular expression to use for the principal transformer.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "The add operation for the principal transformer.",
    "request-properties" : {
        "match" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "If set to true, the name must match the given pattern to make validation successful. If set to false, the name must not match the given pattern to make validation successful.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "pattern" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The regular expression to use for the principal transformer.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "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 principal transformer.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "The remove operation for the principal transformer.",
    "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.regex-validating-principal-transformer

        
<feature spec="subsystem.elytron.regex-validating-principal-transformer">
  <param name="regex-validating-principal-transformer" value="{resource name}"/>
  <param name="match" value="{value}"/>
  <param name="pattern" value="{value}"/>
<feature/>