From 9f536723b58fa60ca21ed9e66c2eae6d8fa52177 Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Fri, 28 Jun 2013 11:39:08 +0000
Subject: [PATCH] Backport r9114
---
src/main/docbkx/admin-guide/chap-monitoring.xml | 12 ++++
src/main/docbkx/admin-guide/chap-rest-operations.xml | 4 +
src/main/docbkx/admin-guide/appendix-interface-stability.xml | 105 ++++++++++++++++++++++++++++++++++
src/main/docbkx/release-notes/chap-compatibility.xml | 17 +++++
4 files changed, 134 insertions(+), 4 deletions(-)
diff --git a/src/main/docbkx/admin-guide/appendix-interface-stability.xml b/src/main/docbkx/admin-guide/appendix-interface-stability.xml
index 4be83b6..ce534dc 100644
--- a/src/main/docbkx/admin-guide/appendix-interface-stability.xml
+++ b/src/main/docbkx/admin-guide/appendix-interface-stability.xml
@@ -32,6 +32,107 @@
<para>This appendix includes ForgeRock definitions for product release levels
and interface stability.</para>
- <xinclude:include href="../shared/sec-release-levels.xml" />
- <xinclude:include href="../shared/sec-interface-stability.xml" />
+ <itemizedlist>
+ <para>In addition to the indications concerning interface stability that
+ you find in the documentation, review the following information about OpenDJ
+ user and application programming interfaces.</para>
+
+ <listitem>
+ <para>Client tools — <command>ldap*</command>, <command>ldif*</command>,
+ and <command>*rate</command> commands — are Evolving.</para>
+ </listitem>
+
+ <listitem>
+ <para>The following classes, interfaces, and methods in the <link
+ xlink:show="new" xlink:href="${serverJavadocBase}">OpenDJ directory server
+ APIs</link> are Evolving.</para>
+
+ <itemizedlist>
+ <listitem><para><literal>org.forgerock.opendj.ldap.Connections#newInternalConnection</literal></para></listitem>
+ <listitem><para><literal>org.forgerock.opendj.ldap.Connections#newInternalConnectionFactory</literal></para></listitem>
+ <listitem><para><literal>org.forgerock.opendj.ldap.Connections#newServerConnectionFactory</literal></para></listitem>
+ <listitem><para><literal>org.forgerock.opendj.ldap.FutureResult</literal></para></listitem>
+ <listitem><para><literal>org.forgerock.opendj.ldap.LDAPClientContext</literal></para></listitem>
+ <listitem><para><literal>org.forgerock.opendj.ldap.LDAPListener</literal></para></listitem>
+ <listitem><para><literal>org.forgerock.opendj.ldap.LDAPListenerOptions</literal></para></listitem>
+ <listitem><para><literal>org.forgerock.opendj.ldap.MemoryBackend</literal></para></listitem>
+ <listitem><para><literal>org.forgerock.opendj.ldap.RequestContext</literal></para></listitem>
+ <listitem><para><literal>org.forgerock.opendj.ldap.RequestHandler</literal></para></listitem>
+ <listitem><para><literal>org.forgerock.opendj.ldap.RequestHandlerFactory</literal></para></listitem>
+ <listitem><para><literal>org.forgerock.opendj.ldap.ServerConnection</literal></para></listitem>
+ <listitem><para><literal>org.forgerock.opendj.ldap.ServerConnectionFactory</literal></para></listitem>
+ </itemizedlist>
+ </listitem>
+
+ <listitem>
+ <para>The following classes and interfaces in the <link xlink:show="new"
+ xlink:href="${sdkJavadocBase}">OpenDJ LDAP SDK APIs</link> are Evolving.</para>
+
+ <itemizedlist>
+ <listitem><para><literal>org.forgerock.opendj.ldap.ConnectionSecurityLayer</literal></para></listitem>
+ <listitem><para><literal>org.forgerock.opendj.ldap.LDAPUrl</literal></para></listitem>
+ <listitem><para><literal>org.forgerock.opendj.ldap.requests.BindRequest</literal>, including sub-types and especially SASL sub-types</para></listitem>
+ <listitem><para><literal>org.forgerock.opendj.ldap.schema.MatchingRuleImpl</literal></para></listitem>
+ <listitem><para><literal>org.forgerock.opendj.ldap.schema.SchemaValidationPolicy</literal></para></listitem>
+ <listitem><para><literal>org.forgerock.opendj.ldap.schema.SyntaxImpl</literal></para></listitem>
+ </itemizedlist>
+
+ <para>The following methods are Deprecated.</para>
+
+ <itemizedlist>
+ <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>
+
+ <para>The class <literal>org.forgerock.opendj.ldap.CoreMessages</literal> is
+ Internal.</para>
+ </listitem>
+
+ <listitem>
+ <para>For all Java APIs, <literal>com.*</literal> packages are Internal.</para>
+ </listitem>
+
+ <listitem>
+ <para>The configuration, user, and application programming interfaces for
+ RESTful access over HTTP to directory data are Evolving. This includes
+ interfaces exposed for the HTTP Connection Handler, its access log, and also
+ the REST LDAP gateway.</para>
+ </listitem>
+
+ <listitem>
+ <para>Text in log messages should be considered Internal. Log message IDs are
+ Evolving.</para>
+ </listitem>
+
+ <listitem>
+ <para>The default content of <literal>cn=schema</literal> (directory server
+ LDAP schema) is Evolving.</para>
+ </listitem>
+
+ <listitem>
+ <para>The monitoring interface <literal>cn=monitor</literal> for LDAP and
+ the monitoring interface exposed by the JMX Connection Handler are
+ Evolving.</para>
+ </listitem>
+
+ <listitem>
+ <para>Newly Deprecated and Removed interfaces are identified in the
+ <citetitle>Release Notes</citetitle> chapter, <link xlink:show="new"
+ xlink:href="release-notes#chap-compatibility"
+ xlink:role="http://docbook.org/xlink/role/olink"><citetitle>OpenDJ
+ Compatibility</citetitle></link>.</para>
+ </listitem>
+
+ <listitem>
+ <para>Interfaces that are not described in released product documentation
+ should be considered Internal/Undocumented. For example, the LDIF
+ representation of the server configuration, <filename>config.ldif</filename>,
+ should be considered Internal.</para>
+ </listitem>
+ </itemizedlist>
+
+ <xinclude:include href="../shared/sec-release-levels.xml" />
+ <xinclude:include href="../shared/sec-interface-stability.xml" />
</appendix>
diff --git a/src/main/docbkx/admin-guide/chap-monitoring.xml b/src/main/docbkx/admin-guide/chap-monitoring.xml
index b0b4b22..6032203 100644
--- a/src/main/docbkx/admin-guide/chap-monitoring.xml
+++ b/src/main/docbkx/admin-guide/chap-monitoring.xml
@@ -49,6 +49,10 @@
exposed. The following example shows monitoring information about the
<literal>userRoot</literal> backend holding Example.com data.</para>
+ <para>Interface stability: <link xlink:href="admin-guide#interface-stability"
+ xlink:show="new" xlink:role="http://docbook.org/xlink/role/olink"
+ >Evolving</link></para>
+
<screen>$ ldapsearch --port 1389 --baseDN cn=monitor "(cn=userRoot backend)"
dn: cn=userRoot backend,cn=Disk Space Monitor,cn=monitor
disk-state: normal
@@ -184,6 +188,10 @@
<command>dsconfig</command> command to configure the JMX connection
handler.</para>
+ <para>Interface stability: <link xlink:href="admin-guide#interface-stability"
+ xlink:show="new" xlink:role="http://docbook.org/xlink/role/olink"
+ >Evolving</link></para>
+
<screen>$ dsconfig
set-connection-handler-prop
--port 4444
@@ -345,6 +353,10 @@
>Microsoft's implementation</link> as well. The following default
fields are shown here in the order they occur in the log file.</para>
+ <para>Interface stability: <link xlink:href="admin-guide#interface-stability"
+ xlink:show="new" xlink:role="http://docbook.org/xlink/role/olink"
+ >Evolving</link></para>
+
<variablelist>
<varlistentry>
<term><literal>cs-host</literal></term>
diff --git a/src/main/docbkx/admin-guide/chap-rest-operations.xml b/src/main/docbkx/admin-guide/chap-rest-operations.xml
index 2ead5e3..f6deb60 100644
--- a/src/main/docbkx/admin-guide/chap-rest-operations.xml
+++ b/src/main/docbkx/admin-guide/chap-rest-operations.xml
@@ -44,6 +44,10 @@
xlink:role="http://docbook.org/xlink/role/olink"><citetitle>To Set Up REST
Access to OpenDJ Directory Server</citetitle></link>.</para>
+ <para>Interface stability: <link xlink:href="admin-guide#interface-stability"
+ xlink:show="new" xlink:role="http://docbook.org/xlink/role/olink"
+ >Evolving</link></para>
+
<section xml:id="understand-rest">
<title>Understanding the OpenDJ REST API</title>
diff --git a/src/main/docbkx/release-notes/chap-compatibility.xml b/src/main/docbkx/release-notes/chap-compatibility.xml
index c37aac4..24b3945 100644
--- a/src/main/docbkx/release-notes/chap-compatibility.xml
+++ b/src/main/docbkx/release-notes/chap-compatibility.xml
@@ -87,13 +87,26 @@
<para>OpenDJ <?eval ${docTargetVersion}?> makes use of new environment
variables aligned with the project name to use <literal>OPENDJ</literal>.
- Use of the old variables is deprecated. The old variables are likely to be
+ Use of the old variables is Deprecated. The old variables are likely to be
removed in a future release.</para>
+
+ <para>The <command>dsframework</command> command is Deprecated and likely
+ to be removed in a future release.</para>
+
+ <itemizedlist>
+ <para>The following OpenDJ LDAP SDK methods are Deprecated and likely to be
+ removed in a future release.</para>
+ <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>
</section>
<section xml:id="removed-functionality">
<title>Removed Functionality</title>
- <para>Native packages in SVR4 format for Solaris are no longer provided.</para>
+ <para>Native packages in SVR4 format for Solaris are no longer provided at
+ this time.</para>
</section>
</chapter>
--
Gitblit v1.10.0