LDAP4D - Protocol Messages

• LDAP_BindRequest
• LDAP_UnbindRequest
• LDAP_AbandonRequest
• LDAP_AddRequest
• LDAP_DeleteRequest
• LDAP_ModifyRequest (operation array parm for v20 or higher)
• LDAP_ModifyRDNRequest
• LDAP_CompareRequest
• LDAP_SearchRequest (parses matchingRuleAssertion in search filters in v20 or higher)
• LDAP_AddControl (v20 or higher)

About this section...

This section describes the methods used to perform the protocol operations specified in RFC 2251 LDAP v3. These methods generate BER encoded text that can be used with LDAP_Message_Send to request an action from an LDAP server. Some aspects of LDAP v3 are not yet implemented. These differences are described in .....

LDAP_BindRequest

Syntax:

result := LDAP_BindRequest (distinguishedName;T ; {password:T }; {version:LI} )

Description:

Create a bind message.

Warning:

Note:

If no version parameter is passed, it defaults to version 3. Also, SASL Authentication option is NOT supported.

Params:

Example:

$tText := LDAP_BindRequest($tDN;$tPassword;$iVersion)
If ($tText = "")  `could check result code also...
  ALERT("Couldn't create Bind request!")
End If

LDAP_UnbindRequest

Syntax:

result:= LDAP_UnbindRequest

Description:

Create a unbind message.

Warning:

Note:

Params:

In/Out	Parameter	Type		Example or note
None
<-	result	Text	BER encoded content of UnbindRequest message

Example:

$tText := LDAP_UnbindRequest
If ($tText = "")
  ALERT("Couldn't generate Unbind request!")
End If

LDAP_AbandonRequest

Syntax:

result := LDAP_AbandonRequest (messageID:LI)

Description:

Create an AbandonRequest. Message should have already been sent to the server.

The function of the Abandon Operation is to allow a client to request
that the server abandon an outstanding operation.

The MessageID MUST be that of a an operation which was requested
earlier in this connection.

(The abandon request itself has its own message id. This is distinct
from the id of the earlier operation being abandoned.)

There is no response defined in the Abandon Operation. Upon
transmission of an Abandon Operation, a client may expect that the
operation identified by the Message ID in the Abandon Request has
been abandoned. In the event that a server receives an Abandon
Request on a Search Operation in the midst of transmitting responses
to the search, that server MUST cease transmitting entry responses to
the abandoned request immediately, and MUST NOT send the
SearchResponseDone. Of course, the server MUST ensure that only
properly encoded LDAPMessage PDUs are transmitted.

Warning:

Note:

Params:

Example:

$text :=LDAP_AbandonRequest($iMessageID)
If ($tText = "")
  ALERT("Couldn't create Abandon request!")
End IF

LDAP_AddRequest

Syntax:

result := LDAP_AddRequest (distinguishedName;T ; pAttributeTypes:P ; pAttributeValues:P )

Description:

Create an AddRequest.

Warning:

Note:

The arrays of attribute types and attribute values must be of the same length.

Params:

Example:

$tText :=LDAP_AddRequest("uid=tswenson, o=dogboy";->at_attributeArray;->at_attributeValues)
If ($tText = "")  `could check result code also...
  ALERT("Couldn't create Add request!")
End If

LDAP_DeleteRequest

Syntax:

result := LDAP_DeleteRequest (distinguishedName;T )

Description:

Create a delete request.

Warning:

Note:

Params:

Example:

$tText := LDAP_DeleteRequest($tDN)
If ($tText = "")  `could check result code also...
  ALERT("Couldn't create Delete request!")
End If

LDAP_ModifyRequest

Syntax:

result := LDAP_ModifyRequest (distinguishedName;T ; pAttributeTypes:P ; pAttributeValues:P ; pOperation{optional}:I)

Description:

Create a modify request.

Warning:

Note:

The arrays must be of the same dimension.

Params:

Example:

$tText := LDAP_ModifyRequest($tDN;->aT_LocalAttribs;->aT_LocalValues)
If ($tText = "")  `could check result code also...
  ALERT("Couldn't create Modify request!")
End If

LDAP_ModifyRDNRequest

Syntax:

result := LDAP_ModifyRDNRequest (distinguishedName;T ; newRDN:T {; deleteOldRDN:B} )

Description:

Create a modify relative distinguished name message.

Warning:

Note:

Use of this message is dependent upon the schema of the target LDAP server.

Params:

Example:

$tText := LDAP_ModifyRDNRequest($tDN;$tPassword;FALSE)
If ($tText = "")  `could check result code also...
  ALERT("Couldn't create Modify RDN request!")
End If

LDAP_CompareRequest

Syntax:

result := LDAP_CompareRequest (distinguishedName;T ; pAttributeTypes:P ; pAttributeValues:P )

Description:

Create a compare message.

Warning:

Note:

Params:

Example:

$tText := LDAP_CompareRequest($tDN;->tA_AttributeTypes;->tA_AttributeValues)
If ($tText = "")  `could check result code also...
  ALERT("Couldn't create Compare request")
End If

LDAP_SearchRequest

Syntax:

result := LDAP_SearchRequest (distinguishedName:T; scope:T; derefAliases:T; sizeLimit:T; timeLimit:T; searchFilter:T; pAttributeTypes:P; returnAttributes:B)

Description:

Create a search request message.

Warning:

Note:

The response to the search request can be examined using the Response Handling methods ot LDAP4D

Params:

Example:

$tText := LDAP_SearchRequest($tDN;"wholeSubTree";"neverDerefAliases";$iSizeLimit
                                       ;$iTimeLimit;$tSearchFilter;->tA_SearchAttributes;False)
If ($tText = "")  `could check result code also...
  ALERT("Couldn't create Search request!")
End If

LDAP_AddControl

Syntax:

result := LDAP_AddControl (pOIDs:P; pCriticalities:P; pControlValues:P; pMessage:P)

Description:

Add a control to an existing LDAP Message that has been created but not yet wrapped in LDAP Message envelope for sending. Since multiple controls can be sent with a single LDAP Message, the paradigm chosen for this API is to pre-assemble the data needed for the controls into arrays and have them constructed into valid BER and added to an existing message using this single command.

Warning:

Note:

$tText:=LDAP_Add Control($pOIDs;$pCriticalities;$pControlvalues;$pMessage)

Params:

Example:

$result := LDAP_AddControl($pOIDs;$pCriticalities;$pControlValues;$pMessage)
If ($result # 0) 
  ALERT("Couldn't Add Control to message")
End If