From 61534a58a104850a103f1d3617aebf33faba2547 Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Sat, 25 Jan 2014 16:38:09 +0000
Subject: [PATCH] CR-2852 Fix for OPENDJ-1274: SDK documentation should warn users about possible problems when not using HBCF
---
opendj-sdk/src/main/docbkx/dev-guide/chap-best-practices.xml | 14 ++++++++++++++
opendj-sdk/src/main/docbkx/dev-guide/index.xml | 4 ++--
2 files changed, 16 insertions(+), 2 deletions(-)
diff --git a/opendj-sdk/src/main/docbkx/dev-guide/chap-best-practices.xml b/opendj-sdk/src/main/docbkx/dev-guide/chap-best-practices.xml
index c4bfe5b..e9fe9b0 100644
--- a/opendj-sdk/src/main/docbkx/dev-guide/chap-best-practices.xml
+++ b/opendj-sdk/src/main/docbkx/dev-guide/chap-best-practices.xml
@@ -106,6 +106,20 @@
<literal>Connections.newHeartBeatConnectionFactory()</literal> methods to
ensure your <literal>ConnectionFactory</literal> serves connections that
are periodically checked to detect whether they are still alive.</para>
+
+ <para>
+ When you do not use a heart beat connection factory,
+ or when you wrap an authenticated connection factory
+ with a heart beat connection factory,
+ it is possible for the first bind request to hang indefinitely.
+ Bind operations do not have control over the client side timeout
+ when you use the synchronous API.
+ In such cases you can use <literal>LDAPOptions.setTimeout()</literal>
+ when creating the <literal>LDAPConnectionFactory</literal>
+ to configure a request timeout for all operations.
+ Take care not to set the timeout so low that long operations
+ such as unindexed searches fail to complete before the timeout.
+ </para>
</section>
<section xml:id="request-what-you-need-all-at-once">
diff --git a/opendj-sdk/src/main/docbkx/dev-guide/index.xml b/opendj-sdk/src/main/docbkx/dev-guide/index.xml
index d7cba07..fa0dd49 100644
--- a/opendj-sdk/src/main/docbkx/dev-guide/index.xml
+++ b/opendj-sdk/src/main/docbkx/dev-guide/index.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011-2013 ForgeRock AS
+ ! Copyright 2011-2014 ForgeRock AS
!
-->
<book xml:id='dev-guide'
@@ -36,7 +36,7 @@
OpenDJ project offers open source LDAP directory services in Java.</para>
</abstract>
<copyright>
- <year>2011-2013</year>
+ <year>2011-2014</year>
<holder>ForgeRock AS</holder>
</copyright>
<authorgroup>
--
Gitblit v1.10.0