Preface

The Sun™ Java System Directory Server Resource Kit LDAP SDK for C Programming Guide documents the Sun Java System LDAP SDK for C, a software development kit (SDK) for writing Lightweight Directory Access Protocol (LDAP) client applications. This preface contains the following sections:

Audience for This Guide

This LDAP SDK for C Programming Guide is intended for use by C and C++ programmers who want to enable new or existing client applications to connect to, search or update databases that are managed by LDAP servers located on a network or the Internet. This book assumes that you are a programmer familiar with writing and compiling C applications on the platform(s) for which you want to implement this functionality. It is also recommended that programmers attempting this implementation understand the LDAP Data Interchange Format (LDIF).

In addition, programmers should be familiar with Sun Java System Directory Server, Sun Microsystems’ LDAP data repository, and the command-line syntax for the particular shell and platform on which the server is installed. The books and guides described in "Related Sources of Information" provide a good introduction to this information.

Directory Server Resource Kit Documentation Set

Tools Reference

The Tools Reference explains how to use each of the tools shipped with the DSRK. The book details their command-line syntax, listing all options, functionality, and return values (where applicable), as well as providing examples of usage.

LDAP SDK for C Programming Guide

The LDAP SDK for C Programming Guide (this guide) documents the LDAP SDK for C by explaining how to use it to enable applications to interact with LDAP servers. It offers a references to the LDAP API, which consists of data structures and functions. This manual is divided into four parts:

Part 1, "Getting Started" explains how you can use the LDAP SDK for C to enable your applications for LDAP.

Part 2, "Working with the LDAP SDK for C" explains how you can use the LDAP SDK for C to enable your applications for LDAP communications.

Part 3, "Advanced Topics" contains additional material including descriptions of entries and attributes.

Part 4, "Reference Guide" describes each data structure, function, and status code in the LDAP API.

LDAP SDK for Java Programming Guide

The LDAP SDK for Java Programming Guide documents the LDAP SDK for Java. It includes descriptions of, and reference material for, the interfaces, classes, and methods used to enable Java applications with the functionality to interact and communicate with LDAP servers. Also available are the Java API specifications or Javadocs.

Documentation Conventions Used in This Guide

In the DSRK documentation, certain typographical conventions and terminology are used. These are described in the following sections.

Typographical Conventions

Italic type is used within text for book titles, new terminology, emphasis, and words used in the literal sense.

Monospace font is used for sample code and code listings, API and language elements (such as function names and class names), filenames, pathnames, directory names, HTML tags, and any text that must be typed on the screen.

Italic serif font is used within code and code fragments to indicate variable placeholders. For example, the following command uses filename as a variable placeholder for an argument to the gunzip command:

gunzip -d filename.tar.gz



Note	Notes, Cautions and Tips highlight important conditions or limitations. Be sure to read this information before continuing.

Terminology

Below is a list of general terms used in the Directory Server Resource Kit documentation set:

DSRK refers to the installed Directory Server Resource Kit software.

Directory Server refers to an installed instance of Sun Java System Directory Server.

DSRK_base is a variable place holder for the home directory where the Directory Server Resource Kit is installed.

DirectoryServer_base is a variable place holder for the home directory where Sun Java System Directory Server is installed.

Related Sources of Information

In addition to the documentation provided with Directory Server Resource Kit, there are several other sources of information that might be helpful.

Directory Server Documentation

The tools in the DSRK interact with Sun Java System Directory Server. The following documentation is referenced throughout this guide:

Sources of Information

Sun Microsystems has other helpful sources of information. Table 0-1 lists these sources.

Table 0-1 Additional Sources of Information
Source	Location
Sun Java System Download Center	http://wwws.sun.com/software/download/
Sun Java System Technical Support	http://www.sun.com/service/sunone/software/index.html
Sun Java System Professional Services Information	http://www.sun.com/service/sunps/sunone/index.html
Sun Enterprise Services, Solaris Patches and Support	http://sunsolve.sun.com/
JavaServer Pages	http://java.sun.com/products/jsp/
The Source for Developers	http://developers.sun.com/
Sun Training and Certification	http://suned.sun.com/

Third-Party Sources of Information

The following sections list sources of information found on sites that are not under the auspices of Sun Microsystems.



Note	Sun is not responsible for the availability of third-party Web sites mentioned in this document. Sun does not endorse nor is responsible or liable for any content, advertising, products, or other material available from such sites or resources. Sun will not be responsible or liable for any damage or loss caused by, alleged to be caused by, or in connection with, the use of or reliance on any such content, goods, or services that are available on or through any such sites or resources.

The Mozilla Project

SDKs for accessing LDAP in C and Java are also released through the Mozilla™ open source project. Instructions on obtaining the source code and contributing to the development of these API is available at:

LDAP and Associated Information

There are many sources of information detailing LDAP and its associated technologies.


Note	Note that some of the links provided are time-sensitve with drafts that might expire.

The Internet Engineering Task Force

http://www.ietf.org/

The C LDAP Application Program Interface Internet-Draft

http://www.mozilla.org/directory/ietf-docs/draft-ietf-ldapext-ldap-c-api-05.t xt

LDAP Control Extension for Server Side Sorting of Search Results, RFC 2891

http://www.faqs.org/rfcs/rfc2891.html

Simple Authentication and Security Layer (SASL)

http://www.faqs.org/rfcs/rfc2222.html

Secure Sockets Layer (SSL) Protocol (v3), Internet-Draft Revision 3

http://wp.netscape.com/eng/ssl3/

Netscape Portable Runtime Library

http://www.mozilla.org/projects/nspr

Acknowledgements

Documentation Feedback

Sun is interested in improving its documentation and welcomes your comments and suggestions. Use this web-based form to provide feedback to Sun:

Please provide the full document title and part number in the appropriate fields. The part number can be found on the title page of the book or at the top of the document, and is usually a seven or nine digit number. For example, the part number of this Directory Server Resource Kit 5.2.1 LDAP SDK for C Programming Guide is 817-6707-05.