Contents

Title and Copyright Information

Send Us Your Comments

Preface

1 Introduction

About Oracle Internet Directory Software Developer's Kit Release 9.2

Components of the Oracle Internet Directory Software Developer's Kit

Other Components of Oracle Internet Directory

Operating Systems Supported

Part I Standard LDAP APIs

2 Concepts

History of LDAP

Overview of LDAP Models

LDAP Naming Model

LDAP Information Model

LDAP Functional Model

LDAP Security Model

About the Oracle Internet Directory API

Initializing an LDAP Session

Initializing the Session by Using the C API

Initializing the Session by Using DBMS_LDAP

LDAP Session Handle Options in the C API

Enabling Authentication to a Directory Server

Enabling Authentication to a Directory Server by Using the C API

Enabling Authentication to a Directory Server by Using DBMS_LDAP

Searching by Using DBMS_LDAP

Flow of Search-Related Operations

Search Scope

Filters

Enabling Session Termination by Using DBMS_LDAP

3 C API for Oracle Internet Directory

About the Oracle Internet Directory C API

Oracle Internet Directory SDK C API SSL Extensions

C API Reference

Summary of LDAP C API

Functions

Initializing an LDAP Session

LDAP Session Handle Options

Working With Controls

Authenticating to the Directory

Closing the Session

Performing LDAP Operations

Abandoning an Operation

Obtaining Results and Peeking Inside LDAP Messages

Handling Errors and Parsing Results

Stepping Through a List of Results

Parsing Search Results

Sample C API Usage

C API Usage with SSL

C API Usage Without SSL

Building Applications with the C API

Required Header Files and Libraries

Building a Sample Search Tool

Dependencies and Limitations

4 The DBMS_LDAP PL/SQL Package

About the DBMS_LDAP Package

Building Applications with DBMS_LDAP

Dependencies and Limitations

DBMS_LDAP Sample Programs

DBMS_LDAP Reference

Summary of Subprograms

Exception Summary

Data-Type Summary

Subprograms

Part II Oracle Extensions to LDAP APIs

5 Overview of Oracle Extensions

The LDAP Access Model

Application Installation Logic

Application Startup and Bootstrap Logic

Application Runtime Logic

Application Shutdown Logic

Application Deinstallation Logic

Entities Modeled in LDAP

Users

Groups

Subscribers

API Enhancements: Overview & Usage Model

API Enhancements: Assumptions

System Placement

API Enhancements Functional Categorization

API Enhancements Usage Model

Installation and First Use

6 Java API for Oracle Internet Directory

Class Descriptions

User Class

Subscriber Class

Group Class

PropertySetCollection, PropertySet, and Property Classes

Classes

oracle.ldap.util.Base64

oracle.ldap.util.Group

oracle.ldap.util.Guid

oracle.ldap.util.LDIF

oracle.ldap.util.LDIFAttribute

oracle.ldap.util.LDIFMigration

oracle.ldap.util.LDIFReader

oracle.ldap.util.LDIFRecord

oracle.ldap.util.LDIFSubstitute

oracle.ldap.util.LDIFWriter

oracle.ldap.util.Property

oracle.ldap.util.PropertySet

oracle.ldap.util.PropertySetCollection

oracle.ldap.util.Subscriber

oracle.ldap.util.User

oracle.ldap.util.Util

java.util.Hashtable getAllDASUrl(DirContext ctx)

oracle.ldap.util.jndi.ConnectionUtil

Exceptions

oracle.ldap.util.AcctIPLockedException

oracle.ldap.util.AcctTotallyLockedException

oracle.ldap.util.AuthFailureException

oracle.ldap.util.AuthPasswdChangeWarningException

oracle.ldap.util.AuthPasswdExpiredException

oracle.ldap.util.GeneralErrorException

oracle.ldap.util.InvalidLDIFRecordException

oracle.ldap.util.InvalidParameterException

oracle.ldap.util.InvalidRootOrclctxException

oracle.ldap.util.InvalidSubscriberOrclctxException

oracle.ldap.util.LoginPolicyFailureException

oracle.ldap.util.MigrationException

oracle.ldap.util.MultipleSubscriberException

oracle.ldap.util.MultipleUserException

oracle.ldap.util.NoGroupMembersException

oracle.ldap.util.NoRootOrclctxException

oracle.ldap.util.NoSubscriberOrclctxException

oracle.ldap.util.NoSuchGroupException

oracle.ldap.util.NoSuchSubscriberException

oracle.ldap.util.NoSuchUserException

oracle.ldap.util.ParameterException

oracle.ldap.util.PasswdExpiredException

oracle.ldap.util.SetPropertiesException

oracle.ldap.util.SubscriberNotFoundException

oracle.ldap.util.UtilException

7 The DBMS_LDAP_UTL PL/SQL Package

Introduction

DBMS_LDAP_UTL Reference

Summary of Subprograms

User-Related Subprograms

Group-Related Subprograms

Subscriber-Related Subprograms

Property-Related Subprograms

Miscellaneous Subprograms

Function Return Code Summary

Data-Type Summary

8 Developing Provisioning-Integrated Applications

Prerequisite Knowledge

Development Usage Model for Provisioning Integration

Development Tasks for Provisioning Integration

Application Installation

User Creation and Enrollment

User Deletion

Application Deinstallation

Provisioning Event Interface Description

LDAP_NTFY Function Definitions

FUNCTION event_ntfy

9 Oracle Internet Directory Server Plug-in Framework

Introduction

Prerequisite Knowledge

Concepts

About Directory Server Plug-ins

About Server Plug-in Framework

Operation-Based Plug-ins Supported in Oracle Internet Directory

Requirements

Designing Plug-ins

Creating Plug-ins

Compiling Plug-ins

Registering Plug-ins

Managing Plug-ins

Enabling and Disabling Plug-ins

Exception Handling

Plug-in LDAP API

Plug-in and Replication

Plug-in and DB Tools

Security

Plug-in LDAP API Specifications

Usage Model and Examples

Example 1: Search Query Logging

Example 2: Synchronizing Two DITs

Type Definition & Usage Model

Database Object Type Definitions

Plug-in Module Interface Specifications

LDAP Server Error Code Reference

Part III Appendixes

A Command-Line Tools Syntax

LDAP Data Interchange Format (LDIF) Syntax

Entry-Management Command-Line Tools

ldapadd Syntax

ldapaddmt Syntax

ldapbind Syntax

ldapdelete Syntax

ldapmoddn Syntax

ldapsearch Syntax

Atttribute-Management Command-Line Tools

The Catalog Management Tool

ldapcompare Syntax

ldapmodify Syntax

ldapmodifymt Syntax

Provisioning Subscription Tool

B Sample Usage

DBMS_LDAP Sample Code

Using DBMS_LDAP from a Database Trigger

Using DBMS_LDAP for a Search

DBMS_LDAP_UTL Sample Code

Example: User-Related Functions

Example: Property-Related Subprograms

Example: Subscriber-Related Functions

Example: Group-Related Functions

Java Sample Code

User Class Sample Code

Subscriber Class Sample Code

Group Class Sample Code

Print Sample Code

Glossary

Index