WARNING: This server provides a static reference view of the NetKernel documentation. Links to dynamic content do not work. For the best experience we recommend you install NetKernel and view the documentation in the live system .

Endpoint
Name:mod-ldap-ldapBatch
Description:
Id:mod-ldap-ldapBatch
Category:accessor
Identifier Syntax

mod-ldap-ldapBatch is an accessor using Active URI syntax with the following base identifiers:

Base
active:ldapBatch

and the following arguments: (for more details on argument passing details see here)

ArgumentRulesTypingDescription
operand
Mandatory
Representation (java.lang.Object)DSML Batch Statement
user
Mandatory
Representation (java.lang.Object)User credentials
config
Optional
Representation (java.lang.Object)Configuration
Request Verbs

The following verb is supported:

Verb
SOURCE
Response

The following response representations can be returned for SOURCE requests:

SOURCE Representations
DOM

This accessor throws no documented exceptions.

Import Requirements

To use mod-ldap-ldapBatch accessor you must import the module urn:org:netkernel:mod:ldap:

<import>
  <uri>urn:org:netkernel:mod:ldap</uri>
</import>

The ldapBatch accessor performs batch LDAP operations specified in DSML markup. DSML is directory (LDAP) data as XML.

Please see the detailed guide for examples of performing DSML operations with this accessor.

Configuration

The ldap host configuration is provided by the config argument. It is an XML resource of the form...

<LDAPConnectionConfig>
  <host>ldapserver.somehost.com</host>
  <port>636</port>
  <connectionPoolSize>3</connectionPoolSize>
  <sharedConnectionSize>2</sharedConnectionSize>
  <ssl />
</LDAPConnectionConfig>

The configuration parameters are as follows:

  • host - the hostname of the LDAP server
  • port - the port. Standard ports are ldap 389 or ldaps 636 (TLS/SSL encrypted)
  • connectionPoolSize - size of the connection pool to use
  • sharedConnectionSize - number of requests that can share a signle connection.
  • ssl - if this tag is present then use a secured SSL connection.

If the config argument is not supplied then the accessor will attempt to source its configuration from res:/etc/LDAPConnectionConfig.xml.

User credentials for logging in to the LDAP repository must be provided by the user argument. This is an XML resource of the form...

<LDAPUserConfig>
  <loginDN>cn=Manager,dc=1060,dc=org</loginDN>
  <password>secret</password>
</LDAPUserConfig>

  • loginDN is the LDAP distinguished name to use for login.