Management API Reference for custom-credential-security-factory

A custom credential SecurityFactory definition.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.security.security-factory.credential	true	/subsystem=elytron/kerberos-security-factory=*

Attributes (3)

class-name - The class name of the implementation of the custom security factory.

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 class name of the implementation of the custom security factory.", "attribute-group" : "class-loading", "expressions-allowed" : false, "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 }`

configuration - The optional key/value configuration for the custom security factory.

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" : "The optional key/value configuration for the custom security factory.", "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 }`

module - The module to use to load the custom security factory.

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 module to use to load the custom security factory.", "attribute-group" : "class-loading", "expressions-allowed" : false, "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 security factory.

Request Parameter	Type	Required	Expressions Allowed	Description
configuration	OBJECT	false	true	The optional key/value configuration for the custom security factory.
class-name	STRING	true	false	The class name of the implementation of the custom security factory.
module	STRING	true	false	The module to use to load the custom security factory.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "The add operation for the security factory.",
    "request-properties" : {
        "configuration" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "The optional key/value configuration for the custom security factory.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "class-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The class name of the implementation of the custom security factory.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "module" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The module to use to load the custom security factory.",
            "expressions-allowed" : false,
            "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 security factory.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "The remove operation for the security 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.custom-credential-security-factory

        
<feature spec="subsystem.elytron.custom-credential-security-factory">
  <param name="custom-credential-security-factory" value="{resource name}"/>
  <param name="class-name" value="{value}"/>
  <param name="configuration" value="{value}"/>
  <param name="module" value="{value}"/>
<feature/>