Skip to content

[#1129] Point the guides' Javadoc links at the published apidocs, and resolve {opendj-version} in the uninstall and monitoring pages #1140

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vharseko merged 2 commits into from
Oct 1, 2026
Merged

[#1129] Point the guides' Javadoc links at the published apidocs, and resolve {opendj-version} in the uninstall and monitoring pages #1140

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6838a13
[#1129] Point the guides' Javadoc links at the published apidocs, and…
vharseko Sep 30, 2026
a3a2060
[#1129] Name in the interface stability appendix only API types that …
vharseko Oct 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-monitoring.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ SNMP is not enabled by default. SNMP-based monitoring depends on OpenDMK, which

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/
Expand Down
1 change: 1 addition & 0 deletions opendj-doc-generated-ref/src/main/asciidoc/install-guide/chap-uninstall.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
:figure-caption!:
:example-caption!:
:table-caption!:
:opendj-version: x.y.z


[#chap-uninstall]
Expand Down
24 changes: 4 additions & 20 deletions ...doc-generated-ref/src/main/asciidoc/reference/appendix-interface-stability.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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!:
Expand All @@ -29,7 +29,7 @@ In addition to the indications concerning interface stability in the documentati

* 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`
Expand All @@ -38,13 +38,11 @@ In addition to the indications concerning interface stability in the documentati

** `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`

Expand Down Expand Up @@ -75,21 +73,7 @@ In addition to the indications concerning interface stability in the documentati
** `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.

Expand Down
8 changes: 4 additions & 4 deletions ...-doc-generated-ref/src/main/asciidoc/server-dev-guide/chap-writing-plugins.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ If you deploy with custom plugins and need support in production, see link:https
[#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]
====
Expand All @@ -57,7 +57,7 @@ This means that a server plugin built with one version of OpenDJ directory serve
==== 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

Expand Down Expand Up @@ -345,7 +345,7 @@ This means that a server plugin built with one version of OpenDJ directory serve
====
`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.

Expand Down Expand Up @@ -375,7 +375,7 @@ In the `applyConfigurationChange()` method the plugin must modify its configurat

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]
Expand Down
Loading