Management API Reference for dir-context

The configuration to connect to a directory (LDAP) server.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.security.dir-context	true	none

Attributes (12)

authentication-context - The authentication context to obtain login credentials to connect to the LDAP server. Can be omitted if authentication-level is 'none' (anonymous).

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 authentication context to obtain login credentials to connect to the LDAP server. Can be omitted if authentication-level is 'none' (anonymous).", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : [ "credential-reference", "ssl-context", "principal" ], "capability-reference" : "org.wildfly.security.authentication-context", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }

authentication-level - The authentication level (security level/authentication mechanism) to use. Corresponds to SECURITY_AUTHENTICATION ('java.naming.security.authentication') environment property. Allowed values: 'none', 'simple', sasl_mech, where sasl_mech is a space-separated list of SASL mechanism names.

Type	STRING
Default Value	simple
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 authentication level (security level/authentication mechanism) to use. Corresponds to SECURITY_AUTHENTICATION ('java.naming.security.authentication') environment property. Allowed values: 'none', 'simple', sasl_mech, where sasl_mech is a space-separated list of SASL mechanism names.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "simple", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

connection-timeout - The timeout for connecting to the LDAP server in milliseconds.

Type	INT
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" : "INT" }, "description" : "The timeout for connecting to the LDAP server in milliseconds.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

credential-reference - The credential reference to authenticate and connect to the LDAP server. Can be omitted if authentication-level is 'none' (anonymous).

Type	OBJECT
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "The credential reference to authenticate and connect to the LDAP server. Can be omitted if authentication-level is 'none' (anonymous).", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["authentication-context"], "stability" : "default", "access-constraints" : {"sensitive" : {"credential" : {"type" : "core"}}}, "value-type" : { "store" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the credential store holding the alias to credential.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.credential-store", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "alias" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The alias which denotes stored secret or credential in the store.", "expressions-allowed" : true, "required" : false, "nillable" : true, "requires" : ["store"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "type" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The type of credential this reference is denoting.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "clear-text" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Secret specified using clear text. Check credential store way of supplying credential/secrets to services.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

enable-connection-pooling - Indicates if connection pooling is enabled.

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" : "Indicates if connection pooling is enabled.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

module - Name of module that will be used as class loading base.

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" : "Name of module that will be used as class loading base.", "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 }`

principal - The principal to authenticate and connect to the LDAP server. Can be omitted if authentication-level is 'none' (anonymous).

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" : "The principal to authenticate and connect to the LDAP server. Can be omitted if authentication-level is 'none' (anonymous).", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : ["authentication-context"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

properties - The additional connection properties for the DirContext.

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 additional connection properties for the DirContext.", "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 }`

read-timeout - The read timeout for an LDAP operation in milliseconds.

Type	INT
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" : "INT" }, "description" : "The read timeout for an LDAP operation in milliseconds.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

referral-mode - If referrals should be followed.

Type	STRING
Default Value	ignore
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
Allowed Values	throw ignore follow
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "If referrals should be followed.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "ignore", "allowed" : [ "follow", "ignore", "throw" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

ssl-context - The name of ssl-context used to secure connection to the LDAP server.

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 name of ssl-context used to secure connection to the LDAP server.", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["authentication-context"], "capability-reference" : "org.wildfly.security.ssl-context", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

url - The connection url.

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 connection url.", "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 the DirContext definition.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
authentication-context	STRING	false	false		The authentication context to obtain login credentials to connect to the LDAP server. Can be omitted if authentication-level is 'none' (anonymous).
authentication-level	STRING	false	true	simple	The authentication level (security level/authentication mechanism) to use. Corresponds to SECURITY_AUTHENTICATION ('java.naming.security.authentication') environment property. Allowed values: 'none', 'simple', sasl_mech, where sasl_mech is a space-separated list of SASL mechanism names.
connection-timeout	INT	false	true		The timeout for connecting to the LDAP server in milliseconds.
credential-reference	OBJECT	false	false		The credential reference to authenticate and connect to the LDAP server. Can be omitted if authentication-level is 'none' (anonymous).
enable-connection-pooling	BOOLEAN	false	true	false	Indicates if connection pooling is enabled.
module	STRING	false	true		Name of module that will be used as class loading base.
principal	STRING	false	true		The principal to authenticate and connect to the LDAP server. Can be omitted if authentication-level is 'none' (anonymous).
properties	OBJECT	false	true		The additional connection properties for the DirContext.
read-timeout	INT	false	true		The read timeout for an LDAP operation in milliseconds.
referral-mode	STRING	false	true	ignore	If referrals should be followed.
ssl-context	STRING	false	false		The name of ssl-context used to secure connection to the LDAP server.
url	STRING	true	true		The connection url.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add the DirContext definition.",
    "request-properties" : {
        "authentication-context" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The authentication context to obtain login credentials to connect to the LDAP server. Can be omitted if authentication-level is 'none' (anonymous).",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "alternatives" : [
                "credential-reference",
                "ssl-context",
                "principal"
            ],
            "capability-reference" : "org.wildfly.security.authentication-context",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "authentication-level" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The authentication level (security level/authentication mechanism) to use. Corresponds to SECURITY_AUTHENTICATION ('java.naming.security.authentication') environment property. Allowed values: 'none', 'simple', sasl_mech, where sasl_mech is a space-separated list of SASL mechanism names.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "simple",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "connection-timeout" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The timeout for connecting to the LDAP server in milliseconds.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "credential-reference" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "The credential reference to authenticate and connect to the LDAP server. Can be omitted if authentication-level is 'none' (anonymous).",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["authentication-context"],
            "stability" : "default",
            "value-type" : {
                "store" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The name of the credential store holding the alias to credential.",
                    "expressions-allowed" : false,
                    "required" : false,
                    "nillable" : true,
                    "capability-reference" : "org.wildfly.security.credential-store",
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "alias" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The alias which denotes stored secret or credential in the store.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "requires" : ["store"],
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "type" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The type of credential this reference is denoting.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "clear-text" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Secret specified using clear text. Check credential store way of supplying credential/secrets to services.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                }
            }
        },
        "enable-connection-pooling" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Indicates if connection pooling is enabled.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "module" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Name of module that will be used as class loading base.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "principal" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The principal to authenticate and connect to the LDAP server. Can be omitted if authentication-level is 'none' (anonymous).",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["authentication-context"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "properties" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "The additional connection properties for the DirContext.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "read-timeout" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The read timeout for an LDAP operation in milliseconds.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "referral-mode" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "If referrals should be followed.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "ignore",
            "allowed" : [
                "follow",
                "ignore",
                "throw"
            ],
            "stability" : "default"
        },
        "ssl-context" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of ssl-context used to secure connection to the LDAP server.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["authentication-context"],
            "capability-reference" : "org.wildfly.security.ssl-context",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "url" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The connection url.",
            "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 the DirContext definition.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove the DirContext definition.",
    "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.dir-context

        
<feature spec="subsystem.elytron.dir-context">
  <param name="dir-context" value="{resource name}"/>
  <param name="authentication-context" value="{value}"/>
  <param name="authentication-level" value="{value}"/>
  <param name="connection-timeout" value="{value}"/>
  <param name="credential-reference" value="{value}"/>
  <param name="enable-connection-pooling" value="{value}"/>
  <param name="module" value="{value}"/>
  <param name="principal" value="{value}"/>
  <param name="properties" value="{value}"/>
  <param name="read-timeout" value="{value}"/>
  <param name="referral-mode" value="{value}"/>
  <param name="ssl-context" value="{value}"/>
  <param name="url" value="{value}"/>
<feature/>