Preface

Oracle Identity Management Application Developer's Guide explains how to modify applications to work with the Oracle Identity Management infrastructure. For the purposes of this book, this infrastructure consists of Oracle Application Server Single Sign-On, Oracle Internet Directory, Oracle Delegated Administration Services, and the Directory Integration Platform.

This preface contains these topics:

• Audience

• Documentation Accessibility

• Structure

• Related Documents

• Conventions

Audience

The following readers can benefit from this book:

• Developers who want to integrate applications with the Oracle Identity Management infrastructure. This process involves storing and updating information in an Oracle Internet Directory server. It also involves modifying applications to work with mod_osso, an authentication module on the Oracle HTTP Server.

• Anyone who wants to learn about the LDAP APIs and Oracle extensions to these APIs.

Documentation Accessibility

Our goal is to make Oracle products, services, and supporting documentation accessible, with good usability, to the disabled community. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Standards will continue to evolve over time, and Oracle is actively engaged with other market-leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For additional information, visit the Oracle Accessibility Program Web site at

http://www.oracle.com/accessibility/

Accessibility of Code Examples in Documentation

JAWS, a Windows screen reader, may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, JAWS may not always read a line of text that consists solely of a bracket or brace.

Accessibility of Links to External Web Sites in Documentation

This documentation may contain links to Web sites of other companies or organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites.

Structure

Part I, Programming for Oracle Identity Management

Chapter 1, "Developing Applications for Oracle Identity Management"

Takes a high level look at how to integrate applications with the Oracle Identity Management infrastructure. Introduces the reader to the Oracle Internet Directory Software Developer's Kit 10g Release 2 (10.1.2). Provides an overview of how an application can use the kit to integrate with the directory.

Chapter 2, "Developing Applications with Standard LDAP APIs"

Provides a brief overview of all of the major operations available in the C API and the PL/SQL API. Provides developers a general understanding of Lightweight Directory Access Protocol (LDAP) from a perspective independent of the API.

Chapter 3, "Developing Applications with Oracle Extensions to the Standard APIs"

Explains the concepts behind Oracle extensions to LDAP APIs. Describes the abstract entities that are modeled by the extensions as well as the usage model of the Oracle extensions.

Chapter 4, "Developing Provisioning-Integrated Applications"

Explains how to develop applications that can use the Oracle Directory Provisioning Integration Service in the Oracle Directory Integration and Provisioning platform. These applications can be either legacy applications or third-party applications that are based on the Oracle platform.

Chapter 5, "Developing Directory Plug-ins"

Explains how to use the plug-in framework for Oracle Internet Directory to facilitate custom development.

Chapter 6, "Integrating with Oracle Delegated Administration Services"

Explains how developers can use the DAS URL to integrate with Oracle Delegated Administration Services.

Chapter 7, "Developing Applications for Single Sign-On"

Explains how the HTTP authentication module mod_osso protects applications enabled by OracleAS Single Sign-On. Provides code that demonstrates how applications are integrated with mod_osso.

Part II Oracle Internet Directory API Reference

Chapter 8, "C API Reference"

Introduces the standard C API. Provides examples of how to use it.

Chapter 9, " DBMS_LDAP PL/SQL Reference"

Introduces the DBMS_LDAP package, which enables PL/SQL programmers to access data from LDAP servers. Provides examples of how to use DBMS_LDAP.

Chapter 10, "Java API Reference"

Directs readers to the Java APIs for Oracle Internet Directory. Provides a link to the standard API and a link to the Oracle extensions.

Chapter 11, "DBMS_LDAP_UTL PL/SQL Reference"

Contains reference material for the DBMS_LDAP_UTL package, which extends the DBMS_LDAP package.

Chapter 12, "DAS_URL Interface Reference"

Describes the Oracle extensions to the DAS_URL API.

Chapter 13, "Provisioning Integration API Reference"

Contains reference information for the Directory Integration and Provisioning Platform API.

Part III Appendixes

Appendix A, "Syntax for LDIF and Command-Line Tools"

Provides syntax, usage notes, and examples for using LDAP Data Interchange Format (LDIF) and LDAP command line tools

Appendix B, "DSML Syntax"

Provides syntax and usage notes for DSML (XML) integration.

Glossary

Defines terms used in this book.

Related Documents

