Management API Reference for logical-permission-mapper

Definition of a logical permission mapper.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.security.permission-mapper	true	/subsystem=elytron/custom-permission-mapper=* /subsystem=elytron/constant-permission-mapper=* /subsystem=elytron/simple-permission-mapper=*

Attributes (3)

left - Reference to the permission mapper to use to the left of the operation.

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" : "Reference to the permission mapper to use to the left of the operation.", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.security.permission-mapper", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

logical-operation - The logical operation to use to combine the permission mappers.

Type	STRING
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Allowed Values	or unless and xor
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The logical operation to use to combine the permission mappers.", "expressions-allowed" : true, "required" : true, "nillable" : false, "allowed" : [ "and", "or", "xor", "unless" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

right - Reference to the permission mapper to use to the right of the operation.

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" : "Reference to the permission mapper to use to the right of the operation.", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.security.permission-mapper", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

Operations (2)

add - Add operation for the permission mapper

Request Parameter	Type	Required	Expressions Allowed	Description
left	STRING	true	false	Reference to the permission mapper to use to the left of the operation.
logical-operation	STRING	true	true	The logical operation to use to combine the permission mappers.
right	STRING	true	false	Reference to the permission mapper to use to the right of the operation.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add operation for the permission mapper",
    "request-properties" : {
        "left" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Reference to the permission mapper to use to the left of the operation.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "capability-reference" : "org.wildfly.security.permission-mapper",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "logical-operation" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The logical operation to use to combine the permission mappers.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "allowed" : [
                "and",
                "or",
                "xor",
                "unless"
            ],
            "stability" : "default"
        },
        "right" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Reference to the permission mapper to use to the right of the operation.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "capability-reference" : "org.wildfly.security.permission-mapper",
            "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 permission mapper

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove operation for the permission mapper",
    "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.logical-permission-mapper

        
<feature spec="subsystem.elytron.logical-permission-mapper">
  <param name="logical-permission-mapper" value="{resource name}"/>
  <param name="left" value="{value}"/>
  <param name="logical-operation" value="{value}"/>
  <param name="right" value="{value}"/>
<feature/>