Package com.unboundid.ldap.sdk.persist

This package provides an API which intends to make it easy to interact with directory data using Java objects.

See: Description

Interface Summary

Interface	Description
ObjectSearchListener<T>	This interface defines a set of methods that provide access to objects returned by the LDAPPersister class in the course of performing a search.

Class Summary

Class	Description
DefaultObjectEncoder	This class provides the default implementation of an ObjectEncoder object that will be used when encoding and decoding fields to be written to or read from an LDAP directory server.
DefaultOIDAllocator	This class provides an OID allocator implementation that will generate OIDs which are equal to the lowercase name of the associated attribute type or object class followed by "-oid".
FieldInfo	This class provides a data structure that holds information about an annotated field.
GenerateSchemaFromSource	This class provides a tool which can be used to generate LDAP attribute type and object class definitions which may be used to store objects created from a specified Java class.
GenerateSourceFromSchema	This class provides a tool which can be used to generate source code for a Java class file based on information read from the schema of an LDAP directory server.
GetterInfo	This class provides a data structure that holds information about an annotated getter method.
LDAPObjectHandler<T>	This class provides a mechanism for validating, encoding, and decoding objects marked with the LDAPObject annotation type.
LDAPPersister<T>	This class provides an interface that can be used to store and update representations of Java objects in an LDAP directory server, and to find and retrieve Java objects from the directory server.
ObjectEncoder	This class provides an API for converting between Java objects and LDAP attributes.
OIDAllocator	This class provides a mechanism that can be used for generating object identifiers (OIDs) for use in attribute type and object class definitions constructed for use in representing an object in the directory.
PersistedObjects<T>	This class provides a mechanism for iterating through the objects returned by a search operation performed using one of the search methods in the LDAPPersister class.
PersistUtils	This class provides a set of utilities that may be used in the course of persistence processing.
SetterInfo	This class provides a data structure that holds information about an annotated setter method.

Enum Summary

Enum	Description
FilterUsage	This enumeration defines a set of options that indicate how the value of a field or getter method may be used in the process of constructing a search filter.
PersistFilterType	This enum defines a set of filter types for filters that may be generated for an object using the LDAP SDK persistence framework.

Exception Summary

Exception	Description
LDAPPersistException	This class defines an exception that may be thrown if a problem occurs while attempting to perform processing related to persisting Java objects in an LDAP directory server.

Annotation Types Summary

Annotation Type	Description
LDAPDNField	This annotation type may be used to mark a field whose value should be the DN of the entry from which the corresponding object was initialized.
LDAPEntryField	This annotation type may be used to mark a field whose value should be the full entry from which the corresponding object was initialized.
LDAPField	This annotation type may be used to mark fields whose values should be persisted in an LDAP directory server.
LDAPGetter	This annotation type may be used to mark methods whose return values should be persisted in an LDAP directory server.
LDAPObject	This annotation type may be used to mark classes for objects that may be persisted in an LDAP directory server.
LDAPSetter	This annotation type may be used to mark methods which may be used to set values in the associated object using attributes read from an LDAP directory server.

Package com.unboundid.ldap.sdk.persist Description

This package provides an API which intends to make it easy to interact with directory data using Java objects. It is primarily a persistence framework, which includes the ability to convert between Java objects and LDAP entries, but it also provides a means of performing LDAP operations (add, delete, modify, and search) with that data.

At the heart of the LDAP persistence framework is a set of annotation types that can be used to mark source code to indicate how it should be stored in the LDAP directory server. Those annotations include:

• LDAPObject -- This annotation type is used to mark the class for objects that may be stored in an LDAP directory server. It provides information about the structural and auxiliary object classes that should be used in the LDAP representation of the data.
• LDAPField -- This annotation type is used to mark fields in classes for objects that should be stored in an LDAP directory server. It provides information about the LDAP attribute that should be used to store the information for that field, and to identify constraints on how that field may be used.
• LDAPGetter and LDAPSetter -- These annotation types provide an alternative to the LDAPField annotation. Rather than marking fields, they should be used to mark getter and setter methods that can be used to retrieve and update the associated value.
• LDAPDNField -- This annotation type should be used to mark at most one field in a Java class whose value should be the DN of the LDAP entry with which the object instance is associated.
• LDAPEntryField -- This annotation type should be used to mark at most one field in a Java class whose value should be a read-only representation of the LDAP entry with which the object instance is associated.

The LDAPObjectHandler class provides the primary interface for interacting with objects of a specified type and converting between the Java and LDAP representations of that data. The ObjectEncoder class provides an API that may be used to convert between Java and LDAP representations for object values.