About This Guide


This Programmer's Guide offers information on how to customize the iPlanet™ Directory Server Access Management Edition (DSAME) to fit the needs of each organization. This preface contains the following sections:

• What You Are Expected to Know

• iPlanet Directory Server Access Management Edition Documentation Set

• Organization of This Guide

• Documentation Conventions Used in This Guide

• Related Information

  
  

  ---

  Note

  Sun™ One Identity Server was previously known as iPlanet Directory Server Access Management Edition (DSAME). The product was renamed shortly before the launch of the product. The late renaming of this product has resulted in a situation where the new product name is not fully integrated into the shipping product. In particular, you will see the product referenced as DSAME within the product GUI and within the product documentation. For this release, please consider Sun One Identity Server and iPlanet Directory Server Access Management Edition as interchangeable names for the same product.

  ---

  
  

What You Are Expected to Know

---

This book is considered the "third" manual in the documentation series provided with iPlanet Directory Server Access Management Edition. It is intended for use by IT administrators and custom software developers who manage access to their web resources through iPlanet servers and software. The functionality allows the management of user data and enforcement of access policies. It is recommended that IS administrators understand directory server technologies, including Lightweight Directory Access Protocol (LDAP), and have some experience with Java and eXtensible Markup Language (XML). Particularly, they should be familiar with Sun™ One Directory Server (DS) and the documentation provided with that product.

iPlanet Directory Server Access Management Edition Documentation Set

---

The Directory Server Access Management Edition documentation set contains the following titles:

• Installation and Configuration Guide describes iPlanet DSAME and provides details on how to plan and install the iPlanet DSAME on Solaris systems.

• Administration Guide documents how to manage user and service data and customize the DSAME console.

• Programmer's Guide (this guide) documents how to customize an iPlanet Directory Server Access Management Edition system for your organization.

• The Release Notes file gathers an assortment of information, including a description of what is new in this release, last minute installation notes, known problems and limitations, and how to report problems.

  
  

  ---

  Note	Be sure to check the Directory Server Access Management Edition documentation web site for updates to the release notes and for revisions to the guides. Updated documents will be marked with the revision date. http://docs.iplanet.com /docs/manuals/dsame.html

  ---

  
  

Organization of This Guide

---

The Programmer's Guide (this guide) has nine chapters. The table below lists and briefly describes the content of these chapters.

Table 1    Programmer's Guide Chapters 

Chapter	Description
About This Guide	An outline of the documentation set and a description of the iPlanet Directory Server Access Management Edition Programmer's Guide.
Chapter 1 "Introduction"	A brief explanation of the application's concepts.
Chapter 2 "DSAME And XML"	A description of how XML is used to customize the application.
Chapter 3 "User Authentication With DSAME"	A description of the Authentication module and how to create a custom authentication service.
Chapter 4 "Identity Management And The SDK"	A description of the management of identity-related objects and the DSAME SDK.
Chapter 5 "Single Sign-On With DSAME"	A description of the single sign-on and cross-domain single sign-on function and its APIs.
Chapter 6 "Logging"	A description of the Logging function and its APIs.
Chapter 7 "Utility APIs"	A description of the application's utility functions and its APIs.
Chapter 8 "iPlanet Directory Server And DSAME"	A description of the iPlanet Directory Server concepts that are used in DSAME.
Index	Alphabetical index of the iPlanet Directory Server Access Management Edition Programmer's Guide.

Documentation Conventions Used in This Guide

---

In the iPlanet Directory Server Access Management Edition documentation, there are certain typographic and terminology conventions used to simplify discussion and to help you better understand the material. These conventions are described below.

Typographic Conventions

This book uses the following typographic 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 the general terms that are used in the iPlanet Directory Server Access Management Edition documentation set:

• DSAME refers to iPlanet Directory Server Access Management Edition and any installed instances of the iPlanet Directory Server Access Management Edition software.

• Policy and Management Services refers to the collective set of iPlanet Directory Server Access Management Edition components and software you have installed and running on a dedicated Web Server.

• Web Server that runs DSAME refers to the dedicated Web Server where the DSAME is installed.

• Directory Server refers to an installed instance of iPlanet Directory Server or Netscape™ Directory Server.

• DSAME_root is a variable placeholder for the home directory where you have installed iPlanet Directory Server Access Management Edition.

• Directory_Server_root is a variable placeholder for the home directory where you have installed iPlanet Directory Server.

• Web_Server_root is a variable placeholder for the home directory where you have installed iPlanet Web Server.

Related Information

---

In addition to the documentation provided with iPlanet Directory Server Access Management Edition, you should be familiar with several other sets of documentation. Of particular interest are the iPlanet Directory Server, iPlanet Web Server, iPlanet Proxy Server, and iPlanet Certificate Management System documentation sets. This sections lists additional sources of information that can be used with iPlanet Directory Server Access Management Edition.

iPlanet Directory Server Documentation
You can find the iPlanet Directory Server documentation at the following site:

http://docs.iplanet.com/docs/manuals/directory.html

iPlanet Web Server Documentation
You can find the iPlanet Web Server documentation at the following site:

http://docs.iplanet.com/docs/manuals/enterprise.html

iPlanet Certificate Management System Documentation
You can find the iPlanet Certificate Management System documentation at the following site:

http://docs.iplanet.com/docs/manuals/cms.html

iPlanet Proxy Server Documentation
You can find the iPlanet Proxy Server documentation at the following site:

http://docs.iplanet.com/docs/manuals/proxy.html

Directory Server Developer Information
In addition to the Directory Server documentation, you can find information on Directory Server Access Management Edition, LDAP, the iPlanet Directory Server, and associated technologies at the following iPlanet developer sites:

http://developer.iplanet.com/tech/directory/

http://www.iplanet.com/downloads/developer/

Other iPlanet Product Documentation
Documentation for all iPlanet and Netscape servers and technologies can be found at the following web site:

http://docs.iplanet.com/docs/manuals/

iPlanet Technical Support
You can contact iPlanet Technical Support through the following location:

http://www.iplanet.com/support/