From a6a033e16d301d7400fa917309c0cb3a03b52797 Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Mon, 28 May 2012 09:59:26 +0000
Subject: [PATCH] Links to examples
---
opendj3/src/main/docbkx/dev-guide/chap-authenticating.xml | 22 +++++++++-
opendj3/src/main/docbkx/dev-guide/chap-writing.xml | 12 +++++
opendj3/src/main/docbkx/dev-guide/chap-extended-ops.xml | 7 +++
opendj3/src/main/docbkx/dev-guide/chap-using-the-sdk.xml | 15 ++++++-
opendj3/src/main/docbkx/dev-guide/chap-get-sdk.xml | 2
opendj3/src/main/docbkx/dev-guide/chap-getting-directory-info.xml | 6 +++
opendj3/src/main/docbkx/dev-guide/chap-reading.xml | 24 ++++++++++++
opendj3/src/main/docbkx/dev-guide/chap-controls.xml | 7 +++
8 files changed, 88 insertions(+), 7 deletions(-)
diff --git a/opendj3/src/main/docbkx/dev-guide/chap-authenticating.xml b/opendj3/src/main/docbkx/dev-guide/chap-authenticating.xml
index 0200c25..8beb191 100644
--- a/opendj3/src/main/docbkx/dev-guide/chap-authenticating.xml
+++ b/opendj3/src/main/docbkx/dev-guide/chap-authenticating.xml
@@ -52,9 +52,7 @@
<para>To bind using Barbara Jensen's identity and simple authentication,
for example, your application would provide the DN
<literal>uid=bjensen,ou=People,dc=example,dc=com</literal> with the
- password <literal>hifalutin</literal>. An example is provided with the
- OpenDJ LDAP SDK examples in
- <filename>org.forgerock.opendj.examples.SimpleAuth.java</filename>.</para>
+ password <literal>hifalutin</literal>.</para>
<para>The directory stores the password value used for simple authentication
in binary form on the <literal>userPassword</literal> attribute of the entry.
@@ -104,6 +102,12 @@
case, however, the directory authenticates the user as anonymous, therefore
no doubt with fewer rights than the normal user, and surely fewer rights
than an administrator.</para>
+
+ <para>For a complete example in context, see <link
+ xlink:href="http://opendj.forgerock.org/opendj-ldap-sdk-examples/xref/org/forgerock/opendj/examples/SimpleAuth.html"
+ xlink:show="new">SimpleAuth.java</link>, one of the <link
+ xlink:href="http://opendj.forgerock.org/opendj-ldap-sdk-examples/"
+ xlink:show="new">OpenDJ LDAP SDK examples</link>.</para>
</section>
<section xml:id="simple-auth-with-starttls-or-ssl">
@@ -188,6 +192,12 @@
connection.close();
}
}</programlisting>
+
+ <para>For a complete example in context, see <link
+ xlink:href="http://opendj.forgerock.org/opendj-ldap-sdk-examples/xref/org/forgerock/opendj/examples/SimpleAuth.html"
+ xlink:show="new">SimpleAuth.java</link>, one of the <link
+ xlink:href="http://opendj.forgerock.org/opendj-ldap-sdk-examples/"
+ xlink:show="new">OpenDJ LDAP SDK examples</link>.</para>
</section>
<section xml:id="sasl-auth">
@@ -258,5 +268,11 @@
default to use the Exact Match Identity Mapper to look up user IDs as
<literal>uid</literal> values. If you use another directory server, you might
have to configure how it maps user IDs to user entries.</para>
+
+ <para>For a complete example in context, see <link
+ xlink:href="http://opendj.forgerock.org/opendj-ldap-sdk-examples/xref/org/forgerock/opendj/examples/SASLAuth.html"
+ xlink:show="new">SASLAuth.java</link>, one of the <link
+ xlink:href="http://opendj.forgerock.org/opendj-ldap-sdk-examples/"
+ xlink:show="new">OpenDJ LDAP SDK examples</link>.</para>
</section>
</chapter>
diff --git a/opendj3/src/main/docbkx/dev-guide/chap-controls.xml b/opendj3/src/main/docbkx/dev-guide/chap-controls.xml
index 7e49e71..3af4b0d 100644
--- a/opendj3/src/main/docbkx/dev-guide/chap-controls.xml
+++ b/opendj3/src/main/docbkx/dev-guide/chap-controls.xml
@@ -40,6 +40,13 @@
<para>This chapter demonstrates how to use LDAP controls.</para>
+ <para>For complete examples corresponding to the excerpts shown below, see
+ <link
+ xlink:href="http://opendj.forgerock.org/opendj-ldap-sdk-examples/xref/org/forgerock/opendj/examples/Controls.html"
+ xlink:show="new">Controls.java</link>, one of the <link
+ xlink:href="http://opendj.forgerock.org/opendj-ldap-sdk-examples/"
+ xlink:show="new">OpenDJ LDAP SDK examples</link>.</para>
+
<section xml:id="about-ldap-controls">
<title>About LDAP Controls</title>
<para>Controls provide a mechanism whereby the semantics and arguments of
diff --git a/opendj3/src/main/docbkx/dev-guide/chap-extended-ops.xml b/opendj3/src/main/docbkx/dev-guide/chap-extended-ops.xml
index ec42f19..f169870 100644
--- a/opendj3/src/main/docbkx/dev-guide/chap-extended-ops.xml
+++ b/opendj3/src/main/docbkx/dev-guide/chap-extended-ops.xml
@@ -40,6 +40,13 @@
<para>This chapter demonstrates how to use LDAP extended operations.</para>
+ <para>For complete examples corresponding to the excerpts shown below, see
+ <link
+ xlink:href="http://opendj.forgerock.org/opendj-ldap-sdk-examples/xref/org/forgerock/opendj/examples/ExtendedOperations.html"
+ xlink:show="new">ExtendedOperations.java</link>, one of the <link
+ xlink:href="http://opendj.forgerock.org/opendj-ldap-sdk-examples/"
+ xlink:show="new">OpenDJ LDAP SDK examples</link>.</para>
+
<section xml:id="about-ldap-extended-operations">
<title>About LDAP Extended Operations</title>
<para>Extended operations allow additional operations to be defined for
diff --git a/opendj3/src/main/docbkx/dev-guide/chap-get-sdk.xml b/opendj3/src/main/docbkx/dev-guide/chap-get-sdk.xml
index 8bdaf26..9fb57ee 100644
--- a/opendj3/src/main/docbkx/dev-guide/chap-get-sdk.xml
+++ b/opendj3/src/main/docbkx/dev-guide/chap-get-sdk.xml
@@ -371,7 +371,7 @@
<para>A number of OpenDJ LDAP SDK examples are available online on the <link
xlink:href="http://opendj.forgerock.org/opendj-ldap-sdk-examples/"
- xlink:show="new"></link>OpenDJ community site. There you find samples
+ xlink:show="new">OpenDJ community site</link>. There you find samples
whose excerpts are shown in this guide.</para>
</section>
</chapter>
diff --git a/opendj3/src/main/docbkx/dev-guide/chap-getting-directory-info.xml b/opendj3/src/main/docbkx/dev-guide/chap-getting-directory-info.xml
index 8613431..6388bee 100644
--- a/opendj3/src/main/docbkx/dev-guide/chap-getting-directory-info.xml
+++ b/opendj3/src/main/docbkx/dev-guide/chap-getting-directory-info.xml
@@ -86,6 +86,12 @@
writer.flush();
}</programlisting>
+ <para>For a complete example in context, see <link
+ xlink:href="http://opendj.forgerock.org/opendj-ldap-sdk-examples/xref/org/forgerock/opendj/examples/GetInfo.html"
+ xlink:show="new">GetInfo.java</link>, one of the <link
+ xlink:href="http://opendj.forgerock.org/opendj-ldap-sdk-examples/"
+ xlink:show="new">OpenDJ LDAP SDK examples</link>.</para>
+
<para>Notice that by default you can access the root DSE after authenticating
anonymously. When you look at the entry in LDIF, you see that supported
capabilities are generally identified by object identifier (OID).</para>
diff --git a/opendj3/src/main/docbkx/dev-guide/chap-reading.xml b/opendj3/src/main/docbkx/dev-guide/chap-reading.xml
index aaea764..a052d80 100644
--- a/opendj3/src/main/docbkx/dev-guide/chap-reading.xml
+++ b/opendj3/src/main/docbkx/dev-guide/chap-reading.xml
@@ -146,6 +146,12 @@
connection.close();
}
}</programlisting>
+
+ <para>For a complete example in context, see <link
+ xlink:href="http://opendj.forgerock.org/opendj-ldap-sdk-examples/xref/org/forgerock/opendj/examples/SearchBind.html"
+ xlink:show="new">SearchBind.java</link>, one of the <link
+ xlink:href="http://opendj.forgerock.org/opendj-ldap-sdk-examples/"
+ xlink:show="new">OpenDJ LDAP SDK examples</link>.</para>
</section>
<section xml:id="basedn-and-scope">
@@ -420,6 +426,12 @@
returns a single entry, you can read the entry with the
<literal>searchSingleEntry()</literal> methods. If you have the distinguished
name, you can use <literal>readEntry()</literal> directly.</para>
+
+ <para>For a complete example in context, see <link
+ xlink:href="http://opendj.forgerock.org/opendj-ldap-sdk-examples/xref/org/forgerock/opendj/examples/Search.html"
+ xlink:show="new">Search.java</link>, one of the <link
+ xlink:href="http://opendj.forgerock.org/opendj-ldap-sdk-examples/"
+ xlink:show="new">OpenDJ LDAP SDK examples</link>.</para>
</section>
<section xml:id="get-search-results">
@@ -466,6 +478,12 @@
{
reader.close();
}</programlisting>
+
+ <para>For a complete example in context, see <link
+ xlink:href="http://opendj.forgerock.org/opendj-ldap-sdk-examples/xref/org/forgerock/opendj/examples/Search.html"
+ xlink:show="new">Search.java</link>, one of the <link
+ xlink:href="http://opendj.forgerock.org/opendj-ldap-sdk-examples/"
+ xlink:show="new">OpenDJ LDAP SDK examples</link>.</para>
</listitem>
<listitem>
@@ -534,6 +552,12 @@
// Do something with the objects.
// ...
</programlisting>
+
+ <para>For a complete example in context, see <link
+ xlink:href="http://opendj.forgerock.org/opendj-ldap-sdk-examples/xref/org/forgerock/opendj/examples/ParseAttributes.html"
+ xlink:show="new">ParseAttributes.java</link>, one of the <link
+ xlink:href="http://opendj.forgerock.org/opendj-ldap-sdk-examples/"
+ xlink:show="new">OpenDJ LDAP SDK examples</link>.</para>
</section>
<section xml:id="handle-ldap-urls">
diff --git a/opendj3/src/main/docbkx/dev-guide/chap-using-the-sdk.xml b/opendj3/src/main/docbkx/dev-guide/chap-using-the-sdk.xml
index 0328b72..5885646 100644
--- a/opendj3/src/main/docbkx/dev-guide/chap-using-the-sdk.xml
+++ b/opendj3/src/main/docbkx/dev-guide/chap-using-the-sdk.xml
@@ -74,6 +74,12 @@
}
</programlisting>
+ <para>For a complete example in context, see <link
+ xlink:href="http://opendj.forgerock.org/opendj-ldap-sdk-examples/xref/org/forgerock/opendj/examples/Search.html"
+ xlink:show="new">Search.java</link>, one of the <link
+ xlink:href="http://opendj.forgerock.org/opendj-ldap-sdk-examples/"
+ xlink:show="new">OpenDJ LDAP SDK examples</link>.</para>
+
<para>For asynchronous operations, your application passes a result handler
to <literal>LDAPConnectionFactory.getConnectionAsync()</literal> that
implements the <literal>ResultHandler<Connection></literal>
@@ -119,8 +125,13 @@
<para>Asynchronous methods are non-blocking, returning a
<literal>FutureResult</literal> whose <literal>get()</literal> method lets
you retrieve the result. Your application must coordinate concurrency when
- you use asynchronous operations. See <filename>SearchAsync.java</filename>
- for an example.</para>
+ you use asynchronous operations.</para>
+
+ <para>For a complete example in context, see <link
+ xlink:href="http://opendj.forgerock.org/opendj-ldap-sdk-examples/xref/org/forgerock/opendj/examples/SearchAsync.html"
+ xlink:show="new">SearchAsync.java</link>, one of the <link
+ xlink:href="http://opendj.forgerock.org/opendj-ldap-sdk-examples/"
+ xlink:show="new">OpenDJ LDAP SDK examples</link>.</para>
</section>
<section xml:id="error-handling">
diff --git a/opendj3/src/main/docbkx/dev-guide/chap-writing.xml b/opendj3/src/main/docbkx/dev-guide/chap-writing.xml
index 5533dae..6981ff8 100644
--- a/opendj3/src/main/docbkx/dev-guide/chap-writing.xml
+++ b/opendj3/src/main/docbkx/dev-guide/chap-writing.xml
@@ -34,6 +34,13 @@
<para>Modern directory servers like OpenDJ can handle a high load of write
requests, replicating changes quickly both on the LAN and over the WAN.</para>
+ <para>For a complete example corresponding to the excerpts shown below, see
+ <link
+ xlink:href="http://opendj.forgerock.org/opendj-ldap-sdk-examples/xref/org/forgerock/opendj/examples/ShortLife.html"
+ xlink:show="new">ShortLife.java</link>, one of the <link
+ xlink:href="http://opendj.forgerock.org/opendj-ldap-sdk-examples/"
+ xlink:show="new">OpenDJ LDAP SDK examples</link>.</para>
+
<section xml:id="about-writes">
<title>About Add, Modify, Rename, & Delete</title>
@@ -272,6 +279,9 @@
<para>If you must delete an entire branch of entries instead of a single
leaf entry, build a <literal>DeleteRequest</literal> that includes the
- <literal>SubtreeDeleteRequestControl</literal>.</para>
+ <literal>SubtreeDeleteRequestControl</literal>, as described in the
+ section, <link xlink:href="dev-guide#use-subtree-delete-control"
+ xlink:role="http://docbook.org/xlink/role/olink"><citetitle>Subtree Delete
+ Request Control</citetitle></link>.</para>
</section>
</chapter>
--
Gitblit v1.10.0