ldapBatch

Home > Books > NetKernel API and Services Reference > Accessor Listing > LDAP / DSML Accessors and Utilities > ldapBatch

Module

urn:org:ten60:netkernel:mod:ldap

The ldapBatch accessor is exported by the urn:org:ten60:netkernel:mod:ldap module. Import this module to gain access to the accessor.

Syntax

URI

active:ldapBatch

Argument	Rules	Description
operand	Mandatory	A DSML statement to batch process
config	Optional	Configuration to locate the LDAP repository
user	Mandatory	User credentials to authenticate to the LDAP repository

Example Usage

DPML

<instr>
  <type>ldapBatch</type>
  <operand>batch.dsml</operand>
  <user>/etc/myldapUserConfig.xml</user>
  <target>address.dsml</target>
</instr>

NetKernel Foundation API

req=context.createSubRequest("active:ldapBatch");
req.addArgument("operand", [resource representation, aspect, or URI] );
req.addArgument("user", [resource representation, aspect, or URI] );
result=context.issueSubRequest(req);

Purpose

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 ffcpl:/etc/LDAPConnectionConfig.xml in the current context.

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.