Preface

The Sun™ Java System SAML v2 Plug-in for Federation Services User's Guide provides information and procedures concerning this initial release of the Sun Java System SAML v2 Plug-in for Federation Services. The User's Guide includes installation instructions, administrative procedures, developer material, technical notes, and use cases.

Who Should Use This Book

The Sun Java System SAML v2 Plug-in for Federation Services User's Guide is intended for use by IT professionals, network administrators and software developers who wish to implement Security Assertion Markup Language (SAML) version 2 features in their deployment of Sun Java System Access Manager or Sun Java System Federation Manager server software. It is recommended that administrators understand the following technologies:

Security Assertion Markup Language (SAML)
Liberty Alliance Project Specifications for Federation and Web Services
Java™ 2 Platform, Enterprise Edition (J2EE™ platform) web containers and corresponding deployment tools
JavaServer Pages™
HyperText Transfer Protocol (HTTP)
HyperText Markup Language (HTML)
eXtensible Markup Language (XML)
Web Services Description Language (WSDL)
SOAP

In addition, administrators should have a clear knowledge of the legal aspects of identity federation (including privacy laws) and corporate policies.

Before You Read This Book

The Sun Java System SAML v2 Plug-in for Federation Services can be installed on working instances of Sun Java System Access Manager and Sun Java System Federation Manager. Access Manager is a component of the Sun Java Enterprise System suite of products.

If installing the SAML v2 Plug-in for Federation Services on an instance of Federation Manager, you should be familiar with the Sun Java System Federation Manager documentation.
If installing the SAML v2 Plug-in for Federation Services on an instance of Access Manager, you should be familiar with the Sun Java System Access Manager documentation. Specifically, the Sun Java System Access Manager 7 2005Q4 Federation and SAML Administration Guide might be helpful.
Because the Sun Java System SAML v2 Plug-in for Federation Services contains features based on the SAML specifications, you should be familiar with the SAML specifications.
Because the Sun Java System SAML v2 Plug-in for Federation Services contains features based on the Liberty Alliance Project specifications, you should be familiar with the Liberty Alliance Project specifications.
Because Access Manager is part of the Sun Java Enterprise System suite, you should be familiar with the Sun Java Enterprise System documentation.

How This Book Is Organized

The Sun Java System SAML v2 Plug-in for Federation Services User's Guide contains instructional and conceptual material regarding the use of the Sun Java System SAML v2 Plug-in for Federation Services. The book is organized into the chapters described in the following table.

Table P–1 Chapters in the SAML v2 Plug-in for Federation Services User's Guide


Chapter	Description
Chapter 1, Introducing the SAML v2 Plug-in for Federation Services	An overview of the features of SAML v2 and the Sun Java System SAML v2 Plug-in for Federation Services.
Chapter 2, Installing the SAML v2 Plug-in for Federation Services	Contains the installation procedures for the SAML v2 Plug-in for Federation Services, the SAML v2 IDP Discovery Service, and related information.
Chapter 3, Administration	Contains information on how to set up and configure the SAML v2 Plug-in for Federation Services for SAML v2 communications.
Chapter 4, Configuring Specialized Interactions	Contains deployment information and use cases for the SAML v2 Plug-in for Federation Services.
Chapter 5, Developer Tools	Contains developer information for the SAML v2 Plug-in for Federation Services including how to install the software development kit, how to customize the JavaServer Pages, and how to implement the application programming interfaces and the service provider interfaces.
Appendix A, Deploying the SAML v2 Plug-in for Federation Services Generated WAR	Contains details on how to deploy a SAML v2 Plug-in for Federation Services generated WAR in the supported web containers.
Appendix B, Log Message Reference	Contains explanations of the messages written to the log files.

Related Books

The following titles are part of the documentation for the SAML v2 Plug-in for Federation Services. They can be found in the Sun Java System Access Manager 7 2005Q4 collection of manuals or the Sun Java System Federation Manager 7 2005Q4 collection of manuals on the Sun Microsystems documentation web site.

The Sun Java System SAML v2 Plug-in for Federation Services Release Notes will be available online after the product is released. It gathers an assortment of last-minute information, including features and enhancements, known limitations and issues, and technical notes.
The Sun Java System SAML v2 Plug-in for Federation Services User's Guide (this guide) is the core manual for the SAML v2 Plug-in for Federation Services. It includes instructions on how to install the SAML v2 Plug-in for Federation Services and information on how to use the features and manage the metadata. It also includes some basic deployment information in the form of use cases.
The Sun Java System SAML v2 Plug-in for Federation Services Java API Reference are generated from Java code using the JavaDoc tool. These HTML pages provide information on the implementation of the Java packages.

Contacting Sun Technical Support

If you have technical questions about this product that are not answered in the product documentation, contact Sun Support Services.

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.

Sun Welcomes Your Feedback

Sun Microsystems is interested in improving its documentation and welcomes your comments and suggestions. To share your thoughts, go to http://docs.sun.com and click the Send Comments link at the top of the page. In the online form provided, include 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 book or at the top of the document. For example, the title of this book is Sun Java System SAML v2 Plug-in for Federation Services User's Guide, and the part number is 819–5209.

Accessing Sun Documentation Online

The docs.sun.com^SM web site enables you to access Sun technical documentation online. You can browse the docs.sun.com archive or search for a specific book title or subject. The URL is http://docs.sun.com.

Ordering Sun Documentation

Sun Microsystems offers select product documentation in print. For a list of documents and how to order them, see “Buy printed documentation” at http://docs.sun.com.

Typographic Conventions

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

Table P–2 Typographic Conventions


Typeface	Meaning	Example
`AaBbCc123`	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.`
`AaBbCc123`	What you type, contrasted with onscreen computer output	`machine_name%` `su` `Password:`
`aabbcc123`	Placeholder: replace with a real name or value	The command to remove a file is `rm` `filename`.
AaBbCc123	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–3 Shell Prompts


Shell	Prompt
C shell	`machine_name%`
C shell for superuser	`machine_name#`
Bourne shell and Korn shell	`$`
Bourne shell and Korn shell for superuser	`#`

Additional Sun Resources

For product downloads, professional services, patches, support, and additional developer information, go to the following locations:

If you have technical questions about any Sun products, contact Sun Support and Services.