CR-3996 Fix for OPENDJ-1501: Publish 2.6.9 SDK javadoc

Mark Craig

10.41.2014 f6b20444ec2b43b6c4f8fb4ccd124aa87e6466fc

CR-3996 Fix for OPENDJ-1501: Publish 2.6.9 SDK javadoc

 src/main/docbkx/sdk-release-notes/chap-before-you-install.xml

New file
@@ -0,0 +1,63 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
  ! CCPL HEADER START
  !
  ! This work is licensed under the Creative Commons
  ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
  ! To view a copy of this license, visit
  ! http://creativecommons.org/licenses/by-nc-nd/3.0/
  ! or send a letter to Creative Commons, 444 Castro Street,
  ! Suite 900, Mountain View, California, 94041, USA.
  !
  ! You can also obtain a copy of the license at
  ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
  ! If applicable, add the following below this CCPL HEADER, with the fields
  ! enclosed by brackets "[]" replaced with your own identifying information:
  !      Portions Copyright [yyyy] [name of copyright owner]
  !
  ! CCPL HEADER END
  !
  !      Copyright 2014 ForgeRock AS
  !    
-->
<chapter xml:id='chap-before-you-install'
 xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
 xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
 xsi:schemaLocation='http://docbook.org/ns/docbook
                     http://docbook.org/xml/5.0/xsd/docbook.xsd'>
 <title>Before You Install OpenDJ LDAP SDK Software</title>

 <para>
  This chapter covers requirements to consider before you run OpenDJ LDAP SDK.
 </para>

 <section xml:id="prerequisites-java">
  <title>Java Environment</title>

  <para>
   OpenDJ LDAP SDK is a pure Java library.
   OpenDJ LDAP SDK therefore should run on any system with full Java support.
   OpenDJ software runs on a variety of operating systems,
   including but not limited to Solaris SPARC and x86,
   various Linux distributions,
   Microsoft Windows,
   and Apple Mac OS X.
  </para>
  
  <para>
   OpenDJ software requires Java 6 or 7,
   specifically at least the Java Standard Edition runtime environment.
   To build applications with OpenDJ LDAP SDK,
   you need the corresponding Java SDK.
  </para>

  <para>
   ForgeRock recommends that you keep your Java installation up to date
   with the latest security fixes.
  </para>
 </section>

</chapter>

 src/main/docbkx/sdk-release-notes/chap-compatibility.xml

New file
@@ -0,0 +1,72 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
  ! CCPL HEADER START
  !
  ! This work is licensed under the Creative Commons
  ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
  ! To view a copy of this license, visit
  ! http://creativecommons.org/licenses/by-nc-nd/3.0/
  ! or send a letter to Creative Commons, 444 Castro Street,
  ! Suite 900, Mountain View, California, 94041, USA.
  !
  ! You can also obtain a copy of the license at
  ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
  ! If applicable, add the following below this CCPL HEADER, with the fields
  ! enclosed by brackets "[]" replaced with your own identifying information:
  !      Portions Copyright [yyyy] [name of copyright owner]
  !
  ! CCPL HEADER END
  !
  !      Copyright 2014 ForgeRock AS
  !    
-->
<chapter xml:id='chap-compatibility'
 xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
 xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
 xsi:schemaLocation='http://docbook.org/ns/docbook
                     http://docbook.org/xml/5.0/xsd/docbook.xsd'
 xmlns:xlink='http://www.w3.org/1999/xlink'>
 <title>Compatibility</title>

 <para>
  This chapter covers major changes to existing APIs,
  and deprecated and removed APIs.
 </para>

 <section xml:id="changes">
  <title>Major Changes</title>

  <para>
   This maintenance release is binary-compatible with
   OpenDJ LDAP SDK ${docPreviousVersion}.
   It does not introduce major changes.
  </para>
 </section>

 <section xml:id="deprecation">
  <title>Deprecation</title>
  
  <para>
   Deprecated APIs are listed in the API Specification, on the
   <link
    xlink:show="new"
    xlink:href="${sdkJavadocBase}/index.html?deprecated-list.html"
   >Deprecated list</link> page.
  </para>

  <para>
   Deprecated APIs are likely to be removed in a future release.
  </para>
 </section>
 
 <section xml:id="removals">
  <title>Removals</title>

  <para>
   Nothing has been removed from the public APIs in this release.
  </para>
 </section>
</chapter>

 src/main/docbkx/sdk-release-notes/chap-feedback.xml

