Sun ONE Identity Server Customization and API Guide |
About This Guide
The Sun ONE Identity Server Customization and API Guide offers information on how to customize Sun ONE Identity Server and integrate its functionality into an organization’s current technical infrastructure. It also contains details about the programmatic aspects of the product and its API. This preface contains the following sections:
Audience for This GuideThis Customization and API Guide is intended for use by IT administrators and software developers who implement an integrated identity management and web access platform using Sun ONE servers and software. It is recommended that administrators understand the following technologies:
Because Sun ONE Directory Server is used as the data store in an Identity Server deployment, administrators should also be familiar with the documentation provided with that product. The latest Directory Server documentation can be accessed online.
Identity Server 6.1 Documentation SetThe Identity Server documentation set is separated into two core sets of manuals: the Sun ONE Identity Server 6.1 core application manuals and the Sun ONE Identity Server Policy Agents books.
Identity Server Core Documentation
The Identity Server documentation set contains the following titles:
- Product Brief provides an overview of the Identity Server application and its features and functions.
- Migration Guide provides details on how to migrate existing data and Sun ONE product deployments to the latest version of Identity Server. For instructions on installing Identity Server, see the Sun Java Enterprise System 2003Q4 Installation Guide.
- Administration Guide describes how to use the Identity Server console as well as manage user and service data via the command line.
- Customization and API Guide documents how to customize an Identity Server installation. It also includes instructions on how to augment the application with new services using the public APIs.
- Deployment Guide provides information on planning an Identity Server deployment within an existing information technology infrastructure.
- The Release Notes will be available online after the product is released. They gather an assortment of last-minute information, including a description of what is new in this current release, known problems and limitations, installation notes, and how to report issues with the software or the documentation.
Updates to the Release Notes and links to modifications of the core documentation can be found on the Identity Server page at the Sun ONE documentation web site. Updated documents will be marked with a revision date.
Identity Server Policy Agent Documentation Set
Policy agents for Identity Server are available on a different schedule than the server product itself. Therefore, the documentation set for the policy agents is available outside the core set of Identity Server documentation. The following titles are included in the set:
- Web Policy Agents Guide documents how to install and configure an Identity Server policy agent on various web and proxy servers. It also includes troubleshooting and information specific to each agent.
- J2EE Policy Agents Guide documents how to install and configure an Identity Server policy agent that can protect a variety of hosted J2EE applications. It also includes troubleshooting and information specific to each agent.
- The Release Notes will be available online after the set of agents is released. There is generally one Release Notes file for each agent type release. The Release Notes gather an assortment of last-minute information, including a description of what is new in this current release, known problems and limitations, installation notes, and how to report issues with the software or the documentation.
Updates to the Release Notes and modifications to the policy agent documentation can be found on the Policy Agents page at the Sun ONE documentation web site. Updated documents will be marked with a revision date.
Your Feedback on the Documentation
Sun Microsystems and the Identity Server technical writers are interested in improving the documentation and welcome any comments and suggestions. Please email these comments to docfeedback@sun.com.
Documentation Conventions Used in This GuideIn the Identity Server documentation, certain typographic conventions and terminology are used. These conventions are described in the following sections.
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 general terms used in the Identity Server documentation set:
- Identity Server refers to Identity Server and any installed instances of the Identity Server software.
- Policy and Management services refers to the collective set of Identity Server components and software that are installed and running on a dedicated deployment container such as a web server.
- Directory Server refers to an installed instance of Sun ONE Directory Server.
- Application Server refers to an installed instance of Sun ONE Application Server.
- Web Server refers to an installed instance of Sun ONE Web Server.
- IdentityServer_base is a variable place holder for the home directory where you have installed Identity Server.
- DirectoryServer_base is a variable place holder for the home directory where you have installed Sun ONE Directory Server.
- ApplicationServer_base is a variable place holder for the home directory where you have installed Sun ONE Application Server.
- WebServer_base is a variable place holder for the home directory where you have installed Sun ONE Web Server.
- Web container that runs Identity Server refers to the dedicated J2EE container (such as Web Server or Application Server) where the Policy and Management Services are installed.
Related InformationIn addition to the documentation provided with Identity Server, there are several other sets of documentation that might be helpful. Table 0-1 lists these and additional sources of information.
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 materials that are available on or through such sites or resources. Sun will not be responsible or liable for any actual or alleged damage or loss caused by or in connection with the use of or reliance on any such content, goods, or services that are available on or through such sites or resources.