Preface

Sun Java^TM System Access Manager is a component of the Sun Java Enterprise System (Java ES), a set of software components that provide services needed to support enterprise applications distributed across a network or Internet environment. The Sun Java System Access Manager 7 2005Q4 C API Reference provides a listing of APIs you can use to enable C applications to access the Access Manager services. The reference includes function descriptions and syntax.

Revision History

The following table shows the Access Manager 7 2005Q4 Release Notes revision history.

Table P–1 Revision History


Date	Part Number	Description of Changes
January 2006	819-2140-11	Added note in section Summary of C Code Samples.
April 2006	819-2140-12	Added Chapter 10, Miscellaneous Functions.

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 Java System servers and software. Readers of this guide should be familiar with the following concepts and technologies:

Access Manager technical concepts as described in the Sun Java System Access Manager 7 2005Q4 Technical Overview
Deployment platform: Solaris^TM or Linux operating system
Web container that will run Access Manager: Sun Java System Application Server, Sun Java System Web Server, BEA WebLogic, or IBM WebSphere Application Server
Technical concepts: Lightweight Directory Access Protocol (LDAP), Java^TM technology, JavaServer Pages^TM (JSP) technology, HyperText Transfer Protocol (HTTP), HyperText Markup Language (HTML), and eXtensible Markup Language (XML)

Related Books

Related documentation is available as follows:

Access Manager Core Documentation

The Access Manager core documentation set contains the following titles:

The Sun Java System Access Manager 7 2005Q4 Release Notes will be available online after the product is released. It gathers 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.
The Sun Java System Access Manager 7 2005Q4 Technical Overview provides an overview of how Access Manager components work together to consolidate access control functions, and to protect enterprise assets and web-based applications. It also explains basic Access Manager concepts and terminology.
The Sun Java System Access Manager 7 2005Q4 Deployment Planning Guide provides planning and deployment solutions for Sun Java^TM System Access Manager based on the solution life cycle.
The Sun Java System Access Manager 7 2005Q4 Performance Tuning Guide provides information on how to tune Access Manager and its related components for optimal performance.
The Sun Java System Access Manager 7 2005Q4 Administration Guide describes how to use the Access Manager console as well as manage user and service data via the command line interface.
The Sun Java System Access Manager 7 2005Q4 Federation and SAML Administration Guide provides information about the Federation module based on the Liberty Alliance Project specifications. It includes information on the integrated services based on these specifications, instructions for enabling a Liberty-based environment, and summaries of the application programming interface (API) for extending the framework.
The Sun Java System Access Manager 7 2005Q4 Developer’s Guide offers information on how to customize Access Manager 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.
The Sun Java System Access Manager 7 2005Q4 Java API Reference (this guide) provides information about the implementation of Java packages in Access Manager.
The Sun Java System Access Manager Policy Agent 2.2 User’s Guide provides an overview of the policy functionality and the policy agents available for Access Manager.

Updates to the Sun Java System Access Manager 7 2005Q4 Release Notes and links to modifications of the core documentation can be found on the Access Manager page at the Sun Java Enterprise System documentation web site. Updated documents will be marked with a revision date.

Sun Java Enterprise System Product Documentation

Useful information can be found in the documentation for the following products:

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

Sun Function	URL	Description
Documentation	`http://www.sun.com/documentation/`	Download PDF and HTML documents, and order printed documents
Support and Training	`http://www.sun.com/training/`	Obtain technical support, download patches, and learn about Sun courses

Typographic Conventions

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

Table P–2 Typographic Conventions


Typeface or Symbol	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. Perform a patch analysis. Do not save the file. [Note that some emphasized items appear bold online.]

Shell Prompts in Command Examples

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

Table P–3 Shell Prompts


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

Sun Welcomes Your Comments

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

To share your comments, go to http://docs.sun.com 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 book or at the top of the document.

For example, the title of this book is Sun Java System Access Manager 7 2005Q4 C API Reference, and the part number is 819-2140–10.