Clean up Javadoc warnings and fail the build on new ones

commons/audit/handler-csv/src/main/java/org/forgerock/audit/handlers/csv/CsvWriter.java

@@ -12,6 +12,7 @@
  * information: "Portions copyright [year] [name of copyright owner]".
  *
  * Copyright 2015 ForgeRock AS.
+ * Portions Copyrighted 2026 3A Systems, LLC
  */
 package org.forgerock.audit.handlers.csv;
 
@@ -37,13 +38,13 @@ interface CsvWriter extends AutoCloseable {
     /**
      * Write a row into the CSV files.
      * @param values The keys of the {@link Map} have to match the column's header.
-     * @throws IOException
+     * @throws IOException if an I/O error occurs while writing the row.
      */
     void writeEvent(Map<String, String> values) throws IOException;
 
     /**
      * Flush the data into the CSV file.
-     * @throws IOException
+     * @throws IOException if an I/O error occurs while flushing.
      */
     void flush() throws IOException;
 

commons/audit/handler-csv/src/main/java/org/forgerock/audit/handlers/csv/HmacCalculator.java

@@ -12,6 +12,7 @@
 * information: "Portions copyright [year] [name of copyright owner]".
 *
 * Copyright 2015 ForgeRock AS.
+* Portions Copyrighted 2026 3A Systems, LLC
 */
 
 package org.forgerock.audit.handlers.csv;
@@ -61,7 +62,7 @@ public void setCurrentKey(byte[] bytes) {
      *
      * @param data the data used to calculate the HMAC
      * @return the calculated HMAC as a base64 encoded String.
-     * @throws SignatureException
+     * @throws SignatureException if the HMAC cannot be generated.
      */
     public String calculate(byte[] data) throws SignatureException {
         try {

commons/audit/handler-csv/src/main/java/org/forgerock/audit/handlers/csv/SecureCsvWriter.java

@@ -12,6 +12,7 @@
  * information: "Portions copyright [year] [name of copyright owner]".
  *
  * Copyright 2015-2016 ForgeRock AS.
+ * Portions Copyrighted 2026 3A Systems, LLC
  */
 package org.forgerock.audit.handlers.csv;
 
@@ -308,7 +309,7 @@ public boolean forceRotation() throws IOException {
     /**
      * Write a row into the CSV files.
      * @param values The keys of the {@link Map} have to match the column's header.
-     * @throws IOException
+     * @throws IOException if an I/O error occurs while writing the event.
      */
     @Override
     public void writeEvent(Map<String, String> values) throws IOException {
@@ -318,7 +319,7 @@ public void writeEvent(Map<String, String> values) throws IOException {
     /**
      * Write a row into the CSV files.
      * @param values The keys of the {@link Map} have to match the column's header.
-     * @throws IOException
+     * @throws IOException if an I/O error occurs while writing the event.
      */
     public void writeEvent(Writer writer, Map<String, String> values) throws IOException {
         signatureLock.lock();

commons/audit/handler-csv/src/main/java/org/forgerock/audit/handlers/csv/StandardCsvWriter.java

@@ -12,6 +12,7 @@
  * information: "Portions copyright [year] [name of copyright owner]".
  *
  * Copyright 2015-2016 ForgeRock AS.
+ * Portions Copyrighted 2026 3A Systems, LLC
  */
 package org.forgerock.audit.handlers.csv;
 
@@ -123,7 +124,7 @@ public void writeHeader(String... headers) throws IOException {
     /**
      * Write a row into the CSV files.
      * @param values The keys of the {@link Map} have to match the column's header.
-     * @throws IOException
+     * @throws IOException if an I/O error occurs while writing the row.
      */
     @Override
     public void writeEvent(Map<String, String> values) throws IOException {
@@ -132,7 +133,7 @@ public void writeEvent(Map<String, String> values) throws IOException {
 
     /**
      * Flush the data into the CSV file.
-     * @throws IOException
+     * @throws IOException if an I/O error occurs while flushing.
      */
     public void flush() throws IOException {
         csvWriter.flush();

commons/audit/handler-jms/src/main/java/org/forgerock/audit/handlers/jms/JmsResourceManager.java

@@ -12,7 +12,7 @@
  * information: "Portions copyright [year] [name of copyright owner]".
  *
  * Copyright 2016 ForgeRock AS.
- * Portions copyright 2024 3A Systems LLC.
+ * Portions copyright 2024-2026 3A Systems LLC.
  */
 
 package org.forgerock.audit.handlers.jms;
@@ -67,7 +67,7 @@ class JmsResourceManager {
      *
      * @param configuration The Audit Configuration.
      * @param jmsContextManager The {@link JmsContextManager}.
-     * @throws InternalServerErrorException
+     * @throws InternalServerErrorException if the JMS resources cannot be initialized.
      */
     public JmsResourceManager(JmsAuditEventHandlerConfiguration configuration, JmsContextManager jmsContextManager)
             throws ResourceException {
@@ -87,7 +87,7 @@ public JmsResourceManager(JmsAuditEventHandlerConfiguration configuration, JmsCo
 
     /**
      * Opens the connection to the JMS services with the configured session mode.
-     * @throws JMSException
+     * @throws JMSException if there is trouble opening the connection.
      */
     public void openConnection() throws JMSException {
         connection = connectionFactory.createConnection();
@@ -98,7 +98,7 @@ public void openConnection() throws JMSException {
     /**
      * Closes the connection to the JMS services.
      *
-     * @throws JMSException
+     * @throws JMSException if there is trouble closing the connection.
      */
     public void closeConnection() throws JMSException {
         if (null != connection) {

commons/json-schema/cli/src/main/java/org/forgerock/json/schema/Main.java

@@ -12,6 +12,7 @@
  * information: "Portions Copyrighted [year] [name of copyright owner]".
  *
  * Copyright 2011-2016 ForgeRock AS.
+ * Portions Copyrighted 2026 3A Systems, LLC
  */
 
 package org.forgerock.json.schema;
@@ -199,9 +200,9 @@ private void loadSchema(URI base, File schemaFile) throws IOException {
      * Files found; the List is sorted using File.compareTo().
      *
      * @param aStartingDir is a valid directory, which can be read.
-     * @param filter
-     * @return
-     * @throws java.io.FileNotFoundException
+     * @param filter the filter used to select which files to include.
+     * @return the list of files found beneath the starting directory.
+     * @throws java.io.FileNotFoundException if the starting directory does not exist or cannot be read.
      */
     private List<File> getFileListingNoSort(File aStartingDir, FileFilter filter) throws FileNotFoundException {
         List<File> result = new ArrayList<>();
@@ -222,8 +223,8 @@ private List<File> getFileListingNoSort(File aStartingDir, FileFilter filter) th
     /**
      * Directory is valid if it exists, does not represent a file, and can be read.
      *
-     * @param aDirectory
-     * @throws java.io.FileNotFoundException
+     * @param aDirectory the directory to validate.
+     * @throws java.io.FileNotFoundException if the directory does not exist.
      */
     private void validateDirectory(File aDirectory) throws FileNotFoundException {
         if (aDirectory == null) {

commons/launcher/launcher/src/main/java/org/forgerock/commons/launcher/ConfigurationUtil.java

@@ -62,6 +62,7 @@ private ConfigurationUtil() {
      * which will match each entry.
      * 
      * @param location
+     *            the URL of the jar file to scan.
      * @param includes
      *            to filter the results within a regular expression.
      * @return a list of files within the jar |file|
@@ -153,6 +154,7 @@ public void connect() throws IOException {}
      * which will match each entry.
      * 
      * @param location
+     *            the URL of the zip file to scan.
      * @param includes
      *            to filter the results within a regular expression.
      * @return a list of files within the zip |file|

commons/launcher/launcher/src/main/javadoc/overview.html

@@ -1,3 +1,4 @@
+<!-- Portions Copyrighted 2026 3A Systems, LLC -->
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
 <html>
 <head>
@@ -13,7 +14,5 @@
 </head>
 <body>
 <p class="p1">ForgeRock OSGi Launcher</p>
-
-<p></p>
 </body>
 </html>

commons/launcher/pom.xml

@@ -22,7 +22,7 @@
   ~ your own identifying information:
   ~ "Portions Copyrighted [year] [name of copyright owner]"
 
-    Portions Copyright 2017-2024 3A Systems, LLC.
+    Portions Copyright 2017-2026 3A Systems, LLC.
   -->
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
@@ -96,7 +96,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>
-                <version>2.9</version>
+                <version>${javadocPluginVersion}</version>
                 <reportSets>
                     <reportSet>
                         <reports>

commons/selfservice/core/src/main/java/org/forgerock/selfservice/core/crypto/FieldStorageSchemeImpl.java

@@ -12,6 +12,7 @@
  * information: "Portions copyright [year] [name of copyright owner]".
  *
  * Copyright 2015 ForgeRock AS.
+ * Portions Copyrighted 2026 3A Systems, LLC
  */
 package org.forgerock.selfservice.core.crypto;
 
@@ -66,7 +67,7 @@ class FieldStorageSchemeImpl implements FieldStorageScheme {
      *
      * @param digestSize the size of the digest in bytes.
      * @param algorithm  the algorithm to use.
-     * @throws Exception
+     * @throws Exception if no provider supports the given digest algorithm.
      */
     FieldStorageSchemeImpl(int digestSize, String algorithm) throws Exception {
         this.messageDigest = MessageDigest.getInstance(algorithm);

i18n-framework/maven-plugin/src/main/java/org/forgerock/i18n/maven/AbstractGenerateMessagesMojo.java

@@ -12,6 +12,7 @@
  * information: "Portions Copyrighted [year] [name of copyright owner]".
  *
  *      Copyright 2011-2013 ForgeRock AS
+ *      Portions Copyrighted 2026 3A Systems, LLC
  */
 package org.forgerock.i18n.maven;
 
@@ -341,7 +342,12 @@ String getComment() {
 
             final String[] sa = ws.split(EOL);
             for (final String s : sa) {
-                sb.append(indent(1)).append(" * ").append(s).append(EOL);
+                // Escape HTML metacharacters so that message text (which may contain
+                // '&', '<' or '>' - e.g. LDAP filters or GUI HTML fragments) yields
+                // valid Javadoc. The runtime message is loaded from the property
+                // bundle by key, so escaping this documentation comment is harmless.
+                final String escaped = s.replace("&", "&amp;").replace("<", "&lt;").replace(">", "&gt;");
+                sb.append(indent(1)).append(" * ").append(escaped).append(EOL);
             }
             sb.append(indent(1)).append(" */").append(EOL);
             return sb.toString();

maven-external-dependency-plugin/maven-external-dependency-plugin/pom.xml

@@ -16,7 +16,9 @@ software distributed under the License is distributed on an
 KIND, either express or implied.  See the License for the
 specific language governing permissions and limitations
 under the License.
---> 
+
+Portions Copyrighted 2026 3A Systems, LLC
+-->
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
     <modelVersion>4.0.0</modelVersion>
     <parent>
@@ -247,7 +249,7 @@ under the License.
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-javadoc-plugin</artifactId>
-        <version>2.6.1</version>
+        <version>${javadocPluginVersion}</version>
         <configuration>
           <stylesheetfile>${basedir}/src/main/javadoc/stylesheet.css</stylesheetfile>
           <show>public</show>

maven-external-dependency-plugin/maven-external-dependency-plugin/src/main/java/com/savage7/maven/plugin/dependency/DeployExternalDependencyMojo.java

@@ -259,8 +259,8 @@ else if (artifactItem.getGeneratePom() == true)
      * section
      *
      * @return deployment repository defined in distribution management
-     * @throws MojoExecutionException
-     * @throws MojoFailureException
+     * @throws MojoExecutionException if the repository is not defined in the POM's distribution management section
+     * @throws MojoFailureException if the deployment goal fails
      */
     private ArtifactRepository getDeploymentRepository()
             throws MojoExecutionException, MojoFailureException
@@ -282,7 +282,7 @@ private ArtifactRepository getDeploymentRepository()
      * Checks for offline mode; throws exception if offline, deploy goal cannot
      * proceed
      *
-     * @throws MojoFailureException
+     * @throws MojoFailureException if Maven is running in offline mode
      */
     private void failIfOffline() throws MojoFailureException
     {

persistit/core/src/main/java/com/persistit/Accumulator.java

@@ -535,8 +535,8 @@ private Accumulator(final Tree tree, final int index, final long baseValue, fina
      * This method is called when computing a snapshot value and when
      * aggregating <code>Delta</code> instances.
      * 
-     * @param a
-     * @param b
+     * @param a the first operand
+     * @param b the second operand
      * @return the result of the commutative operation on a and b
      */
     abstract long applyValue(long a, long b);
@@ -548,18 +548,18 @@ private Accumulator(final Tree tree, final int index, final long baseValue, fina
      * <code>SeqAccumulator</code> update(a, b) returns a + b (computed
      * atomically) whereas apply(a, b) return Math.max(a, b).
      * 
-     * @param a
-     * @param b
+     * @param a the first operand
+     * @param b the second operand
      * @return the result of the commutative operation on a and b
      */
     abstract long updateValue(long a, long b);
 
     /**
-     * @param value
+     * @param value the current value
      * @param updated
      *            return One of the supplied parameters as the value to be held
      *            in a <code>Delta</code>.
-     * 
+     *
      */
     abstract long selectValue(long value, long updated);
 
@@ -665,8 +665,8 @@ public long getSnapshotValue() throws PersistitInterruptedException {
     }
 
     /**
-     * @param timestamp
-     * @param step
+     * @param timestamp the start timestamp bounding committed transactions to include
+     * @param step the step number bounding operations of the current transaction to include
      * @return The value computed by accumulating values contributed by (a) all
      *         transactions having commit timestamps less than or equal to
      *         <code>timestamp</code>, and (b) all operations performed by the
@@ -686,7 +686,7 @@ long getSnapshotValue(final long timestamp, final int step) throws PersistitInte
      * recovery processing to apply Deltas from recovered committed
      * transactions.
      * 
-     * @param value
+     * @param value the delta value to apply to the base value
      */
     void updateBaseValue(final long value, final long commitTimestamp) {
         _baseValue = applyValue(_baseValue, value);

persistit/core/src/main/java/com/persistit/AlertMonitor.java

@@ -749,7 +749,7 @@ public MBeanNotificationInfo[] getNotificationInfo() {
      * standard log message. If there have been multiple Events, emit a
      * recurring event message.
      * 
-     * @param history
+     * @param history the event history to log
      */
     private void log(final History history) {
         final Event event = history.getLastEvent();
@@ -765,7 +765,7 @@ private void log(final History history) {
     /**
      * Broadcast a JMX Notification.
      * 
-     * @param history
+     * @param history the event history to broadcast
      */
     private void sendNotification(final History history) {
         final Event event = history.getLastEvent();
@@ -793,7 +793,7 @@ private void sendNotification(final History history) {
      * were three argument elements.
      * </p>
      * 
-     * @param event
+     * @param event the event to format
      * @return formatted event
      */
     private String format(final Event event) {

persistit/core/src/main/java/com/persistit/BackupTask.java

@@ -1,6 +1,7 @@
 /**
  * Copyright 2011-2012 Akiban Technologies, Inc.
- * 
+ * Portions Copyrighted 2026 3A Systems, LLC
+ *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
@@ -171,8 +172,9 @@ private void populateBackupFiles() throws Exception {
      * A convenience method for backing up relatively small amounts of data from
      * within Persistit. In production it is expected that the actual file
      * copies required for backup will be performed be third-party utilities.
-     * 
+     *
      * @throws Exception
+     *             if the backup operation fails
      */
     private void doBackup() throws Exception {
         final ZipOutputStream zos = new ZipOutputStream(new BufferedOutputStream(new FileOutputStream(_toFile),
@@ -221,8 +223,9 @@ private void doBackup() throws Exception {
      * A convenience method for unit tests to unzip a backup created by
      * {@link #doBackup()}. In production it is expected a backup produced by
      * {@link #doBackup()} will be restored via an external unzip utility.
-     * 
+     *
      * @throws Exception
+     *             if the restore operation fails
      */
     public void doRestore(final String path) throws Exception {
         final File zipFile = new File(path);