Sun OpenSSO Enterprise 8.0 Integration Guide


The SunTM OpenSSO Enterprise Integration Guide provides information to help you determine which OpenSSO Enterprise to use in your deployment. This guide contains deployment architecture diagrams, process flow diagrams, and benefits/tradeoffs analysis for various OpenSSO Enterprise features.

The following topics are contained in this Preface:

Who Should Use This Guide

Before You Read This Guide

Readers should be familiar with the following components and concepts:

Related Documentation

Related documentation is available as follows:

OpenSSO Enterprise Documentation Set

The following table describes the OpenSSO Enterprise documentation set.

Table P–1 OpenSSO Enterprise Documentation Set



Sun OpenSSO Enterprise 8.0 Release Notes

Describes new features, installation notes, and known issues and limitations. The Release Notes are updated periodically after the initial release to describe any new features, patches, or problems. 

Sun OpenSSO Enterprise 8.0 Installation and Configuration Guide

Provides information about installing and configuring OpenSSO Enterprise including OpenSSO Enterprise server, Administration Console only, client SDK, scripts and utilities, Distributed Authentication UI server, and session failover. 

Sun OpenSSO Enterprise 8.0 Technical Overview

Provides an overview of how components work together to consolidate access control functions, and to protect enterprise assets and web-based applications. It also explains basic concepts and terminology. 

Sun OpenSSO Enterprise 8.0 Deployment Planning Guide

Provides planning and deployment solutions for OpenSSO Enterprise. 

Deployment Example: Single Sign-On, Load Balancing and Failover Using Sun OpenSSO Enterprise 8.0

Provides step-by-step instructions for deploying OpenSSO Enterprise in a single sign-on environment using load balancers and redundant systems for high availability. 

Deployment Example: SAML v2 Using Sun OpenSSO Enterprise 8.0

Provides step-by-step instructions for deploying OpenSSO Enterprise to achieve identity federation among an Identity Provider and multiple Service Providers. 

Sun OpenSSO Enterprise 8.0 Administration Guide

Describes how to use the OpenSSO Enterprise Administration Console as well as how to manage user and service data using the command-line interface (CLI). 

Sun OpenSSO Enterprise 8.0 Administration Reference

Provides reference information for the OpenSSO Enterprise command-line interface (CLI), configuration attributes, log files, and error codes. 

Sun OpenSSO Enterprise 8.0 Developer’s Guide

Provides information about customizing OpenSSO Enterprise and integrating its functionality into an organization’s current technical infrastructure. It also provides details about the programmatic aspects of the product and its API. 

Sun OpenSSO Enterprise 8.0 C API Reference for Application and Web Policy Agent Developers

Provides summaries of data types, structures, and functions that make up the public OpenSSO Enterprise C APIs. 

Sun OpenSSO Enterprise 8.0 Java API Reference

Provides information about the implementation of Java packages in OpenSSO Enterprise. 

Sun OpenSSO Enterprise 8.0 Performance Tuning Guide

Provides information about how to tune OpenSSO Enterprise and its related components for optimal performance. 

Sun OpenSSO Enterprise 8.0 Integration Guide (This book)

(This book) Provides information about how to integrate Sun Identity Manager, CA SiteMinder, or Oracle Access Manager with OpenSSO Enterprise.  

Sun OpenSSO Enterprise Policy Agent 3.0 User’s Guide for J2EE Agents

Provides an overview of version 3.0 policy agents. 

Related Product Documentation

The following table provides links to documentation collections for related products.

Table P–2 Related Product Documentation



Sun Java System Directory Server 6.3

Sun Java System Web Server 7.0 Update 3

Sun Java System Application Server 9.1

Sun Java System Message Queue 4.1

Sun Java System Web Proxy Server 4.0.6

Sun Identity Manager 8.0

Searching Sun Product Documentation

Besides searching Sun product documentation from the docs.sun.comSM web site, you can use a search engine by typing the following syntax in the search field:


For example, to search for “broker,” type the following:


To include other Sun web sites in your search (for example,,, and, use in place of in the search field.

Related Third-Party Web Site References

Third-party URLs are referenced in this document and provide additional, related information.

Note –

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 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 such sites or resources.

Documentation, Support, and Training

The Sun web site provides information about the following additional resources:

Typographic Conventions

The following table describes the typographic conventions that are used in this book.

Table P–3 Typographic Conventions





The names of commands, files, and directories, and onscreen computer output 

Edit your .login file.

Use ls -a to list all files.

machine_name% you have mail.


What you type, contrasted with onscreen computer output 

machine_name% su



Placeholder: replace with a real name or value 

The command to remove a file is rm filename.


Book titles, new terms, and terms to be emphasized 

Read Chapter 6 in the User's Guide.

A cache is a copy that is stored locally.

Do not save the file.

Note: Some emphasized items appear bold online.

Shell Prompts in Command Examples

The following table shows the default UNIX® system prompt and superuser prompt for the C shell, Bourne shell, and Korn shell.

Table P–4 Shell Prompts



C shell 


C shell for superuser 


Bourne shell and Korn shell 


Bourne shell and Korn shell for superuser 


Default Paths and Directory Names

The OpenSSO Enterprise documentation uses the following terms to represent default paths and directory names:

Table P–5 Default Paths and Directory Names




Represents the directory where the file is unzipped.


Represents the deployment directory where the web container deploys the opensso.war file.

This value varies depending on the web container. To determine the value of OpenSSO-Deploy-base, view the file name in the .openssocfg directory, which resides in the home directory of the user who deployed the opensso.war file. For example, consider this scenario with Application Server 9.1 as the web container:

  • Application Server 9.1 is installed in the default directory: /opt/SUNWappserver.

  • The opensso.war file is deployed by super user (root) on Application Server 9.1.

The .openssocfg directory is in the root home directory (/), and the file name in .openssocfg is:


Then, the value for OpenSSO-Deploy-base is:



Represents the name of the configuration directory specified during the initial configuration of OpenSSO Enterprise server instance using the Configurator. 

The default is opensso in the home directory of the user running the Configurator. Thus, if the Configurator is run by root, ConfigurationDirectory is /opensso.

Sun Welcomes Your Comments

Sun is interested in improving its documentation and welcomes your comments and suggestions.

To share your comments, go to and click Send comments. In the online form, provide the document title and part number. The part number is a seven-digit or nine-digit number that can be found on the title page of the guide or at the top of the document.

For example, the title of this guide is the Sun OpenSSO Enterprise Integration Guide, and the part number is 820-4729.