|
| |
| 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 GuideThis 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.
Note
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:
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 SetThe 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.
- Part 1, "Getting Started"provides an introduction to the tools and installation instructions for the product.
- Part 2, "Directory Access Tools" contains information on tools for accessing a LDAP directory. Use these commands to retrieve entries, view their attributes, and make modifications.
- Part 3, "Performance Tools" explains the tools that help you run tests to measure your server’s average response time. These tools perform repeated LDAP authentication, search, add, and delete operations to simulate actual usage.
- Part 4, "LDAP v3 Tools" explains the tools that are specific to directory server’s whose schema format is based on version 3 of the LDAP protocol (LDAPv3). These tool measure the performance of add, modify and search operations, and rate of authentication.
- Part 5, "LDIF Deployment Tools"describes the tools that process large LDIF (LDAP Data Interchange Format) files, either generating, modifying, or comparing the LDAP entries and attribute values they contain.
- Part 6, "Maintenance and Debugging Tools" illustrates the maintenance and debugging tools that help directory administrators to interpret logs and other trouble-shooting files.
- Part 7, "Sample Phonebook Application,"documents a sample application that uses servlets to provide a web interface to access a directory server.
- Part 8, "Additional Tools and Information," contains the documentation for an unsupported plug-in module for Sun ONE Directory Server 5.2.
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 GuideIn 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:
- 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
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 ONE Directory Server.
- DSRK_base is a variable place holder for the home directory where Directory Server Resource Kit is installed.
- DirectoryServer_base is a variable place holder for the home directory where Sun ONE Directory Server is installed.
Related Sources of InformationIn 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:
http://docs.sun.com/coll/S1_DirectoryServer_52
Sources of Information
Sun Microsystems has other helpful sources of information. Table 0-1 lists these sources.
Third-Party Sources of Information
The following sections list sources of information found on sites that are not under the auspices of Sun Microsystems.
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:
http://www.mozilla.org/directory
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:
- The Perl Directory: http://www.perl.org
- Comprehensive Perl Archive Network: http://www.cpan.org/
- Perl documentation: http://www.perldoc.com/
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:
http://jakarta.apache.org/tomcat/tomcat-4.0-doc/index.html
AcknowledgementsThis product includes software developed by the Apache Software Foundation (http://www.apache.org/).
This product also includes software developed through Mozilla (http://www.mozilla.org/).
Documentation FeedbackSun is interested in improving its documentation and welcomes your comments and suggestions. Use this web-based form to provide feedback to Sun:
http://www.sun.com/hwdocs/feedback/
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.