Sun Java logo     Previous      Contents      Index      Next     

Sun logo
Sun ONE Directory Server Resource Kit 5.2 Tools Reference 

About This Guide

The Sun™ ONE Directory Server Resource Kit Tools Reference covers the installation of the Sun ONE Directory Server Resource Kit (DSRK) and details information about its command-line tools and included Lightweight Directory Access Protocol (LDAP) application programming interfaces (API). This preface contains the following sections:

Audience for This Guide

This Tools Reference is intended for use by IT administrators and software developers who implement a centralized and distributed LDAP data repository for use in an intranet, an extranet for communication with your business partners, or over the public Internet to reach your customers. The DSRK is a set of tools for testing and maintaining LDAP directory servers. Therefore, they should understand how to administer the directory server and its contents. This includes basic directory architectural concepts needed to successfully design and deploy a directory service. It is also recommended that administrators understand the following technologies:

In addition, they should be familiar with Sun ONE 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.


This reference guide documents only the tools of the DSRK. It is not intended to be a deployment, testing, or maintenance guide for your directory installation. You should be aware of the following characteristics of your directory when using these tools:

  • Size and number of entries.
  • Directory structure and access permissions.
  • Virtual attributes, class of service, and indexing.
  • Usage, types of access, and access patterns.

Please refer to the Sun ONE Directory Server Deployment Guide for information on how to determine the influence of these factors and take them into consideration.

Directory Server Resource Kit Documentation Set

The DSRK documentation set contains three manuals:

Tools Reference

The Tools Reference explains how to use each of the DSRK tools by detailing its command-line syntax, listing all options, their functionality, and all return values (where applicable), and providing examples of usage.

Sun ONE LDAP SDK for C Programming Guide

The Sun ONE LDAP SDK for C Programming Guide documents the Sun ONE LDAP software development kit (SDK) for C. The SDK includes C libraries which are used for writing LDAP client applications. The applications can be used to connect to, search, and update LDAP servers located on a network or on the Internet.

Sun ONE LDAP SDK for Java Programming Guide

The Sun ONE LDAP SDK for Java Programming Guide documents the Sun ONE LDAP SDK for Java. The SDK includes the interfaces, classes, and methods used to interact and communicate with LDAP servers. Also available are the Java API specifications or Javadocs.

Documentation Conventions Used in This Guide

In the Directory Server Resource Kit documentation, certain typographical conventions and terminology are used. These conventions are described in the following sections.

Typographical Conventions

This book uses the following typographical conventions:


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

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 ONE Directory Server. The following documentation is referenced throughout this guide:

A listing of the full set of documentation can be found at:

Sources of Information

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

Table 0-1  Additional Sources of Information 



Sun ONE Download Center

Sun ONE Technical Support

Sun ONE Professional Services Information

Sun Enterprise Services, Solaris Patches and Support

JavaServer Pages

The Source for Developers

Sun Training and Certification

Third-Party Sources of Information

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


Sun is not responsible for the availability of third-party Web sites mentioned in this document. Sun does not endorse and is not responsible or liable for any content, advertising, products, or other material on or available from such sites or resources. Sun will not be responsible or liable for any damage or loss caused or alleged to be caused by or in connection with 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

The Sun ONE LDAP SDK for Java and Sun ONE LDAP SDK for C 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:

Perl Development

Many of the tools in the DSRK are Perl scripts that rely on a Perl interpreter. Information about the Perl language and other Perl resources is available at:

Tomcat Web Server

The new web-based gateway demonstrated in the sample phonebook application relies on the Tomcat application of the Jakarta project from the Apache Software Foundation:


This product includes software developed by the Apache Software Foundation (

This product also includes software developed through Mozilla (

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 Tools Reference is 816-6400-10.

Previous      Contents      Index      Next     

Copyright 2004 Sun Microsystems, Inc. All rights reserved.