New file
@@ -0,0 +1,119 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
  ! CCPL HEADER START
  !
  ! This work is licensed under the Creative Commons
  ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
  ! To view a copy of this license, visit
  ! http://creativecommons.org/licenses/by-nc-nd/3.0/
  ! or send a letter to Creative Commons, 444 Castro Street,
  ! Suite 900, Mountain View, California, 94041, USA.
  !
  ! You can also obtain a copy of the license at
  ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
  ! If applicable, add the following below this CCPL HEADER, with the fields
  ! enclosed by brackets "[]" replaced with your own identifying information:
  !      Portions Copyright [yyyy] [name of copyright owner]
  !
  ! CCPL HEADER END
  !
  !      Copyright 2014 ForgeRock AS
  !    
-->
<chapter xml:id='chap-feedback'
 xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
 xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
 xsi:schemaLocation='http://docbook.org/ns/docbook
                     http://docbook.org/xml/5.0/xsd/docbook.xsd'
 xmlns:xlink='http://www.w3.org/1999/xlink'>
 <title>How to Report Problems &amp; Provide Feedback</title>

 <para>
  If you have questions regarding OpenDJ LDAP SDK
  that are not answered by the documentation,
  there is a mailing list which can be found at
  <link xlink:href="https://lists.forgerock.org/mailman/listinfo/opendj" xlink:show="new" />
  where you are likely to find an answer.
 </para>

 <para>
  If you have found issues or reproducible bugs
  within this release of OpenDJ LDAP SDK, report them in the
  <link
   xlink:show="new"
   xlink:href="https://bugster.forgerock.org/jira/browse/OPENDJ"
   >OpenDJ issue tracker</link>.
 </para>

 <para>
  When requesting help with a problem, please include the following information:
 </para>

 <itemizedlist>
  <listitem>
   <para>
    Description of the problem, including when the problem occurs
    and its impact on your operation
   </para>
  </listitem>

  <listitem>
   <itemizedlist>
    <para>
     Description of the environment, including the following information:
    </para>

    <listitem>
     <para>
      Machine type
     </para>
    </listitem>

    <listitem>
     <para>
      Operating system &amp; version
     </para>
    </listitem>

    <listitem>
     <para>
      Storage type &amp; version
     </para>
    </listitem>

    <listitem>
     <para>
      Java version
     </para>
    </listitem>

    <listitem>
     <para>
      OpenDJ LDAP SDK release version
     </para>
    </listitem>

    <listitem>
     <para>
      Any patches or other software that might be affecting the problem
     </para>
    </listitem>
   </itemizedlist>
  </listitem>

  <listitem>
   <para>
    Steps to reproduce the problem
   </para>
  </listitem>

  <listitem>
   <para>
    Any relevant access and error logs, and stack traces
   </para>
  </listitem>
 </itemizedlist>
</chapter>

 src/main/docbkx/sdk-release-notes/chap-get-sdk.xml

New file
@@ -0,0 +1,51 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
  ! CCPL HEADER START
  !
  ! This work is licensed under the Creative Commons
  ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
  ! To view a copy of this license, visit
  ! http://creativecommons.org/licenses/by-nc-nd/3.0/
  ! or send a letter to Creative Commons, 444 Castro Street,
  ! Suite 900, Mountain View, California, 94041, USA.
  !
  ! You can also obtain a copy of the license at
  ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
  ! If applicable, add the following below this CCPL HEADER, with the fields
  ! enclosed by brackets "[]" replaced with your own identifying information:
  !      Portions Copyright [yyyy] [name of copyright owner]
  !
  ! CCPL HEADER END
  !
  !      Copyright 2014 ForgeRock AS
  !    
-->
<chapter xml:id='chap-get-sdk'
 xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
 xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
 xsi:schemaLocation='http://docbook.org/ns/docbook
                     http://docbook.org/xml/5.0/xsd/docbook.xsd'
 xmlns:xinclude='http://www.w3.org/2001/XInclude'
 xmlns:xlink='http://www.w3.org/1999/xlink'>
 <title>Getting OpenDJ LDAP SDK</title>

 <para>
  OpenDJ LDAP SDK is available from the ForgeRock repository,
  <link xlink:show="new" xlink:href="http://maven.forgerock.org/repo/" />.
 </para>

 <para>
  To include OpenDJ LDAP SDK as a Maven dependency,
  include the ForgeRock repository in your list,
  and include the SDK as a dependency.
 </para>

 <programlisting language="xml">
<xinclude:include href="resources/maven-xml.txt" parse="text">
 <xinclude:fallback>Failed to include Maven POM sections</xinclude:fallback>
</xinclude:include>
 </programlisting>
</chapter>

 src/main/docbkx/sdk-release-notes/chap-issues.xml

