Sun OpenSSO Enterprise 8.0 Developer's Guide


Sun OpenSSO Enterprise 8.0 provides a comprehensive solution for protecting network resources that integrates authentication and authorization services, policy agents, and identity federation. This Preface to the OpenSSO Enterprise 8.0 Developer's Guide provides information about using the OpenSSO Enterprise Java application programming interfaces (API) and service provider interfaces (SPI).

Note –

For information about using the C API see Sun OpenSSO Enterprise 8.0 C API Reference for Application and Web Policy Agent Developers. Additional information on the Java interfaces can be found in the Sun OpenSSO Enterprise 8.0 Java API Reference.

Before You Read This Book

This book is intended for use by IT administrators and software developers who implement a web access platform using Sun servers and software. Readers of this guide should be familiar with the following technologies:

Related Documentation

Related documentation is available as follows:

OpenSSO Enterprise 8.0 Core Documentation

The OpenSSO Enterprise 8.0 core documentation set contains the following titles:

Updates to the Release Notes and links to modifications of the core documentation can be found on the OpenSSO Enterprise page at Updated documents will be marked with a revision date.

Related Product Documentation

The following table provides links to documentation for related products.



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 Java System 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.

Documentation, Support, and Training

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

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.

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 full document title and part number. The part number is a 7-digit or 9-digit number that can be found on the book's title page or in the document's URL. For example, the title of this book is Sun OpenSSO Enterprise 8.0 Technical Overview, and the part number is 820–3740.

Typographical Conventions

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

Table P–1 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.

Default Paths and Directory Names

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

Table P–2 Default Paths and Directory Names




Represents the directory where the file is decompressed.


Represents the directory where the web container deploys opensso.war. The location varies depending on the web container used. To determine the value of OpenSSO-Deploy-base, view the file in the .openssocfg directory (located in the home directory of the user who deployed opensso.war). 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 AMConfig_opt_SUNWappserver_domains_domain1_applications_j2ee-modules_opensso_. Thus, the value for OpenSSO-Deploy-base is:



Represents the name of the directory specified during the initial configuration of OpenSSO Enterprise. 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.