# Class: XmlLdapQuerySource

## tibco.objectapi.de.base.XmlLdapQuerySource

#### new XmlLdapQuerySource()

Definition of an LDAP Source entry (identified by the LDAP alias) in an LDAP container. This class of LDAP Source is used to locate candidate entries using an LDAP Query, and optional base-dn. Constructs a new XmlLdapQuerySource.

The following features are supported:

- `Base Dn`
- `Ldap Query`
- `Search Scope`

### Extends

- tibco.objectapi.de.base.XmlLdapSource

### Members

#### attributeMapping :Array.<tibco.objectapi.de.base.XmlLdapAttributeMapping>

This property holds the value of the 'Attribute Mapping' containment reference list.

##### Type:

- Array.<tibco.objectapi.de.base.XmlLdapAttributeMapping>

Inherited From:
  - tibco.objectapi.de.base.XmlLdapSource#attributeMapping

#### baseDn :string

(Optional) Provides an additional base DN that will be used to restrict the scope of the LDAP query. This base DN is relative to, and in additon, to any base DN specified in the URL of the LDAP connection shared resource identified by the ldap-alias. This property holds the value of the 'Base Dn' attribute.

##### Type:

- string

#### ldapAlias :string

The name (or alias) by which a configured LDAP connection shared resource is identified. LDAP connection shared resource are named with the prefix "ldap/de/" in order to indicate that they are intended for Directory Engine use. The alias given here is that name without the "ldap/de/" prefix. An LDAP container can contain only one instance of an LDAP source for any alias. This property holds the value of the 'Ldap Alias' attribute.

##### Type:

- string

Inherited From:
  - tibco.objectapi.de.base.XmlLdapSource#ldapAlias

#### ldapQuery :string

LDAP query expression used to identify the entries to be returned from this LDAP source. This property holds the value of the 'Ldap Query' attribute.

##### Type:

- string

#### resourceNameAttributes :string

(Optional) A space-separated list of named LDAP attributes, whose values will be concatenated to generate a default display name for resources derived from entries in this LDAP source. When an LDAP container contains one or more secondary LDAP sources, and those LDAP sources also provide resource-name-attributes, those of the first entry encountered will be used. This property holds the value of the 'Resource Name Attributes' attribute.

##### Type:

- string

Inherited From:
  - tibco.objectapi.de.base.XmlLdapSource#resourceNameAttributes

#### searchScope :tibco.objectapi.de.base.XmlLdapSearchScope

The Search Scope determines the depth to which the search will be performed. By default the search will be SUBTREE. This property holds the value of the 'Search Scope' attribute.

##### Type:

- tibco.objectapi.de.base.XmlLdapSearchScope