Management API Reference for simple-regex-realm-mapper

Definition of a simple RealmMapper that attempts to extract the realm name using the capture group from the regular expression, if that does not provide a match then the delegate RealmMapper is used instead.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.security.realm-mapper	true	/subsystem=elytron/constant-realm-mapper=* /subsystem=elytron/mapped-regex-realm-mapper=* /subsystem=elytron/custom-realm-mapper=*

Attributes (2)

delegate-realm-mapper - The RealmMapper to delegate to if there is no match using the pattern.

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 RealmMapper to delegate to if there is no match using the pattern.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.realm-mapper", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

pattern - The regular expression which must contain at least one capture group to extract the realm from the name. If the regular expression matches more than one capture group, the first capture group is used.

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 which must contain at least one capture group to extract the realm from the name. If the regular expression matches more than one capture group, the first capture group is used.", "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 - Add operation for the RealmMapper

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
delegate-realm-mapper	STRING	false	false		The RealmMapper to delegate to if there is no match using the pattern.
pattern	STRING	true	true		The regular expression which must contain at least one capture group to extract the realm from the name. If the regular expression matches more than one capture group, the first capture group is used.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add operation for the RealmMapper",
    "request-properties" : {
        "delegate-realm-mapper" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The RealmMapper to delegate to if there is no match using the pattern.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.security.realm-mapper",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "pattern" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The regular expression which must contain at least one capture group to extract the realm from the name. If the regular expression matches more than one capture group, the first capture group is used.",
            "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 - Remove operation for the RealmMapper

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove operation for the RealmMapper",
    "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.simple-regex-realm-mapper

        
<feature spec="subsystem.elytron.simple-regex-realm-mapper">
  <param name="simple-regex-realm-mapper" value="{resource name}"/>
  <param name="delegate-realm-mapper" value="{value}"/>
  <param name="pattern" value="{value}"/>
<feature/>