Management API Reference for regex-principal-transformer

A regular expression based principal transformer

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/constant-principal-transformer=* /subsystem=elytron/case-principal-transformer=* /subsystem=elytron/concatenating-principal-decoder=* /subsystem=elytron/regex-validating-principal-transformer=*

Attributes (3)

pattern - The regular expression to use to locate the portion of the name to be replaced.

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 to locate the portion of the name to be replaced.", "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 }`

replace-all - Should all occurrences of the pattern matched be replaced or only the first occurrence.

Type	BOOLEAN
Default Value	false
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" : "Should all occurrences of the pattern matched be replaced or only the first occurrence.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

replacement - The value to be used as the replacement.

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 value to be used as the replacement.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 0, "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
pattern	STRING	true	true		The regular expression to use to locate the portion of the name to be replaced.
replace-all	BOOLEAN	false	true	false	Should all occurrences of the pattern matched be replaced or only the first occurrence.
replacement	STRING	true	true		The value to be used as the replacement.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "The add operation for the principal transformer.",
    "request-properties" : {
        "pattern" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The regular expression to use to locate the portion of the name to be replaced.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "replace-all" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Should all occurrences of the pattern matched be replaced or only the first occurrence.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "replacement" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The value to be used as the replacement.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min-length" : 0,
            "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-principal-transformer

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