Preface

This guide shows you how to develop scripts that use OpenDJ tools.

If you are building a Java-based LDAP client application, refer to the OpenDJ LDAP SDK Developer’s Guide instead. In reading and following the instructions in this guide, you will learn how to:

  • Access OpenDJ directory server by using REST APIs over HTTP

  • Access OpenDJ directory server using the LDAP tools delivered with the server

  • Use LDAP schema

  • Work with standard LDAP groups and OpenDJ-specific groups

  • Work with LDAP collective attributes and OpenDJ virtual attributes

  • Work with LDAP referrals in search results

Using This Guide

This guide is intended for directory administrators who write scripts that use OpenDJ directory services. This guide is written with the expectation that you already have basic familiarity with the following topics:

  • Installing OpenDJ directory server, if the server is not yet installed

    If you are not yet familiar with OpenDJ directory server installation, read the Installation Guide first.

  • Using command-line tools

  • LDAP and directory services

  • Basic OpenDJ server configuration

    Some examples in this guide require OpenDJ configuration steps.

  • HTTP, JavaScript Object Notation (JSON), and web applications

Formatting Conventions

Most examples in the documentation are created in GNU/Linux or Mac OS X operating environments. If distinctions are necessary between operating environments, examples are labeled with the operating environment name in parentheses. To avoid repetition file system directory names are often given only in UNIX format as in /path/to/server , even if the text applies to C:\path\to\server as well. Absolute path names usually begin with the placeholder /path/to/ . This path might translate to /opt/ , C:\Program Files\ , or somewhere else on your system. Command-line, terminal sessions are formatted as follows:

$ echo $JAVA_HOME
/path/to/jdk

Command output is sometimes formatted for narrower, more readable output even though formatting parameters are not shown in the command. Program listings are formatted as follows:

class Test {
    public static void main(String [] args)  {
        System.out.println("This is a program listing.");
    }
}

Accessing Documentation Online

Open Identity Platform Community publishes comprehensive documentation online:

  • The Open Identity Platform Community Documentation offers a large and increasing number of up-to-date, practical articles that help you deploy and manage Open Identity Platform software.

  • Open Identity Platform product documentation, such as this document, aims to be technically accurate and complete with respect to the software documented. It is visible to everyone and covers all product features and examples of how to use them.

Joining the Open Identity Platform Community

Visit the community resource center where you can find information about each project, download nightly builds, browse the resource catalog, ask and answer questions on the forums, find community events near you, and of course get the source code as well.

Getting Support and the Contacting Open Identity Platform Community

Open Identity Platform Community Approved Vendors provide support services, professional services, trainings, and partner services to assist you in setting up and maintaining your deployments.