<?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.
|
!
|
! 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 2013 ForgeRock AS
|
!
|
-->
|
<appendix xml:id="appendix-interface-stability"
|
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'>
|
<title>Release Levels & Interface Stability</title>
|
|
<para>This appendix includes ForgeRock definitions for product release levels
|
and interface stability.</para>
|
|
<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>
|
|
</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>
|
|
<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>
|
