CR-2852 Fix for OPENDJ-1274: SDK documentation should warn users about poss...

Mark Craig

25.38.2014 82ca8a118e5b57f670582400ae1e42cb21a7adb4

CR-2852 Fix for OPENDJ-1274: SDK documentation should warn users about possible problems when not using HBCF

 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">

 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>