From d2ec630b29e971f9fbbda26f708d4487dd6e131c Mon Sep 17 00:00:00 2001
From: Valery Kharseko <vharseko@3a-systems.ru>
Date: Thu, 01 Oct 2026 11:43:05 +0000
Subject: [PATCH] [#1129] Point the guides' Javadoc links at the published apidocs, and resolve {opendj-version} in the uninstall and monitoring pages (#1140)
---
opendj-doc-generated-ref/src/main/asciidoc/install-guide/chap-uninstall.adoc | 1 +
opendj-doc-generated-ref/src/main/asciidoc/server-dev-guide/chap-writing-plugins.adoc | 8 ++++----
opendj-doc-generated-ref/src/main/asciidoc/reference/appendix-interface-stability.adoc | 24 ++++--------------------
opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-monitoring.adoc | 2 +-
4 files changed, 10 insertions(+), 25 deletions(-)
diff --git a/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-monitoring.adoc b/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-monitoring.adoc
index ceb1133..435b5e9 100644
--- a/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-monitoring.adoc
+++ b/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-monitoring.adoc
@@ -79,7 +79,7 @@
To run the OpenDMK installer, use the self-extracting .jar:
-[source, console]
+[source, console, subs="attributes"]
----
$ java -jar ~/Downloads/opendmk-1.0-b02-*.jar
$ cd ~/Downloads/
diff --git a/opendj-doc-generated-ref/src/main/asciidoc/install-guide/chap-uninstall.adoc b/opendj-doc-generated-ref/src/main/asciidoc/install-guide/chap-uninstall.adoc
index a4fc0ff..af448ff 100644
--- a/opendj-doc-generated-ref/src/main/asciidoc/install-guide/chap-uninstall.adoc
+++ b/opendj-doc-generated-ref/src/main/asciidoc/install-guide/chap-uninstall.adoc
@@ -18,6 +18,7 @@
:figure-caption!:
:example-caption!:
:table-caption!:
+:opendj-version: x.y.z
[#chap-uninstall]
diff --git a/opendj-doc-generated-ref/src/main/asciidoc/reference/appendix-interface-stability.adoc b/opendj-doc-generated-ref/src/main/asciidoc/reference/appendix-interface-stability.adoc
index 282573f..888107b 100644
--- a/opendj-doc-generated-ref/src/main/asciidoc/reference/appendix-interface-stability.adoc
+++ b/opendj-doc-generated-ref/src/main/asciidoc/reference/appendix-interface-stability.adoc
@@ -12,7 +12,7 @@
information: "Portions copyright [year] [name of copyright owner]".
Copyright 2017 ForgeRock AS.
- Portions Copyright 2024 3A Systems LLC.
+ Portions Copyright 2024-2026 3A Systems LLC.
////
:figure-caption!:
@@ -29,7 +29,7 @@
* Client tools—`ldap*`, `ldif*`, and `*rate` commands—are Evolving.
-* The following classes, interfaces, and methods in the link:../javadoc/index.html[OpenDJ APIs, window=\_blank] are Evolving:
+* The following classes, interfaces, and methods in the link:https://doc.openidentityplatform.org/opendj/apidocs/index.html[OpenDJ APIs, window=\_blank] are Evolving:
+
** `org.forgerock.opendj.ldap.Connections#newInternalConnection`
@@ -38,13 +38,11 @@
** `org.forgerock.opendj.ldap.Connections#newServerConnectionFactory`
-** `org.forgerock.opendj.ldap.FutureResult`
-
** `org.forgerock.opendj.ldap.LDAPClientContext`
** `org.forgerock.opendj.ldap.LDAPListener`
-** `org.forgerock.opendj.ldap.LDAPListenerOptions`
+** `org.forgerock.opendj.ldap.LdapPromise`
** `org.forgerock.opendj.ldap.MemoryBackend`
@@ -75,21 +73,7 @@
** `org.forgerock.opendj.ldap.schema.SyntaxImpl`
-* The following methods are Deprecated:
-+
-
-** `org.forgerock.opendj.ldap.Connections#newHeartBeatConnectionFactory`
-
-** `org.forgerock.opendj.ldap.LDAPListenerOptions#getTCPNIOTransport`
-
-** `org.forgerock.opendj.ldap.LDAPListenerOptions#setTCPNIOTransport`
-
-** `org.forgerock.opendj.ldap.LDAPOptions#getTCPNIOTransport`
-
-** `org.forgerock.opendj.ldap.LDAPOptions#setTCPNIOTransport`
-
-
-* The class `org.forgerock.opendj.ldap.CoreMessages` is Internal.
+* The class `com.forgerock.opendj.ldap.CoreMessages` is Internal.
* For all Java APIs, `com.*` packages are Internal.
diff --git a/opendj-doc-generated-ref/src/main/asciidoc/server-dev-guide/chap-writing-plugins.adoc b/opendj-doc-generated-ref/src/main/asciidoc/server-dev-guide/chap-writing-plugins.adoc
index 49fda8e..0e40bd4 100644
--- a/opendj-doc-generated-ref/src/main/asciidoc/server-dev-guide/chap-writing-plugins.adoc
+++ b/opendj-doc-generated-ref/src/main/asciidoc/server-dev-guide/chap-writing-plugins.adoc
@@ -44,7 +44,7 @@
[#about-server-plugins]
=== About OpenDJ Directory Server Plugins
-OpenDJ directory server plugins are Java libraries compiled against the OpenDJ link:../javadoc/index.html[Java API, window=\_blank]. Plugins are built to be configured as part of the server and to be invoked at specific points in the lifecycle of a client request, or in the server process lifecycle.
+OpenDJ directory server plugins are Java libraries compiled against the OpenDJ link:https://doc.openidentityplatform.org/opendj/apidocs/index.html[Java API, window=\_blank]. Plugins are built to be configured as part of the server and to be invoked at specific points in the lifecycle of a client request, or in the server process lifecycle.
[NOTE]
====
@@ -57,7 +57,7 @@
==== Plugin Types
Plugin types correspond to the points where the server invokes the plugin.
-For the full list of plugin invocation points, see the Javadoc for link:../javadoc/index.html?org/opends/server/api/plugin/PluginType.html[PluginType, window=\_blank]. The following list summarizes the plugin invocation points:
+For the full list of plugin invocation points, see the Javadoc for link:https://doc.openidentityplatform.org/opendj/apidocs/org/opends/server/api/plugin/PluginType.html[PluginType, window=\_blank]. The following list summarizes the plugin invocation points:
* At server startup and shutdown
@@ -345,7 +345,7 @@
====
`ExamplePlugin` statically imports everything from the generated message implementation sources. Resolution of `ExamplePluginMessages.*` fails until the implementation is generated by the `i18n-maven-plugin`.
-`ExamplePlugin` extends link:../javadoc/index.html?org/opends/server/api/plugin/DirectoryServerPlugin.html[DirectoryServerPlugin, window=\_blank] with its own type of configuration, `ExamplePluginCfg`. The implementation for `ExamplePluginCfg` is generated from the configuration declared in XML. Therefore, resolution of `ExamplePluginCfg` fails until the sources are generated by the `opendj-maven-plugin`.
+`ExamplePlugin` extends link:https://doc.openidentityplatform.org/opendj/apidocs/org/opends/server/api/plugin/DirectoryServerPlugin.html[DirectoryServerPlugin, window=\_blank] with its own type of configuration, `ExamplePluginCfg`. The implementation for `ExamplePluginCfg` is generated from the configuration declared in XML. Therefore, resolution of `ExamplePluginCfg` fails until the sources are generated by the `opendj-maven-plugin`.
`ExamplePlugin` implements `ConfigurationChangeListener` so the plugin can be notified of changes to its configuration. The plugin can then potentially update its configuration without the need to restart the plugin or OpenDJ directory server.
@@ -375,7 +375,7 @@
The plugin types are the exception: a plugin receives them only when it is initialized, so the server does not pass a change to `plugin-type` to the running plugin. When `plugin-type` changes on an enabled plugin, the server creates a new instance of the plugin, initializes it for the new plugin types, registers it in place of the running instance, and then calls the `finalizePlugin()` method of the running instance. If `initializePlugin()` refuses the new plugin types, the change fails and the running instance stays registered for the plugin types it had. The server then calls `finalizePlugin()` of the refused instance, so `finalizePlugin()` must release whatever `initializePlugin()` acquired before it failed, such as a change listener. Until `plugin-type` is changed to types the plugin accepts, every later change of the plugin configuration also fails with the same reason, although the other changes are applied to the running instance. State that the plugin keeps in memory does not carry over to the new instance.
-In the example plugin, the method that extends the server's behavior is the `doStartup()` method. Which method is implemented depends on what class the plugin extends. For example, a password validator extending link:../javadoc/index.html?org/opends/server/api/PasswordValidator.html[PasswordValidator, window=\_blank] would implement a `passwordIsAcceptable()` method.
+In the example plugin, the method that extends the server's behavior is the `doStartup()` method. Which method is implemented depends on what class the plugin extends. For example, a password validator extending link:https://doc.openidentityplatform.org/opendj/apidocs/org/opends/server/api/PasswordValidator.html[PasswordValidator, window=\_blank] would implement a `passwordIsAcceptable()` method.
[#example-plugin-i18n]
--
Gitblit v1.10.0