BBjLDAPSearchResult

Description

In BBj 11.0 and higher, BBjLDAPSearchResult provides a data structure for holding information about the result of processing a search request. This includes the list of BBjLDAPEntry objects, one for each matching result.

Creation

Obtain a BBjLDAPSearchResult object through the following BBjLDAPConnection method:

Return Value

Method

BBjLDAPSearchResult

search(string baseDN, int scope, int sizeLimit, int timeLimit, string filter)

Methods of BBjLDAPSearchResult

Return Value

Method

int

getEntryCount()

BBjVector

getSearchEntries()

Remarks

None.

Constants

Constant

Description

SCOPE_ONE

Indicates that only entries that are immediate subordinates of the entry specified by the base DN (but not the base entry itself) should be considered.

SCOPE_BASE

Indicates that only the entry specified by the base DN should be considered.

SCOPE_SUB

Indicates that the base entry itself and any subordinate entries (to any depth) should be considered.

SCOPE_SUBORDINATE_SUBTREE

Indicates that any subordinate entries (to any depth) below the entry specified by the base DN should be considered, but the base entry itself should not be considered, as described in draft-sermersheim-ldap-subordinate-scope.

  

Example

REM ' getLDAPConnection sample 1

use com.basis.bbj.proxies.ldap.BBjLDAPSearchResult

use com.basis.bbj.proxies.ldap.BBjLDAPConnection

declare BBjLDAPConnection ldapCon!

declare BBjLDAPSearchResult searchResults!

declare BBjVector entries!

declare BBjVector attrs!

REM Get a connection to a specific LDAP server

host$ = "localhost"

port = 10389

authDN$ = "uid=admin,ou=system"

pwd$ = "secret"

ldapCon! = BBjAPI().getLDAPConnection(host$, port, authDN$, pwd$)

REM Return a list of all immediate children of the ou=system object

searchResults! = ldapCon!.search("ou=system",BBjLDAPSearchResult.SCOPE_ONE, 100, 100, "(objectClass=*)")

entries! = searchResults!.getSearchEntries()

for e = 0 to entries!.size() - 1

entry! = entries!.getItem(e)

print "ENTRY - dn: " + entry!.getDN()

attrs! = entry!.getAttributeNames()

for i = 0 to attrs!.size() - 1

attr$ = attrs!.getItem(i)

print "     " + attr$

next i

next e

REM Unbind and close the connection

ldapCon!.close()

See Also

Using LDAP and Active Directory User Authentication

Object Variables

BBj Object Assignment

BBj Object Error Handling

BBj Object Operators

See the BBj Object Diagram for an illustration of the relationship between BBj Objects.




______________________________________________________________________________________

Copyright BASIS International Ltd. BBj®, Visual PRO/5®, PRO/5®, and BBx® are registered trademarks.