Management API Reference for jaspi-configuration

Resource containing the JASPI ServerAuthModule configuration for the servlet profile.

Attributes (4)

application-context - The application-context this configuration is to be associated with or '*' for all application contexts.

Type	STRING
Default Value	*
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" : "STRING" }, "description" : "The application-context this configuration is to be associated with or '' for all application contexts.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

description - Description of this configuration.

Type	STRING
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" : "STRING" }, "description" : "Description of this configuration.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

layer - The layer this configuration is to be associated with or '*' for all layers.

Type	STRING
Default Value	*
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" : "STRING" }, "description" : "The layer this configuration is to be associated with or '' for all layers.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

server-auth-modules - List of ServerAuthModule definitions for this configuration.

Type	LIST
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" : "LIST" }, "description" : "List of ServerAuthModule definitions for this configuration.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "class-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The fully qualified class name of the ServerAuthModule.", "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 load the ServerAuthModule from.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "flag" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Control flag for coordination of the ServerAuthModule results.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "required", "allowed" : [ "required", "requisite", "sufficient", "optional" ], "stability" : "default" }, "options" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "Configuration options to be passed into the ServerAuthModule.", "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 }

Operations (2)

add - Add a new JASPI configuration.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
application-context	STRING	false	true	*	The application-context this configuration is to be associated with or '*' for all application contexts.
description	STRING	false	true		Description of this configuration.
layer	STRING	false	true	*	The layer this configuration is to be associated with or '*' for all layers.
server-auth-modules	LIST	false	false		List of ServerAuthModule definitions for this configuration.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add a new JASPI configuration.",
    "request-properties" : {
        "application-context" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The application-context this configuration is to be associated with or '*' for all application contexts.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "*",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "description" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Description of this configuration.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "layer" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The layer this configuration is to be associated with or '*' for all layers.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "*",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "server-auth-modules" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "List of ServerAuthModule definitions for this configuration.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "class-name" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The fully qualified class name of the ServerAuthModule.",
                    "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 load the ServerAuthModule from.",
                    "expressions-allowed" : false,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "flag" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Control flag for coordination of the ServerAuthModule results.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "default" : "required",
                    "allowed" : [
                        "required",
                        "requisite",
                        "sufficient",
                        "optional"
                    ],
                    "stability" : "default"
                },
                "options" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "OBJECT"
                    },
                    "description" : "Configuration options to be passed into the ServerAuthModule.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "stability" : "default",
                    "value-type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    }
                }
            }
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

remove - Remove the JASPI configuration.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove the JASPI configuration.",
    "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.jaspi-configuration

        
<feature spec="subsystem.elytron.jaspi-configuration">
  <param name="jaspi-configuration" value="{resource name}"/>
  <param name="application-context" value="{value}"/>
  <param name="description" value="{value}"/>
  <param name="layer" value="{value}"/>
  <param name="server-auth-modules" value="{value}"/>
<feature/>