|
| Sun ONE Directory Server 5.2 Plug-In API Reference |
About This GuideSun™ ONE Directory Server 5.2 is a powerful and scalable distributed directory server based on the industry-standard Lightweight Directory Access Protocol (LDAP). Sun ONE Directory Server software is part of the Sun Open Net Environment (Sun ONE), Sun's standards-based software vision, architecture, platform, and expertise for building and deploying Services On Demand.
Sun ONE Directory Server is the cornerstone for building a centralized and distributed data repository that can be used in your intranet, over your extranet with your trading partners, or over the public Internet to reach your customers.
Purpose of This Guide
This reference covers the data types and structures, functions and parameter block data that make up the public Sun ONE Directory Server plug-in API. Refer to it as you develop server plug-ins to extend Sun ONE Directory Server functionality.
Prerequisites
To make the most of this document, you must already be familiar with LDAP and with programming in the C language.
You should also have a clear understanding of the server extensions to develop, preferably including appropriate specifications.
For directory client programming, download the Sun ONE Directory Server Resource Kit. Refer to "Downloading Directory Server Tools" for instructions.
Typographical Conventions
This section explains the typographical conventions used in this book.
Monospaced font - This typeface is used for literal text, such as the names of attributes and object classes when they appear in text. It is also used for URLs, filenames, and examples.
Italic font - This typeface is used for emphasis, for new terms, and for text that you must substitute for actual values, such as placeholders in path names.
The greater-than symbol (>) is used as a separator when naming an item in a menu or sub-menu. For example, Object > New > User means that you should select the User item in the New sub-menu of the Object menu.
Note Notes, Cautions, and Tips highlight important conditions or limitations. Be sure to read this information before continuing.
Default Paths and Filenames
All path and filename examples in the Sun ONE Directory Server product documentation are one of the following two forms:
- ServerRoot/... - The ServerRoot is the location of the Sun ONE Directory Server product. This path contains the shared binary files of Directory Server, Sun ONE Administration Server, and command line tools.
The actual ServerRoot path depends on your platform, your installation, and your configuration. The default path depends on the product platform and packaging as shown in Table 1.
- ServerRoot/slapd-serverID/... - The serverID is the name of the Directory Server instance that you defined during installation or configuration. This path contains database and configuration files that are specific to the given instance.
Table 1 Default ServerRoot Paths
Product Version
ServerRoot Path
Solaris Packages1
/var/mps/serverroot - After configuration, this directory contains links to the following locations:
Compressed Archive Installation on Solaris and Other UNIX Systems
/var/Sun/mps
Zip Installation on Windows Systems
C:\Program Files\Sun\MPS
Directory Server instances are located under ServerRoot/slapd-serverID/, where serverID represents the server identifier given to the instance on creation. For example, if you gave the name dirserv to your Directory Server, then the actual path would appear as shown in Table 2. If you have created a Directory Server instance in a different location, adapt the path accordingly.
Downloading Directory Server Tools
Some supported platforms provide native tools for accessing Directory Server. More tools for testing and maintaining LDAP directory servers, download the Sun ONE Directory Server Resource Kit (DSRK). This software is available at the following location:
Installation instructions and reference documentation for the DSRK tools is available in the Sun ONE Directory Server Resource Kit Tools Reference.
For developing directory client applications, you may also download the iPlanet Directory SDK for C and the iPlanet Directory SDK for Java from the same location.
Additionally, Java Naming and Directory Interface (JNDI) technology supports accessing the Directory Server using LDAP and DSML v2 from Java applications. Information about JNDI is available from:
The JNDI Tutorial contains detailed descriptions and examples of how to use JNDI. It is available at:
Suggested Reading
Sun ONE Directory Server product documentation includes the following documents delivered in both HTML and PDF:
- Sun ONE Directory Server Getting Started Guide - Provides a quick look at many key features of Directory Server 5.2.
- Sun ONE Directory Server Deployment Guide - Explains how to plan directory topology, data structure, security, and monitoring, and discusses example deployments.
- Sun ONE Directory Server Installation and Tuning Guide - Covers installation and upgrade procedures, and provides tips for optimizing Directory Server performance.
- Sun ONE Directory Server Administration Guide - Gives the procedures for using the console and command-line to manage your directory contents and configure every feature of Directory Server.
- Sun ONE Directory Server Reference Manual - Details the Directory Server configuration parameters, commands, files, error messages, and schema.
- Sun ONE Directory Server Plug-In API Programming Guide - Demonstrates how to develop Directory Server plug-ins.
- Sun ONE Directory Server Plug-In API Reference - Details the data structures and functions of the Directory Server plug-in API.
- Sun ONE Server Console Server Management Guide - Discusses how to manage servers using the Sun ONE Administration Server and Java based console.
- Sun ONE Directory Server Resource Kit Tools Reference - Covers installation and features of the Sun ONE Directory Server Resource Kit, including many useful tools.
Other useful information can be found on the following Web sites:
- Product documentation online: http://docs.sun.com/coll/S1_DirectoryServer_52
- Sun software: http://wwws.sun.com/software/
- Sun ONE Services: http://www.sun.com/service/sunps/sunone/
- Sun Support Services: http://www.sun.com/service/support/
- Sun ONE for Developers: http://sunonedev.sun.com/
- Training: http://suned.sun.com/