Package com.compoze.exchange.activedirectory

This package provides classes that wrap the Active Directory Services API.

See:
Description

Interface Summary

IAddressListAttributes	This interface contains LDAP constants pertaining to attributes of the Address-Book-Container class.
IContactAttributes	This interface contains LDAP constants pertaining to attributes of the Contact class.
IGroupAttributes	This interface contains LDAP constants pertaining to attributes of the Group class.
IMailRecipientAttributes	This interface contains LDAP constants pertaining to attributes of the Person class.
IOrganizationalPersonAttributes	This interface contains LDAP constants pertaining to attributes of the OrganizationalPerson class.
IPersonAttributes	This interface contains LDAP constants pertaining to attributes of the Person class.
ITopAttributes	This interface contains LDAP constants pertaining to attributes of the Top class.

Class Summary

AbstractOrganizationalPerson	This class contains organizational information about a user.
AbstractOrganizationalPersonFilter	This class is used to filter orgainizational information of a user from Microsoft Active Directory.
AbstractPerson	This class contains personal information about a user.
AbstractPersonFilter	This class is used to filter personal information of a user from Microsoft Active Directory.
AbstractTop	This class is the top level class in which all classes are derived from.
AbstractTopFilter	This class is used to filter top level information from Microsoft Active Directory.
Accounts	This class contains a list of contact, user and group accounts.
ActiveDirectorySession	This class provides a wrapper around a session to Microsoft Active Directory Services, and is the entry point into the Active Directory API.
Address	This class represents a street address.
AddressList	This class represents a container for holding members of an address book view, also known as an address list.
AddressListFilter	This class is used to filter address lists from the Microsoft Active Directory.
AddressLists	This class contains a list of address book views, also known as address lists.
Contact	This class contains information about a person or company that may be considered a contact, or one that need to be contacted on a regular basis.
ContactFilter	This class is used to filter contacts from Micorsoft Active Directory.
Exerciser	This class is the exerciser for the Active Directory API.
Group	This class is used to store a list of user names.
GroupFilter	This class is used to filter groups from Micorsoft Active Directory.
MailRecipientFilter	This class is used to filter mail recipients from Microsoft Active Directory.
Name	This class represents a person's full name.
User	This class is used to store information about an employee or contractor that works for an organization.
UserFilter	This class is used to filter users from Micorsoft Active Directory.

Exception Summary

ActiveDirectoryException

This class is wrapper around an exception thrown in Active Directory directory service..

Package com.compoze.exchange.activedirectory Description

This package provides classes that wrap the Active Directory Services API. The following has been added to insure ease of use:

• toString() methods that aid in debugging.
• All exceptions have been wrapped in a single ActiveDirectoryException for programming convenience.
• Acive Directory sessions are kept in a cache so that only a single session is ever opened for a given user. Using this cache, an Acive Directory session does not need to be opened and closed on every request in an application, which increases performance.
• An exerciser program is included to test API functionality and diagnose problems (see com.compoze.exchange.activedirectory.Exerciser). The source code for this exerciser is included.
• Access to information of the user logged into a session (see ActiveDirectorySession.getUserInfo())

One good way to start understanding the API is to try running the exerciser program. This will also test the connection to your server. You can do this by running java com.compoze.exchange.activedirectory.Exerciser from the command prompt. Usage will be printed to tell you how to run the program. The source code for the exerciser (Exerciser.java in $HARMONY_HOME/examples/source/) also serves as an example of how to do different things.

To begin using the API in this package you must first obtain a session to the server. See ActiveDirectorySession.getSession(String,String,String) for information on how to do this.

Although it should not strictly be needed, sometimes you may wish to refer to the Active Directory Services documentation documentation. This is available from Microsoft at http://msdn.microsoft.com/activedirectory/.