LDAP DAO - Learn JBStrap

Data handling in LDAP

Fetch

Use this functionality to programmatically retrieve data based on a DataDescriptor from an LDAP server. In the data query, you can apply filter criteria to the query. Filter criteria are JBStrap Criteria objects. Results are returned as DataRecord or List<DataRecord> objects. You can retrieve all the corresponding records or only a subset of the record for a faster response time.

If you can specify the client object, the access rights in the DataDescriptor are checked. If a user does not have read rights for the data (as specified in the DataDescriptor), the an error is returned, preventing unauthorized access to the data.

Here are a few examples of how to fetch data using the LDAP DataDescriptor:

  Fetching all data using a DataDescriptor  
        
List<DataRecord> result = LDAPDaoAPI.find(dataDescriptor);

  Fetching all data using a DataDescriptor while checking for access rights  
        
List<DataRecord> result = LDAPDaoAPI.find(dataDescriptor, client);

  Fetching all data that meet the specified Criteria using a DataDescriptor (fetching every Record object where the objectClass is a person)  
        
List<DataRecord> result = LDAPDaoAPI.find(dataDescriptor, new Criteria("objectClass", OperatorType.EQUALS, "person"));

  Fetching all records from the DataDescriptor where the objectClass is a person while also checking the access rights  
        
List<DataRecord> result = LDAPDaoAPI.find(dataDescriptor, client, new Criteria("objectClass", OperatorType.EQUALS, "person"));

  Fetching the first 50 records using a DataDescriptor that meets the specified filters (records where the objectClass is a person). If there are more than 50 corresponding records, only the first 50 ones will be fetched).  
        
List<DataRecord> result = LDAPDaoAPI.find(dataDescriptor, 0, 50, new Criteria("objectClass", OperatorType.EQUALS, "person");

  Fetching the next 50 records (51-100) while checking the access rights  
        
List<DataRecord> result = LDAPDaoAPI.find(dataDescriptor, client, 51, 100, new Criteria("objectClass", OperatorType.EQUALS, "person");

  Fetching the first 50 records that meet the specified criteria and sorting the results in descending order by name  
        
List<DataRecord> result = LDAPDaoAPI.find(dataDescriptor, 0, 50, new Criteria("objectClass", OperatorType.EQUALS, "person"), new Order("name", OrderType.DESCENDING));

  Fetching the first 50 records while checking the access rights and sorting search results in descending order by name and ascending order by company  
        
List<DataRecord> result = LDAPDaoAPI.find(dataDescriptor, client, 0, 50, new Criteria("objectClass", OperatorType.EQUALS, "person"), new Order("name", OrderType.DESCENDING), new Order("company", OrderType.ASCENDING));

Fetching a record from the LDAP server using its unique ID:

  Fetching the record that corresponds to the primary key (CN=Example User,OU=Users,OU=ExampleOrgUnit,DC=company,DC=com) from a DataDescriptor  
        
DataRecord result = LDAPDaoAPI.findById(dataDescriptor, "CN=Example User,OU=Users,OU=ExampleOrgUnit,DC=company,DC=com");

  Fetching the record that corresponds to the primary key (CN=Example User,OU=Users,OU=ExampleOrgUnit,DC=company,DC=com) from a DataDescriptor while checking for access rights  
        
DataRecord result = LDAPDaoAPI.findById(dataDescriptor, client, "CN=Example User,OU=Users,OU=ExampleOrgUnit,DC=company,DC=com");

Counting the records:

  Counting the record rows in a DataDescriptor  
        
long count = LDAPDaoAPI.getRowCount(dataDescriptor);

  Counting the record rows in a DataDescriptor while checking the access rights  
        
long count = LDAPDaoAPI.getRowCount(dataDescriptor, client);

  Counting the record rows in a DataDescriptor that meet the specified criteria (where the objectClass column is a person)  
        
long count = LDAPDaoAPI.getRowCount(dataDescriptor, new Criteria("objectClass", OperatorType.EQUALS, "person"));

  Counting the record rows in a DataDescriptor that meet the specified criteria while checking the access rights  
        
long count = LDAPDaoAPI.getRowCount(dataDescriptor, client, new Criteria("objectClass", OperatorType.EQUALS, "person"));