WildFly 36 Model Reference

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).
    • Attribute Value
    Capability reference
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default
  • 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.
    • Attribute Value
    Default Value simple
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default
  • connection-timeout The timeout for connecting to the LDAP server in milliseconds.
    • Attribute Value
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default
  • credential-reference The credential reference to authenticate and connect to the LDAP server. Can be omitted if authentication-level is 'none' (anonymous).
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • enable-connection-pooling Indicates if connection pooling is enabled.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default
  • module Name of module that will be used as class loading base.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default
  • principal The principal to authenticate and connect to the LDAP server. Can be omitted if authentication-level is 'none' (anonymous).
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default
  • properties The additional connection properties for the DirContext.
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default
  • read-timeout The read timeout for an LDAP operation in milliseconds.
    • Attribute Value
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default
  • referral-mode If referrals should be followed.
    • Attribute Value
    Default Value ignore
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Allowed Values follow
    ignore
    throw
    Stability default
  • ssl-context The name of ssl-context used to secure connection to the LDAP server.
    • Attribute Value
    Capability reference
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default
  • url The connection url.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default

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.
  • remove Remove the DirContext definition.