For more information, see these Oracle resources:

• Oracle Identity Management Concepts and Deployment Planning Guide

• Oracle Internet Directory Administrator's Guide

• Oracle Identity Management Integration Guide

• Oracle Identity Management Guide to Delegated Administration

• Oracle Application Server Single Sign-On Administrator's Guide

• PL/SQL User's Guide and Reference

• Oracle Database Application Developer's Guide - Fundamentals

In North America, printed documentation is available for sale in the Oracle Store at

http://oraclestore.oracle.com/

Customers in Europe, the Middle East, and Africa (EMEA) can purchase documentation from

http://www.oraclebookshop.com/

Other customers can contact their Oracle representative to purchase printed documentation.

To download free release notes, installation documentation, white papers, or other collateral, please visit the Oracle Technology Network (OTN). You must register online before using OTN; registration is free and can be done at

http://otn.oracle.com/admin/account/membership.html

If you already have a user name and password for OTN, then you can go directly to the documentation section of the OTN Web site at

http://otn.oracle.com/docs/index.htm

To access the database documentation search engine directly, please visit

http://tahiti.oracle.com

For additional information, see:

• Chadwick, David. Understanding X.500—The Directory. Thomson Computer Press, 1996.

• Howes, Tim and Mark Smith. LDAP: Programming Directory-enabled Applications with Lightweight Directory Access Protocol. Macmillan Technical Publishing, 1997.

• Howes, Tim, Mark Smith and Gordon Good, Understanding and Deploying LDAP Directory Services. Macmillan Technical Publishing, 1999.

• Internet Assigned Numbers Authority home page, http://www.iana.org, for information about object identifiers

• Internet Engineering Task Force (IETF) documentation available at: http://www.ietf.org, especially:

  • The LDAPEXT charter and LDAP drafts

  • The LDUP charter and drafts

  • RFC 2254, "The String Representation of LDAP Search Filters"

  • RFC 1823, "The LDAP Application Program Interface"

• The OpenLDAP Community, http://www.openldap.org

Conventions

This section describes the conventions used in the text and code examples of this documentation set. It describes:

• Conventions in Text

• Conventions in Code Examples

• Conventions for Windows Operating Systems

Conventions in Text

We use various conventions in text to help you more quickly identify special terms. The following table describes those conventions and provides examples of their use.

Convention	Meaning	Example
Bold	Bold typeface indicates terms that are defined in the text or terms that appear in a glossary, or both.	When you specify this clause, you create an index-organized table.
Italics	Italic typeface indicates book titles or emphasis.	Oracle Database Concepts Ensure that the recovery catalog and target database do not reside on the same disk.
UPPERCASE monospace (fixed-width) font	Uppercase monospace typeface indicates elements supplied by the system. Such elements include parameters, privileges, datatypes, RMAN keywords, SQL keywords, SQL*Plus or utility commands, packages and methods, as well as system-supplied column names, database objects and structures, usernames, and roles.	You can specify this clause only for a NUMBER column. You can back up the database by using the BACKUP command. Query the TABLE_NAME column in the USER_TABLES data dictionary view. Use the DBMS_STATS.GENERATE_STATS procedure.
lowercase monospace (fixed-width) font	Lowercase monospace typeface indicates executable programs, filenames, directory names, and sample user-supplied elements. Such elements include computer and database names, net service names and connect identifiers, user-supplied database objects and structures, column names, packages and classes, usernames and roles, program units, and parameter values. Note: Some programmatic elements use a mixture of UPPERCASE and lowercase. Enter these elements as shown.	Enter sqlplus to start SQL*Plus. The password is specified in the orapwd file. Back up the datafiles and control files in the /disk1/oracle/dbs directory. The department_id, department_name, and location_id columns are in the hr.departments table. Set the QUERY_REWRITE_ENABLED initialization parameter to true. Connect as oe user. The JRepUtil class implements these methods.
lowercase italic monospace (fixed-width) font	Lowercase italic monospace font represents placeholders or variables.	You can specify the parallel_clause. Run old_release.SQL where old_release refers to the release you installed prior to upgrading.

Conventions in Code Examples

Code examples illustrate SQL, PL/SQL, SQL*Plus, or other command-line statements. They are displayed in a monospace (fixed-width) font and separated from normal text as shown in this example:

