index.xml.vm revision 73adb2e3dbaa8a9f6448cefccb7933f68c3c7348
<?xml version="1.0" encoding="UTF-8"?>
<!--
! CDDL HEADER START
!
! The contents of this file are subject to the terms of the
! Common Development and Distribution License, Version 1.0 only
! (the "License"). You may not use this file except in compliance
! with the License.
!
! You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
! See the License for the specific language governing permissions
! and limitations under the License.
!
! When distributing Covered Code, include this CDDL HEADER in each
! file and include the License file at legal-notices/CDDLv1_0.txt.
! If applicable, add the following below this CDDL HEADER, with the
! fields enclosed by brackets "[]" replaced with your own identifying
! information:
! Portions Copyright [yyyy] [name of copyright owner]
!
! CDDL HEADER END
!
! Copyright 2011-2015 ForgeRock AS.
!
-->
<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
<properties>
</properties>
<body>
<section name="About ${project.name}">
<p>This module contains example LDAP applications implemented using the
OpenDJ LDAP SDK.</p>
<p>
The following examples use the synchronous APIs:
</p>
<ul>
<li>
- illustrates how to perform an LDAP search operation using the
synchronous APIs
</li>
<li>
- illustrates how to perform an LDAP modify operation using the
synchronous APIs
</li>
<li>
- illustrates how to implement a very simple LDAP server
</li>
<li>
- illustrates how to bind to an LDAP server using the synchronous APIs
</li>
<li>
- illustrates how to implement a SASL PLAIN bind to an LDAP server
</li>
<li>
attributes</a> - illustrates how to get an entry's attribute values as objects
</li>
<li>
- illustrates how to read and verify an LDAP server's schema
</li>
<li>
- illustrates how to read an LDAP server's capabilities and schema
</li>
<li>
- illustrates how to authenticate given a mail address and a password
using the synchronous APIs
</li>
<li>
- illustrates how to create, update, rename, and delete an entry
using the synchronous APIs
</li>
<li>
- illustrates how to validate an entry using the directory server LDAP schema
using the synchronous APIs
</li>
<li>
- illustrates how to use supported LDAP controls
</li>
<li>
LDAP Extended Operations</a> - illustrates how to use supported LDAP extended
operations
</li>
<li>
- illustrates how to add or remove a member from a static group
using the synchronous APIs
</li>
<li>
<a href="xref/org/forgerock/opendj/examples/UseGenericControl.html">Use <code>GenericControl</code></a>
- illustrates how to use <code>GenericControl</code> to add a pre-read request control
</li>
<li>
<a href="xref/org/forgerock/opendj/examples/GetADChangeNotifications.html">Get AD Change Notifications</a>
- illustrates how to use <code>GetADChangeNotifications</code> to get change notifications from Active Directory
</li>
<li>
- illustrates how to reset a user password in Active Directory as Administrator,
or change the password as the user
</li>
</ul>
<p>
The following examples use the asynchronous APIs:
</p>
<ul>
<li>
- illustrates how to perform an LDAP search operation using the
asynchronous APIs
</li>
<li>
- illustrates how to perform an LDAP modify operation using the
asynchronous APIs
</li>
<li>
- illustrates how to implement a very simple LDAP proxy
</li>
<li>
- illustrates how to bind to an LDAP server using the asynchronous APIs
</li>
<li>
- illustrates how to authenticate given a mail address and a password
using the asynchronous APIs
</li>
<li>
- illustrates how to create, update, rename, and delete an entry
using the asynchronous APIs
</li>
<li>
- illustrates how to validate an entry using the directory server LDAP schema
using the asynchronous APIs
</li>
<li>
- illustrates how to rewrite DNs and attribute names in a proxy layer
</li>
<li>
- illustrates how to add or remove a member from a static group
using the asynchronous APIs
</li>
</ul>
</section>
<section name="Documentation for ${project.name}">
<p>
</p>
</section>
<section name="Get ${project.name}">
<p>
You can get ${project.name} using any of the following methods:
</p>
<subsection name="Download">
<p>
Pre-built binaries can be downloaded directly from the ForgeRock Maven
repository:
</p>
<ul>
<li><a href="${mavenRepoReleases}/org/forgerock/opendj/${project.artifactId}">Stable releases</a></li>
<li><a href="${mavenRepoSnapshots}/org/forgerock/opendj/${project.artifactId}/${project.version}">Latest development snapshot</a></li>
</ul>
</subsection>
<subsection name="Build">
<p>
For the DIY enthusiasts you can build it yourself by checking out the
building it with Maven 3.
</p>
</subsection>
</section>
</body>
</document>