From e9237b05764f5b9062635a363c7d6675e84e4d38 Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Thu, 10 Jul 2014 10:49:55 +0000
Subject: [PATCH] Backport CR-3996 Fix for OPENDJ-1501: Publish 2.6.9 SDK javadoc
---
src/main/docbkx/dev-guide/index.xml | 19
src/main/docbkx/sdk-release-notes/chap-get-sdk.xml | 51 +++
src/main/docbkx/sdk-release-notes/chap-feedback.xml | 119 +++++++++
src/main/docbkx/sdk-release-notes/resources/maven-xml.txt | 28 ++
src/main/docbkx/sdk-release-notes/chap-whats-new.xml | 39 +++
src/main/docbkx/sdk-release-notes/chap-compatibility.xml | 72 +++++
src/main/docbkx/sdk-release-notes/index.xml | 100 +++++++
pom.xml | 48 ++-
src/main/docbkx/admin-guide/index.xml | 19
src/main/docbkx/shared/mediaobject-fr-logo.xml | 10
src/main/docbkx/sdk-release-notes/chap-issues.xml | 72 +++++
src/main/docbkx/install-guide/index.xml | 21
src/main/docbkx/sdk-release-notes/chap-support.xml | 48 +++
src/main/docbkx/shared/images/forgerock-opendj-logo.png | 0
src/main/docbkx/sdk-release-notes/chap-before-you-install.xml | 63 ++++
src/main/docbkx/release-notes/index.xml | 7
src/main/docbkx/shared/affiliation-fr.xml | 17 +
17 files changed, 685 insertions(+), 48 deletions(-)
diff --git a/pom.xml b/pom.xml
index d1348b0..5f46298 100644
--- a/pom.xml
+++ b/pom.xml
@@ -98,17 +98,9 @@
<module>opendj-server2x-adapter</module>
</modules>
<properties>
- <currentSDKversion>${project.version}</currentSDKversion>
- <stableSDKversion>version.not.defined</stableSDKversion>
- <currentServerVersion>2.6.0</currentServerVersion>
- <stableServerVersion>2.6.0</stableServerVersion>
- <docTargetVersion>2.6.1</docTargetVersion>
- <sdkDocTargetVersion>2.6.7</sdkDocTargetVersion>
- <siteDistributionURL>scp://forgerock.org/var/www/vhosts/opendj.forgerock.org/httpdocs</siteDistributionURL>
- <i18nFrameworkVersion>1.4.0</i18nFrameworkVersion>
<grizzlyFrameworkVersion>2.3.14</grizzlyFrameworkVersion>
<forgerockRestVersion>2.0.2</forgerockRestVersion>
- <gaId>UA-23412190-8</gaId>
+ <i18nFrameworkVersion>1.4.0</i18nFrameworkVersion>
<!-- OSGi bundles properties -->
<opendj.osgi.import.additional />
<!--
@@ -121,24 +113,36 @@
${opendj.osgi.import.additional},
*
</opendj.osgi.import>
- <!--
- Release date and publication date are set at release build time.
- -D"releaseDate=Software release date: January 1, 1970"
- -D"pubDate=Publication date: December 31, 1969"
- At all other times, the dates should be empty.
- -->
- <releaseDate />
- <softwareReleaseDate>${releaseDate}</softwareReleaseDate>
- <pubDate />
- <publicationDate>${pubDate}</publicationDate>
+
<checkstyleHeaderLocation>org/forgerock/checkstyle/opendj-java-header</checkstyleHeaderLocation>
- <frDocPluginVersion>2.0.0</frDocPluginVersion>
+
+ <!-- START Documentation properties -->
+ <docTargetVersion>${project.version}</docTargetVersion><!-- Reset before final publication -->
+ <docPreviousVersion>2.6.0</docPreviousVersion>
+ <sdkDocTargetVersion>${docTargetVersion}</sdkDocTargetVersion>
+
+ <frDocPluginVersion>2.1.3</frDocPluginVersion>
+ <gaId>UA-23412190-8</gaId>
+
+ <siteDistributionURL>scp://forgerock.org/var/www/vhosts/opendj.forgerock.org/httpdocs</siteDistributionURL>
+
+ <!--
+ Release date and publication date are set at release build time.
+ -D"releaseDate=Software release date: January 1, 1970"
+ -D"pubDate=Publication date: December 31, 1969"
+ At all other times, the dates should be empty.
+ -->
+ <releaseDate/>
+ <softwareReleaseDate>${releaseDate}</softwareReleaseDate>
+ <pubDate/>
+ <publicationDate>${pubDate}</publicationDate>
<!-- Permit doc build to override relative locations of non DocBook content -->
+ <coreDocBase>http://opendj.forgerock.org/doc/</coreDocBase>
<configRefBase>http://docs.forgerock.org/en/opendj/2.6.0/configref/</configRefBase>
<serverJavadocBase>http://docs.forgerock.org/en/opendj/2.6.0/javadoc/</serverJavadocBase>
<sdkJavadocBase>http://docs.forgerock.org/en/opendj/2.6.0/javadoc/</sdkJavadocBase>
-
+ <!-- END Documentation properties -->
</properties>
<build>
<plugins>
@@ -177,6 +181,8 @@
<inherited>false</inherited>
<configuration>
<projectName>OpenDJ</projectName>
+ <projectVersion>${docTargetVersion}</projectVersion>
+ <latestJson>http://docs.forgerock.org/latest.json</latestJson>
<googleAnalyticsId>${gaId}</googleAnalyticsId>
</configuration>
<executions>
diff --git a/src/main/docbkx/admin-guide/index.xml b/src/main/docbkx/admin-guide/index.xml
index fc86958..cc280db 100644
--- a/src/main/docbkx/admin-guide/index.xml
+++ b/src/main/docbkx/admin-guide/index.xml
@@ -29,7 +29,9 @@
xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
xmlns:xinclude='http://www.w3.org/2001/XInclude'>
<info>
- <title>OpenDJ <?eval ${docTargetVersion}?> Administration Guide</title>
+ <xinclude:include href="../shared/mediaobject-fr-logo.xml" />
+ <title>OpenDJ Administration Guide</title>
+ <subtitle>Version ${docTargetVersion}</subtitle>
<abstract>
<para>Hands-on guide to configuring and using OpenDJ features. The OpenDJ
project offers open source LDAP directory services in Java.</para>
@@ -40,22 +42,23 @@
</copyright>
<authorgroup>
<author>
- <personname><firstname>Mark</firstname><surname>Craig</surname></personname>
+ <personname><firstname>Mark </firstname><surname>Craig</surname></personname>
</author>
<author>
- <personname><firstname>Nemanja</firstname><surname>Lukić</surname></personname>
+ <personname><firstname>Nemanja </firstname><surname>Lukić</surname></personname>
</author>
<author>
- <personname><firstname>Ludovic</firstname><surname>Poitou</surname></personname>
+ <personname><firstname>Ludovic </firstname><surname>Poitou</surname></personname>
</author>
<author>
- <personname><firstname>Chris</firstname><surname>Ridd</surname></personname>
+ <personname><firstname>Chris </firstname><surname>Ridd</surname></personname>
+ <xinclude:include href="../shared/affiliation-fr.xml"/>
</author>
</authorgroup>
<xinclude:include href='../legal.xml' />
- <date><?dbtimestamp format="B d, Y"?></date>
- <pubdate>Publication date: <?dbtimestamp format="B d, Y"?></pubdate>
- <releaseinfo><?eval ${softwareReleaseDate}?></releaseinfo>
+ <date>${publicationDate}</date>
+ <pubdate>${publicationDate}</pubdate>
+ <releaseinfo>${softwareReleaseDate}</releaseinfo>
</info>
<toc />
diff --git a/src/main/docbkx/dev-guide/index.xml b/src/main/docbkx/dev-guide/index.xml
index 58a9f3f..b717baa 100644
--- a/src/main/docbkx/dev-guide/index.xml
+++ b/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'
@@ -30,27 +30,30 @@
xmlns:xlink='http://www.w3.org/1999/xlink'
xmlns:xinclude='http://www.w3.org/2001/XInclude'>
<info>
- <title>OpenDJ <?eval ${sdkDocTargetVersion}?> SDK Developer's Guide</title>
+ <xinclude:include href="../shared/mediaobject-fr-logo.xml" />
+ <title>OpenDJ SDK Developer's Guide</title>
+ <subtitle>Version ${sdkDocTargetVersion}</subtitle>
<abstract>
<para>Hands-on guide to developing applications with the OpenDJ SDK. The
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>
<author>
- <personname><firstname>Mark</firstname><surname>Craig</surname></personname>
+ <personname><firstname>Mark </firstname><surname>Craig</surname></personname>
</author>
<author>
- <personname><firstname>Ludovic</firstname><surname>Poitou</surname></personname>
+ <personname><firstname>Ludovic </firstname><surname>Poitou</surname></personname>
+ <xinclude:include href="../shared/affiliation-fr.xml"/>
</author>
</authorgroup>
<xinclude:include href='../legal.xml' />
- <date><?dbtimestamp format="B d, Y"?></date>
- <pubdate>Publication date: <?dbtimestamp format="B d, Y"?></pubdate>
- <releaseinfo><?eval ${softwareReleaseDate}?></releaseinfo>
+ <date>${publicationDate}</date>
+ <pubdate>${publicationDate}</pubdate>
+ <releaseinfo>${softwareReleaseDate}</releaseinfo>
</info>
<toc />
diff --git a/src/main/docbkx/install-guide/index.xml b/src/main/docbkx/install-guide/index.xml
index 84639e9..a1bc761 100644
--- a/src/main/docbkx/install-guide/index.xml
+++ b/src/main/docbkx/install-guide/index.xml
@@ -20,34 +20,37 @@
!
! CCPL HEADER END
!
- ! Copyright 2011-2013 ForgeRock AS
+ ! Copyright 2011-2014 ForgeRock AS
!
-->
<book xml:id='install-guide'
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'
+ xsi:schemaLocation='http://docbook.org/ns/docbook
+ http://docbook.org/xml/5.0/xsd/docbook.xsd'
xmlns:xinclude='http://www.w3.org/2001/XInclude'>
<info>
- <title>OpenDJ <?eval ${docTargetVersion}?> Installation Guide</title>
+ <xinclude:include href="../shared/mediaobject-fr-logo.xml" />
+ <title>OpenDJ Installation Guide</title>
+ <subtitle>Version ${docTargetVersion}</subtitle>
<abstract>
<para>This guide shows you how to install OpenDJ directory services. The
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>
<author>
- <personname><firstname>Mark</firstname><surname>Craig</surname></personname>
+ <personname><firstname>Mark </firstname><surname>Craig</surname></personname>
+ <xinclude:include href="../shared/affiliation-fr.xml"/>
</author>
</authorgroup>
<xinclude:include href='../legal.xml' />
- <date><?dbtimestamp format="B d, Y"?></date>
- <pubdate>Publication date: <?dbtimestamp format="B d, Y"?></pubdate>
- <releaseinfo><?eval ${softwareReleaseDate}?></releaseinfo>
+ <date>${publicationDate}</date>
+ <pubdate>${publicationDate}</pubdate>
+ <releaseinfo>${softwareReleaseDate}</releaseinfo>
</info>
<toc />
diff --git a/src/main/docbkx/release-notes/index.xml b/src/main/docbkx/release-notes/index.xml
index a96fc2c..2f559cb 100644
--- a/src/main/docbkx/release-notes/index.xml
+++ b/src/main/docbkx/release-notes/index.xml
@@ -31,7 +31,9 @@
xmlns:xlink='http://www.w3.org/1999/xlink'
xmlns:xinclude='http://www.w3.org/2001/XInclude'>
<info>
- <title>OpenDJ <?eval ${docTargetVersion}?> Release Notes</title>
+ <xinclude:include href="../shared/mediaobject-fr-logo.xml" />
+ <title>OpenDJ Release Notes</title>
+ <subtitle>Version ${docTargetVersion}</subtitle>
<abstract>
<para>Notes covering OpenDJ hardware & software requirements, fixes,
known issues. The OpenDJ project offers open source LDAP directory services
@@ -43,7 +45,8 @@
</copyright>
<authorgroup>
<author>
- <personname><firstname>Mark</firstname><surname>Craig</surname></personname>
+ <personname><firstname>Mark </firstname><surname>Craig</surname></personname>
+ <xinclude:include href="../shared/affiliation-fr.xml"/>
</author>
</authorgroup>
<xinclude:include href='../legal.xml' />
diff --git a/src/main/docbkx/sdk-release-notes/chap-before-you-install.xml b/src/main/docbkx/sdk-release-notes/chap-before-you-install.xml
new file mode 100644
index 0000000..631d54c
--- /dev/null
+++ b/src/main/docbkx/sdk-release-notes/chap-before-you-install.xml
@@ -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>
diff --git a/src/main/docbkx/sdk-release-notes/chap-compatibility.xml b/src/main/docbkx/sdk-release-notes/chap-compatibility.xml
new file mode 100644
index 0000000..fdedf47
--- /dev/null
+++ b/src/main/docbkx/sdk-release-notes/chap-compatibility.xml
@@ -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>
diff --git a/src/main/docbkx/sdk-release-notes/chap-feedback.xml b/src/main/docbkx/sdk-release-notes/chap-feedback.xml
new file mode 100644
index 0000000..26522fb
--- /dev/null
+++ b/src/main/docbkx/sdk-release-notes/chap-feedback.xml
@@ -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 & 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 & version
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Storage type & 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>
diff --git a/src/main/docbkx/sdk-release-notes/chap-get-sdk.xml b/src/main/docbkx/sdk-release-notes/chap-get-sdk.xml
new file mode 100644
index 0000000..2c9b81f
--- /dev/null
+++ b/src/main/docbkx/sdk-release-notes/chap-get-sdk.xml
@@ -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>
diff --git a/src/main/docbkx/sdk-release-notes/chap-issues.xml b/src/main/docbkx/sdk-release-notes/chap-issues.xml
new file mode 100644
index 0000000..30681b8
--- /dev/null
+++ b/src/main/docbkx/sdk-release-notes/chap-issues.xml
@@ -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, & 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>
diff --git a/src/main/docbkx/sdk-release-notes/chap-support.xml b/src/main/docbkx/sdk-release-notes/chap-support.xml
new file mode 100644
index 0000000..58ddce2
--- /dev/null
+++ b/src/main/docbkx/sdk-release-notes/chap-support.xml
@@ -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>
diff --git a/src/main/docbkx/sdk-release-notes/chap-whats-new.xml b/src/main/docbkx/sdk-release-notes/chap-whats-new.xml
new file mode 100644
index 0000000..d5b25c0
--- /dev/null
+++ b/src/main/docbkx/sdk-release-notes/chap-whats-new.xml
@@ -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>
diff --git a/src/main/docbkx/sdk-release-notes/index.xml b/src/main/docbkx/sdk-release-notes/index.xml
new file mode 100644
index 0000000..9d7e7d4
--- /dev/null
+++ b/src/main/docbkx/sdk-release-notes/index.xml
@@ -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>
diff --git a/src/main/docbkx/sdk-release-notes/resources/maven-xml.txt b/src/main/docbkx/sdk-release-notes/resources/maven-xml.txt
new file mode 100644
index 0000000..f20a6e7
--- /dev/null
+++ b/src/main/docbkx/sdk-release-notes/resources/maven-xml.txt
@@ -0,0 +1,28 @@
+<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-ldap-sdk</artifactId>
+ <version>${sdkDocTargetVersion}</version>
+ </dependency>
+</dependencies>
diff --git a/src/main/docbkx/shared/affiliation-fr.xml b/src/main/docbkx/shared/affiliation-fr.xml
new file mode 100644
index 0000000..a3864e6
--- /dev/null
+++ b/src/main/docbkx/shared/affiliation-fr.xml
@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<affiliation 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'
+ xmlns:xinclude='http://www.w3.org/2001/XInclude'>
+
+ <orgname>ForgeRock AS</orgname>
+ <address>
+ <street>33 New Montgomery St.</street>
+ <otheraddr>Suite 1500</otheraddr>
+ <city>San Francisco</city>, <state>CA</state> <postcode>94105</postcode>
+ <country>USA</country>
+ <phone>+1 415-523-0772</phone>
+ <uri>www.forgerock.com</uri>
+ </address>
+</affiliation>
\ No newline at end of file
diff --git a/src/main/docbkx/shared/images/forgerock-opendj-logo.png b/src/main/docbkx/shared/images/forgerock-opendj-logo.png
new file mode 100644
index 0000000..ee4aaf8
--- /dev/null
+++ b/src/main/docbkx/shared/images/forgerock-opendj-logo.png
Binary files differ
diff --git a/src/main/docbkx/shared/mediaobject-fr-logo.xml b/src/main/docbkx/shared/mediaobject-fr-logo.xml
new file mode 100644
index 0000000..f455105
--- /dev/null
+++ b/src/main/docbkx/shared/mediaobject-fr-logo.xml
@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<mediaobject 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'
+ xmlns:xinclude='http://www.w3.org/2001/XInclude'>
+ <imageobject>
+ <imagedata fileref="images/forgerock-opendj-logo.png" role="top"/>
+ </imageobject>
+</mediaobject>
--
Gitblit v1.10.0