EARTH WEEK
Now through April 22, save up to 70% on digital learning resources. Learn more.
Register your product to gain access to bonus material or receive a coupon.
Lightweight Directory Access Protocol (LDAP) is now a staple of enterprise and Internet software environments. Anyone involved with Internet development, where Java(TM) technology is prominent, or in enterprise information systems must understand how to use Java technology--especially the Directory SDK for Java--in order to unlock the power of LDAP.
Written by the designer of the Directory SDK for Java and by a leading implementor of directory-based solutions, LDAP Programming with Java(TM) is the first accurate, concise, and complete guide on accessing LDAP from Java applications. Assuming familiarity with Java programming, the book provides a comprehensive discussion of LDAP, from basic directory concepts to the most advanced techniques. It collects in one convenient resource the many innovative and experience-based techniques and approaches programmers have discovered for using the Directory SDK to solve LDAP access challenges.
If you are new to LDAP, you will find helpful background information about the role of directories in today's software systems; LDAP methods of storing, accessing, searching, and updating data; and how the Directory SDK for Java helps applications gain access to an LDAP server. Once you have become proficient with the essential concepts and techniques, you can move on to detailed material about authentication, LDAP and JavaScript(TM), working with JavaBeans(TM) for reusable LDAP components, expressing data relationships in a directory, and other advanced LDAP subjects.
Specific topics covered include:
LDAP Programming with Java(TM) also presents numerous examples, from simple code snippets to complete components and applications.
Preface.
Acknowledgments.
Introduction.
1. What Can You Find in a Directory?
What Is a Directory?
What Is That Phone Number?
Directory Clients for an Online Phone Book.
Is He Really Who He Says He Is?
Working Together.
Computers, Printers, Toasters.
A Brief History of Electronic Directories.
I Heard It through the Grapevine.
Directories for the Internet.
>Directories for a Single Network: Proprietary Solutions.
X.500: The "Heavyweight" Directory Service.
From Humble Beginnings.
Future Directions for LDAP.
The LDAP Information and Naming Models: How Directories Are Organized.
The LDAP Information Model.
The LDAP Naming Model.
LDAP Spoken Here.
Many Roads to Rome.
Directory SDK for C.
Directory SDK for Java.
Java Naming and Directory Interface.
What Directory SDK for Java Can Do for You: Freedom from Protocol Handling.
The Use of Standard Java Objects for Returning and Processing Data: Utility Classes for Handling LDAP-Specific Entities.
Full Access to All LDAP Services.
Flexible Authentication Models.
Write Once, Run Anywhere.
Multilayered Functionality.
A Platform for Directory-Enabled Applications.
What Else Can the SDK Do for Me?
Dynamic Organizational Chart.
Directory-Linking Tool.
Access Control for Existing or New Applications.
Installation and Setup of the SDK.
Staying Current.
Installing the SDK.
Conclusion.
II. GETTING STARTED.
4. Setting Up Your Own Directory.Downloading and Installing Netscape Directory Server.
Before You Download and Install the Software.
Downloading Netscape Directory Server.
Installing Netscape Directory Server.
Setting Up the Sample Database.
Using the Command-Line Tools with Your New Directory.
Finding Entries with LDAPSearch.
Adding Entries to the Directory.
Understanding LDIF: How to Describe a Directory Entry.
Object Classes: Determining What Information Makes Up an Entry.
Choosing a Distinguished Name: Where Do You Want to Add the Entry?
Examples of Defining and Adding Entries.
Conclusion.
5. Searching with the SDK.Our First Search.
Host Name.
Port.
Base DN.
Scope.
Filter.
Attributes.
Search Preferences.
Our First Search Program.
Using Search Filters.
Handling Results.
Attributes in Detail.
I Want Only One Record and I Have the DN.
Searching and Comparing.
More on Filters.
Sorting.
Authenticating for Searches.
Improving Directory Search Performance.
Use Indexed Attributes.
Specify an Object Class to Get Only Entries of the Desired Type.
Retrieve Only Attributes You Need.
Keep the DN Handy.
Use compare Where It Makes Sense.
Conclusion.
6. Creating and Maintaining Information.Before We Can Update: Authentication Basics.
Adding an Entry.
Summary of Steps to Add a New Entry.
Inserting Records from a Data File.
Adding an Organizational Unit.
Processing Exceptions.
Modifying an Existing Entry.
Summary of Steps to Modify an Existing Entry.
Adding an Attribute.
Modifying an Attribute.
Removing an Attribute.
Updating Multivalued Attributes.
Storing Binary Data.
Storing Preferences and State.
Deleting an Entry.
Renaming an Entry: Modifying the RDN.
Managing Groups.
Adding a User to a Group.
Removing a User from a Group.
Using the LDAPIsMember Bean.
Conclusion.
7. Securing the Data.No Standards for Access Control.
Setting Up an Access Control List.
Viewing Access Control Lists through LDAP.
Modifying Access Control Lists through LDAP.
Authenticating to the Directory.
Using Password-Based Authentication.
Communicating over Secure Sockets Layer.
Using Certificate-Based Authentication.
Using SASL Authentication.
Authenticating with SASL in LDAP.
Callbacks in SASL.
The SASL Framework Classes.
Preparing to Use an Existing Mechanism.
Your Own SaslClient and ClientFactory.
Conclusion.
III. GETTING DOWN AND DIRTY.
8. More Power to the Browser: An Applet That Speaks LDAP.What's So Different about an Applet?
Certificates and Signed Applets.
Writing LDAP Applets for Netscape Navigator.
Requesting Connection Privileges.
Packaging Your Applet.
Generating a Test Certificate.
Signing Your Code.
Testing Your Applet.
Using the Codebase as a Principal.
Writing LDAP Applets for Microsoft Internet Explorer.
Requesting Connection Privileges.
Packaging Your Applet.
Generating a Test Certificate.
Signing Your Code.
Creating a Web Page for the Applet.
Writing LDAP Applets for Java Plug-In Software.
Packaging Your Applet.
Generating a Key Pair and Self-signed Certificate.
Signing Your Code.
Setting Up the End Useris System.
A Directory Viewer Applet.
A Simple Example for Java Plug-In Software.
Conclusion.
9. Scripting LDAP: JavaScript and Java.Accessing Java Applets from JavaScript.
Accessing Java Objects from JavaScript.
JavaScript Gotchas.
Handling Java Exceptions in JavaScript.
Handling Arrays of Strings.
Requesting Privileges and Signing Your JavaScript Code.
Accessing the LDAP Classes from JScript in Internet Explorer.
Conclusion.
10. Don't Redo It, Reuse It: LDAP JavaBeans.Invisible LDAP JavaBeans.
LDAPBasePropertySupport.
LDAPSimpleAuth.
LDAPGetEntries.
Directory-Based Authentication in JavaScript.
Using PropertyChangeEvent Notifications.
Graphical LDAP JavaBeans.
A Directory Browser.
A Directory Lister.
Conclusion.
11. Make Your Application Location-Independent.The Teex Multicharacter-Set Text Editor.
The Teex JavaBean.
A Class for User Preferences.
Storing Preferences as Attributes in User Entries.
Saving Preferences as an Object in the Directory.
Using Directory Structure to Model Attributes.
Conclusion.
12. Modeling Relationships.Mirroring an Organizational Structure.
Attributes as Pointers.
Parsing the Reporting Relationships in a Directory.
An Alternative Strategy for Management Parsing.
An Organizational Chart Tree Component.
A More Traditional Organizational Chart Component.
Inspecting Properties of an Entry.
Connecting the Property Table and the Directory Viewers.
Conclusion.
13. Servlets and LDAP.Overview of Servlets.
Uses of LDAP in Servlets.
Designing the LDAP Servlet.
Location of Files.
Our Phone Book Servlet.
Phone Book Lookups.
Accessibility with a Simple Browser.
Utilizing the Corporate LDAP Directory.
Customizability.
Search Attributes.
Intranet and Extranet.
User Self-administration.
Connection Pooling and Data Caching.
Accessibility over SSL.
Connection-Pooling Class.
Servlet Request-Response Model.
Setting Up and Using the Servlet.
Tips for Servlet Developers.
Conclusion.
IV. BEYOND THE BASICS.
14. Options and Constraints.How Do They Affect Me?
A View into Options.
TimeLimit.
Referrals.
BindProc.
ReBindProc.
HopLimit.
Constraints for Searching.
ServerTimeLimit.
Dereference.
MaxResults.
BatchSize.
MaxBackLog.
Conclusion.
15. Odds and Ends.LDAP URLs.
An IETF Standard.
Using LDAP URLs in Java.
Not Your Average URL.
A Rose by Any Other Name.
When What You Read Is Not What You Wrote.
Sometimes One Thread Is Not Enough.
Don't Step on My Settings.
A Cloned Connection Is a Safe Connection.
Performance, and How to Get It.
Breaking Up Is Hard to Do: Avoid Unnecessary Connections.
Pool the Connections.
Fewer But Better Searches.
To Cache or Not to Cache.
Conclusion.
16. Advanced Topics.Information about Information: Managing the Schema.
Programmatic Access through the Schema Classes.
A Pretty Printer for Schema Contents.
Controls: An Essential Extension.
Too Much Data: A Virtual List View.
Call Me When You're Ready: Persistent Search.
Password Expiration Notification.
Trust Me: The Proxied Authorization Control.
Your Very Own Controls: Using the BER Package.
When the Data Lives Elsewhere: Managing Referrals.
Catching and Processing Referral Exceptions.
Automatic Referrals: Anonymous or under Client Control.
The manageDsaIT Control.
LDAPBind for Complete Client Control.
And Now for Something Completely Different: Extended Operations.
Aiming for 24 x 7: Failover and Reconnecting.
Transparent Reconnection.
Controlling the Result Queue: The Connection Backlog.
Down to the Wire: Using the Asynchronous Interface.
Conclusion.
Appendix A: More to Learn About LDAP.Going to the Source: Internet Standards.
Where to Get RFCs and Internet Drafts.
LDAP RFCs.
LDAP Internet Drafts.
X.500 Documents.
Books about LDAP.
LDAP Concepts and Deployment.
LDAP Programming.
X.500.
LDAP Information on the Internet.
LDAP FAQs and Presentations.
LDAP Client SDKs.
Add-On Products for LDAP Directories.
Collections of LDAP Documents and Links.
X.500.
Miscellaneous.
Newsgroups Where LDAP Is Spoken.
LDAP in Your Inbox.
LDAP Servers at Your Disposal.
Appendix B: Classes of the LDAP SDK.The netscape.ldap Package.
LDAPConnection and Connection Management.
Basic LDAP Message and Data Encapsulation.
Handling Messages from the Server.
Authentication and Reauthentication.
Exceptions.
Controls.
Caching.
Client-Side Sorting.
Schema Representation.
Miscellaneous Utility Classes.
The netscape.ldap.util Package.
DNs and RDNs.
LDIF Reader Classes.
Connection Pool.
>The util Package. Appendix C: Common LDAP Schema Elements.Object Classes.
Abstract Object Classes.
Structural Object Classes.
Auxiliary Object Classes.
Attributes.
Attribute Syntaxes.
Attribute Types
Appendix D: LDAP Error Codes.After a maturation phase in the early and mid-1990s, Lightweight Directory Access Protocol (LDAP) exploded into the mainstream of enterprise and Internet software environments. Just a few years ago, only researchers and a few brave souls doing pilot projects concerned themselves with the new protocol for sharing and accessing directory information. Today, one of the requirements of any major enterprise-level or Internet-oriented application is to be able to use an existing shared resource for user information, authentication, and authorization, and nowadays that resource in a great many cases is an LDAP directory.
This book is dedicated to the programmers and system administrators who are faced with LDAP-enabling their applications, tools, and systems.
There are various programming language interfaces to LDAP: C, Perl, Microsoft's ADSI. Java and LDAP are a particularly good fit, with all the options available today for deploying Java on servers--Java servlets, Java Server Pages (JSP), Enterprise JavaBeans (EJB), and server-side JavaScript--and in clients as Java applications, applets, or client-side JavaScript. The Netscape Navigator Web browser includes Directory SDK for Java, making it easy to deploy Web-based client applications that use LDAP to authenticate or to retrieve and store data.
In this book we've provided a very large number of examples for every aspect of programming with Directory SDK for Java, from simple code snippets to more than two dozen complete components and applications. You may be able to use some of them as starting points for your own projects. We do not discuss directory deployment scenarios or how to configure an LDAP server. Such topics are explored in detail in other books and in documentation provided by vendors of LDAP servers.
Introduction to LDAP
Chapter 2 introduces the LDAP protocol against this background and presents the LDAP naming and information models that together define how data is stored and accessed in a directory.
After acquainting you with the basic LDAP concepts and terminology, in Chapter 3 we will look at how Directory SDK for Java can help a Java program, servlet, or applet gain access to an LDAP server. After installing the SDK, we will try a few simple searches with the SDK's command-line search tool to become familiar with how a client typically interacts with an LDAP server.
Getting Started
With the SDK installed and a directory available, Chapter 5 dives into how to retrieve data from an LDAP server. Searching is the predominant LDAP operation in most programs, and we will cover all parameters that affect the results to be returned, as well as how to obtain optimal performance. Chapter 6 explores the add, modify, delete, and rename operations for updating data in a directory, along with how to use groups.
Authentication is touched on briefly in Chapter 6 because most directories are configured not to allow anonymous clients to update any data. Chapter 7, however, covers the topic thoroughly. Besides covering simple authentication with a distinguished name (DN) and password, it introduces authentication with Secure Sockets Layer (SSL) and Simple Authentication and Security Layer (SASL), and it explains how access control is configured and updated in Netscape Directory Server.
Down and Dirty
In Chapter 9 we investigate how to access the SDK from JavaScript in a browser.
Chapter 10 demonstrates how to encapsulate LDAP functionality in a JavaBean and provides full source for a directory tree browser JavaBean and a table JavaBean for listing the results of a search operation.
In Chapter 11 we take a detailed look at how an application can store configuration and preferences in a directory.
In a directory, data is stored as a tree. Chapter 12 illustrates how directory data can model relationships other than the physical tree relationships. A JavaBean is developed to extract reporting relationships from LDAP data and present the results as an organizational chart. Another JavaBean presents the contents of a directory entry. The chapter concludes by hooking up into simple applications the graphical JavaBeans that have been developed up to that point in the book.
Chapter 13 develops a complete server-side application: a corporate online "phone book." The application is a Java servlet that makes selected personal directory information, such as phone numbers and photographs, available to any user with a browser.
In Chapter 14 we summarize and discuss all the options and constraints that may be selected by an application for searching and other operations.
Beyond the Basics
Advanced topics, such as schema management, LDAP controls, and the asynchronous operation methods, are presented in Chapter 16.
The appendices contain important reference material for the SDK and for LDAP in general.
If you are familiar with the use of directories and with LDAP concepts, you may choose to skip over the first two chapters. If you already have an LDAP server available and the SDK is installed, you can go directly to Chapter 5.
If you are not interested in writing applets or JavaScript applications that use LDAP, you can safely skip over Chapters 8 and 9. Similarly, if you do not need to know how to write a Java servlet that uses LDAP, you may choose to skip over Chapter 13.