SELECT username FROM dba_users WHERE username = 'MIGRATE';

The following table describes typographic conventions used in code examples and provides examples of their use.

Convention	Meaning	Example
[ ]	Anything enclosed in brackets is optional.	DECIMAL (digits [ , precision ])
{ }	Braces are used for grouping items.	{ENABLE | DISABLE}
|	A vertical bar represents a choice of two options.	{ENABLE | DISABLE} [COMPRESS | NOCOMPRESS]
...	Ellipsis points mean repetition in syntax descriptions. In addition, ellipsis points can mean an omission in code examples or text.	CREATE TABLE ... AS subquery; SELECT col1, col2, ... , coln FROM employees;
Other symbols	You must use symbols other than brackets ([ ]), braces ({ }), vertical bars (|), and ellipsis points (...) exactly as shown.	acctbal NUMBER(11,2); acct CONSTANT NUMBER(4) := 3;
Italics	Italicized text indicates placeholders or variables for which you must supply particular values.	CONNECT SYSTEM/system_password DB_NAME = database_name
UPPERCASE	Uppercase typeface indicates elements supplied by the system. We show these terms in uppercase in order to distinguish them from terms you define. Unless terms appear in brackets, enter them in the order and with the spelling shown. Because these terms are not case sensitive, you can use them in either UPPERCASE or lowercase.	SELECT last_name, employee_id FROM employees; SELECT * FROM USER_TABLES; DROP TABLE hr.employees;
lowercase	Lowercase typeface indicates user-defined programmatic elements, such as names of tables, columns, or files. Note: Some programmatic elements use a mixture of UPPERCASE and lowercase. Enter these elements as shown.	SELECT last_name, employee_id FROM employees; sqlplus hr/hr CREATE USER mjones IDENTIFIED BY ty3MU9;

Conventions for Windows Operating Systems

The following table describes conventions for Windows operating systems and provides examples of their use.

Convention	Meaning	Example
Choose Start > menu item	How to start a program.	To start the Database Configuration Assistant, choose Start > Programs > Oracle - HOME_NAME > Configuration and Migration Tools > Database Configuration Assistant.
File and directory names	File and directory names are not case sensitive. The following special characters are not allowed: left angle bracket (<), right angle bracket (>), colon (:), double quotation marks ("), slash (/), pipe (|), and dash (-). The special character backslash (\) is treated as an element separator, even when it appears in quotes. If the filename begins with \\, then Windows assumes it uses the Universal Naming Convention.	c:\winnt"\"system32 is the same as C:\WINNT\SYSTEM32
C:\>	Represents the Windows command prompt of the current hard disk drive. The escape character in a command prompt is the caret (^). Your prompt reflects the subdirectory in which you are working. Referred to as the command prompt in this manual.	C:\oracle\oradata>
Special characters	The backslash (\) special character is sometimes required as an escape character for the double quotation mark (") special character at the Windows command prompt. Parentheses and the single quotation mark (') do not require an escape character. Refer to your Windows operating system documentation for more information on escape and special characters.	C:\>exp HR/HR TABLES=employees QUERY=\"WHERE job_id='SA_REP' and salary<8000\"
HOME_NAME	Represents the Oracle home name. The home name can be up to 16 alphanumeric characters. The only special character allowed in the home name is the underscore.	C:\> net start OracleHOME_NAMETNSListener
ORACLE_HOME and ORACLE_BASE	In releases prior to Oracle8i release 8.1.3, when you installed Oracle components, all subdirectories were located under a top level ORACLE_HOME directory. The default for Windows NT was C:\orant. This release complies with Optimal Flexible Architecture (OFA) guidelines. All subdirectories are not under a top level ORACLE_HOME directory. There is a top level directory called ORACLE_BASE that by default is C:\oracle\product\10.1.0. If you install the latest Oracle release on a computer with no other Oracle software installed, then the default setting for the first Oracle home directory is C:\oracle\product\10.1.0\db_n, where n is the latest Oracle home number. The Oracle home directory is located directly under ORACLE_BASE. All directory path examples in this guide follow OFA conventions. Refer to Oracle Database Installation Guide for Windows for additional information about OFA compliances and for information about installing Oracle products in non-OFA compliant directories.	Go to the ORACLE_BASE\ORACLE_HOME\rdbms\admin directory.