Fix OPENDJ-1058 – HeartbeatConnectionFactory does not actively shutdown dea...

Matthew Swift

18.20.2013 3f6fbba325443b013aa525e80e1d859e44fdd34d

Fix OPENDJ-1058 – HeartbeatConnectionFactory does not actively shutdown dead connections

* update Rest2LDAP documentation due to new configuration options.

 opends/src/main/docbkx/admin-guide/appendix-interface-stability.xml

@@ -77,15 +77,21 @@
    <listitem><para><literal>org.forgerock.opendj.ldap.schema.SyntaxImpl</literal></para></listitem>
   </itemizedlist>

  </listitem>

  <listitem>
   <para>The following methods are Deprecated.</para>

   <itemizedlist>
    <listitem><para><literal>org.forgerock.opendj.ldap.Connections#newHeartBeatConnectionFactory</literal></para></listitem>
    <listitem><para><literal>org.forgerock.opendj.ldap.LDAPListenerOptions#getTCPNIOTransport</literal></para></listitem>
    <listitem><para><literal>org.forgerock.opendj.ldap.LDAPListenerOptions#setTCPNIOTransport</literal></para></listitem>
    <listitem><para><literal>org.forgerock.opendj.ldap.LDAPOptions#getTCPNIOTransport</literal></para></listitem>
    <listitem><para><literal>org.forgerock.opendj.ldap.LDAPOptions#setTCPNIOTransport</literal></para></listitem>
   </itemizedlist>
  </listitem>

  <listitem>
   <para>The class <literal>org.forgerock.opendj.ldap.CoreMessages</literal> is
   Internal.</para>
  </listitem>

 opends/src/main/docbkx/admin-guide/appendix-rest2ldap.xml

@@ -134,8 +134,10 @@
          <term>"heartBeatIntervalSeconds" (optional)</term>
          <listitem>
           <para>The gateway tests its connections every
           <literal>heartBeatIntervalSeconds</literal> seconds to detect whether
           the connection is still alive.</para>
           <literal>heartBeatIntervalSeconds</literal> to detect whether
           the connection is still alive. The first test is performed
           immediately when the gateway gets a connection. Subsequent tests
           follow every <literal>heartBeatIntervalSeconds</literal>.</para>

           <para>Default: 30 (seconds)</para>

@@ -144,6 +146,18 @@
         </varlistentry>

         <varlistentry>
          <term>"heartBeatTimeoutMilliSeconds" (optional)</term>
          <listitem>
          <para>When the gateway tests a connection, if the heartbeat does not come back after 
          <literal>heartBeatTimeoutMilliSeconds</literal> the connection is marked as closed.</para>

           <para>Default: 500 (milliseconds)</para>

           <programlisting language="javascript">"heartBeatTimeoutMilliSeconds": 500</programlisting>
          </listitem>
         </varlistentry>

         <varlistentry>
          <term>"fileBasedTrustManagerFile" (optional)</term>
          <listitem>
           <para>If "trustManager" is set to "file", then this setting