JBStrap LDAP DataDescriptor

Use the LDAP DataDescriptor to describe LDAP objects, such as leaf nodes with a distinguished name and attributes. LDAP DataDescriptors use the LDAP DAO layer to access data and allow you to read the data stored in the LDAP server. The LDAP DAO does not support updating data on the LDAP server.

Creating a simple LDAP DataDescriptor with an XML structure:

         <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE xml>
<datadescriptor name="Example" connectorType="LDAP">
  <access>
    <type>Public</type>
  </access>
  <column name="distinguishedName" datatype="VARCHAR2" nullable="false" primaryKey="true" />
  <column name="name" datatype="VARCHAR2" length="255"/>
  <column name="uSNCreated" datatype="LONG"/>
</datadescriptor>
        

Programmatically creating an LDAP DataDescriptor that corresponds to the above XML:

         final LDAPDataDescriptor dataDescriptor = new LDAPDataDescriptor("Example")
		.setAccess(AccessType.PUBLIC)
		.addColumn(new DataDescriptorColumn("distinguishedName", DataDescriptorColumnDatatype.TEXT, "Example")
				.setPrimaryKey(true)
				.setNullable(false)
				)
		.addColumn(new DataDescriptorColumn("name", DataDescriptorColumnDatatype.TEXT, "Example")
				.setLength(255)
				)
		.addColumn(new DataDescriptorColumn("uSNCreated", DataDescriptorColumnDatatype.LONG, "Example"));
        

When building an LDAP connection, you can specify the default search path and search scope. By default, searches take place in the entire tree using a subtree scope.

         new LDAPConnection()
	.setDefaultSearchScope(LDAPSearchScope.SUBTREE_SCOPE)
	.setDefaultSearchDn("OU=ExampleOrgUnit,DC=company,DC=com")
        

The LDAP DataDescriptor does not support all sorts of data manipulation, it only allows you to read data from a specified LDAP server.

Fetching all objects from the LDAP server using the data descriptor:

Fetching all objects corresponding to the given criteria from the LDAP server using the data descriptor:

         List<DataRecord> result = dataDescriptor.find(new Criteria("name", OperatorType.EQUALS, "John"));
        

Fetching a object using its ID:

         DataRecord exampleUser = dataDescriptor.findById("CN=Example User,OU=Users,OU=ExampleOrgUnit,DC=company,DC=com");
        