The Sun Java™ System Access Manager 7.1 2006Q4 C API Reference provides a listing of application programming interfaces (APIs) you can use to enable C applications to access the Sun Java System Access Manager components. The C API Reference includes function descriptions and syntax.
The C API Reference is intended for use by IT professionals, network administrators and software developers who implement a network access platform using Sun Java System servers and software. It is recommended that readers of this guide are familiar with the following technologies:
Lightweight Directory Access Protocol (LDAP)
Java™
JavaServer Pages™ (JSP)
HyperText Transfer Protocol (HTTP)
HyperText Markup Language (HTML)
eXtensible Markup Language (XML)
Web Services Description Language (WSDL)
Security Assertion Markup Language (SAML)
SOAP (SOAP is no longer an acronym.)
SolarisTM Operating System or Linux Application Environment (dependent on deployment platform)
Web container in which Access Manager will run: Sun Java System Application Server, Sun Java System Web Server, BEA WebLogic, or IBM WebSphere Application Server
Access Manager is a component of the Sun Java Enterprise System (Java ES), a software infrastructure that supports enterprise applications distributed across a network or Internet environment. Related documentation is available as follows:
The Access Manager core documentation set contains the following titles:
The Sun Java System Access Manager 7.1 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.1 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.1 Postinstallation Guide provides information about specific configurations for Access Manager after installation.
The Sun Java System Access Manager 7.1 Deployment Planning Guide provides information for planning an Access Manager deployment within an existing information technology infrastructure.
The Sun Java System Access Manager 7.1 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.1 Administration Guide describes how to configure, monitor, manage, and maintain Access Manager services, identities, and policies using either the Access Manager Console or the command-line interface.
The Sun Java System Access Manager 7.1 2006Q4 Administration Reference provides reference information for administrators including, for example, error codes.
The Sun Java System Access Manager 7.1 Federation and SAML Administration Guide provides information about the features in Access Manager that are based on the Liberty Alliance Project and SAML specifications. It includes information on the 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.1 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.1 2006Q4 C API Reference (this guide) provides a listing of APIs you can use to enable C applications to access the Access Manager components. The book includes function descriptions and syntax.
The Sun Java System Access Manager 7.1 2006Q4 Java API Reference is generated from JavaTM code using the JavadocTM tool. The pages provide information on the implementation of the 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.1 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.
Useful information can be found in the documentation for the following Sun Java System products:
For product downloads, professional services, patches, support, and additional developer information, go to:
Third-party URLs are referenced in this documentation set and provide additional, related 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.
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 bottom 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 Access Manager 7.1 2006Q2 C API Reference, and the part number is 819–4676.
Sun Function |
URL |
Description |
---|---|---|
Documentation |
Download PDF and HTML documents, and order printed documents |
|
Support and Training |
Obtain technical support, download patches, and learn about Sun courses |
The following table describes the typographic changes that are used in this book.
Table P–1 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.] |
The following table shows the default system prompt and superuser prompt for the C shell, Bourne shell, and Korn shell.
Table P–2 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 |
# |