New file
@@ -0,0 +1,72 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
  ! CCPL HEADER START
  !
  ! This work is licensed under the Creative Commons
  ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
  ! To view a copy of this license, visit
  ! http://creativecommons.org/licenses/by-nc-nd/3.0/
  ! or send a letter to Creative Commons, 444 Castro Street,
  ! Suite 900, Mountain View, California, 94041, USA.
  !
  ! You can also obtain a copy of the license at
  ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
  ! If applicable, add the following below this CCPL HEADER, with the fields
  ! enclosed by brackets "[]" replaced with your own identifying information:
  !      Portions Copyright [yyyy] [name of copyright owner]
  !
  ! CCPL HEADER END
  !
  !      Copyright 2014 ForgeRock AS
  !    
-->
<chapter xml:id='chap-issues'
 xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
 xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
 xsi:schemaLocation='http://docbook.org/ns/docbook
                     http://docbook.org/xml/5.0/xsd/docbook.xsd'
 xmlns:xlink='http://www.w3.org/1999/xlink'>
 <title>OpenDJ LDAP SDK Fixes, Limitations, &amp; Known Issues</title>

 <para>
  This chapter covers the status of key issues and limitations
  for this version of OpenDJ LDAP SDK.
  For detailed information regarding a particular issue, see the
  <link
   xlink:show="new"
   xlink:href="https://bugster.forgerock.org/jira/browse/OPENDJ"
   >OpenDJ issue tracker</link>.
 </para>

 <section xml:id="fixes">
  <title>Key Fixes</title>

  <para>
   The following bugs were fixed in this release.
  </para>

  <para>TODO</para><!-- https://github.com/markcraig/release-notes-list-builder -->
 </section>

 <section xml:id="limitations">
  <title>Limitations</title>

  <para>
   No limitations are noted for this release.
  </para>
 </section>

 <section xml:id="known-issues">
  <title>Known Issues</title>

  <para>
   The following important issues remained open
   at the time this release became available.
  </para>

  <para>TODO</para><!-- https://github.com/markcraig/release-notes-list-builder -->
 </section>
</chapter>

 src/main/docbkx/sdk-release-notes/chap-support.xml

New file
@@ -0,0 +1,48 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
  ! CCPL HEADER START
  !
  ! This work is licensed under the Creative Commons
  ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
  ! To view a copy of this license, visit
  ! http://creativecommons.org/licenses/by-nc-nd/3.0/
  ! or send a letter to Creative Commons, 444 Castro Street,
  ! Suite 900, Mountain View, California, 94041, USA.
  !
  ! You can also obtain a copy of the license at
  ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
  ! If applicable, add the following below this CCPL HEADER, with the fields
  ! enclosed by brackets "[]" replaced with your own identifying information:
  !      Portions Copyright [yyyy] [name of copyright owner]
  !
  ! CCPL HEADER END
  !
  !      Copyright 2014 ForgeRock AS
  !    
-->
<chapter xml:id='chap-support'
 xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
 xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
 xsi:schemaLocation='http://docbook.org/ns/docbook
                     http://docbook.org/xml/5.0/xsd/docbook.xsd'
 xmlns:xlink='http://www.w3.org/1999/xlink'>
 <title>Support</title>

 <para>
  You can purchase OpenDJ LDAP SDK support subscriptions from ForgeRock
  and from consulting partners around the world and in your area.
 </para>

 <para>
  To contact ForgeRock, send mail to
  <link xlink:href='mailto:info@forgerock.com'>info@forgerock.com</link>.
 </para>

 <para>
  To find a partner in your area, see
  <link xlink:show="new" xlink:href="http://forgerock.com/partners/find-a-partner/" />.
 </para>
</chapter>

 src/main/docbkx/sdk-release-notes/chap-whats-new.xml

New file
@@ -0,0 +1,39 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
  ! CCPL HEADER START
  !
  ! This work is licensed under the Creative Commons
  ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
  ! To view a copy of this license, visit
  ! http://creativecommons.org/licenses/by-nc-nd/3.0/
  ! or send a letter to Creative Commons, 444 Castro Street,
  ! Suite 900, Mountain View, California, 94041, USA.
  !
  ! You can also obtain a copy of the license at
  ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
  ! If applicable, add the following below this CCPL HEADER, with the fields
  ! enclosed by brackets "[]" replaced with your own identifying information:
  !      Portions Copyright [yyyy] [name of copyright owner]
  !
  ! CCPL HEADER END
  !
  !      Copyright 2014 ForgeRock AS
  !    
-->
<chapter xml:id='chap-whats-new'
  xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
  xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
  xsi:schemaLocation='http://docbook.org/ns/docbook
                      http://docbook.org/xml/5.0/xsd/docbook.xsd'
  xmlns:xlink='http://www.w3.org/1999/xlink'>
  <title>What's New in OpenDJ LDAP SDK ${sdkDocTargetVersion}</title>

  <para>
   This release provides the following new features and enhancements.
  </para>
  
  <para>TODO</para><!-- https://github.com/markcraig/release-notes-list-builder -->
</chapter>

 src/main/docbkx/sdk-release-notes/index.xml

New file
@@ -0,0 +1,100 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
  ! CCPL HEADER START
  !
  ! This work is licensed under the Creative Commons
  ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
  ! To view a copy of this license, visit
  ! http://creativecommons.org/licenses/by-nc-nd/3.0/
  ! or send a letter to Creative Commons, 444 Castro Street,
  ! Suite 900, Mountain View, California, 94041, USA.
  !
  ! You can also obtain a copy of the license at
  ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
  ! If applicable, add the following below this CCPL HEADER, with the fields
  ! enclosed by brackets "[]" replaced with your own identifying information:
  !      Portions Copyright [yyyy] [name of copyright owner]
  !
  ! CCPL HEADER END
  !
  !      Copyright 2014 ForgeRock AS
  !    
-->
<book xml:id='release-notes'
 xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
 xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
 xsi:schemaLocation='http://docbook.org/ns/docbook
                     http://docbook.org/xml/5.0/xsd/docbook.xsd'
 xmlns:xinclude='http://www.w3.org/2001/XInclude'
 xmlns:xlink='http://www.w3.org/1999/xlink'>
 <info>
  <xinclude:include href="../shared/mediaobject-fr-logo.xml" />
  <title>OpenDJ LDAP SDK Release Notes</title>
  <subtitle>Version ${sdkDocTargetVersion}</subtitle>
  <abstract>
   <para>
    Notes covering OpenDJ LDAP SDK software requirements, fixes, known issues.
    The OpenDJ project offers open source LDAP directory services in Java.
   </para>
  </abstract>
  <copyright>
   <year>2014</year>
   <holder>ForgeRock AS</holder>
  </copyright>
  <authorgroup>
   <author>
    <personname><firstname>Mark </firstname><surname>Craig</surname></personname>
   </author>
   <author>
    <personname><firstname>Chris </firstname><surname>Ridd</surname></personname>
    <xinclude:include href="../shared/affiliation-fr.xml"/>
   </author>
  </authorgroup>
  <xinclude:include href='../legal.xml' />
  <date>${publicationDate}</date>
  <pubdate>${publicationDate}</pubdate>
  <releaseinfo>${softwareReleaseDate}</releaseinfo>
 </info>

 <toc />

 <preface xml:id="preface">
  <title>Preface</title>

  <para>
   OpenDJ LDAP SDK provides a set of modern, developer-friendly Java APIs
   as part of the OpenDJ product suite.
   The product suite includes the client SDK
   alongside command-line tools and sample code,
   a 100% pure Java directory server, and more.
   You can use OpenDJ LDAP SDK to create client applications
   for use with any server that complies with the
   <citetitle>Lightweight Directory Access Protocol (LDAP):
    Technical Specification Road Map</citetitle>,
   <link
    xlink:href="http://tools.ietf.org/html/rfc4510"
    xlink:show="new"
   >RFC 4510</link>.
  </para>

  <para>
   OpenDJ LDAP SDK brings you easy-to-use connection management,
   connection pooling, load balancing, and all the standard LDAP operations
   to read and write directory entries.
   OpenDJ LDAP SDK also lets you build applications with capabilities
   defined in additional draft and experimental RFCs
   that are supported by modern LDAP servers.
  </para>
 </preface>

 <xinclude:include href='chap-get-sdk.xml' />
 <xinclude:include href='chap-whats-new.xml' />
 <xinclude:include href='chap-before-you-install.xml' />
 <xinclude:include href='chap-compatibility.xml' />
 <xinclude:include href='chap-issues.xml' />
 <xinclude:include href='chap-feedback.xml' />
 <xinclude:include href='chap-support.xml' />
</book>

 src/main/docbkx/sdk-release-notes/resources/maven-xml.txt

New file
@@ -0,0 +1,33 @@
<repositories>
  <repository>
    <id>forgerock-staging-repository</id>
    <name>ForgeRock Release Repository</name>
    <url>http://maven.forgerock.org/repo/releases</url>
    <snapshots>
      <enabled>false</enabled>
    </snapshots>
  </repository>
  <repository>
    <id>forgerock-snapshots-repository</id>
    <name>ForgeRock Snapshot Repository</name>
    <url>http://maven.forgerock.org/repo/snapshots</url>
    <releases>
      <enabled>false</enabled>
    </releases>
  </repository>
</repositories>

...

<dependencies>
  <dependency>
    <groupId>org.forgerock.opendj</groupId>
    <artifactId>opendj-core</artifactId>
    <version>${sdkDocTargetVersion}</version>
  </dependency>
  <dependency>
    <groupId>org.forgerock.opendj</groupId>
    <artifactId>opendj-grizzly</artifactId>
    <version>${sdkDocTargetVersion}</version>
  </dependency>
</dependencies>