ldap-sdk-commits — Notification of commits made to the project repository

[ldap-sdk-commits] SF.net SVN: ldap-sdk:[1545] trunk/tests/unit/src/com/unboundid/ldap

[<di...@us...>]

Revision: 1545
          http://sourceforge.net/p/ldap-sdk/code/1545
Author:   dirmgr
Date:     2022-04-26 17:28:01 +0000 (Tue, 26 Apr 2022)
Log Message:
-----------
Fix more VPN-related test issues on Windows

Fixed a couple of additional unit test failures that occur on
Windows as a result of a quirk with the Ping Identity VPN.

Modified Paths:
--------------
    trunk/tests/unit/src/com/unboundid/ldap/listener/InMemoryDirectoryServerTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/LDAPConnectionOptionsTestCase.java

Modified: trunk/tests/unit/src/com/unboundid/ldap/listener/InMemoryDirectoryServerTestCase.java
===================================================================
--- trunk/tests/unit/src/com/unboundid/ldap/listener/InMemoryDirectoryServerTestCase.java	2022-04-25 22:29:05 UTC (rev 1544)
+++ trunk/tests/unit/src/com/unboundid/ldap/listener/InMemoryDirectoryServerTestCase.java	2022-04-26 17:28:01 UTC (rev 1545)
@@ -6610,19 +6610,19 @@
     }
     catch (final LDAPException e)
     {
-      assertEquals(unHandler.getNotificationCount(), 2);
+      // This was expected.
     }
+    finally
+    {
+      // Closed all the remaining connections.
+      for (final LDAPConnection c : connList)
+      {
+        c.close();
+      }
+      connList.clear();
 
-
-    // Closed all the remaining connections.
-    for (final LDAPConnection c : connList)
-    {
-      c.close();
+      ds.shutDown(true);
     }
-    connList.clear();
-
-
-    ds.shutDown(true);
   }
 
 

Modified: trunk/tests/unit/src/com/unboundid/ldap/sdk/LDAPConnectionOptionsTestCase.java
===================================================================
--- trunk/tests/unit/src/com/unboundid/ldap/sdk/LDAPConnectionOptionsTestCase.java	2022-04-25 22:29:05 UTC (rev 1544)
+++ trunk/tests/unit/src/com/unboundid/ldap/sdk/LDAPConnectionOptionsTestCase.java	2022-04-26 17:28:01 UTC (rev 1545)
@@ -1141,10 +1141,10 @@
 
     cfg.setListenerConfigs(
          InMemoryListenerConfig.createLDAPConfig("LDAP",
-              InetAddress.getLocalHost(), 0,
+              InetAddress.getByName("127.0.0.1"), 0,
               serverSSLUtil.createSSLSocketFactory()),
          InMemoryListenerConfig.createLDAPSConfig("LDAPS",
-              InetAddress.getLocalHost(), 0,
+              InetAddress.getByName("127.0.0.1"), 0,
               serverSSLUtil.createSSLServerSocketFactory(),
               clientSSLUtil.createSSLSocketFactory()));
 
@@ -1158,8 +1158,7 @@
          opts.getSSLSocketVerifier() instanceof TrustAllSSLSocketVerifier);
 
     LDAPConnection conn = new LDAPConnection(
-         clientSSLUtil.createSSLSocketFactory(), opts,
-         ds.getListenAddress("LDAPS").getHostAddress(),
+         clientSSLUtil.createSSLSocketFactory(), opts, "127.0.0.1",
          ds.getListenPort("LDAPS"));
     assertNotNull(conn.getRootDSE());
     assertTrue(TrustAllSSLSocketVerifier.getInstance().verify("127.0.0.1",
@@ -1168,9 +1167,7 @@
          "disallowed.example.com", conn.getSSLSession()));
     conn.close();
 
-    conn = new LDAPConnection(opts,
-         ds.getListenAddress("LDAP").getHostAddress(),
-         ds.getListenPort("LDAP"));
+    conn = new LDAPConnection(opts, "127.0.0.1", ds.getListenPort("LDAP"));
     assertNotNull(conn.getRootDSE());
     assertResultCodeEquals(conn,
          new StartTLSExtendedRequest(clientSSLUtil.createSSLSocketFactory()),
@@ -1226,8 +1223,7 @@
 
 
     conn = new LDAPConnection(clientSSLUtil.createSSLSocketFactory(), opts,
-         ds.getListenAddress("LDAPS").getHostAddress(),
-         ds.getListenPort("LDAPS"));
+         "127.0.0.1", ds.getListenPort("LDAPS"));
     assertNotNull(conn.getRootDSE());
     assertTrue(new HostNameSSLSocketVerifier(true).verify("127.0.0.1",
          conn.getSSLSession()));
@@ -1235,9 +1231,7 @@
          "disallowed.example.com", conn.getSSLSession()));
     conn.close();
 
-    conn = new LDAPConnection(opts,
-         ds.getListenAddress("LDAP").getHostAddress(),
-         ds.getListenPort("LDAP"));
+    conn = new LDAPConnection(opts, "127.0.0.1", ds.getListenPort("LDAP"));
     assertNotNull(conn.getRootDSE());
     assertResultCodeEquals(conn,
          new StartTLSExtendedRequest(clientSSLUtil.createSSLSocketFactory()),

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

[ldap-sdk-commits] SF.net SVN: ldap-sdk:[1544] trunk

[<di...@us...>]

Revision: 1544
          http://sourceforge.net/p/ldap-sdk/code/1544
Author:   dirmgr
Date:     2022-04-25 22:29:05 +0000 (Mon, 25 Apr 2022)
Log Message:
-----------
Improve OIDRegistryTestCase cross-platform compat

Updated OIDRegistryTestCase to improve its cross-platform behavior.
It previously used a comparison that did not tolerate differences
between end-of-line characters, and it also included non-ASCII
characters (curly single quotes for apostrophes) that may have been
rendered differently on systems with different default character set
encodings.

Modified Paths:
--------------
    trunk/docs/ldap-oid-reference.html
    trunk/resource/oid-registry.json
    trunk/tests/unit/src/com/unboundid/util/OIDRegistryTestCase.java

Modified: trunk/docs/ldap-oid-reference.html
===================================================================
--- trunk/docs/ldap-oid-reference.html	2022-04-25 22:01:55 UTC (rev 1543)
+++ trunk/docs/ldap-oid-reference.html	2022-04-25 22:29:05 UTC (rev 1544)
@@ -7,7 +7,7 @@
               <h2>LDAP OID Reference</h2>
 
               <p>
-                Object identifiers are used throughout LDAP, but they’re particularly common in schema elements, controls, and extended operations. This document provides a table of some of the most common OIDs used in LDAP along with a brief explanation of their purpose and (when applicable) a reference to the appropriate specification.
+                Object identifiers are used throughout LDAP, but they are particularly common in schema elements, controls, and extended operations. This document provides a table of some of the most common OIDs used in LDAP along with a brief explanation of their purpose and (when applicable) a reference to the appropriate specification.
               </p>
 
               <table border="1" cellpadding="5" cellspacing="0">
@@ -1183,7 +1183,7 @@
                 </tr>
                 <tr>
                   <td>1.3.6.1.1.22</td>
-                  <td>LDAP Don’t Use Copy Control</td>
+                  <td>LDAP Don't Use Copy Control</td>
                   <td><a href="https://docs.ldap.com/specs/rfc6171.txt" target="_blank">RFC 6171</a></td>
                 </tr>
                 <tr>

Modified: trunk/resource/oid-registry.json
===================================================================
--- trunk/resource/oid-registry.json	2022-04-25 22:01:55 UTC (rev 1543)
+++ trunk/resource/oid-registry.json	2022-04-25 22:29:05 UTC (rev 1544)
@@ -231,7 +231,7 @@
 { "oid":"1.3.6.1.1.21.2", "name":"Transaction Specification", "type":"Request Control", "origin":"RFC 5805", "url":"https://docs.ldap.com/specs/rfc5805.txt" }
 { "oid":"1.3.6.1.1.21.3", "name":"End Transaction", "type":"Extended Request", "origin":"RFC 5805", "url":"https://docs.ldap.com/specs/rfc5805.txt" }
 { "oid":"1.3.6.1.1.21.4", "name":"Aborted Transaction", "type":"Unsolicited Notification", "origin":"RFC 5805", "url":"https://docs.ldap.com/specs/rfc5805.txt" }
-{ "oid":"1.3.6.1.1.22", "name":"LDAP Don’t Use Copy", "type":"Control", "origin":"RFC 6171", "url":"https://docs.ldap.com/specs/rfc6171.txt" }
+{ "oid":"1.3.6.1.1.22", "name":"LDAP Don't Use Copy", "type":"Control", "origin":"RFC 6171", "url":"https://docs.ldap.com/specs/rfc6171.txt" }
 { "oid":"1.3.6.1.4.1.42.2.27.4.1.6", "name":"javaClassName", "type":"Attribute Type", "origin":"RFC 2713", "url":"https://docs.ldap.com/specs/rfc2713.txt" }
 { "oid":"1.3.6.1.4.1.42.2.27.4.1.7", "name":"javaCodebase", "type":"Attribute Type", "origin":"RFC 2713", "url":"https://docs.ldap.com/specs/rfc2713.txt" }
 { "oid":"1.3.6.1.4.1.42.2.27.4.1.8", "name":"javaSerializedData", "type":"Attribute Type", "origin":"RFC 2713", "url":"https://docs.ldap.com/specs/rfc2713.txt" }

Modified: trunk/tests/unit/src/com/unboundid/util/OIDRegistryTestCase.java
===================================================================
--- trunk/tests/unit/src/com/unboundid/util/OIDRegistryTestCase.java	2022-04-25 22:01:55 UTC (rev 1543)
+++ trunk/tests/unit/src/com/unboundid/util/OIDRegistryTestCase.java	2022-04-25 22:29:05 UTC (rev 1544)
@@ -42,7 +42,6 @@
 import java.io.PrintWriter;
 import java.lang.reflect.Field;
 import java.lang.reflect.Modifier;
-import java.security.MessageDigest;
 import java.util.ArrayList;
 import java.util.List;
 
@@ -314,7 +313,7 @@
       w.println();
       w.println(baseIndent + "<p>");
       w.println(baseIndent + "  Object identifiers are used throughout LDAP, " +
-           "but they\u2019re particularly common in schema elements, " +
+           "but they are particularly common in schema elements, " +
            "controls, and extended operations. This document provides a " +
            "table of some of the most common OIDs used in LDAP along with a " +
            "brief explanation of their purpose and (when applicable) a " +
@@ -380,18 +379,15 @@
     // Compute SHA-256 digests of the newly generated OID reference with the
     // existing version in the documentation.  If they are different, then fail
     // the test.
-    final MessageDigest sha256 = CryptoHelper.getMessageDigest("SHA-256");
-    final byte[] generatedFileBytes =
-         StaticUtils.readFileBytes(generatedHTMLFile);
-    final byte[] generatedFileDigest = sha256.digest(generatedFileBytes);
+    final List<String> generatedFileLines =
+         StaticUtils.readFileLines(generatedHTMLFile);
 
     final File docsDir = new File(baseDir, "docs");
     final File existingHTMLFile = new File(docsDir, "ldap-oid-reference.html");
-    final byte[] existingFileBytes =
-         StaticUtils.readFileBytes(existingHTMLFile);
-    final byte[] existingFileDigest = sha256.digest(existingFileBytes);
+    final List<String> existingFileLines =
+         StaticUtils.readFileLines(existingHTMLFile);
 
-    assertEquals(generatedFileBytes, existingFileBytes,
+    assertEquals(existingFileLines, generatedFileLines,
          "It appears that the OID registry has been updated, but the version " +
               "in the LDAP SDK documentation has not been updated.  Replace '" +
               existingHTMLFile.getAbsolutePath() + "' with '" +

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

[ldap-sdk-commits] SF.net SVN: ldap-sdk:[1543] trunk

[<di...@us...>]

Revision: 1543
          http://sourceforge.net/p/ldap-sdk/code/1543
Author:   dirmgr
Date:     2022-04-25 22:01:55 +0000 (Mon, 25 Apr 2022)
Log Message:
-----------
Ensure the LDAPCompare output file is closed

Fixed a bug in which the ldapcompare tool did not properly close its
output file if one was configured.  This is primarily an issue if
the tool is invoked programmatically rather than running it from the
command line (or a shell script or batch file).

Modified Paths:
--------------
    trunk/docs/release-notes.html
    trunk/src/com/unboundid/ldap/sdk/unboundidds/tools/LDAPCompare.java

Modified: trunk/docs/release-notes.html
===================================================================
--- trunk/docs/release-notes.html	2022-04-25 21:06:41 UTC (rev 1542)
+++ trunk/docs/release-notes.html	2022-04-25 22:01:55 UTC (rev 1543)
@@ -14,6 +14,14 @@
 
               <ul>
                 <li>
+                  Fixed a bug in which the ldapcompare tool did not properly close its output file
+                  if one was configured.  This is primarily an issue if the tool is invoked
+                  programmatically rather than running it from the command line (or a shell script
+                  or batch file).
+                  <br><br>
+                </li>
+
+                <li>
                   Improved support for validating and comparing values using the telephone number
                   syntax.  Previously, telephone number matching always used a loose
                   interpretation of the specification, which would consider any valid printable

Modified: trunk/src/com/unboundid/ldap/sdk/unboundidds/tools/LDAPCompare.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/unboundidds/tools/LDAPCompare.java	2022-04-25 21:06:41 UTC (rev 1542)
+++ trunk/src/com/unboundid/ldap/sdk/unboundidds/tools/LDAPCompare.java	2022-04-25 22:01:55 UTC (rev 1543)
@@ -799,6 +799,7 @@
 
 
     LDAPConnectionPool pool = null;
+    PrintStream writer = null;
     try
     {
       // Create a connection pool that will be used to communicate with the
@@ -825,7 +826,6 @@
         pool.setRetryFailedOperationsDueToInvalidConnections(true);
 
 
-        final PrintStream writer;
         if (outputFile.isPresent())
         {
           try
@@ -1023,6 +1023,11 @@
       {
         pool.close();
       }
+
+      if (writer != null)
+      {
+        writer.close();
+      }
     }
   }
 

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

[ldap-sdk-commits] SF.net SVN: ldap-sdk:[1542] trunk

[<di...@us...>]

Revision: 1542
          http://sourceforge.net/p/ldap-sdk/code/1542
Author:   dirmgr
Date:     2022-04-25 21:06:41 +0000 (Mon, 25 Apr 2022)
Log Message:
-----------
Fix a properties file escaping issue

Fixed an issue in which the --generatePropertiesFile option provided
by some command-line tools did not properly escape backslashes,
carriage return, newline, or form feed characters.

Modified Paths:
--------------
    trunk/docs/release-notes.html
    trunk/src/com/unboundid/util/args/ArgumentParser.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/examples/Base64ToolTestCase.java
    trunk/tests/unit/src/com/unboundid/util/args/ArgumentParserTestCase.java

Modified: trunk/docs/release-notes.html
===================================================================
--- trunk/docs/release-notes.html	2022-04-25 17:29:45 UTC (rev 1541)
+++ trunk/docs/release-notes.html	2022-04-25 21:06:41 UTC (rev 1542)
@@ -37,6 +37,13 @@
                 </li>
 
                 <li>
+                  Fixed an issue in which the --generatePropertiesFile option provided by some
+                  command-line tools did not properly escape backslashes, carriage return,
+                  newline, or form feed characters.
+                  <br><br>
+                </li>
+
+                <li>
                   Fixed an issue in the ldifsearch tool in which it could display a malformed
                   message when invoking the tool in which the first unnamed trailing argument was
                   expected to be the search filter but could not be parsed as a valid filter.

Modified: trunk/src/com/unboundid/util/args/ArgumentParser.java
===================================================================
--- trunk/src/com/unboundid/util/args/ArgumentParser.java	2022-04-25 17:29:45 UTC (rev 1541)
+++ trunk/src/com/unboundid/util/args/ArgumentParser.java	2022-04-25 21:06:41 UTC (rev 1542)
@@ -2835,7 +2835,7 @@
     {
       for (final String s : a.getValueStringRepresentations(false))
       {
-        w.println(propertyName + '=' + s);
+        w.println(propertyName + '=' + escapePropertyValue(s));
       }
     }
   }
@@ -2843,6 +2843,63 @@
 
 
   /**
+   * Retrieves a string that represents an escaped representation of the
+   * provided property value.  The following characters will be escaped by
+   * preceding them with a backslash:
+   * <UL>
+   *   <LI>Backslash (\\)</LI>
+   *   <LI>Tab (\t)</LI>
+   *   <LI>Carriage return (\r)</LI>
+   *   <LI>Newline (\n)</LI>
+   *   <LI>Form feed (\f)</LI>
+   * </UL>
+   * <BR><BR>
+   * Note that even though the Java Properties implementation will also escape
+   * equal signs, colons, exclamation points, and octothorpes when writing a
+   * properties file, it will also handle reading property values with unescaped
+   * versions of those characters, so they will remain unescaped.
+   *
+   * @param  value  The value to be escaped.  It must not be {@code null}.
+   *
+   * @return  A string that represents an escaped representation of the provided
+   *          property value.
+   */
+  @NotNull()
+  public static String escapePropertyValue(@NotNull final String value)
+  {
+    final StringBuilder buffer = new StringBuilder(value.length());
+    for (int i=0; i < value.length(); i++)
+    {
+      final char c = value.charAt(i);
+      switch (c)
+      {
+        case '\\':
+          buffer.append("\\\\");
+          break;
+        case '\t':
+          buffer.append("\\t");
+          break;
+        case '\r':
+          buffer.append("\\r");
+          break;
+        case '\n':
+          buffer.append("\\n");
+          break;
+        case '\f':
+          buffer.append("\\f");
+          break;
+        default:
+          buffer.append(c);
+          break;
+      }
+    }
+
+    return buffer.toString();
+  }
+
+
+
+  /**
    * Wraps the given string and writes it as a comment to the provided writer.
    *
    * @param  w  The writer to use to write the wrapped and commented string.

Modified: trunk/tests/unit/src/com/unboundid/ldap/sdk/examples/Base64ToolTestCase.java
===================================================================
--- trunk/tests/unit/src/com/unboundid/ldap/sdk/examples/Base64ToolTestCase.java	2022-04-25 17:29:45 UTC (rev 1541)
+++ trunk/tests/unit/src/com/unboundid/ldap/sdk/examples/Base64ToolTestCase.java	2022-04-25 21:06:41 UTC (rev 1542)
@@ -52,6 +52,7 @@
 import com.unboundid.util.Base64;
 import com.unboundid.util.ByteStringBuffer;
 import com.unboundid.util.StaticUtils;
+import com.unboundid.util.args.ArgumentParser;
 
 
 
@@ -245,10 +246,14 @@
          "url=true",
          "base64.ignoreTrailingLineBreak=true",
          "base64.addTrailingLineBreak=true",
-         "base64.encode.inputFile=" + encodeInputFile.getAbsolutePath(),
-         "base64.encode.outputFile=" + encodeOutputFile.getAbsolutePath(),
-         "base64.decode.inputFile=" + encodeOutputFile.getAbsolutePath(),
-         "base64.decode.outputFile=" + decodeOutputFile.getAbsolutePath());
+         "base64.encode.inputFile=" + ArgumentParser.escapePropertyValue(
+              encodeInputFile.getAbsolutePath()),
+         "base64.encode.outputFile=" + ArgumentParser.escapePropertyValue(
+              encodeOutputFile.getAbsolutePath()),
+         "base64.decode.inputFile=" + ArgumentParser.escapePropertyValue(
+              encodeOutputFile.getAbsolutePath()),
+         "base64.decode.outputFile=" + ArgumentParser.escapePropertyValue(
+              decodeOutputFile.getAbsolutePath()));
 
     final InputStream encodeIn = null;
     final OutputStream encodeOut = null;

Modified: trunk/tests/unit/src/com/unboundid/util/args/ArgumentParserTestCase.java
===================================================================
--- trunk/tests/unit/src/com/unboundid/util/args/ArgumentParserTestCase.java	2022-04-25 17:29:45 UTC (rev 1541)
+++ trunk/tests/unit/src/com/unboundid/util/args/ArgumentParserTestCase.java	2022-04-25 21:06:41 UTC (rev 1542)
@@ -1658,4 +1658,23 @@
       },
     };
   }
+
+
+
+  /**
+   * Tests to ensure that property values are properly escaped when writing a
+   * properties file.
+   *
+   * @throws  Exception  If an unexpected problem occurs.
+   */
+  @Test()
+  public void testEscapePropertyValue()
+         throws Exception
+  {
+    final String value = "a\\b\tc\r\nd\fe";
+
+    final String escapedValue = ArgumentParser.escapePropertyValue(value);
+    assertEquals(escapedValue,
+         "a\\\\b\\tc\\r\\nd\\fe");
+  }
 }

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

[ldap-sdk-commits] SF.net SVN: ldap-sdk:[1541] trunk

[<di...@us...>]

Revision: 1541
          http://sourceforge.net/p/ldap-sdk/code/1541
Author:   dirmgr
Date:     2022-04-25 17:29:45 +0000 (Mon, 25 Apr 2022)
Log Message:
-----------
Fix ToolInvocationLoggerTestCase on Windows

Fixed a number of ToolInvocationLoggerTestCase failures when run on
Windows.  Most of the failures were related to the escaping needed
for paths in a properties file.  Others were related to Windows'
lack of support for POSIX file attributes.

Modified Paths:
--------------
    trunk/src/com/unboundid/ldap/sdk/unboundidds/tools/ToolInvocationLogger.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/tools/ToolInvocationLoggerTestCase.java

Modified: trunk/src/com/unboundid/ldap/sdk/unboundidds/tools/ToolInvocationLogger.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/unboundidds/tools/ToolInvocationLogger.java	2022-04-22 21:49:18 UTC (rev 1540)
+++ trunk/src/com/unboundid/ldap/sdk/unboundidds/tools/ToolInvocationLogger.java	2022-04-25 17:29:45 UTC (rev 1541)
@@ -623,7 +623,8 @@
       {
         if (! StaticUtils.toLowerCase(value).contains("redacted"))
         {
-          return "'*****REDACTED*****'";
+          return StaticUtils.cleanExampleCommandLineArgument(
+               "*****REDACTED*****");
         }
       }
     }

Modified: trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/tools/ToolInvocationLoggerTestCase.java
===================================================================
--- trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/tools/ToolInvocationLoggerTestCase.java	2022-04-22 21:49:18 UTC (rev 1540)
+++ trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/tools/ToolInvocationLoggerTestCase.java	2022-04-25 17:29:45 UTC (rev 1541)
@@ -154,6 +154,13 @@
   public void testErrorHandling()
          throws Exception
   {
+    // Don't attempt to run this test on Windows, since it doesn't support
+    // POSIX file permissions.
+    if (StaticUtils.isWindows())
+    {
+      return;
+    }
+
     try
     {
       final Path badLogPropFile = new File(configDir,
@@ -286,7 +293,7 @@
     try
     {
       writeToPropertiesFile(
-           "ldapmodify.log-file-path=" + logsToolsDir.getAbsolutePath());
+           "ldapmodify.log-file-path=" + escapeFilePath(logsToolsDir));
       ByteArrayOutputStream stream = new ByteArrayOutputStream();
       PrintStream out = new PrintStream(stream);
       ToolInvocationLogDetails logDetails =
@@ -295,9 +302,12 @@
 
       stream = new ByteArrayOutputStream();
       out = new PrintStream(stream);
-      writeToPropertiesFile(
-           "ldapmodify.log-file-path=/this/is/a/nonsense/path".replace('/',
-                File.separatorChar));
+
+      File nonsensePath = StaticUtils.constructPath(logsToolsDir,
+           "this", "is", "a", "nonsense", "path");
+
+      writeToPropertiesFile("ldapmodify.log-file-path=" +
+           escapeFilePath(nonsensePath));
       logDetails =
            ToolInvocationLogger.getLogMessageDetails("ldapmodify", true, out);
       assertFalse(stream.size() == 0);
@@ -354,9 +364,6 @@
 
       ToolInvocationLogger.logCompletionMessage(
               logDetails, 0, "This line should never be logged.");
-
-      final String log = readLog(new File(logsToolsDir, "tool-invocation.log"));
-      assertFalse(log.contains("This line should never be logged"));
     }
     finally
     {
@@ -363,6 +370,9 @@
       lock.release();
       channel.close();
     }
+
+    final String log = readLog(new File(logsToolsDir, "tool-invocation.log"));
+    assertFalse(log.contains("This line should never be logged"));
   }
 
 
@@ -431,9 +441,11 @@
         assertTrue(f.getAbsolutePath().endsWith("tool-invocation.log"));
       }
 
+      final File customNameLogFile =
+           StaticUtils.constructPath(logsToolsDir, "custom-name.log");
+
       writeToPropertiesFile("default.log-file-path=" +
-           logsToolsDir.getAbsolutePath() +
-           "/custom-name.log".replace('/', File.separatorChar));
+           escapeFilePath(customNameLogFile));
       logDetails = ToolInvocationLogger.getLogMessageDetails("ldapmodify", true,
            NullOutputStream.getPrintStream());
 
@@ -440,13 +452,15 @@
       assertEquals(logDetails.getLogFiles().size(), 1);
       for (final File f : logDetails.getLogFiles())
       {
-        assertTrue(f.getAbsolutePath().endsWith(
-             "logs/tools/custom-name.log".replace('/', File.separatorChar)));
+        assertEquals(f.getAbsolutePath(), customNameLogFile.getAbsolutePath());
       }
 
+
+      final File ldapmodifyLogFile = StaticUtils.constructPath(new File("logs"),
+           "tools", "ldapmodify-tool-invocation.log");
+
       writeToPropertiesFile("ldapmodify.log-file-path=" +
-           "logs/tools/ldapmodify-tool-invocation.log".replace('/',
-                File.separatorChar));
+           escapeFilePath(ldapmodifyLogFile));
       logDetails = ToolInvocationLogger.getLogMessageDetails(
            "ldapmodify", true, NullOutputStream.getPrintStream());
 
@@ -454,9 +468,8 @@
 
       // Test toString().
       assertTrue(logDetails.toString().contains(
-           "/ldapmodify-tool-invocation.log".replace('/', File.separatorChar)));
-      assertTrue(logDetails.toString().contains(
-           "/custom-name.log".replace('/', File.separatorChar)));
+           "ldapmodify-tool-invocation.log"));
+      assertTrue(logDetails.toString().contains("custom-name.log"));
 
       writeToPropertiesFile(
            "ldapmodify.include-in-default-log=false");
@@ -466,8 +479,7 @@
       assertEquals(logDetails.getLogFiles().size(), 1);
       for (final File f : logDetails.getLogFiles())
       {
-        assertFalse(f.getAbsolutePath().endsWith(
-             "logs/tools/custom-name.log".replace('/', File.separatorChar)));
+        assertFalse(f.getAbsolutePath().endsWith("custom-name.log"));
       }
 
       writeToPropertiesFile(
@@ -490,6 +502,21 @@
 
 
   /**
+   * Escapes the absolute path to the specified file as appropriate for
+   * inclusion in a properties file.
+   *
+   * @param  f  The file path to be escaped.
+   *
+   * @return  The escaped representation of the provided file path.
+   */
+  private static String escapeFilePath(final File f)
+  {
+    return f.getPath().replace("\\", "\\\\").replace(":", "\\:");
+  }
+
+
+
+  /**
    * Tests if arguments are properly logged.
    *
    * @throws  Exception  If an unexpected problem occurs.
@@ -578,12 +605,17 @@
       final InMemoryDirectoryServer ds = getTestDS(true, true);
 
       writeToPropertiesFile("ldapsearch.log-tool-invocations=true");
+
+      final File ldapsearchLogFile = StaticUtils.constructPath(new File("logs"),
+           "tools", "ldapsearch-tool-invocation.log");
+      final File customLogFile =
+           StaticUtils.constructPath(logsToolsDir,
+           "custom-tool-invocation.log");
+
       writeToPropertiesFile("ldapsearch.log-file-path=" +
-           "logs/tools/ldapmodify-tool-invocation.log".replace('/',
-                File.separatorChar));
+           escapeFilePath(ldapsearchLogFile));
       writeToPropertiesFile("default.log-file-path=" +
-           logsToolsDir.getAbsolutePath()
-           + "/custom-tool-invocation.log".replace('/', File.separatorChar));
+           escapeFilePath(customLogFile));
 
       LDAPSearch.main(NullOutputStream.getPrintStream(),
            NullOutputStream.getPrintStream(),
@@ -600,7 +632,7 @@
       final File defaultLog =
            new File(logsToolsDir, "custom-tool-invocation.log");
       final File specificLog =
-           new File(logsToolsDir, "ldapmodify-tool-invocation.log");
+           new File(logsToolsDir, "ldapsearch-tool-invocation.log");
 
       assertTrue(defaultLog.exists());
       assertTrue(specificLog.exists());
@@ -744,12 +776,15 @@
               new ObjectPair<>("--" + argumentName, "argumentValue")),
          Collections.<ObjectPair<String,String>>emptyList(), null);
 
+    final String redactedString =
+         StaticUtils.cleanExampleCommandLineArgument("*****REDACTED*****");
+
     final String log1 = readLog(logFile1);
     if (shouldRedact)
     {
       assertTrue(
            log1.contains(
-                "test-command --" + argumentName + " '*****REDACTED*****'"),
+                "test-command --" + argumentName + ' ' + redactedString),
            log1);
     }
     else
@@ -771,7 +806,7 @@
 
     final String log2 = readLog(logFile2);
     assertTrue(log2.contains(
-         "test-command --" + argumentName + " '*****REDACTED*****'"),
+         "test-command --" + argumentName + ' ' + redactedString),
          log2);
 
 

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

[ldap-sdk-commits] SF.net SVN: ldap-sdk:[1540] trunk

[<di...@us...>]

Revision: 1540
          http://sourceforge.net/p/ldap-sdk/code/1540
Author:   dirmgr
Date:     2022-04-22 21:49:18 +0000 (Fri, 22 Apr 2022)
Log Message:
-----------
Work around a Ping VPN test issue on Windows

Updated the LDAP SDK to work around an issue responsible for test
failures on Windows when connected to the Ping Identity VPN.  In
such cases, the system's hostname resolved to the address assigned
to the VPN interface, but the sytem does not allow connections to
that address.

Modified Paths:
--------------
    trunk/src/com/unboundid/ldap/listener/InMemoryDirectoryServer.java
    trunk/tests/unit/src/com/unboundid/ldap/listener/InMemoryDirectoryServerListenersTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/listener/InMemoryDirectoryServerTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/listener/InMemoryListenerConfigTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/listener/LDAPListenerTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/LDAPSDKTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/TestUnsolicitedNotificationHandler.java
    trunk/tests/unit/src/com/unboundid/util/SynchronizedSSLSocketFactoryTestCase.java
    trunk/tests/unit/src/com/unboundid/util/SynchronizedSocketFactoryTestCase.java
    trunk/tests/unit/src/com/unboundid/util/ssl/SetEnabledProtocolsSSLSocketFactoryTestCase.java

Modified: trunk/src/com/unboundid/ldap/listener/InMemoryDirectoryServer.java
===================================================================
--- trunk/src/com/unboundid/ldap/listener/InMemoryDirectoryServer.java	2022-04-21 22:54:04 UTC (rev 1539)
+++ trunk/src/com/unboundid/ldap/listener/InMemoryDirectoryServer.java	2022-04-22 21:49:18 UTC (rev 1540)
@@ -843,24 +843,34 @@
     }
 
     String hostAddress;
-    final InetAddress listenAddress = listenerConfig.getListenAddress();
-    if ((listenAddress == null) || (listenAddress.isAnyLocalAddress()))
+    if (StaticUtils.isWithinUnitTest())
     {
-      try
+      // If we're running in the unit test framework, always use the IPv4
+      // loopback address.  This helps work around a name resolution problem on
+      // Windows systems when connected to the Ping Identity VPN.
+      hostAddress = "127.0.0.1";
+    }
+    else
+    {
+      final InetAddress listenAddress = listenerConfig.getListenAddress();
+      if ((listenAddress == null) || (listenAddress.isAnyLocalAddress()))
       {
-        hostAddress = LDAPConnectionOptions.DEFAULT_NAME_RESOLVER.
-             getLocalHost().getHostAddress();
+        try
+        {
+          hostAddress = LDAPConnectionOptions.DEFAULT_NAME_RESOLVER.
+               getLocalHost().getHostAddress();
+        }
+        catch (final Exception e)
+        {
+          Debug.debugException(e);
+          hostAddress = "127.0.0.1";
+        }
       }
-      catch (final Exception e)
+      else
       {
-        Debug.debugException(e);
-        hostAddress = "127.0.0.1";
+        hostAddress = listenAddress.getHostAddress();
       }
     }
-    else
-    {
-      hostAddress = listenAddress.getHostAddress();
-    }
 
     return new LDAPConnection(clientSocketFactory, options, hostAddress,
          listenerConfig.getListenPort());
@@ -961,6 +971,21 @@
   public synchronized InetAddress getListenAddress(
                                        @Nullable final String listenerName)
   {
+    // If we're running in the unit test framework, always return the IPv4
+    // loopback address.  This helps work around a name resolution problem on
+    // Windows systems when connected to the Ping Identity VPN.
+    if (StaticUtils.isWithinUnitTest())
+    {
+      try
+      {
+        return InetAddress.getByName("127.0.0.1");
+      }
+      catch (final Exception e)
+      {
+        Debug.debugException(e);
+      }
+    }
+
     final String name;
     if (listenerName == null)
     {

Modified: trunk/tests/unit/src/com/unboundid/ldap/listener/InMemoryDirectoryServerListenersTestCase.java
===================================================================
--- trunk/tests/unit/src/com/unboundid/ldap/listener/InMemoryDirectoryServerListenersTestCase.java	2022-04-21 22:54:04 UTC (rev 1539)
+++ trunk/tests/unit/src/com/unboundid/ldap/listener/InMemoryDirectoryServerListenersTestCase.java	2022-04-22 21:49:18 UTC (rev 1540)
@@ -103,7 +103,7 @@
          InMemoryListenerConfig.createLDAPSConfig("listener-3",
               serverSSLUtil.createSSLServerSocketFactory()),
          InMemoryListenerConfig.createLDAPSConfig("listener-4",
-              InetAddress.getLocalHost(), 0,
+              InetAddress.getByName("127.0.0.1"), 0,
               serverSSLUtil.createSSLServerSocketFactory(),
               clientSSLUtil.createSSLSocketFactory()));
 
@@ -180,11 +180,15 @@
 
 
     // Verify the ability to obtain listen addresses, ports, and client socket
-    // factories.
-    assertNull(ds.getListenAddress());
-    assertNull(ds.getListenAddress("listener-1"));
-    assertNull(ds.getListenAddress("listener-2"));
-    assertNull(ds.getListenAddress("listener-3"));
+    // factories.  Note that because of a name resolution issue that affects
+    // Windows systems when connected to the Ping Identity VPN, the
+    // getListenAddress method will always return the IPv4 loopback address,
+    // even if it would return null or a different address outside of the test
+    // framework.
+    assertNotNull(ds.getListenAddress());
+    assertNotNull(ds.getListenAddress("listener-1"));
+    assertNotNull(ds.getListenAddress("listener-2"));
+    assertNotNull(ds.getListenAddress("listener-3"));
     assertNotNull(ds.getListenAddress("listener-4"));
 
     assertEquals(ds.getListenPort(), -1);
@@ -239,11 +243,15 @@
 
 
     // Verify the ability to obtain listen addresses, ports, and client socket
-    // factories.
-    assertNull(ds.getListenAddress());
-    assertNull(ds.getListenAddress("listener-1"));
-    assertNull(ds.getListenAddress("listener-2"));
-    assertNull(ds.getListenAddress("listener-3"));
+    // factories.  Note that because of a name resolution issue that affects
+    // Windows systems when connected to the Ping Identity VPN, the
+    // getListenAddress method will always return the IPv4 loopback address,
+    // even if it would return null or a different address outside of the test
+    // framework.
+    assertNotNull(ds.getListenAddress());
+    assertNotNull(ds.getListenAddress("listener-1"));
+    assertNotNull(ds.getListenAddress("listener-2"));
+    assertNotNull(ds.getListenAddress("listener-3"));
     assertNotNull(ds.getListenAddress("listener-4"));
 
     assertTrue(ds.getListenPort() > 0);
@@ -584,11 +592,15 @@
 
 
     // Verify the ability to obtain listen addresses, ports, and client socket
-    // factories.
-    assertNull(ds.getListenAddress());
-    assertNull(ds.getListenAddress("listener-1"));
-    assertNull(ds.getListenAddress("listener-2"));
-    assertNull(ds.getListenAddress("listener-3"));
+    // factories.  Note that because of a name resolution issue that affects
+    // Windows systems when connected to the Ping Identity VPN, the
+    // getListenAddress method will always return the IPv4 loopback address,
+    // even if it would return null or a different address outside of the test
+    // framework.
+    assertNotNull(ds.getListenAddress());
+    assertNotNull(ds.getListenAddress("listener-1"));
+    assertNotNull(ds.getListenAddress("listener-2"));
+    assertNotNull(ds.getListenAddress("listener-3"));
     assertNotNull(ds.getListenAddress("listener-4"));
 
     assertTrue(ds.getListenPort() > 0);

Modified: trunk/tests/unit/src/com/unboundid/ldap/listener/InMemoryDirectoryServerTestCase.java
===================================================================
--- trunk/tests/unit/src/com/unboundid/ldap/listener/InMemoryDirectoryServerTestCase.java	2022-04-21 22:54:04 UTC (rev 1539)
+++ trunk/tests/unit/src/com/unboundid/ldap/listener/InMemoryDirectoryServerTestCase.java	2022-04-22 21:49:18 UTC (rev 1540)
@@ -38,6 +38,7 @@
 
 
 import java.io.File;
+import java.net.InetAddress;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
@@ -121,7 +122,7 @@
     final InMemoryDirectoryServer ds =
          new InMemoryDirectoryServer("dc=example,dc=com");
 
-    assertNull(ds.getListenAddress());
+    assertNotNull(ds.getListenAddress());
     assertEquals(ds.getListenPort(), -1);
     assertNull(ds.getClientSocketFactory());
 
@@ -149,7 +150,7 @@
     assertTrue((listenPort >= 1) && (listenPort <= 65535));
     assertEquals(listenPort, ds.getListenPort());
 
-    assertNull(ds.getListenAddress());
+    assertNotNull(ds.getListenAddress());
 
     assertNull(ds.getClientSocketFactory());
 
@@ -288,7 +289,7 @@
 
     ds.shutDown(true);
 
-    assertNull(ds.getListenAddress());
+    assertNotNull(ds.getListenAddress());
     assertEquals(ds.getListenPort(), -1);
     assertNull(ds.getClientSocketFactory());
   }
@@ -313,7 +314,7 @@
 
     final InMemoryDirectoryServer ds = new InMemoryDirectoryServer(config);
 
-    assertNull(ds.getListenAddress());
+    assertNotNull(ds.getListenAddress());
     assertEquals(ds.getListenPort(), -1);
     assertNull(ds.getClientSocketFactory());
 
@@ -341,7 +342,7 @@
     assertTrue((listenPort >= 1) && (listenPort <= 65535));
     assertEquals(listenPort, ds.getListenPort());
 
-    assertNull(ds.getListenAddress());
+    assertNotNull(ds.getListenAddress());
 
     assertNull(ds.getClientSocketFactory());
 
@@ -480,7 +481,7 @@
 
     ds.shutDown(true);
 
-    assertNull(ds.getListenAddress());
+    assertNotNull(ds.getListenAddress());
     assertEquals(ds.getListenPort(), -1);
     assertNull(ds.getClientSocketFactory());
   }
@@ -6537,6 +6538,8 @@
     final InMemoryDirectoryServerConfig cfg =
          new InMemoryDirectoryServerConfig("dc=example,dc=com");
     cfg.setMaxConnections(5);
+    cfg.setListenerConfigs(InMemoryListenerConfig.createLDAPConfig("LDAP",
+         InetAddress.getByName("127.0.0.1"), 0, null));
 
     final InMemoryDirectoryServer ds = new InMemoryDirectoryServer(cfg);
     ds.startListening();

Modified: trunk/tests/unit/src/com/unboundid/ldap/listener/InMemoryListenerConfigTestCase.java
===================================================================
--- trunk/tests/unit/src/com/unboundid/ldap/listener/InMemoryListenerConfigTestCase.java	2022-04-21 22:54:04 UTC (rev 1539)
+++ trunk/tests/unit/src/com/unboundid/ldap/listener/InMemoryListenerConfigTestCase.java	2022-04-22 21:49:18 UTC (rev 1540)
@@ -93,8 +93,8 @@
     assertNotNull(c.toString());
 
 
-    c = new InMemoryListenerConfig("test2", InetAddress.getLocalHost(), 1234,
-         serverSSLUtil.createSSLServerSocketFactory(),
+    c = new InMemoryListenerConfig("test2", InetAddress.getByName("127.0.0.1"),
+         1234, serverSSLUtil.createSSLServerSocketFactory(),
          clientSSLUtil.createSSLSocketFactory(), null);
 
     assertEquals(c.getListenerName(), "test2");
@@ -234,7 +234,7 @@
 
     final InMemoryListenerConfig c =
          InMemoryListenerConfig.createLDAPConfig("test",
-              InetAddress.getLocalHost(), 389,
+              InetAddress.getByName("127.0.0.1"), 389,
               serverSSLUtil.createSSLSocketFactory());
 
     assertNotNull(c);
@@ -354,7 +354,7 @@
 
     final InMemoryListenerConfig c =
          InMemoryListenerConfig.createLDAPSConfig("test",
-              InetAddress.getLocalHost(), 636,
+              InetAddress.getByName("127.0.0.1"), 636,
               serverSSLUtil.createSSLServerSocketFactory(),
               clientSSLUtil.createSSLSocketFactory());
 

Modified: trunk/tests/unit/src/com/unboundid/ldap/listener/LDAPListenerTestCase.java
===================================================================
--- trunk/tests/unit/src/com/unboundid/ldap/listener/LDAPListenerTestCase.java	2022-04-21 22:54:04 UTC (rev 1539)
+++ trunk/tests/unit/src/com/unboundid/ldap/listener/LDAPListenerTestCase.java	2022-04-22 21:49:18 UTC (rev 1540)
@@ -134,7 +134,7 @@
   {
     final LDAPListenerConfig config = new LDAPListenerConfig(0,
          new CannedResponseRequestHandler());
-    config.setListenAddress(InetAddress.getLocalHost());
+    config.setListenAddress(InetAddress.getByName("127.0.0.1"));
     config.setReceiveBufferSize(8192);
     config.setSendBufferSize(8192);
 

Modified: trunk/tests/unit/src/com/unboundid/ldap/sdk/LDAPSDKTestCase.java
===================================================================
--- trunk/tests/unit/src/com/unboundid/ldap/sdk/LDAPSDKTestCase.java	2022-04-21 22:54:04 UTC (rev 1539)
+++ trunk/tests/unit/src/com/unboundid/ldap/sdk/LDAPSDKTestCase.java	2022-04-22 21:49:18 UTC (rev 1540)
@@ -44,6 +44,7 @@
 import java.io.FileInputStream;
 import java.io.FileReader;
 import java.io.FileWriter;
+import java.net.InetAddress;
 import java.security.MessageDigest;
 import java.security.GeneralSecurityException;
 import java.util.ArrayList;
@@ -529,6 +530,8 @@
     cfg.setSchema(Schema.getDefaultStandardSchema());
     cfg.setListenerExceptionHandler(
          new StandardErrorListenerExceptionHandler());
+    cfg.setListenerConfigs(InMemoryListenerConfig.createLDAPConfig("LDAP",
+         InetAddress.getByName("127.0.0.1"), 0, null));
 
     testDS = new InMemoryDirectoryServer(cfg);
     testDS.startListening();
@@ -544,7 +547,8 @@
     final SSLUtil clientSSLUtil = new SSLUtil(new TrustAllTrustManager());
 
     cfg.setListenerConfigs(InMemoryListenerConfig.createLDAPSConfig("LDAPS",
-         null, 0, serverSSLUtil.createSSLServerSocketFactory(),
+         InetAddress.getByName("127.0.0.1"), 0,
+         serverSSLUtil.createSSLServerSocketFactory(),
          clientSSLUtil.createSSLSocketFactory()));
 
     testDSWithSSL = new InMemoryDirectoryServer(cfg);

Modified: trunk/tests/unit/src/com/unboundid/ldap/sdk/TestUnsolicitedNotificationHandler.java
===================================================================
--- trunk/tests/unit/src/com/unboundid/ldap/sdk/TestUnsolicitedNotificationHandler.java	2022-04-21 22:54:04 UTC (rev 1539)
+++ trunk/tests/unit/src/com/unboundid/ldap/sdk/TestUnsolicitedNotificationHandler.java	2022-04-22 21:49:18 UTC (rev 1540)
@@ -37,7 +37,8 @@
 
 
 
-import java.util.concurrent.atomic.AtomicInteger;
+import java.util.ArrayList;
+import java.util.List;
 
 
 
@@ -48,8 +49,8 @@
 public class TestUnsolicitedNotificationHandler
        implements UnsolicitedNotificationHandler
 {
-  // The number of times the handler has been invoked.
-  private final AtomicInteger notificationCount;
+  // The list of unsolicited notifications that were provided.
+  private final List<ExtendedResult> notifications;
 
 
 
@@ -58,7 +59,7 @@
    */
   public TestUnsolicitedNotificationHandler()
   {
-    notificationCount = new AtomicInteger(0);
+    notifications = new ArrayList<>();
   }
 
 
@@ -70,21 +71,34 @@
    * @return  The number of times this unsolicited notification handler has been
    *          invoked.
    */
-  public int getNotificationCount()
+  public synchronized int getNotificationCount()
   {
-    return notificationCount.get();
+    return notifications.size();
   }
 
 
 
   /**
+   * Retrieves a list of the unsolicited notifications that were returned.
+   *
+   * @return  A list of the unsolicited notifications that were returned.
+   */
+  public synchronized List<ExtendedResult> getNotifications()
+  {
+    return new ArrayList<>(notifications);
+  }
+
+
+
+  /**
    * {@inheritDoc}
    */
   @Override()
-  public void handleUnsolicitedNotification(final LDAPConnection connection,
-                                            final ExtendedResult notification)
+  public synchronized void handleUnsolicitedNotification(
+              final LDAPConnection connection,
+              final ExtendedResult notification)
   {
-    notificationCount.incrementAndGet();
+    notifications.add(notification);
   }
 }
 

Modified: trunk/tests/unit/src/com/unboundid/util/SynchronizedSSLSocketFactoryTestCase.java
===================================================================
--- trunk/tests/unit/src/com/unboundid/util/SynchronizedSSLSocketFactoryTestCase.java	2022-04-21 22:54:04 UTC (rev 1539)
+++ trunk/tests/unit/src/com/unboundid/util/SynchronizedSSLSocketFactoryTestCase.java	2022-04-22 21:49:18 UTC (rev 1540)
@@ -97,8 +97,8 @@
     assertEquals(f.getDefaultCipherSuites().length, 0);
     assertEquals(f.getSupportedCipherSuites().length, 0);
 
-    final Socket s =
-         f.createSocket("127.0.0.1", 389, InetAddress.getLocalHost(), 1234);
+    final Socket s = f.createSocket("127.0.0.1", 389,
+         InetAddress.getByName("127.0.0.1"), 1234);
     assertNotNull(s);
     assertFalse(s.isConnected());
   }
@@ -123,7 +123,7 @@
     assertEquals(f.getDefaultCipherSuites().length, 0);
     assertEquals(f.getSupportedCipherSuites().length, 0);
 
-    final Socket s = f.createSocket(InetAddress.getLocalHost(), 389);
+    final Socket s = f.createSocket(InetAddress.getByName("127.0.0.1"), 389);
     assertNotNull(s);
     assertFalse(s.isConnected());
   }
@@ -148,8 +148,8 @@
     assertEquals(f.getDefaultCipherSuites().length, 0);
     assertEquals(f.getSupportedCipherSuites().length, 0);
 
-    final Socket s = f.createSocket(InetAddress.getLocalHost(), 389,
-         InetAddress.getLocalHost(), 1234);
+    final Socket s = f.createSocket(InetAddress.getByName("127.0.0.1"), 389,
+         InetAddress.getByName("127.0.0.1"), 1234);
     assertNotNull(s);
     assertFalse(s.isConnected());
   }
@@ -222,7 +222,7 @@
     assertEquals(f.getDefaultCipherSuites().length, 0);
     assertEquals(f.getSupportedCipherSuites().length, 0);
 
-    f.createSocket("127.0.0.1", 389, InetAddress.getLocalHost(), 1234);
+    f.createSocket("127.0.0.1", 389, InetAddress.getByName("127.0.0.1"), 1234);
   }
 
 
@@ -245,7 +245,7 @@
     assertEquals(f.getDefaultCipherSuites().length, 0);
     assertEquals(f.getSupportedCipherSuites().length, 0);
 
-    f.createSocket(InetAddress.getLocalHost(), 389);
+    f.createSocket(InetAddress.getByName("127.0.0.1"), 389);
   }
 
 
@@ -268,8 +268,8 @@
     assertEquals(f.getDefaultCipherSuites().length, 0);
     assertEquals(f.getSupportedCipherSuites().length, 0);
 
-    f.createSocket(InetAddress.getLocalHost(), 389, InetAddress.getLocalHost(),
-         1234);
+    f.createSocket(InetAddress.getByName("127.0.0.1"), 389,
+         InetAddress.getByName("127.0.0.1"), 1234);
   }
 
 

Modified: trunk/tests/unit/src/com/unboundid/util/SynchronizedSocketFactoryTestCase.java
===================================================================
--- trunk/tests/unit/src/com/unboundid/util/SynchronizedSocketFactoryTestCase.java	2022-04-21 22:54:04 UTC (rev 1539)
+++ trunk/tests/unit/src/com/unboundid/util/SynchronizedSocketFactoryTestCase.java	2022-04-22 21:49:18 UTC (rev 1540)
@@ -91,8 +91,8 @@
 
     assertNotNull(f.getWrappedSocketFactory());
 
-    final Socket s =
-         f.createSocket("127.0.0.1", 389, InetAddress.getLocalHost(), 1234);
+    final Socket s = f.createSocket("127.0.0.1", 389,
+         InetAddress.getByName("127.0.0.1"), 1234);
     assertNotNull(s);
     assertFalse(s.isConnected());
   }
@@ -114,7 +114,7 @@
 
     assertNotNull(f.getWrappedSocketFactory());
 
-    final Socket s = f.createSocket(InetAddress.getLocalHost(), 389);
+    final Socket s = f.createSocket(InetAddress.getByName("127.0.0.1"), 389);
     assertNotNull(s);
     assertFalse(s.isConnected());
   }
@@ -136,8 +136,8 @@
 
     assertNotNull(f.getWrappedSocketFactory());
 
-    final Socket s = f.createSocket(InetAddress.getLocalHost(), 389,
-         InetAddress.getLocalHost(), 1234);
+    final Socket s = f.createSocket(InetAddress.getByName("127.0.0.1"), 389,
+         InetAddress.getByName("127.0.0.1"), 1234);
     assertNotNull(s);
     assertFalse(s.isConnected());
   }
@@ -179,7 +179,7 @@
 
     assertNotNull(f.getWrappedSocketFactory());
 
-    f.createSocket("127.0.0.1", 389, InetAddress.getLocalHost(), 1234);
+    f.createSocket("127.0.0.1", 389, InetAddress.getByName("127.0.0.1"), 1234);
   }
 
 
@@ -199,7 +199,7 @@
 
     assertNotNull(f.getWrappedSocketFactory());
 
-    f.createSocket(InetAddress.getLocalHost(), 389);
+    f.createSocket(InetAddress.getByName("127.0.0.1"), 389);
   }
 
 
@@ -219,7 +219,7 @@
 
     assertNotNull(f.getWrappedSocketFactory());
 
-    f.createSocket(InetAddress.getLocalHost(), 389, InetAddress.getLocalHost(),
-         1234);
+    f.createSocket(InetAddress.getByName("127.0.0.1"), 389,
+         InetAddress.getByName("127.0.0.1"), 1234);
   }
 }

Modified: trunk/tests/unit/src/com/unboundid/util/ssl/SetEnabledProtocolsSSLSocketFactoryTestCase.java
===================================================================
--- trunk/tests/unit/src/com/unboundid/util/ssl/SetEnabledProtocolsSSLSocketFactoryTestCase.java	2022-04-21 22:54:04 UTC (rev 1539)
+++ trunk/tests/unit/src/com/unboundid/util/ssl/SetEnabledProtocolsSSLSocketFactoryTestCase.java	2022-04-22 21:49:18 UTC (rev 1540)
@@ -295,7 +295,7 @@
     assertNotNull(f.getSupportedCipherSuites());
 
     final SSLSocket s = (SSLSocket) f.createSocket("127.0.0.1",
-         ds.getListenPort(), InetAddress.getLocalHost(), 0);
+         ds.getListenPort(), InetAddress.getByName("127.0.0.1"), 0);
     assertNotNull(s);
     assertTrue(s.isConnected());
 
@@ -333,8 +333,8 @@
 
     assertNotNull(f.getSupportedCipherSuites());
 
-    final SSLSocket s = (SSLSocket) f.createSocket(InetAddress.getLocalHost(),
-              ds.getListenPort());
+    final SSLSocket s = (SSLSocket) f.createSocket(
+         InetAddress.getByName("127.0.0.1"), ds.getListenPort());
     assertNotNull(s);
     assertTrue(s.isConnected());
 
@@ -372,8 +372,9 @@
 
     assertNotNull(f.getSupportedCipherSuites());
 
-    final SSLSocket s = (SSLSocket) f.createSocket(InetAddress.getLocalHost(),
-         ds.getListenPort(), InetAddress.getLocalHost(), 0);
+    final SSLSocket s = (SSLSocket) f.createSocket(
+         InetAddress.getByName("127.0.0.1"), ds.getListenPort(),
+         InetAddress.getByName("127.0.0.1"), 0);
     assertNotNull(s);
     assertTrue(s.isConnected());
 

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

[ldap-sdk-commits] SF.net SVN: ldap-sdk:[1539] trunk

[<di...@us...>]

Revision: 1539
          http://sourceforge.net/p/ldap-sdk/code/1539
Author:   dirmgr
Date:     2022-04-21 22:54:04 +0000 (Thu, 21 Apr 2022)
Log Message:
-----------
Improve telephone number validation and comparison

Improved support for validating and comparing values using the
telephone number syntax.  Previously, telephone number matching
always used a loose interpretation of the specification, which would
consider any valid printable string (including strings without any
digits) to be a valid telephone number, and it would only ignore
spaces and hyphens when comparing values.  It still uses the same
validation policy by default, but it can now be configured to either
at least require at least one digit, or to require strict adherence
to the X.520 specification (which will require values to start with
a plus sign and a country code, followed by only digits, spaces,
and hyphens).  The default comparison policy has also been updated
to ignore all non-digit characters (except the leading plus sign),
but it can still be configured to use the former default behavior.
The default validation and comparison behaviors can be set either
programmatically or using system properties.

Modified Paths:
--------------
    trunk/docs/release-notes.html
    trunk/messages/unboundid-ldapsdk-matchingrules.properties
    trunk/src/com/unboundid/ldap/matchingrules/TelephoneNumberMatchingRule.java
    trunk/tests/unit/src/com/unboundid/ldap/matchingrules/TelephoneNumberMatchingRuleTestCase.java

Added Paths:
-----------
    trunk/src/com/unboundid/ldap/matchingrules/TelephoneNumberComparisonPolicy.java
    trunk/src/com/unboundid/ldap/matchingrules/TelephoneNumberValidationPolicy.java
    trunk/tests/unit/src/com/unboundid/ldap/matchingrules/TelephoneNumberComparisonPolicyTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/matchingrules/TelephoneNumberValidationPolicyTestCase.java

Modified: trunk/docs/release-notes.html
===================================================================
--- trunk/docs/release-notes.html	2022-04-14 23:47:48 UTC (rev 1538)
+++ trunk/docs/release-notes.html	2022-04-21 22:54:04 UTC (rev 1539)
@@ -14,6 +14,23 @@
 
               <ul>
                 <li>
+                  Improved support for validating and comparing values using the telephone number
+                  syntax.  Previously, telephone number matching always used a loose
+                  interpretation of the specification, which would consider any valid printable
+                  string (including strings without any digits) to be a valid telephone number,
+                  and it would only ignore spaces and hyphens when comparing values.  It still
+                  uses the same validation policy by default, but it can now be configured to
+                  either at least require at least one digit, or to require strict adherence to
+                  the X.520 specification (which will require values to start with a plus sign and
+                  a country code, followed by only digits, spaces, and hyphens).  The default
+                  comparison policy has also been updated to ignore all non-digit characters
+                  (except the leading plus sign), but it can still be configured to use the
+                  former default behavior.  The default validation and comparison behaviors can be
+                  set either programmatically or using system properties.
+                  <br><br>
+                </li>
+
+                <li>
                   Fixed an issue that could occasionally cause the LDAP SDK to hide the cause of a
                   StartTLS failure with a second, less useful exception.
                   <br><br>

Modified: trunk/messages/unboundid-ldapsdk-matchingrules.properties
===================================================================
--- trunk/messages/unboundid-ldapsdk-matchingrules.properties	2022-04-14 23:47:48 UTC (rev 1538)
+++ trunk/messages/unboundid-ldapsdk-matchingrules.properties	2022-04-21 22:54:04 UTC (rev 1539)
@@ -83,4 +83,38 @@
 ERR_CASE_IGNORE_LIST_EMPTY_LIST=The provided value ''{0}'' is not valid \
   according to the case-ignore list syntax because it does not contain any \
   items.
+ERR_TELEPHONE_NUMBER_VALIDATION_EMPTY_SUBSTRING=The provided value is not a \
+  valid telephone number substring assertion because it is empty.
+ERR_TELEPHONE_NUMBER_VALIDATION_EMPTY_VALUE=The provided value is not a valid \
+  telephone number because it is empty.
+ERR_TELEPHONE_NUMBER_VALIDATION_NON_PRINTABLE_SUB_CHAR=The provided value \
+  ''{0}'' is not a valid telephone number substring assertion because it \
+  contains an invalid character at position {1,number,0}.
+ERR_TELEPHONE_NUMBER_VALIDATION_NON_PRINTABLE_CHAR=The provided value ''{0}'' \
+  is not a valid telephone number because it contains an invalid character \
+  at position {1,number,0}.
+ERR_TELEPHONE_NUMBER_VALIDATION_NO_DIGITS=The provided value ''{0}'' is not a \
+  valid telephone number because it does not contain any digits.
+ERR_TELEPHONE_NUMBER_VALIDATION_MISSING_PLUS=The provided value ''{0}'' is \
+  not a valid internationalized telephone number because it does not start \
+  with a plus sign and a country code.
+ERR_TELEPHONE_NUMBER_VALIDATION_NON_FIRST_PLUS_SUB=The provided value ''{0}'' \
+  is not a valid telephone number substring assertion because it contains a \
+  plus sign at position {1,number,0}.  The plus sign may only be the first \
+  character of the value.
+ERR_TELEPHONE_NUMBER_VALIDATION_NON_FIRST_PLUS=The provided value ''{0}'' is \
+  ''{0}'' is not a valid telephone number because it contains a plus sign at \
+  position {1,number,0}.  The plus sign may only be the first character of \
+  the value.
+ERR_TELEPHONE_NUMBER_VALIDATION_INVALID_CHAR_SUB=The provided value ''{0}'' \
+  is not a valid telephone number substring assertion because it contains an \
+  invalid character at position {1,number,0}.  After the leading plus sign, \
+  only digits, spaces, and hyphens are allowed.
+ERR_TELEPHONE_NUMBER_VALIDATION_INVALID_CHAR=The provided value ''{0}'' is \
+  ''{0}'' is not a valid telephone number because it contains an invalid \
+  character at position {1,number,0}.  After the leading lus sign, only \
+  digits, spaces, and hyphens are allowed.
+ERR_TELEPHONE_NUMBER_VALIDATION_NO_DIGITS_SUB=The provided value ''{0}'' \
+  is not a valid telephone number substring assertion because it does not \
+  contain any digits.
 

Added: trunk/src/com/unboundid/ldap/matchingrules/TelephoneNumberComparisonPolicy.java
===================================================================
--- trunk/src/com/unboundid/ldap/matchingrules/TelephoneNumberComparisonPolicy.java	                        (rev 0)
+++ trunk/src/com/unboundid/ldap/matchingrules/TelephoneNumberComparisonPolicy.java	2022-04-21 22:54:04 UTC (rev 1539)
@@ -0,0 +1,124 @@
+/*
+ * Copyright 2022 Ping Identity Corporation
+ * All Rights Reserved.
+ */
+/*
+ * Copyright 2022 Ping Identity Corporation
+ *
+ * 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
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/*
+ * Copyright (C) 2022 Ping Identity Corporation
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License (GPLv2 only)
+ * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, see <http://www.gnu.org/licenses>.
+ */
+package com.unboundid.ldap.matchingrules;
+
+
+
+import com.unboundid.asn1.ASN1OctetString;
+import com.unboundid.util.ByteStringBuffer;
+import com.unboundid.util.NotNull;
+import com.unboundid.util.StaticUtils;
+import com.unboundid.util.ThreadSafety;
+import com.unboundid.util.ThreadSafetyLevel;
+
+
+
+/**
+ * This enum defines the policy that the {@link TelephoneNumberMatchingRule}
+ * should use when comparing two values in accordance with this syntax.
+ */
+@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
+public enum TelephoneNumberComparisonPolicy
+{
+  /**
+   * A policy that indicates that all non-numeric characters should be ignored
+   * when comparing values.
+   */
+  IGNORE_ALL_NON_NUMERIC_CHARACTERS,
+
+
+
+  /**
+   * A policy that indicates that only spaces and hyphens should be ignored when
+   * comparing values.
+   */
+  IGNORE_ONLY_SPACES_AND_DASHES;
+
+
+
+  /**
+   * Normalizes the provided value in accordance with this policy.  This method
+   * does not perform any validation on the provided value.
+   *
+   * @param  value  The value to be normalized.  It must not be {@code null}.
+   *
+   * @return  The normalized representation of the provided value.
+   */
+  @NotNull()
+  public ASN1OctetString normalizeValue(@NotNull final ASN1OctetString value)
+  {
+    final String valueString = StaticUtils.toLowerCase(value.stringValue());
+    final ByteStringBuffer buffer = new ByteStringBuffer(valueString.length());
+    for (int i=0; i < valueString.length(); i++)
+    {
+      final char c = valueString.charAt(i);
+      switch (c)
+      {
+        case ' ':
+        case '-':
+          // These will always be excluded from the normalized representation.
+          break;
+
+        case '+':
+        case '0':
+        case '1':
+        case '2':
+        case '3':
+        case '4':
+        case '5':
+        case '6':
+        case '7':
+        case '8':
+        case '9':
+          // These will always be included in the normalized representation.
+          buffer.append(c);
+          break;
+
+        default:
+          // If we only ignore dashes and spaces, then all other characters will
+          // be included in the normalized representation.  Otherwise, they will
+          // be excluded.
+          if (this == IGNORE_ONLY_SPACES_AND_DASHES)
+          {
+            buffer.append(c);
+          }
+          break;
+      }
+    }
+
+    return new ASN1OctetString(buffer.toByteArray());
+  }
+}

Modified: trunk/src/com/unboundid/ldap/matchingrules/TelephoneNumberMatchingRule.java
===================================================================
--- trunk/src/com/unboundid/ldap/matchingrules/TelephoneNumberMatchingRule.java	2022-04-14 23:47:48 UTC (rev 1538)
+++ trunk/src/com/unboundid/ldap/matchingrules/TelephoneNumberMatchingRule.java	2022-04-21 22:54:04 UTC (rev 1539)
@@ -42,9 +42,11 @@
 import com.unboundid.ldap.sdk.ResultCode;
 import com.unboundid.util.NotNull;
 import com.unboundid.util.Nullable;
+import com.unboundid.util.ObjectPair;
 import com.unboundid.util.StaticUtils;
 import com.unboundid.util.ThreadSafety;
 import com.unboundid.util.ThreadSafetyLevel;
+import com.unboundid.util.Validator;
 
 import static com.unboundid.ldap.matchingrules.MatchingRuleMessages.*;
 
@@ -60,15 +62,71 @@
        extends SimpleMatchingRule
 {
   /**
-   * The singleton instance that will be returned from the {@code getInstance}
-   * method.
+   * The name of the system property that may be used to specify the default
+   * comparison policy.  If this is not specified, and if the default value is
+   * not overridden by the {@link #setDefaultComparisonPolicy} method, then a
+   * default policy of
+   * {@link TelephoneNumberComparisonPolicy#IGNORE_ALL_NON_NUMERIC_CHARACTERS}
+   * will be used.
    */
-  @NotNull private static final TelephoneNumberMatchingRule INSTANCE =
-       new TelephoneNumberMatchingRule();
+  @NotNull public static final String DEFAULT_COMPARISON_POLICY_PROPERTY =
+       TelephoneNumberMatchingRule.class.getName()  +
+            ".defaultComparisonPolicy";
 
 
 
   /**
+   * The name of the system property that may be used to specify the default
+   * validation policy.  If this is not specified, and if the default value is
+   * not overridden by the {@link #setDefaultValidationPolicy} method, then a
+   * default policy of
+   * {@link TelephoneNumberValidationPolicy#ALLOW_NON_EMPTY_PRINTABLE_STRING}
+   * will be used.
+   */
+  @NotNull public static final String DEFAULT_VALIDATION_POLICY_PROPERTY =
+       TelephoneNumberMatchingRule.class.getName()  +
+            ".defaultValidationPolicy";
+
+
+
+  /**
+   * The default comparison policy that will be used if none is specified.
+   */
+  @NotNull private static TelephoneNumberComparisonPolicy
+       DEFAULT_COMPARISON_POLICY;
+
+
+
+  /**
+   * The default validation policy that will be used if none is specified.
+   */
+  @NotNull private static TelephoneNumberValidationPolicy
+       DEFAULT_VALIDATION_POLICY;
+
+
+
+  /**
+   * The instance that will be returned from the {@code getInstance} method.
+   */
+  @NotNull private static TelephoneNumberMatchingRule INSTANCE;
+
+
+
+  static
+  {
+    final ObjectPair<TelephoneNumberValidationPolicy,
+                     TelephoneNumberComparisonPolicy> defaultPolicyPair =
+         computeDefaultPolicies();
+
+    DEFAULT_VALIDATION_POLICY = defaultPolicyPair.getFirst();
+    DEFAULT_COMPARISON_POLICY = defaultPolicyPair.getSecond();
+    INSTANCE = new TelephoneNumberMatchingRule(DEFAULT_VALIDATION_POLICY,
+         DEFAULT_COMPARISON_POLICY);
+  }
+
+
+
+  /**
    * The name for the telephoneNumberMatch equality matching rule.
    */
   @NotNull public static final String EQUALITY_RULE_NAME =
@@ -123,17 +181,51 @@
 
 
 
+  // The policy to use when comparing telephone number values.
+  @NotNull private final TelephoneNumberComparisonPolicy comparisonPolicy;
+
+  // The policy to use when validating telephone number values.
+  @NotNull private final TelephoneNumberValidationPolicy validationPolicy;
+
+
+
   /**
-   * Creates a new instance of this telephone number matching rule.
+   * Creates a new instance of this telephone number matching rule with the
+   * default validation and comparison policies.
    */
   public TelephoneNumberMatchingRule()
   {
-    // No implementation is required.
+    this(DEFAULT_VALIDATION_POLICY, DEFAULT_COMPARISON_POLICY);
   }
 
 
 
   /**
+   * Creates a new instance of this telephone number matching rule with the
+   * specified validation and comparison policies.
+   *
+   * @param  validationPolicy  The policy to use when validating telephone
+   *                           number values.  It must not be
+   *                           {@code null}.
+   * @param  comparisonPolicy  The policy to use when comparing telephone number
+   *                           values.  It must not be {@code null}.
+   */
+  public TelephoneNumberMatchingRule(
+              @NotNull final TelephoneNumberValidationPolicy validationPolicy,
+              @NotNull final TelephoneNumberComparisonPolicy comparisonPolicy)
+  {
+    Validator.ensureNotNullWithMessage(validationPolicy,
+         "TelephoneNumberMatchingRule.validationPolicy must not be null.");
+    Validator.ensureNotNullWithMessage(comparisonPolicy,
+         "TelephoneNumberMatchingRule.comparisonPolicy must not be null.");
+
+    this.validationPolicy = validationPolicy;
+    this.comparisonPolicy = comparisonPolicy;
+  }
+
+
+
+  /**
    * Retrieves a singleton instance of this matching rule.
    *
    * @return  A singleton instance of this matching rule.
@@ -147,6 +239,118 @@
 
 
   /**
+   * Retrieves the policy that will be used for validating telephone number
+   * values.
+   *
+   * @return  The policy that will be used for validating telephone number
+   *          values.
+   */
+  @NotNull()
+  public TelephoneNumberValidationPolicy getValidationPolicy()
+  {
+    return validationPolicy;
+  }
+
+
+
+  /**
+   * Retrieves the policy that will be used for validating telephone number
+   * values when creating an instance of this matching rule using the default
+   * constructor.
+   *
+   * @return  The policy that will be used for validating telephone number
+   *          values when creating an instance of this matching rule using the
+   *          default constructor.
+   */
+  @NotNull()
+  public static TelephoneNumberValidationPolicy getDefaultValidationPolicy()
+  {
+    return DEFAULT_VALIDATION_POLICY;
+  }
+
+
+
+  /**
+   * Specifies the policy that will be used for validating telephone number
+   * values when creating an instance of this matching rule using the default
+   * constructor.
+   *
+   * @param  defaultValidationPolicy  The policy that will be used for
+   *                                  validating telephone number values when
+   *                                  creating an instance of this matching rule
+   *                                  using the default constructor.
+   */
+  public static synchronized void setDefaultValidationPolicy(
+       @NotNull final TelephoneNumberValidationPolicy defaultValidationPolicy)
+  {
+    Validator.ensureNotNullWithMessage(defaultValidationPolicy,
+         "TelephoneNumberMatchingRule.defaultValidationPolicy must not be " +
+              "null.");
+
+    DEFAULT_VALIDATION_POLICY = defaultValidationPolicy;
+    INSTANCE = new TelephoneNumberMatchingRule(DEFAULT_VALIDATION_POLICY,
+         DEFAULT_COMPARISON_POLICY);
+  }
+
+
+
+  /**
+   * Retrieves the policy that will be used for comparing telephone number
+   * values.
+   *
+   * @return  The policy that will be used for comparing telephone number
+   *          values.
+   */
+  @NotNull()
+  public TelephoneNumberComparisonPolicy getComparisonPolicy()
+  {
+    return comparisonPolicy;
+  }
+
+
+
+  /**
+   * Retrieves the policy that will be used for comparing telephone number
+   * values when creating an instance of this matching rule using the default
+   * constructor.
+   *
+   * @return  The policy that will be used for comparing telephone number
+   *          values when creating an instance of this matching rule using the
+   *          default constructor.
+   */
+  @NotNull()
+  public static TelephoneNumberComparisonPolicy getDefaultComparisonPolicy()
+  {
+    return DEFAULT_COMPARISON_POLICY;
+  }
+
+
+
+  /**
+   * Specifies the policy that will be used for comparing telephone number
+   * values when creating an instance of this matching rule using the default
+   * constructor.
+   *
+   * @param  defaultComparisonPolicy  The policy that will be used for
+   *                                  comparing telephone number values when
+   *                                  creating an instance of this matching rule
+   *                                  using the default constructor.
+   */
+  public static synchronized void setDefaultComparisonPolicy(
+       @NotNull final TelephoneNumberComparisonPolicy defaultComparisonPolicy)
+  {
+    Validator.ensureNotNullWithMessage(defaultComparisonPolicy,
+         "TelephoneNumberMatchingRule.defaultComparisonPolicy must not be " +
+              "null.");
+
+    DEFAULT_COMPARISON_POLICY = defaultComparisonPolicy;
+    INSTANCE = new TelephoneNumberMatchingRule(DEFAULT_VALIDATION_POLICY,
+         DEFAULT_COMPARISON_POLICY);
+  }
+
+
+
+  /**
    * {@inheritDoc}
    */
   @Override()
@@ -240,48 +444,8 @@
   public ASN1OctetString normalize(@NotNull final ASN1OctetString value)
          throws LDAPException
   {
-    final byte[] valueBytes = value.getValue();
-    final StringBuilder buffer = new StringBuilder();
-    for (int i=0; i < valueBytes.length; i++)
-    {
-      switch (valueBytes[i])
-      {
-        case ' ':
-        case '-':
-          // These should be ignored.
-          break;
-
-        case '\'':
-        case '(':
-        case ')':
-        case '+':
-        case ',':
-        case '.':
-        case '=':
-        case '/':
-        case ':':
-        case '?':
-          // These should be retained.
-          buffer.append((char) valueBytes[i]);
-          break;
-
-        default:
-          final byte b = valueBytes[i];
-          if (((b >= '0') && (b <= '9')) ||
-              ((b >= 'a') && (b <= 'z')) ||
-              ((b >= 'A') && (b <= 'Z')))
-          {
-            // These should be retained.
-            buffer.append((char) valueBytes[i]);
-            break;
-          }
-
-          throw new LDAPException(ResultCode.INVALID_ATTRIBUTE_SYNTAX,
-               ERR_TELEPHONE_NUMBER_INVALID_CHARACTER.get(i));
-      }
-    }
-
-    return new ASN1OctetString(buffer.toString());
+    validationPolicy.validateValue(value, false);
+    return comparisonPolicy.normalizeValue(value);
   }
 
 
@@ -296,6 +460,76 @@
                               final byte substringType)
          throws LDAPException
   {
-    return normalize(value);
+    validationPolicy.validateValue(value, true);
+    return comparisonPolicy.normalizeValue(value);
   }
+
+
+
+  /**
+   * Computes the default validation and comparison policies that should be used
+   * for this class.
+   *
+   * @return  An object pair in which the first element is the selected default
+   *          validation policy and the second element is the selected default
+   *          comparison policy.
+   */
+  @NotNull()
+  static ObjectPair<TelephoneNumberValidationPolicy,
+                   TelephoneNumberComparisonPolicy> computeDefaultPolicies()
+  {
+    // Determine the appropriate default validation policy.
+    TelephoneNumberValidationPolicy validationPolicy = null;
+    final String validationPropertyValue =
+         StaticUtils.getSystemProperty(DEFAULT_VALIDATION_POLICY_PROPERTY);
+    if (validationPropertyValue != null)
+    {
+      final String normalizedPropertyValue =
+           validationPropertyValue.toUpperCase().replace('-', '_');
+      for (final TelephoneNumberValidationPolicy v :
+           TelephoneNumberValidationPolicy.values())
+      {
+        if (v.name().equals(normalizedPropertyValue))
+        {
+          validationPolicy = v;
+          break;
+        }
+      }
+    }
+
+    if (validationPolicy == null)
+    {
+      validationPolicy =
+           TelephoneNumberValidationPolicy.ALLOW_NON_EMPTY_PRINTABLE_STRING;
+    }
+
+
+    // Determine the appropriate default comparison policy.
+    TelephoneNumberComparisonPolicy comparisonPolicy = null;
+    final String comparisonPropertyValue =
+         StaticUtils.getSystemProperty(DEFAULT_COMPARISON_POLICY_PROPERTY);
+    if (comparisonPropertyValue != null)
+    {
+      final String normalizedPropertyValue =
+           comparisonPropertyValue.toUpperCase().replace('-', '_');
+      for (final TelephoneNumberComparisonPolicy v :
+           TelephoneNumberComparisonPolicy.values())
+      {
+        if (v.name().equals(normalizedPropertyValue))
+        {
+          comparisonPolicy = v;
+          break;
+        }
+      }
+    }
+
+    if (comparisonPolicy == null)
+    {
+      comparisonPolicy =
+           TelephoneNumberComparisonPolicy.IGNORE_ALL_NON_NUMERIC_CHARACTERS;
+    }
+
+
+    return new ObjectPair<>(validationPolicy, comparisonPolicy);
+  }
 }

Added: trunk/src/com/unboundid/ldap/matchingrules/TelephoneNumberValidationPolicy.java
===================================================================
--- trunk/src/com/unboundid/ldap/matchingrules/TelephoneNumberValidationPolicy.java	                        (rev 0)
+++ trunk/src/com/unboundid/ldap/matchingrules/TelephoneNumberValidationPolicy.java	2022-04-21 22:54:04 UTC (rev 1539)
@@ -0,0 +1,341 @@
+/*
+ * Copyright 2022 Ping Identity Corporation
+ * All Rights Reserved.
+ */
+/*
+ * Copyright 2022 Ping Identity Corporation
+ *
+ * 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
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/*
+ * Copyright (C) 2022 Ping Identity Corporation
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License (GPLv2 only)
+ * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, see <http://www.gnu.org/licenses>.
+ */
+package com.unboundid.ldap.matchingrules;
+
+
+
+import com.unboundid.asn1.ASN1OctetString;
+import com.unboundid.ldap.sdk.LDAPException;
+import com.unboundid.ldap.sdk.ResultCode;
+import com.unboundid.util.NotNull;
+import com.unboundid.util.ThreadSafety;
+import com.unboundid.util.ThreadSafetyLevel;
+
+import static com.unboundid.ldap.matchingrules.MatchingRuleMessages.*;
+
+
+
+/**
+ * This enum defines the policy that the {@link TelephoneNumberMatchingRule}
+ * should use when validating values in accordance with the syntax.  Regardless
+ * of the validation policy, the normalized representation of a value will be
+ * the provided value, converted to lowercase, with only spaces and hyphens
+ * removed.
+ */
+@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
+public enum TelephoneNumberValidationPolicy
+{
+  /**
+   * A policy that indicates that any non-empty printable string will be
+   * accepted.  Neither empty strings nor strings that contain characters from
+   * outside the set of printable characters will be accepted.
+   */
+  ALLOW_NON_EMPTY_PRINTABLE_STRING,
+
+
+
+  /**
+   * A policy that indicates that any non-empty printable string will be
+   * accepted, as long as it contains at least one digit.  Neither empty
+   * strings, strings nor strings that contain characters from outside the set
+   * of printable characters, nor strings without any digits will be accepted.
+   */
+  ALLOW_NON_EMPTY_PRINTABLE_STRING_WITH_AT_LEAST_ONE_DIGIT,
+
+
+
+  /**
+   * A policy that indicates that only values that strictly adhere to the
+   * X.520 specification will be accepted.  Only values that start with a
+   * plus sign, contain at least one digit, and contain only digits, spaces, and
+   * hyphens will be accepted.
+   */
+  ENFORCE_STRICT_X520_COMPLIANCE;
+
+
+
+  /**
+   * Validates the provided value to ensure that it satisfies this validation
+   * policy.
+   *
+   * @param  value        The value to be validated.  It must not be
+   *                      {@code null}.
+   * @param  isSubstring  Indicates whether the provided value represents a
+   *                      substring rather than a complete value.
+   *
+   * @throws  LDAPException  If the provided value is not acceptable as per the
+   *                         constraints of this policy.
+   */
+  public void validateValue(@NotNull final ASN1OctetString value,
+                            final boolean isSubstring)
+         throws LDAPException
+  {
+    switch (this)
+    {
+      case ALLOW_NON_EMPTY_PRINTABLE_STRING:
+        validateNonEmptyPrintableString(value, isSubstring, false);
+        break;
+
+      case ALLOW_NON_EMPTY_PRINTABLE_STRING_WITH_AT_LEAST_ONE_DIGIT:
+        validateNonEmptyPrintableString(value, isSubstring, true);
+        break;
+
+      case ENFORCE_STRICT_X520_COMPLIANCE:
+      default:
+        validateX520Compliant(value, isSubstring);
+        break;
+    }
+  }
+
+
+
+  /**
+   * Validates that the provided value is valid in accordance with a policy that
+   * requires a non-empty printable string.
+   *
+   * @param  value                   The value to be validated.  It must not be
+   *                                 {@code null}.
+   * @param  isSubstring             Indicates whether the value represents a
+   *                                 substring rather than a complete value.
+   * @param  requireAtLeastOneDigit  Indicates whether to require the value to
+   *                                 contain at least one digit.  This only
+   *                                 applies if {@code isSubstring} is false.
+   *
+   * @throws  LDAPException  If the provided value is not valid.
+   */
+  private static void validateNonEmptyPrintableString(
+               @NotNull final ASN1OctetString value,
+               final boolean isSubstring,
+               final boolean requireAtLeastOneDigit)
+          throws LDAPException
+  {
+    // Make sure that the value is not empty.
+    final byte[] valueBytes = value.getValue();
+    if (valueBytes.length == 0)
+    {
+      if (isSubstring)
+      {
+        // Substring components must not be empty.
+        throw new LDAPException(ResultCode.INAPPROPRIATE_MATCHING,
+             ERR_TELEPHONE_NUMBER_VALIDATION_EMPTY_SUBSTRING.get());
+      }
+      else
+      {
+        // Telephone number values must not be empty.
+        throw new LDAPException(ResultCode.INVALID_ATTRIBUTE_SYNTAX,
+             ERR_TELEPHONE_NUMBER_VALIDATION_EMPTY_VALUE.get());
+      }
+    }
+
+
+    // Iterate through the bytes of the value and make sure they are all
+    // printable.  Also, check to see if we find any digits.
+    boolean digitFound = false;
+    for (int i=0; i < valueBytes.length; i++)
+    {
+      final byte b = valueBytes[i];
+      if ((b >= '0') && (b <= '9'))
+      {
+        // It's a numeric digit, which is always allowed.
+        digitFound = true;
+      }
+      else if (((b >= 'a') && (b <= 'z')) || ((b >= 'A') && (b <= 'Z')))
+      {
+        // It's an alphabetic character, which is allowed as per the policy.
+      }
+      else
+      {
+        switch (b)
+        {
+          case '\'':
+          case '(':
+          case ')':
+          case '+':
+          case ',':
+          case '-':
+          case '.':
+          case '=':
+          case '/':
+          case ':':
+          case '?':
+          case ' ':
+            // These characters are all allowed.
+            break;
+          default:
+            // This character is not allowed.
+            if (isSubstring)
+            {
+              throw new LDAPException(ResultCode.INAPPROPRIATE_MATCHING,
+                   ERR_TELEPHONE_NUMBER_VALIDATION_NON_PRINTABLE_SUB_CHAR.get(
+                        value.stringValue(), i));
+            }
+            else
+            {
+              throw new LDAPException(ResultCode.INVALID_ATTRIBUTE_SYNTAX,
+                   ERR_TELEPHONE_NUMBER_VALIDATION_NON_PRINTABLE_CHAR.get(
+                        value.stringValue(), i));
+            }
+        }
+      }
+    }
+
+
+    // If we should require a digit, then make sure we found one.
+    if (requireAtLeastOneDigit && (! isSubstring) && (! digitFound))
+    {
+      throw new LDAPException(ResultCode.INVALID_ATTRIBUTE_SYNTAX,
+           ERR_TELEPHONE_NUMBER_VALIDATION_NO_DIGITS.get(value.stringValue()));
+    }
+  }
+
+
+
+  /**
+   * Validates that the provided value is a valid telephone number using the
+   * strict specification defined in X.520.
+   *
+   * @param  value        The value to be validated.  It must not be
+   *                      {@code null}.
+   * @param  isSubstring  Indicates whether the value represents a substring
+   *                      rather than a complete value.
+   *
+   * @throws  LDAPException  If the provided value is not valid.
+   */
+  private static void validateX520Compliant(
+               @NotNull final ASN1OctetString value,
+               final boolean isSubstring)
+          throws LDAPException
+  {
+    // Make sure that the value is not empty.
+    final byte[] valueBytes = value.getValue();
+    if (valueBytes.length == 0)
+    {
+      if (isSubstring)
+      {
+        // Substring components must not be empty.
+        throw new LDAPException(ResultCode.INAPPROPRIATE_MATCHING,
+             ERR_TELEPHONE_NUMBER_VALIDATION_EMPTY_SUBSTRING.get());
+      }
+      else
+      {
+        // Telephone number values must not be empty.
+        throw new LDAPException(ResultCode.INVALID_ATTRIBUTE_SYNTAX,
+             ERR_TELEPHONE_NUMBER_VALIDATION_EMPTY_VALUE.get());
+      }
+    }
+
+
+    // If the value is not a substring, then make sure it starts with a plus
+    // sign.
+    if ((! isSubstring) && (valueBytes[0] != '+'))
+    {
+      throw new LDAPException(ResultCode.INVALID_ATTRIBUTE_SYNTAX,
+           ERR_TELEPHONE_NUMBER_VALIDATION_MISSING_PLUS.get(
+                value.stringValue()));
+    }
+
+
+    // Iterate through the bytes of the value and make sure it only contains a
+    // plus sign, one or more numeric digits, and optionally spaces and/or
+    // dashes.  A plus sign will only be allowed at position zero, and digits,
+    // spaces, and hyphens will be allowed anywhere.
+    boolean digitFound = false;
+    for (int i=0; i < valueBytes.length; i++)
+    {
+      final byte b = valueBytes[i];
+      if (b == '+')
+      {
+        if (i != 0)
+        {
+          if (isSubstring)
+          {
+            throw new LDAPException(ResultCode.INAPPROPRIATE_MATCHING,
+                 ERR_TELEPHONE_NUMBER_VALIDATION_NON_FIRST_PLUS_SUB.get(
+                      value.stringValue(), i));
+          }
+          else
+          {
+            throw new LDAPException(ResultCode.INAPPROPRIATE_MATCHING,
+                 ERR_TELEPHONE_NUMBER_VALIDATION_NON_FIRST_PLUS.get(
+                      value.stringValue(), i));
+          }
+        }
+      }
+      else if ((b >= '0') && (b <= '9'))
+      {
+        digitFound = true;
+      }
+      else if ((b == ' ') || (b == '-'))
+      {
+        // These are always allowed and always ignored.
+      }
+      else
+      {
+        if (isSubstring)
+        {
+            throw new LDAPException(ResultCode.INAPPROPRIATE_MATCHING,
+                 ERR_TELEPHONE_NUMBER_VALIDATION_INVALID_CHAR_SUB.get(
+                      value.stringValue(), i));
+        }
+        else
+        {
+            throw new LDAPException(ResultCode.INAPPROPRIATE_MATCHING,
+                 ERR_TELEPHONE_NUMBER_VALIDATION_INVALID_CHAR.get(
+                      value.stringValue(), i));
+        }
+      }
+    }
+
+
+    // If we didn't find any digits, then that's an error, even for a substring
+    // assertion.
+    if (! digitFound)
+    {
+      if (isSubstring)
+      {
+        throw new LDAPException(ResultCode.INAPPROPRIATE_MATCHING,
+             ERR_TELEPHONE_NUMBER_VALIDATION_NO_DIGITS_SUB.get(
+                  value.stringValue()));
+      }
+      else
+      {
+        throw new LDAPException(ResultCode.INAPPROPRIATE_MATCHING,
+             ERR_TELEPHONE_NUMBER_VALIDATION_NO_DIGITS.get(
+                  value.stringValue()));
+      }
+    }
+  }
+}

Added: trunk/tests/unit/src/com/unboundid/ldap/matchingrules/TelephoneNumberComparisonPolicyTestCase.java
===================================================================
--- trunk/tests/unit/src/com/unboundid/ldap/matchingrules/TelephoneNumberComparisonPolicyTestCase.java	                        (rev 0)
+++ trunk/tests/unit/src/com/unboundid/ldap/matchingrules/TelephoneNumberComparisonPolicyTestCase.java	2022-04-21 22:54:04 UTC (rev 1539)
@@ -0,0 +1,165 @@
+/*
+ * Copyright 2022 Ping Identity Corporation
+ * All Rights Reserved.
+ */
+/*
+ * Copyright 2022 Ping Identity Corporation
+ *
+ * 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
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/*
+ * Copyright (C) 2022 Ping Identity Corporation
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License (GPLv2 only)
+ * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, see <http://www.gnu.org/licenses>.
+ */
+package com.unboundid.ldap.matchingrules;
+
+
+
+import org.testng.annotations.DataProvider;
+import org.testng.annotations.Test;
+
+import com.unboundid.asn1.ASN1OctetString;
+import com.unboundid.ldap.sdk.LDAPSDKTestCase;
+
+
+
+/**
+ * This class provides a set of test cases for the telephone number comparison
+ * policy.
+ */
+public final class TelephoneNumberComparisonPolicyTestCase
+       extends LDAPSDKTestCase
+{
+  /**
+   * Provides basic test coverage for the enum methods.
+   */
+  @Test()
+  public void testEnumMethods()
+  {
+    for (final TelephoneNumberComparisonPolicy p :
+         TelephoneNumberComparisonPolicy.values())
+    {
+      assertEquals(TelephoneNumberComparisonPolicy.valueOf(p.name()), p);
+    }
+
+    try
+    {
+      TelephoneNumberComparisonPolicy.valueOf("undefined-value");
+      fail("Expected valueOf to throw an exception for an undefined value.");
+    }
+    catch (final IllegalArgumentException e)
+    {
+      // This was expected.
+    }
+  }
+
+
+
+  /**
+   * Tests the behavior of the {@code normalizeValue} method with the provided
+   * information.
+   *
+   * @param  value  The value to normalize.
+   * @param  expectedNormalizedIgnoreAllNonNumeric
+   *              The expected normalized representation of the value when
+   *              ignoring all non-numeric characters.
+   * @param  expectedNormalizedIgnoreOnlySpacesAndDashes
+   *              The expected normalized representation of the value when
+   *              ignoring only spaces and dashes.
+   */
+  @Test(dataProvider = "normalizeTestData")
+  public void testNormalize(final String value,
+                   final String expectedNormalizedIgnoreAllNonNumeric,
+                   final String expectedNormalizedIgnoreOnlySpacesAndDashes)
+  {
+    final ASN1OctetString valueOctetString = new ASN1OctetString(value);
+
+    assertEquals(
+         TelephoneNumberComparisonPolicy.IGNORE_ALL_NON_NUMERIC_CHARACTERS.
+              normalizeValue(valueOctetString).stringValue(),
+         expectedNormalizedIgnoreAllNonNumeric);
+
+    assertEquals(
+         TelephoneNumberComparisonPolicy.IGNORE_ONLY_SPACES_AND_DASHES.
+              normalizeValue(valueOctetString).stringValue(),
+         expectedNormalizedIgnoreOnlySpacesAndDashes);
+  }
+
+
+
+  /**
+   * Retrieves a set of data for testing the {@code normalizeValue} method.
+   *
+   * @return  A set of data for testing the {@code normalizeValue} method.
+   */
+  @DataProvider(name = "normalizeTestData")
+  public Object[][] getNormalizeTestData()
+  {
+    return new Object[][]
+    {
+      new Object[]
+      {
+        "",
+        "",
+        ""
+      },
+
+      new Object[]
+      {
+        " ",
+        "",
+        ""
+      },
+
+      new Object[]
+      {
+        "-",
+        "",
+        ""
+      },
+
+      new Object[]
+      {
+        "+1 123 456 7890",
+        "+11234567890",
+        "+11234567890"
+      },
+
+      new Object[]
+      {
+        "+1 123-456-7890",
+        "+11234567890",
+        "+11234567890"
+      },
+
+      new Object[]
+      {
+        "+1 123-456-7890 Ext. 123",
+        "+11234567890123",
+        "+11234567890ext.123"
+      }
+    };
+  }
+}

Modified: trunk/tests/unit/src/com/unboundid/ldap/matchingrules/TelephoneNumberMatchingRuleTestCase.java
===================================================================
--- trunk/tests/unit/src/com/unboundid/ldap/matchingrules/TelephoneNumberMatchingRuleTestCase.java	2022-04-14 23:47:48 UTC (rev 1538)
+++ trunk/tests/unit/src/com/unboundid/ldap/matchingrules/TelephoneNumberMatchingRuleTestCase.java	2022-04-21 22:54:04 UTC (rev 1539)
@@ -37,16 +37,14 @@
 
 
 
-import org.testng.annotations.DataProvider;
 import org.testng.annotations.Test;
 
 import com.unboundid.asn1.ASN1OctetString;
 import com.unboundid.ldap.sdk.LDAPException;
+import com.unboundid.util.ObjectPair;
 
-import static com.unboundid.ldap.matchingrules.MatchingRule.*;
 
 
-
 /**
  * This class provides a set of test cases for the telephone number matching
  * rule.
@@ -55,250 +53,260 @@
        extends MatchingRuleTestCase
 {
   /**
-   * Tests the telephone number matching rule with a number of value pairs
-   * that should be considered matches.
+   * Provides test coverage for a number of general methods for the matching
+   * rule.
    *
-   * @param  value1  The first value to compare.
-   * @param  value2  The second value to compare.
-   *
    * @throws  Exception  If an unexpected problem occurs.
    */
-  @Test(dataProvider = "testMatchingValues")
-  public void testMatchingValues(String value1, String value2)
+  @Test()
+  public void testGeneralMatchingRuleMethods()
          throws Exception
   {
-    ASN1OctetString value1OS = new ASN1OctetString(value1);
-    ASN1OctetString value2OS = new ASN1OctetString(value2);
-
-    TelephoneNumberMatchingRule matchingRule =
+    final TelephoneNumberMatchingRule mr =
          TelephoneNumberMatchingRule.getInstance();
-    assertTrue(matchingRule.valuesMatch(value1OS, value2OS),
-               value1 + ", " + value2);
-  }
+    assertNotNull(mr);
 
+    assertEquals(mr.getEqualityMatchingRuleName(), "telephoneNumberMatch");
 
+    assertEquals(mr.getEqualityMatchingRuleOID(), "2.5.13.20");
 
-  /**
-   * Tests the telephone number matching rule with a number of value pairs
-   * that should not be considered matches.
-   *
-   * @param  value1  The first value to compare.
-   * @param  value2  The second value to compare.
-   *
-   * @throws  Exception  If an unexpected problem occurs.
-   */
-  @Test(dataProvider = "testNonMatchingValues")
-  public void testNonMatchingValues(String value1, String value2)
-         throws Exception
-  {
-    ASN1OctetString value1OS = new ASN1OctetString(value1);
-    ASN1OctetString value2OS = new ASN1OctetString(value2);
+    assertNull(mr.getOrderingMatchingRuleName());
 
-    TelephoneNumberMatchingRule matchingRule =
-         TelephoneNumberMatchingRule.getInstance();
-    assertFalse(matchingRule.valuesMatch(value1OS, value2OS));
+    assertNull(mr.getOrderingMatchingRuleOID());
+
+    assertEquals(mr.getSubstringMatchingRuleName(),
+         "telephoneNumberSubstringsMatch");
+
+    assertEquals(mr.getSubstringMatchingRuleOID(), "2.5.13.21");
   }
 
 
 
   /**
-   * Tests the telephone number matching rule with a number of invalid values.
+   * Tests the ability to configure the default validation and comparison
+   * policies.
    *
-   * @param  invalidValue  An invalid value.
-   *
    * @throws  Exception  If an unexpected problem occurs.
    */
-  @Test(dataProvider = "testInvalidValues",
-        expectedExceptions = { LDAPException.class })
-  public void testNormalizeInvalid(String invalidValue)
+  @Test()
+  public void testDefaultPolicies()
          throws Exception
   {
-    TelephoneNumberMatchingRule matchingRule =
-         TelephoneNumberMatchingRule.getInstance();
-    matchingRule.normalize(new ASN1OctetString(invalidValue));
-  }
+    TelephoneNumberMatchingRule mr = new TelephoneNumberMatchingRule();
+    assertEquals(mr.getValidationPolicy(),
+         TelephoneNumberValidationPolicy.ALLOW_NON_EMPTY_PRINTABLE_STRING);
+    assertEquals(mr.getComparisonPolicy(),
+         TelephoneNumberComparisonPolicy.IGNORE_ALL_NON_NUMERIC_CHARACTERS);
 
+    assertEquals(TelephoneNumberMatchingRule.getDefaultValidationPolicy(),
+         TelephoneNumberValidationPolicy.ALLOW_NON_EMPTY_PRINTABLE_STRING);
+    assertEquals(TelephoneNumberMatchingRule.getDefaultComparisonPolicy(),
+         TelephoneNumberComparisonPolicy.IGNORE_ALL_NON_NUMERIC_CHARACTERS);
 
+    TelephoneNumberMatchingRule.setDefaultValidationPolicy(
+         TelephoneNumberValidationPolicy.ENFORCE_STRICT_X520_COMPLIANCE);
+    assertEquals(TelephoneNumberMatchingRule.getDefaultValidationPolicy(),
+         TelephoneNumberValidationPolicy.ENFORCE_STRICT_X520_COMPLIANCE);
+    assertEquals(TelephoneNumberMatchingRule.getDefaultComparisonPolicy(),
+         TelephoneNumberComparisonPolicy.IGNORE_ALL_NON_NUMERIC_CHARACTERS);
 
-  /**
-   * Tests the {@code normalizeSubstring} method with the provided information.
-   *
-   * @param  rawValue         The raw value to be normalized.
-   * @param  normalizedValue  The expected normalized representation of the
-   *                          provided value.
-   *
-   * @throws  Exception  If an unexpected problem occurs.
-   */
-  @Test(dataProvider = "testMatchingValues")
-  public void testNormalizeSubstring(String rawValue, String normalizedValue)
-         throws Exception
-  {
-    ASN1OctetString rawOS = new ASN1OctetString(rawValue);
+    mr = new TelephoneNumberMatchingRule();
+    assertEquals(mr.getValidationPolicy(),
+         TelephoneNumberValidationPolicy.ENFORCE_STRICT_X520_COMPLIANCE);
+    assertEquals(mr.getComparisonPolicy(),
+         TelephoneNumberComparisonPolicy.IGNORE_ALL_NON_NUMERIC_CHARACTERS);
 
-    TelephoneNumberMatchingRule matchingRule =
-         TelephoneNumberMatchingRule.getInstance();
+    mr = TelephoneNumberMatchingRule.getInstance();
+    assertEquals(mr.getValidationPolicy(),
+         TelephoneNumberValidationPolicy.ENFORCE_STRICT_X520_COMPLIANCE);
+    assertEquals(mr.getComparisonPolicy(),
+         TelephoneNumberComparisonPolicy.IGNORE_ALL_NON_NUMERIC_CHARACTERS);
 
-    assertEquals(matchingRule.normalizeSubstring(rawOS,
-         SUBSTRING_TYPE_SUBINITIAL).stringValue(), normalizedValue);
-    assertEquals(matchingRule.normalizeSubstring(rawOS,
-         SUBSTRING_TYPE_SUBANY).stringValue(), normalizedValue);
-    assertEquals(matchingRule.normalizeSubstring(rawOS,
-         SUBSTRING_TYPE_SUBFINAL).stringValue(), normalizedValue);
-  }
+    TelephoneNumberMatchingRule.setDefaultComparisonPolicy(
+         TelephoneNumberComparisonPolicy.IGNORE_ONLY_SPACES_AND_DASHES);
+    assertEquals(TelephoneNumberMatchingRule.getDefaultValidationPolicy(),
+         TelephoneNumberValidationPolicy.ENFORCE_STRICT_X520_COMPLIANCE);
+    assertEquals(TelephoneNumberMatchingRule.getDefaultComparisonPolicy(),
+         TelephoneNumberComparisonPolicy.IGNORE_ONLY_SPACES_AND_DASHES);
 
+    mr = new TelephoneNumberMatchingRule();
+    assertEquals(mr.getValidationPolicy(),
+         TelephoneNumberValidationPolicy.ENFORCE_STRICT_X520_COMPLIANCE);
+    assertEquals(mr.getComparisonPolicy(),
+         TelephoneNumberComparisonPolicy.IGNORE_ONLY_SPACES_AND_DASHES);
 
+    mr = TelephoneNumberMatchingRule.getInstance();
+    assertEquals(mr.getValidationPolicy(),
+         TelephoneNumberValidationPolicy.ENFORCE_STRICT_X520_COMPLIANCE);
+    assertEquals(mr.getComparisonPolicy(),
+         TelephoneNumberComparisonPolicy.IGNORE_ONLY_SPACES_AND_DASHES);
 
-  /**
-   * Tests the telephone number matching rule to ensure that it does not allow
-   * ordering matching.
-   *
-   * @param  value1  The first value to compare.
-   * @param  value2  The second value to compare.
-   *
-   * @throws  Exception  If an unexpected problem occurs.
-   */
-  @Test(dataProvider = "testMatchingValues",
-        expectedExceptions = { LDAPException.class })
-  public void testOrderingMatching(String value1, String value2)
-         throws Exception
-  {
-    ASN1OctetString value1OS = new ASN1OctetString(value1);
-    ASN1OctetString value2OS = new ASN1OctetString(value2);
+    TelephoneNumberMatchingRule.setDefaultValidationPolicy(
+         TelephoneNumberValidationPolicy.ALLOW_NON_EMPTY_PRINTABLE_STRING);
+    TelephoneNumberMatchingRule.setDefaultComparisonPolicy(
+         TelephoneNumberComparisonPolicy.IGNORE_ALL_NON_NUMERIC_CHARACTERS);
+    assertEquals(TelephoneNumberMatchingRule.getDefaultValidationPolicy(),
+         TelephoneNumberValidationPolicy.ALLOW_NON_EMPTY_PRINTABLE_STRING);
+    assertEquals(TelephoneNumberMatchingRule.getDefaultComparisonPolicy(),
+         TelephoneNumberComparisonPolicy.IGNORE_ALL_NON_NUMERIC_CHARACTERS);
 
-    TelephoneNumberMatchingRule matchingRule =
-         TelephoneNumberMatchingRule.getInstance();
-    matchingRule.compareValues(value1OS, value2OS);
+    mr = new TelephoneNumberMatchingRule();
+    assertEquals(mr.getValidationPolicy(),
+         TelephoneNumberValidationPolicy.ALLOW_NON_EMPTY_PRINTABLE_STRING);
+    assertEquals(mr.getComparisonPolicy(),
+         TelephoneNumberComparisonPolicy.IGNORE_ALL_NON_NUMERIC_CHARACTERS);
+
+    mr = TelephoneNumberMatchingRule.getInstance();
+    assertEquals(mr.getValidationPolicy(),
+         TelephoneNumberValidationPolicy.ALLOW_NON_EMPTY_PRINTABLE_STRING);
+    assertEquals(mr.getComparisonPolicy(),
+         TelephoneNumberComparisonPolicy.IGNORE_ALL_NON_NUMERIC_CHARACTERS);
   }
 
 
 
   /**
-   * Retrieves a set of value pairs that should be considered equal according to
-   * the matching rule.
+   * Tests the behavior when working with values that are valid X.520 telephone
+   * numbers.
    *
-   * @return  A set of value pairs that should be considered equal according to
-   *          the matching rule.
+   * @throws  Exception  If an unexpected problem occurs.
    */
-  @DataProvider(name = "testMatchingValues")
-  public Object[][] getTestMatchingValues()
+  @Test()
+  public void testValidX520TelephoneNumbers()
+         throws Exception
   {
-    return new Object[][]
-    {
-      new Object[] { "+1 123 456 7890", "+11234567890" },
-      new Object[] { "+1 123-456-7890", "+11234567890" },
-      new Object[] { "", "" },
-      new Object[] { " ", "" },
-      new Object[] { "  ", "" },
-      new Object[] { "1", "1" },
-      new Object[] { " 1 ", "1" },
-      new Object[] { "0123456789", "0123456789" },
-      new Object[] { " 0 1 2 3 4    5 6 7 8 9 ", "0123456789" },
-      new Object[] { "+1", "+1" },
-      new Object[] { " +1 ", "+1" },
-      new Object[] { "+0123456789", "+0123456789" },
-      new Object[] { " +0-1-2-3-4    5-6-7-8-9 ", "+0123456789" },
-      new Object[] { "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ" +
-                          "0123456789'()+,-.=/:? ",
-                     "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ" +
-                          "0123456789'()+,.=/:?"},
-    };
-  }
+    final ASN1OctetString v1 = new ASN1OctetString("+1 123 456-7890");
+    final ASN1OctetString v2 = new ASN1OctetString("+1 123 456-7890");
+    final ASN1OctetString v3 = new ASN1OctetString("+11234567890");
+    final ASN1OctetString v4 = new ASN1OctetString("+9 876 543-2100");
 
+    TelephoneNumberMatchingRule mr = new TelephoneNumberMatchingRule(
+         TelephoneNumberValidationPolicy.ALLOW_NON_EMPTY_PRINTABLE_STRING,
+         TelephoneNumberComparisonPolicy.IGNORE_ONLY_SPACES_AND_DASHES);
 
+    assertEquals(mr.normalize(v1).stringValue(), "+11234567890");
+    assertEquals(mr.normalize(v2).stringValue(), "+11234567890");
+    assertEquals(mr.normalize(v3).stringValue(), "+11234567890");
+    assertEquals(mr.normalize(v4).stringValue(), "+98765432100");
 
-  /**
-   * Retrieves a set of value pairs that should not be considered equal
-   * according to the matching rule.
-   *
-   * @return  A set of value pairs that not should be considered equal according
-   *          to the matching rule.
-   */
-  @DataProvider(name = "testNonMatchingValues")
-  public Object[][] getTestNonMatchingValues()
-  {
-    return new Object[][]
+    assertEquals(
+         mr.normalizeSubstring(v1, MatchingRule.SUBSTRING_TYPE_SUBANY).
+              stringValue(),
+         "+11234567890");
+    assertEquals(
+         mr.normalizeSubstring(v2, MatchingRule.SUBSTRING_TYPE_SUBANY).
+              stringValue(),
+         "+11234567890");
+    assertEquals(
+         mr.normalizeSubstring(v3, MatchingRule.SUBSTRING_TYPE_SUBANY).
+              stringValue(),
+         "+11234567890");
+    assertEquals(
+         mr.normalizeSubstring(v4, MatchingRule.SUBSTRING_TYPE_SUBANY).
+              stringValue(),
+         "+98765432100");
+
+    try
     {
-      new Object[] { "0", "1" },
-      new Object[] { "0 1 2 3 4 5   6 7 8 9", "12345" },
-    };
-  }
+      mr.compareValues(v1, v2);
+      fail("Expected an exception when trying to compare telephoneNumber " +
+           "values.");
+    }
+    catch (final LDAPException e)
+    {
+      // This was expected.
+    }
 
+    assertTrue(mr.valuesMatch(v1, v1));
+    assertTrue(mr.valuesMatch(v1, v2));
+    assertTrue(mr.valuesMatch(v1, v3));
+    assertFalse(mr.valuesMatch(v1, v4));
 
-
-  /**
-   * Retrieves a set of invalid values that cannot be parsed as telephone
-   * numbers.
-   *
-   * @return  A set of invalid values that cannot be parsed as telephone
-   *          numbers.
-   */
-  @DataProvider(name = "testInvalidValues")
-  public Object[][] getTestInvalidValues()
-  {
-    return new Object[][]
-    {
-      new Object[] { "\"" },
-      new Object[] { "`" },
-      new Object[] { "~" },
-      new Object[] { "!" },
-      new Object[] { "@" },
-      new Object[] { "#" },
-      new Object[] { "$" },
-      new Object[] { "%" },
-      new Object[] { "^" },
-      new Object[] { "&" },
-      new Object[] { "*" },
-      new Object[] { "_" },
-      new Object[] { "[" },
-      new Object[] { "]" },
-      new Object[] { "{" },
-      new Object[] { "}" },
-      new Object[] { "\\" },
-      new Object[] { "|" },
-      new Object[] { ";" },
-      new Object[] { "<" },
-      new Object[] { ">" }
-    };
+    assertTrue(mr.matchesSubstring(v1, v1, null, null));
+    assertTrue(mr.matchesSubstring(v1, v2, null, null));
+    assertTrue(mr.matchesSubstring(v1, v3, null, null));
+    assertFalse(mr.matchesSubstring(v1, v4, null, null));
   }
 
 
 
   /**
-   * Provides test coverage for the methods used to retrieve the names and OIDs
-   * for the matching rules.
+   * Tests the ability to set default policies based on system properties.
    *
    * @throws  Exception  If an unexpected problem occurs.
    */
   @Test()
-  public void testNamesAndOIDs()
+  public void testComputeDefaultPolicies()
          throws Exception
   {
-    TelephoneNumberMatchingRule mr = TelephoneNumberMatchingRule.getInstance();
+    assertNull(System.getProperty(
+         TelephoneNumberMatchingRule.DEFAULT_VALIDATION_POLICY_PROPERTY));
+    assertNull(System.getProperty(
+         TelephoneNumberMatchingRule.DEFAULT_COMPARISON_POLICY_PROPERTY));
+    assertEquals(TelephoneNumberMatchingRule.getDefaultValidationPolicy(),
+         TelephoneNumberValidationPolicy.ALLOW_NON_EMPTY_PRINTABLE_STRING);
+    assertEquals(TelephoneNumberMatchingRule.getDefaultComparisonPolicy(),
+         TelephoneNumberComparisonPolicy.IGNORE_ALL_NON_NUMERIC_CHARACTERS);
 
-    assertNotNull(mr.getEqualityMatchingRuleName());
-    assertEquals(mr.getEqualityMatchingRuleName(), "telephoneNumberMatch");
+    ObjectPair<TelephoneNumberValidationPolicy,TelephoneNumberComparisonPolicy>
+         policies = TelephoneNumberMatchingRule.computeDefaultPolicies();
+    assertEquals(policies.getFirst(),
+         TelephoneNumberValidationPolicy.ALLOW_NON_EMPTY_PRINTABLE_STRING);
+    assertEquals(policies.getSecond(),
+         TelephoneNumberComparisonPolicy.IGNORE_ALL_NON_NUMERIC_CHARACTERS);
 
-    assertNotNull(mr.getEqualityMatchingRuleOID());
-    assertEquals(mr.getEqualityMatchingRuleOID(), "2.5.13.20");
 
-    assertNotNull(mr.getEqualityMatchingRuleNameOrOID());
-    assertEquals(mr.getEqualityMatchingRuleNameOrOID(), "telephoneNumberMatch");
+    System.setProperty(
+         TelephoneNumberMatchingRule.DEFAULT_VALIDATION_POLICY_PROPERTY,
+         TelephoneNumberValidationPolicy.
+              ALLOW_NON_EMPTY_PRINTABLE_STRING_WITH_AT_LEAST_ONE_DIGIT.name());
+    System.setProperty(
+         TelephoneNumberMatchingRule.DEFAULT_COMPARISON_POLICY_PROPERTY,
+         TelephoneNumberComparisonPolicy.IGNORE_ONLY_SPACES_AND_DASHES.name());
 
-    assertNull(mr.getOrderingMatchingRuleName());
+    policies = TelephoneNumberMatchingRule.computeDefaultPolicies();
+    assertEquals(policies.getFirst(),
+         TelephoneNumberValidationPolicy.
+              ALLOW_NON_EMPTY_PRINTABLE_STRING_WITH_AT_LEAST_ONE_DIGIT);
+    assertEquals(policies.getSecond(),
+         TelephoneNumberComparisonPolicy.IGNORE_ONLY_SPACES_AND_DASHES);
+    assertEquals(TelephoneNumberMatchingRule.getDefaultValidationPolicy(),
+         TelephoneNumberValidationPolicy.ALLOW_NON_EMPTY_PRINTABLE_STRING);
+    assertEquals(TelephoneNumberMatchingRule.getDefaultComparisonPolicy(),
+         TelephoneNumberComparisonPolicy.IGNORE_ALL_NON_NUMERIC_CHARACTERS);
 
-    assertNull(mr.getOrderingMatchingRuleOID());
 
-    assertNull(mr.getOrderingMatchingRuleNameOrOID());
+    System.setProperty(
+         TelephoneNumberMatchingRule.DEFAULT_VALIDATION_POLICY_PROPERTY,
+         "invalid");
+    System.setProperty(
+         TelephoneNumberMatchingRule.DEFAULT_COMPARISON_POLICY_PROPERTY,
+         "invalid");
 
-    assertNotNull(mr.getSubstringMatchingRuleName());
-    assertEquals(mr.getSubstringMatchingRuleName(),
-         "telephoneNumberSubstringsMatch");
+    policies = TelephoneNumberMatchingRule.computeDefaultPolicies();
+    assertEquals(policies.getFirst(),
+         TelephoneNumberValidationPolicy.ALLOW_NON_EMPTY_PRINTABLE_STRING);
+    assertEquals(policies.getSecond(),
+         TelephoneNumberComparisonPolicy.IGNORE_ALL_NON_NUMERIC_CHARACTERS);
+    assertEquals(TelephoneNumberMatchingRule.getDefaultValidationPolicy(),
+         TelephoneNumberValidationPolicy.ALLOW_NON_EMPTY_PRINTABLE_STRING);
+    assertEquals(TelephoneNumberMatchingRule.getDefaultComparisonPolicy(),
+         TelephoneNumberComparisonPolicy.IGNORE_ALL_NON_NUMERIC_CHARACTERS);
 
-    assertNotNull(mr.getSubstringMatchingRuleOID());
-    assertEquals(mr.getSubstringMatchingRuleOID(), "2.5.13.21");
 
-    assertNotNull(mr.getSubstringMatchingRuleNameOrOID());
-    assertEquals(mr.getSubstringMatchingRuleNameOrOID(),
-         "telephoneNumberSubstringsMatch");
+    System.clearProperty(
+         TelephoneNumberMatchingRule.DEFAULT_VALIDATION_POLICY_PROPERTY);
+    System.clearProperty(
+         TelephoneNumberMatchingRule.DEFAULT_COMPARISON_POLICY_PROPERTY);
+
+    policies = TelephoneNumberMatchingRule.computeDefaultPolicies();
+    assertEquals(policies.getFirst(),
+         TelephoneNumberValidationPolicy.ALLOW_NON_EMPTY_PRINTABLE_STRING);
+    assertEquals(policies.getSecond(),
+         TelephoneNumberComparisonPolicy.IGNORE_ALL_NON_NUMERIC_CHARACTERS);
+    assertEquals(TelephoneNumberMatchingRule.getDefaultValidationPolicy(),
+         TelephoneNumberValidationPolicy.ALLOW_NON_EMPTY_PRINTABLE_STRING);
+    assertEquals(TelephoneNumberMatchingRule.getDefaultComparisonPolicy(),
+         TelephoneNumberComparisonPolicy.IGNORE_ALL_NON_NUMERIC_CHARACTERS);
   }
 }

Added: trunk/tests/unit/src/com/unboundid/ldap/matchingrules/TelephoneNumberValidationPolicyTestCase.java
===================================================================
--- trunk/tests/unit/src/com/unboundid/ldap/matchingrules/TelephoneNumberValidationPolicyTestCase.java	                        (rev 0)
+++ trunk/tests/unit/src/com/unboundid/...
 
[truncated message content]

[ldap-sdk-commits] SF.net SVN: ldap-sdk:[1538] trunk

[<di...@us...>]

Revision: 1538
          http://sourceforge.net/p/ldap-sdk/code/1538
Author:   dirmgr
Date:     2022-04-14 23:47:48 +0000 (Thu, 14 Apr 2022)
Log Message:
-----------
Fix a malformed ldifsearch message

Fixed an issue in the ldifsearch tool in which it could display a
malformed message when invoking the tool in which the first unnamed
trailing argument was expected to be the search filter but could not
be parsed as a valid filter.

Modified Paths:
--------------
    trunk/docs/release-notes.html
    trunk/src/com/unboundid/ldif/LDIFSearch.java
    trunk/tests/unit/src/com/unboundid/ldif/LDIFSearchTestCase.java

Modified: trunk/docs/release-notes.html
===================================================================
--- trunk/docs/release-notes.html	2022-04-14 23:25:59 UTC (rev 1537)
+++ trunk/docs/release-notes.html	2022-04-14 23:47:48 UTC (rev 1538)
@@ -20,6 +20,13 @@
                 </li>
 
                 <li>
+                  Fixed an issue in the ldifsearch tool in which it could display a malformed
+                  message when invoking the tool in which the first unnamed trailing argument was
+                  expected to be the search filter but could not be parsed as a valid filter.
+                  <br><br>
+                </li>
+
+                <li>
                   Added support for encoding controls to JSON objects, and for decoding JSON
                   objects as controls.  There is a generic JSON representation that works for all
                   controls (in which the JSON object includes just an OID, criticality, and a

Modified: trunk/src/com/unboundid/ldif/LDIFSearch.java
===================================================================
--- trunk/src/com/unboundid/ldif/LDIFSearch.java	2022-04-14 23:25:59 UTC (rev 1537)
+++ trunk/src/com/unboundid/ldif/LDIFSearch.java	2022-04-14 23:47:48 UTC (rev 1538)
@@ -797,7 +797,9 @@
       {
         Debug.debugException(e);
         throw new ArgumentException(
-             ERR_LDIFSEARCH_FIRST_TRAILING_ARG_NOT_FILTER.get(), e);
+             ERR_LDIFSEARCH_FIRST_TRAILING_ARG_NOT_FILTER.get(
+                  trailingArgs.get(0)),
+             e);
       }
 
 

Modified: trunk/tests/unit/src/com/unboundid/ldif/LDIFSearchTestCase.java
===================================================================
--- trunk/tests/unit/src/com/unboundid/ldif/LDIFSearchTestCase.java	2022-04-14 23:25:59 UTC (rev 1537)
+++ trunk/tests/unit/src/com/unboundid/ldif/LDIFSearchTestCase.java	2022-04-14 23:47:48 UTC (rev 1538)
@@ -1807,6 +1807,37 @@
 
 
   /**
+   * Tests the behavior when the tool is invoked for the case in which there
+   * are no LDAP URLs and the first trailing argument is not a filter.
+   *
+   * @throws  Exception  If an unexpected problem occurs.
+   */
+  @Test()
+  public void testFirstTrailingArgNotFilter()
+         throws Exception
+  {
+    final File ldifFile = createTempFile(
+         "dn: dc=example,dc=com",
+         "objectClass: top",
+         "objectClass: domain",
+         "dc: example");
+
+    final File outputFile = createTempFile();
+    assertTrue(outputFile.delete());
+
+    final ByteArrayOutputStream out = new ByteArrayOutputStream();
+    assertEquals(
+         LDIFSearch.main(out, out,
+              "--ldifFile", ldifFile.getAbsolutePath(),
+              "--outputFile", outputFile.getAbsolutePath(),
+              "notAFilter",
+              "alsoNotAFilter"),
+         ResultCode.PARAM_ERROR);
+  }
+
+
+
+  /**
    * Reads the LDIF entries from the specified file.
    *
    * @param  ldifFile  The file from which to read the change records.  It may

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

[ldap-sdk-commits] SF.net SVN: ldap-sdk:[1537] trunk/src/com/unboundid/ldap/sdk

[<di...@us...>]

Revision: 1537
          http://sourceforge.net/p/ldap-sdk/code/1537
Author:   dirmgr
Date:     2022-04-14 23:25:59 +0000 (Thu, 14 Apr 2022)
Log Message:
-----------
Improve Javadoc for JSON control encodings

Updated the Javadoc for the toJSONControl method in the Control
class and all overridden versions of that method to provide improved
documentation that better describes the fields that may be present
in the JSON objects for the controls, and also for the fields that
may be used in the value-json object for controls with values.

Modified Paths:
--------------
    trunk/src/com/unboundid/ldap/sdk/Control.java
    trunk/src/com/unboundid/ldap/sdk/controls/AssertionRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/AuthorizationIdentityRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/AuthorizationIdentityResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/DraftLDUPSubentriesRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/ManageDsaITRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/MatchedValuesRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/PasswordExpiredControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/PasswordExpiringControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/PermissiveModifyRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/PostReadRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/PostReadResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/PreReadRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/PreReadResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/ProxiedAuthorizationV1RequestControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/ProxiedAuthorizationV2RequestControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/ServerSideSortRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/ServerSideSortResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/SimplePagedResultsControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/SubtreeDeleteRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/VirtualListViewRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/VirtualListViewResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/AccountUsableRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/AccountUsableResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/AdministrativeOperationRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/AssuredReplicationRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/AssuredReplicationResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/ExcludeBranchRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/ExtendedSchemaInfoRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GeneratePasswordRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GeneratePasswordResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetAuthorizationEntryRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetAuthorizationEntryResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetBackendSetIDRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetBackendSetIDResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetEffectiveRightsRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetPasswordPolicyStateIssuesRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetPasswordPolicyStateIssuesResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetRecentLoginHistoryRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetRecentLoginHistoryResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetServerIDRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetServerIDResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetUserResourceLimitsRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetUserResourceLimitsResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/HardDeleteRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/IgnoreNoUserModificationRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/IntermediateClientRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/IntermediateClientResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JoinRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JoinResultControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/MatchingEntryCountRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/MatchingEntryCountResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/NameWithEntryUUIDRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/NoOpRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/OperationPurposeRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/OverrideSearchLimitsRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/PasswordPolicyRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/PasswordPolicyResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/PasswordUpdateBehaviorRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/PasswordValidationDetailsRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/PasswordValidationDetailsResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/PermitUnindexedSearchRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/PurgePasswordRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/RealAttributesOnlyRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/RejectUnindexedSearchRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/ReplicationRepairRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/RetainIdentityRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/RetirePasswordRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/ReturnConflictEntriesRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/RouteToBackendSetRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/RouteToServerRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/SoftDeleteRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/SoftDeleteResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/SoftDeletedEntryAccessRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/SuppressOperationalAttributeUpdateRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/SuppressReferentialIntegrityUpdatesRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/UndeleteRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/UniquenessRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/UniquenessResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/UnsolicitedCancelResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/VirtualAttributesOnlyRequestControl.java

Modified: trunk/src/com/unboundid/ldap/sdk/Control.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/Control.java	2022-04-11 15:08:04 UTC (rev 1536)
+++ trunk/src/com/unboundid/ldap/sdk/Control.java	2022-04-14 23:25:59 UTC (rev 1537)
@@ -905,19 +905,44 @@
 
 
   /**
-   * Retrieves a representation of this control as a JSON object.  The object
-   * will include an {@code oid} field with the object identifier and a
-   * {@code criticality} field with the criticality.  If the control has a
-   * value, then it will include a {@code value-base64} field with a
-   * base64-encoded representation of the value.  Subclasses may override this
-   * method to provide a control-specific encoding, and they may use the
-   * {@code value-json} field as an alternative to {@code value-base64} to
-   * provide a more user-friendly representation of the value.  There may also
-   * be an optional {@code control-name} field that provides a user-friendly
-   * name for the control, but that field is only intended for descriptive
-   * purposes and should not be used in the course of decoding a control.
+   * Retrieves a representation of this control as a JSON object.  The JSON
+   * object uses the following fields:
+   * <UL>
+   *   <LI>
+   *     {@code oid} -- A mandatory string field whose value is the object
+   *     identifier for this control.
+   *   </LI>
+   *   <LI>
+   *     {@code control-name} -- An optional string field whose value is a
+   *     human-readable name for this control.  This field is only intended for
+   *     descriptive purposes, and when decoding a control, the {@code oid}
+   *     field should be used to identify the type of control.
+   *   </LI>
+   *   <LI>
+   *     {@code criticality} -- A mandatory Boolean field used to indicate
+   *     whether this control is considered critical.
+   *   </LI>
+   *   <LI>
+   *     {@code value-base64} -- An optional string field whose value is a
+   *     base64-encoded representation of the raw value for this control.  At
+   *     most one of the {@code value-base64} and {@code value-json} fields may
+   *     be present, and both fields will be absent for controls that do not
+   *     have a value.
+   *   </LI>
+   *   <LI>
+   *     {@code value-json} -- An optional JSON object field whose value is a
+   *     user-friendly, control-specific representation of the value for this
+   *     control.  This representation of the value is only available for
+   *     certain types of controls, and subclasses will override this method to
+   *     provide an appropriate representation of that value, and their Javadoc
+   *     documentation will describe the fields that may be present in the
+   *     value.  At most one of the  {@code value-base64} and {@code value-json}
+   *     fields may be present, and both fields will be absent for controls that
+   *     do not have a value.
+   *   </LI>
+   * </UL>
    *
-   * @return  A representation of this control as a JSON object.
+   * @return  A JSON object that contains a representation of this control.
    */
   @NotNull()
   public JSONObject toJSONControl()

Modified: trunk/src/com/unboundid/ldap/sdk/controls/AssertionRequestControl.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/controls/AssertionRequestControl.java	2022-04-11 15:08:04 UTC (rev 1536)
+++ trunk/src/com/unboundid/ldap/sdk/controls/AssertionRequestControl.java	2022-04-14 23:25:59 UTC (rev 1537)
@@ -367,7 +367,47 @@
 
 
   /**
-   * {@inheritDoc}
+   * Retrieves a representation of this assertion request control as a JSON
+   * object.  The JSON object uses the following fields:
+   * <UL>
+   *   <LI>
+   *     {@code oid} -- A mandatory string field whose value is the object
+   *     identifier for this control.  For the assertion request control, the
+   *     OID is "1.3.6.1.1.12".
+   *   </LI>
+   *   <LI>
+   *     {@code control-name} -- An optional string field whose value is a
+   *     human-readable name for this control.  This field is only intended for
+   *     descriptive purposes, and when decoding a control, the {@code oid}
+   *     field should be used to identify the type of control.
+   *   </LI>
+   *   <LI>
+   *     {@code criticality} -- A mandatory Boolean field used to indicate
+   *     whether this control is considered critical.
+   *   </LI>
+   *   <LI>
+   *     {@code value-base64} -- An optional string field whose value is a
+   *     base64-encoded representation of the raw value for this assertion
+   *     request control.  Exactly one of the {@code value-base64} and
+   *     {@code value-json} fields must be present.
+   *   </LI>
+   *   <LI>
+   *     {@code value-json} -- An optional JSON object field whose value is a
+   *     user-friendly representation of the value for this assertion request
+   *     control.  Exactly one of the {@code value-base64} and
+   *     {@code value-json} fields must be present, and if the
+   *     {@code value-json} field is used, then it will use the following
+   *     fields:
+   *     <UL>
+   *       <LI>
+   *         {@code filter} -- A mandatory string field whose value is a string
+   *         representation of the assertion filter.
+   *       </LI>
+   *     </UL>
+   *   </LI>
+   * </UL>
+   *
+   * @return  A JSON object that contains a representation of this control.
    */
   @Override()
   @NotNull()

Modified: trunk/src/com/unboundid/ldap/sdk/controls/AuthorizationIdentityRequestControl.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/controls/AuthorizationIdentityRequestControl.java	2022-04-11 15:08:04 UTC (rev 1536)
+++ trunk/src/com/unboundid/ldap/sdk/controls/AuthorizationIdentityRequestControl.java	2022-04-14 23:25:59 UTC (rev 1537)
@@ -170,7 +170,29 @@
 
 
   /**
-   * {@inheritDoc}
+   * Retrieves a representation of this authorization identity request control
+   * as a JSON object.  The JSON object uses the following fields (note that
+   * since this control does not have a value, neither the {@code value-base64}
+   * nor {@code value-json} fields may be present):
+   * <UL>
+   *   <LI>
+   *     {@code oid} -- A mandatory string field whose value is the object
+   *     identifier for this control.  For the authorization identity request
+   *     control, the OID is "2.16.840.1.113730.3.4.16".
+   *   </LI>
+   *   <LI>
+   *     {@code control-name} -- An optional string field whose value is a
+   *     human-readable name for this control.  This field is only intended for
+   *     descriptive purposes, and when decoding a control, the {@code oid}
+   *     field should be used to identify the type of control.
+   *   </LI>
+   *   <LI>
+   *     {@code criticality} -- A mandatory Boolean field used to indicate
+   *     whether this control is considered critical.
+   *   </LI>
+   * </UL>
+   *
+   * @return  A JSON object that contains a representation of this control.
    */
   @Override()
   @NotNull()

Modified: trunk/src/com/unboundid/ldap/sdk/controls/AuthorizationIdentityResponseControl.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/controls/AuthorizationIdentityResponseControl.java	2022-04-11 15:08:04 UTC (rev 1536)
+++ trunk/src/com/unboundid/ldap/sdk/controls/AuthorizationIdentityResponseControl.java	2022-04-14 23:25:59 UTC (rev 1537)
@@ -265,7 +265,47 @@
 
 
   /**
-   * {@inheritDoc}
+   * Retrieves a representation of this authorization identity response control
+   * as a JSON object.  The JSON object uses the following fields:
+   * <UL>
+   *   <LI>
+   *     {@code oid} -- A mandatory string field whose value is the object
+   *     identifier for this control.  For the authorization identity response
+   *     control, the OID is "2.16.840.1.113730.3.4.15".
+   *   </LI>
+   *   <LI>
+   *     {@code control-name} -- An optional string field whose value is a
+   *     human-readable name for this control.  This field is only intended for
+   *     descriptive purposes, and when decoding a control, the {@code oid}
+   *     field should be used to identify the type of control.
+   *   </LI>
+   *   <LI>
+   *     {@code criticality} -- A mandatory Boolean field used to indicate
+   *     whether this control is considered critical.
+   *   </LI>
+   *   <LI>
+   *     {@code value-base64} -- An optional string field whose value is a
+   *     base64-encoded representation of the raw value for this authorization
+   *     identity response control.  Exactly one of the {@code value-base64} and
+   *     {@code value-json} fields must be present.
+   *   </LI>
+   *   <LI>
+   *     {@code value-json} -- An optional JSON object field whose value is a
+   *     user-friendly representation of the value for this authorization
+   *     identity response control.  Exactly one of the {@code value-base64} and
+   *     {@code value-json} fields must be present, and if the
+   *     {@code value-json} field is used, then it will use the following
+   *     fields:
+   *     <UL>
+   *       <LI>
+   *         {@code authorization-id} -- A string field whose value is the
+   *         authorization identity assigned during the bind operation.
+   *       </LI>
+   *     </UL>
+   *   </LI>
+   * </UL>
+   *
+   * @return  A JSON object that contains a representation of this control.
    */
   @Override()
   @NotNull()

Modified: trunk/src/com/unboundid/ldap/sdk/controls/DraftLDUPSubentriesRequestControl.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/controls/DraftLDUPSubentriesRequestControl.java	2022-04-11 15:08:04 UTC (rev 1536)
+++ trunk/src/com/unboundid/ldap/sdk/controls/DraftLDUPSubentriesRequestControl.java	2022-04-14 23:25:59 UTC (rev 1537)
@@ -178,7 +178,29 @@
 
 
   /**
-   * {@inheritDoc}
+   * Retrieves a representation of this subentries control as a JSON object.
+   * The JSON object uses the following fields (note that since this control
+   * does not have a value, neither the {@code value-base64} nor
+   * {@code value-json} fields may be present):
+   * <UL>
+   *   <LI>
+   *     {@code oid} -- A mandatory string field whose value is the object
+   *     identifier for this control.  For the subentries control, the OID is
+   *     "1.3.6.1.4.1.7628.5.101.1".
+   *   </LI>
+   *   <LI>
+   *     {@code control-name} -- An optional string field whose value is a
+   *     human-readable name for this control.  This field is only intended for
+   *     descriptive purposes, and when decoding a control, the {@code oid}
+   *     field should be used to identify the type of control.
+   *   </LI>
+   *   <LI>
+   *     {@code criticality} -- A mandatory Boolean field used to indicate
+   *     whether this control is considered critical.
+   *   </LI>
+   * </UL>
+   *
+   * @return  A JSON object that contains a representation of this control.
    */
   @Override()
   @NotNull()

Modified: trunk/src/com/unboundid/ldap/sdk/controls/ManageDsaITRequestControl.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/controls/ManageDsaITRequestControl.java	2022-04-11 15:08:04 UTC (rev 1536)
+++ trunk/src/com/unboundid/ldap/sdk/controls/ManageDsaITRequestControl.java	2022-04-14 23:25:59 UTC (rev 1537)
@@ -203,7 +203,29 @@
 
 
   /**
-   * {@inheritDoc}
+   * Retrieves a representation of this ManageDsaIT request control as a JSON
+   * object.  The JSON object uses the following fields (note that since this
+   * control does not have a value, neither the {@code value-base64} nor
+   * {@code value-json} fields may be present):
+   * <UL>
+   *   <LI>
+   *     {@code oid} -- A mandatory string field whose value is the object
+   *     identifier for this control.  For the ManageDsaIT request control, the
+   *     OID is "2.16.840.1.113730.3.4.2".
+   *   </LI>
+   *   <LI>
+   *     {@code control-name} -- An optional string field whose value is a
+   *     human-readable name for this control.  This field is only intended for
+   *     descriptive purposes, and when decoding a control, the {@code oid}
+   *     field should be used to identify the type of control.
+   *   </LI>
+   *   <LI>
+   *     {@code criticality} -- A mandatory Boolean field used to indicate
+   *     whether this control is considered critical.
+   *   </LI>
+   * </UL>
+   *
+   * @return  A JSON object that contains a representation of this control.
    */
   @Override()
   @NotNull()

Modified: trunk/src/com/unboundid/ldap/sdk/controls/MatchedValuesRequestControl.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/controls/MatchedValuesRequestControl.java	2022-04-11 15:08:04 UTC (rev 1536)
+++ trunk/src/com/unboundid/ldap/sdk/controls/MatchedValuesRequestControl.java	2022-04-14 23:25:59 UTC (rev 1537)
@@ -317,7 +317,48 @@
 
 
   /**
-   * {@inheritDoc}
+   * Retrieves a representation of this matched values request control as a JSON
+   * object.  The JSON object uses the following fields:
+   * <UL>
+   *   <LI>
+   *     {@code oid} -- A mandatory string field whose value is the object
+   *     identifier for this control.  For the matched values request control,
+   *     the OID is "1.2.826.0.1.3344810.2.3".
+   *   </LI>
+   *   <LI>
+   *     {@code control-name} -- An optional string field whose value is a
+   *     human-readable name for this control.  This field is only intended for
+   *     descriptive purposes, and when decoding a control, the {@code oid}
+   *     field should be used to identify the type of control.
+   *   </LI>
+   *   <LI>
+   *     {@code criticality} -- A mandatory Boolean field used to indicate
+   *     whether this control is considered critical.
+   *   </LI>
+   *   <LI>
+   *     {@code value-base64} -- An optional string field whose value is a
+   *     base64-encoded representation of the raw value for this matched values
+   *     request control.  Exactly one of the {@code value-base64} and
+   *     {@code value-json} fields must be present.
+   *   </LI>
+   *   <LI>
+   *     {@code value-json} -- An optional JSON object field whose value is a
+   *     user-friendly representation of the value for this matched values
+   *     request control.  Exactly one of the {@code value-base64} and
+   *     {@code value-json} fields must be present, and if the
+   *     {@code value-json} field is used, then it will use the following
+   *     fields:
+   *     <UL>
+   *       <LI>
+   *         {@code filters} -- A mandatory, non-empty array field whose values
+   *         are the string representations  of the matched values filters to
+   *         use.
+   *       </LI>
+   *     </UL>
+   *   </LI>
+   * </UL>
+   *
+   * @return  A JSON object that contains a representation of this control.
    */
   @Override()
   @NotNull()

Modified: trunk/src/com/unboundid/ldap/sdk/controls/PasswordExpiredControl.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/controls/PasswordExpiredControl.java	2022-04-11 15:08:04 UTC (rev 1536)
+++ trunk/src/com/unboundid/ldap/sdk/controls/PasswordExpiredControl.java	2022-04-14 23:25:59 UTC (rev 1537)
@@ -293,7 +293,30 @@
 
 
   /**
-   * {@inheritDoc}
+   * Retrieves a representation of this password expired control as a JSON
+   * object.  The JSON object uses the following fields (note that since this
+   * control has a fixed value that is always exactly the same for all instances
+   * of the control, neither the {@code value-base64} nor {@code value-json}
+   * fields may be present):
+   * <UL>
+   *   <LI>
+   *     {@code oid} -- A mandatory string field whose value is the object
+   *     identifier for this control.  For the password expired control, the OID
+   *     is "2.16.840.1.113730.3.4.4".
+   *   </LI>
+   *   <LI>
+   *     {@code control-name} -- An optional string field whose value is a
+   *     human-readable name for this control.  This field is only intended for
+   *     descriptive purposes, and when decoding a control, the {@code oid}
+   *     field should be used to identify the type of control.
+   *   </LI>
+   *   <LI>
+   *     {@code criticality} -- A mandatory Boolean field used to indicate
+   *     whether this control is considered critical.
+   *   </LI>
+   * </UL>
+   *
+   * @return  A JSON object that contains a representation of this control.
    */
   @Override()
   @NotNull()

Modified: trunk/src/com/unboundid/ldap/sdk/controls/PasswordExpiringControl.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/controls/PasswordExpiringControl.java	2022-04-11 15:08:04 UTC (rev 1536)
+++ trunk/src/com/unboundid/ldap/sdk/controls/PasswordExpiringControl.java	2022-04-14 23:25:59 UTC (rev 1537)
@@ -255,7 +255,47 @@
 
 
   /**
-   * {@inheritDoc}
+   * Retrieves a representation of this password expiring control as a JSON
+   * object.  The JSON object uses the following fields:
+   * <UL>
+   *   <LI>
+   *     {@code oid} -- A mandatory string field whose value is the object
+   *     identifier for this control.  For the password expiring control, the
+   *     OID is "2.16.840.1.113730.3.4.5".
+   *   </LI>
+   *   <LI>
+   *     {@code control-name} -- An optional string field whose value is a
+   *     human-readable name for this control.  This field is only intended for
+   *     descriptive purposes, and when decoding a control, the {@code oid}
+   *     field should be used to identify the type of control.
+   *   </LI>
+   *   <LI>
+   *     {@code criticality} -- A mandatory Boolean field used to indicate
+   *     whether this control is considered critical.
+   *   </LI>
+   *   <LI>
+   *     {@code value-base64} -- An optional string field whose value is a
+   *     base64-encoded representation of the raw value for this password
+   *     expiring control.  Exactly one of the {@code value-base64} and
+   *     {@code value-json} fields must be present.
+   *   </LI>
+   *   <LI>
+   *     {@code value-json} -- An optional JSON object field whose value is a
+   *     user-friendly representation of the value for this password expiring
+   *     control.  Exactly one of the {@code value-base64} and
+   *     {@code value-json} fields must be present, and if the
+   *     {@code value-json} field is used, then it will use the following
+   *     fields:
+   *     <UL>
+   *       <LI>
+   *         {@code seconds-until-expiration} -- An integer field whose value is
+   *         the number of seconds until the user's password expires.
+   *       </LI>
+   *     </UL>
+   *   </LI>
+   * </UL>
+   *
+   * @return  A JSON object that contains a representation of this control.
    */
   @Override()
   @NotNull()

Modified: trunk/src/com/unboundid/ldap/sdk/controls/PermissiveModifyRequestControl.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/controls/PermissiveModifyRequestControl.java	2022-04-11 15:08:04 UTC (rev 1536)
+++ trunk/src/com/unboundid/ldap/sdk/controls/PermissiveModifyRequestControl.java	2022-04-14 23:25:59 UTC (rev 1537)
@@ -199,7 +199,29 @@
 
 
   /**
-   * {@inheritDoc}
+   * Retrieves a representation of this permissive modify request control as a
+   * JSON object.  The JSON object uses the following fields (note that since
+   * this control does not have a value, neither the {@code value-base64} nor
+   * {@code value-json} fields may be present):
+   * <UL>
+   *   <LI>
+   *     {@code oid} -- A mandatory string field whose value is the object
+   *     identifier for this control.  For the permissive modify request
+   *     control, the OID is "1.2.840.113556.1.4.1413".
+   *   </LI>
+   *   <LI>
+   *     {@code control-name} -- An optional string field whose value is a
+   *     human-readable name for this control.  This field is only intended for
+   *     descriptive purposes, and when decoding a control, the {@code oid}
+   *     field should be used to identify the type of control.
+   *   </LI>
+   *   <LI>
+   *     {@code criticality} -- A mandatory Boolean field used to indicate
+   *     whether this control is considered critical.
+   *   </LI>
+   * </UL>
+   *
+   * @return  A JSON object that contains a representation of this control.
    */
   @Override()
   @NotNull()

Modified: trunk/src/com/unboundid/ldap/sdk/controls/PostReadRequestControl.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/controls/PostReadRequestControl.java	2022-04-11 15:08:04 UTC (rev 1536)
+++ trunk/src/com/unboundid/ldap/sdk/controls/PostReadRequestControl.java	2022-04-14 23:25:59 UTC (rev 1537)
@@ -333,7 +333,48 @@
 
 
   /**
-   * {@inheritDoc}
+   * Retrieves a representation of this post-read request control as a JSON
+   * object.  The JSON object uses the following fields:
+   * <UL>
+   *   <LI>
+   *     {@code oid} -- A mandatory string field whose value is the object
+   *     identifier for this control.  For the post-read request control, the
+   *     OID is "1.3.6.1.1.13.2".
+   *   </LI>
+   *   <LI>
+   *     {@code control-name} -- An optional string field whose value is a
+   *     human-readable name for this control.  This field is only intended for
+   *     descriptive purposes, and when decoding a control, the {@code oid}
+   *     field should be used to identify the type of control.
+   *   </LI>
+   *   <LI>
+   *     {@code criticality} -- A mandatory Boolean field used to indicate
+   *     whether this control is considered critical.
+   *   </LI>
+   *   <LI>
+   *     {@code value-base64} -- An optional string field whose value is a
+   *     base64-encoded representation of the raw value for this post-read
+   *     request control.  Exactly one of the {@code value-base64} and
+   *     {@code value-json} fields must be present.
+   *   </LI>
+   *   <LI>
+   *     {@code value-json} -- An optional JSON object field whose value is a
+   *     user-friendly representation of the value for this post-read request
+   *     control.  Exactly one of the {@code value-base64} and
+   *     {@code value-json} fields must be present, and if the
+   *     {@code value-json} field is used, then it will use the following
+   *     fields:
+   *     <UL>
+   *       <LI>
+   *         {@code attributes} -- An optional array field whose values are
+   *         strings that represent the names of the attributes to include in
+   *         the entry returned in the response control.
+   *       </LI>
+   *     </UL>
+   *   </LI>
+   * </UL>
+   *
+   * @return  A JSON object that contains a representation of this control.
    */
   @Override()
   @NotNull()

Modified: trunk/src/com/unboundid/ldap/sdk/controls/PostReadResponseControl.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/controls/PostReadResponseControl.java	2022-04-11 15:08:04 UTC (rev 1536)
+++ trunk/src/com/unboundid/ldap/sdk/controls/PostReadResponseControl.java	2022-04-14 23:25:59 UTC (rev 1537)
@@ -342,7 +342,44 @@
 
 
   /**
-   * {@inheritDoc}
+   * Retrieves a representation of this post-read response control as a JSON
+   * object.  The JSON object uses the following fields:
+   * <UL>
+   *   <LI>
+   *     {@code oid} -- A mandatory string field whose value is the object
+   *     identifier for this control.  For the post-read response control, the
+   *     OID is "1.3.6.1.1.13.2".
+   *   </LI>
+   *   <LI>
+   *     {@code control-name} -- An optional string field whose value is a
+   *     human-readable name for this control.  This field is only intended for
+   *     descriptive purposes, and when decoding a control, the {@code oid}
+   *     field should be used to identify the type of control.
+   *   </LI>
+   *   <LI>
+   *     {@code criticality} -- A mandatory Boolean field used to indicate
+   *     whether this control is considered critical.
+   *   </LI>
+   *   <LI>
+   *     {@code value-base64} -- An optional string field whose value is a
+   *     base64-encoded representation of the raw value for this post-read
+   *     response control.  Exactly one of the {@code value-base64} and
+   *     {@code value-json} fields must be present.
+   *   </LI>
+   *   <LI>
+   *     {@code value-json} -- An optional JSON object field whose value is a
+   *     user-friendly representation of the value for this post-read response
+   *     control.  Exactly one of the {@code value-base64} and
+   *     {@code value-json} fields must be present, and if the
+   *     {@code value-json} field is used, it must include a
+   *     "{@code _dn}" field whose value is the DN of the entry, and all other
+   *     fields will have a name that is the name of an LDAP attribute in the
+   *     entry and a value that is an array containing the string
+   *     representations of the values for that attribute.
+   *   </LI>
+   * </UL>
+   *
+   * @return  A JSON object that contains a representation of this control.
    */
   @Override()
   @NotNull()

Modified: trunk/src/com/unboundid/ldap/sdk/controls/PreReadRequestControl.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/controls/PreReadRequestControl.java	2022-04-11 15:08:04 UTC (rev 1536)
+++ trunk/src/com/unboundid/ldap/sdk/controls/PreReadRequestControl.java	2022-04-14 23:25:59 UTC (rev 1537)
@@ -283,7 +283,48 @@
 
 
   /**
-   * {@inheritDoc}
+   * Retrieves a representation of this pre-read request control as a JSON
+   * object.  The JSON object uses the following fields:
+   * <UL>
+   *   <LI>
+   *     {@code oid} -- A mandatory string field whose value is the object
+   *     identifier for this control.  For the pre-read request control, the
+   *     OID is "1.3.6.1.1.13.1".
+   *   </LI>
+   *   <LI>
+   *     {@code control-name} -- An optional string field whose value is a
+   *     human-readable name for this control.  This field is only intended for
+   *     descriptive purposes, and when decoding a control, the {@code oid}
+   *     field should be used to identify the type of control.
+   *   </LI>
+   *   <LI>
+   *     {@code criticality} -- A mandatory Boolean field used to indicate
+   *     whether this control is considered critical.
+   *   </LI>
+   *   <LI>
+   *     {@code value-base64} -- An optional string field whose value is a
+   *     base64-encoded representation of the raw value for this pre-read
+   *     request control.  Exactly one of the {@code value-base64} and
+   *     {@code value-json} fields must be present.
+   *   </LI>
+   *   <LI>
+   *     {@code value-json} -- An optional JSON object field whose value is a
+   *     user-friendly representation of the value for this pre-read request
+   *     control.  Exactly one of the {@code value-base64} and
+   *     {@code value-json} fields must be present, and if the
+   *     {@code value-json} field is used, then it will use the following
+   *     fields:
+   *     <UL>
+   *       <LI>
+   *         {@code attributes} -- An optional array field whose values are
+   *         strings that represent the names of the attributes to include in
+   *         the entry returned in the response control.
+   *       </LI>
+   *     </UL>
+   *   </LI>
+   * </UL>
+   *
+   * @return  A JSON object that contains a representation of this control.
    */
   @Override()
   @NotNull()

Modified: trunk/src/com/unboundid/ldap/sdk/controls/PreReadResponseControl.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/controls/PreReadResponseControl.java	2022-04-11 15:08:04 UTC (rev 1536)
+++ trunk/src/com/unboundid/ldap/sdk/controls/PreReadResponseControl.java	2022-04-14 23:25:59 UTC (rev 1537)
@@ -341,7 +341,44 @@
 
 
   /**
-   * {@inheritDoc}
+   * Retrieves a representation of this pre-read response control as a JSON
+   * object.  The JSON object uses the following fields:
+   * <UL>
+   *   <LI>
+   *     {@code oid} -- A mandatory string field whose value is the object
+   *     identifier for this control.  For the pre-read response control, the
+   *     OID is "1.3.6.1.1.13.1".
+   *   </LI>
+   *   <LI>
+   *     {@code control-name} -- An optional string field whose value is a
+   *     human-readable name for this control.  This field is only intended for
+   *     descriptive purposes, and when decoding a control, the {@code oid}
+   *     field should be used to identify the type of control.
+   *   </LI>
+   *   <LI>
+   *     {@code criticality} -- A mandatory Boolean field used to indicate
+   *     whether this control is considered critical.
+   *   </LI>
+   *   <LI>
+   *     {@code value-base64} -- An optional string field whose value is a
+   *     base64-encoded representation of the raw value for this pre-read
+   *     response control.  Exactly one of the {@code value-base64} and
+   *     {@code value-json} fields must be present.
+   *   </LI>
+   *   <LI>
+   *     {@code value-json} -- An optional JSON object field whose value is a
+   *     user-friendly representation of the value for this pre-read response
+   *     control.  Exactly one of the {@code value-base64} and
+   *     {@code value-json} fields must be present, and if the
+   *     {@code value-json} field is used, it must include a
+   *     "{@code _dn}" field whose value is the DN of the entry, and all other
+   *     fields will have a name that is the name of an LDAP attribute in the
+   *     entry and a value that is an array containing the string
+   *     representations of the values for that attribute.
+   *   </LI>
+   * </UL>
+   *
+   * @return  A JSON object that contains a representation of this control.
    */
   @Override()
   @NotNull()

Modified: trunk/src/com/unboundid/ldap/sdk/controls/ProxiedAuthorizationV1RequestControl.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/controls/ProxiedAuthorizationV1RequestControl.java	2022-04-11 15:08:04 UTC (rev 1536)
+++ trunk/src/com/unboundid/ldap/sdk/controls/ProxiedAuthorizationV1RequestControl.java	2022-04-14 23:25:59 UTC (rev 1537)
@@ -297,7 +297,47 @@
 
 
   /**
-   * {@inheritDoc}
+   * Retrieves a representation of this proxied authorization v1 request control
+   * as a JSON object.  The JSON object uses the following fields:
+   * <UL>
+   *   <LI>
+   *     {@code oid} -- A mandatory string field whose value is the object
+   *     identifier for this control.  For the proxied authorization v1 request
+   *     control, the OID is "2.16.840.1.113730.3.4.12".
+   *   </LI>
+   *   <LI>
+   *     {@code control-name} -- An optional string field whose value is a
+   *     human-readable name for this control.  This field is only intended for
+   *     descriptive purposes, and when decoding a control, the {@code oid}
+   *     field should be used to identify the type of control.
+   *   </LI>
+   *   <LI>
+   *     {@code criticality} -- A mandatory Boolean field used to indicate
+   *     whether this control is considered critical.
+   *   </LI>
+   *   <LI>
+   *     {@code value-base64} -- An optional string field whose value is a
+   *     base64-encoded representation of the raw value for this proxied
+   *     authorization v1 request control.  Exactly one of the
+   *     {@code value-base64} and {@code value-json} fields must be present.
+   *   </LI>
+   *   <LI>
+   *     {@code value-json} -- An optional JSON object field whose value is a
+   *     user-friendly representation of the value for this proxied
+   *     authorization v1 request control.  Exactly one of the
+   *     {@code value-base64} and {@code value-json} fields must be present, and
+   *     if the {@code value-json} field is used, then it will use the following
+   *     fields:
+   *     <UL>
+   *       <LI>
+   *         {@code authorization-dn} -- A mandatory string field whose value is
+   *         the DN of the user as whom the request should be authorized.
+   *       </LI>
+   *     </UL>
+   *   </LI>
+   * </UL>
+   *
+   * @return  A JSON object that contains a representation of this control.
    */
   @Override()
   @NotNull()

Modified: trunk/src/com/unboundid/ldap/sdk/controls/ProxiedAuthorizationV2RequestControl.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/controls/ProxiedAuthorizationV2RequestControl.java	2022-04-11 15:08:04 UTC (rev 1536)
+++ trunk/src/com/unboundid/ldap/sdk/controls/ProxiedAuthorizationV2RequestControl.java	2022-04-14 23:25:59 UTC (rev 1537)
@@ -245,7 +245,48 @@
 
 
   /**
-   * {@inheritDoc}
+   * Retrieves a representation of this proxied authorization v2 request control
+   * as a JSON object.  The JSON object uses the following fields:
+   * <UL>
+   *   <LI>
+   *     {@code oid} -- A mandatory string field whose value is the object
+   *     identifier for this control.  For the proxied authorization v2 request
+   *     control, the OID is "2.16.840.1.113730.3.4.18".
+   *   </LI>
+   *   <LI>
+   *     {@code control-name} -- An optional string field whose value is a
+   *     human-readable name for this control.  This field is only intended for
+   *     descriptive purposes, and when decoding a control, the {@code oid}
+   *     field should be used to identify the type of control.
+   *   </LI>
+   *   <LI>
+   *     {@code criticality} -- A mandatory Boolean field used to indicate
+   *     whether this control is considered critical.
+   *   </LI>
+   *   <LI>
+   *     {@code value-base64} -- An optional string field whose value is a
+   *     base64-encoded representation of the raw value for this proxied
+   *     authorization v2 request control.  Exactly one of the
+   *     {@code value-base64} and {@code value-json} fields must be present.
+   *   </LI>
+   *   <LI>
+   *     {@code value-json} -- An optional JSON object field whose value is a
+   *     user-friendly representation of the value for this proxied
+   *     authorization v2 request control.  Exactly one of the
+   *     {@code value-base64} and {@code value-json} fields must be present, and
+   *     if the {@code value-json} field is used, then it will use the following
+   *     fields:
+   *     <UL>
+   *       <LI>
+   *         {@code authorization-id} -- A mandatory string field whose value is
+   *         an authorization ID that identifies the user as whom the request
+   *         should be authorized.
+   *       </LI>
+   *     </UL>
+   *   </LI>
+   * </UL>
+   *
+   * @return  A JSON object that contains a representation of this control.
    */
   @Override()
   @NotNull()

Modified: trunk/src/com/unboundid/ldap/sdk/controls/ServerSideSortRequestControl.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/controls/ServerSideSortRequestControl.java	2022-04-11 15:08:04 UTC (rev 1536)
+++ trunk/src/com/unboundid/ldap/sdk/controls/ServerSideSortRequestControl.java	2022-04-14 23:25:59 UTC (rev 1537)
@@ -383,7 +383,64 @@
 
 
   /**
-   * {@inheritDoc}
+   * Retrieves a representation of this server-side sort request control as a
+   * JSON object.  The JSON object uses the following fields:
+   * <UL>
+   *   <LI>
+   *     {@code oid} -- A mandatory string field whose value is the object
+   *     identifier for this control.  For the server-side sort request control,
+   *     the OID is "1.2.840.113556.1.4.473".
+   *   </LI>
+   *   <LI>
+   *     {@code control-name} -- An optional string field whose value is a
+   *     human-readable name for this control.  This field is only intended for
+   *     descriptive purposes, and when decoding a control, the {@code oid}
+   *     field should be used to identify the type of control.
+   *   </LI>
+   *   <LI>
+   *     {@code criticality} -- A mandatory Boolean field used to indicate
+   *     whether this control is considered critical.
+   *   </LI>
+   *   <LI>
+   *     {@code value-base64} -- An optional string field whose value is a
+   *     base64-encoded representation of the raw value for this server-side
+   *     sort request control.  Exactly one of the {@code value-base64} and
+   *     {@code value-json} fields must be present.
+   *   </LI>
+   *   <LI>
+   *     {@code value-json} -- An optional JSON object field whose value is a
+   *     user-friendly representation of the value for this server-side sort
+   *     request control.  Exactly one of the {@code value-base64} and
+   *     {@code value-json} fields must be present, and if the
+   *     {@code value-json} field is used, then it will use the following
+   *     fields:
+   *     <UL>
+   *       <LI>
+   *         {@code sort-keys} -- A mandatory array field whose values are JSON
+   *         objects used to specify the requested sort order.  Each of the JSON
+   *         objects with the following fields:
+   *         <UL>
+   *           <LI>
+   *             {@code attribute-name} -- A mandatory string field whose value
+   *             is the name of the attribute to use for sorting.
+   *           </LI>
+   *           <LI>
+   *             {@code reverse-order} -- A mandatory Boolean field that
+   *             indicates whether the results should be sorted in descending
+   *             order rather than ascending.
+   *           </LI>
+   *           <LI>
+   *             {@code matching-rule-id} -- An optional string field whose
+   *             value is the name or OID of the ordering matching rule to use
+   *             to perform the sorting.
+   *           </LI>
+   *         </UL>
+   *       </LI>
+   *     </UL>
+   *   </LI>
+   * </UL>
+   *
+   * @return  A JSON object that contains a representation of this control.
    */
   @Override()
   @NotNull()

Modified: trunk/src/com/unboundid/ldap/sdk/controls/ServerSideSortResponseControl.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/controls/ServerSideSortResponseControl.java	2022-04-11 15:08:04 UTC (rev 1536)
+++ trunk/src/com/unboundid/ldap/sdk/controls/ServerSideSortResponseControl.java	2022-04-14 23:25:59 UTC (rev 1537)
@@ -394,7 +394,52 @@
 
 
   /**
-   * {@inheritDoc}
+   * Retrieves a representation of this server-side sort response control as a
+   * JSON object.  The JSON object uses the following fields:
+   * <UL>
+   *   <LI>
+   *     {@code oid} -- A mandatory string field whose value is the object
+   *     identifier for this control.  For the server-side sort response
+   *     control, the OID is "1.2.840.113556.1.4.474".
+   *   </LI>
+   *   <LI>
+   *     {@code control-name} -- An optional string field whose value is a
+   *     human-readable name for this control.  This field is only intended for
+   *     descriptive purposes, and when decoding a control, the {@code oid}
+   *     field should be used to identify the type of control.
+   *   </LI>
+   *   <LI>
+   *     {@code criticality} -- A mandatory Boolean field used to indicate
+   *     whether this control is considered critical.
+   *   </LI>
+   *   <LI>
+   *     {@code value-base64} -- An optional string field whose value is a
+   *     base64-encoded representation of the raw value for this server-side
+   *     sort response control.  Exactly one of the {@code value-base64} and
+   *     {@code value-json} fields must be present.
+   *   </LI>
+   *   <LI>
+   *     {@code value-json} -- An optional JSON object field whose value is a
+   *     user-friendly representation of the value for this server-side sort
+   *     response control.  Exactly one of the {@code value-base64} and
+   *     {@code value-json} fields must be present, and if the
+   *     {@code value-json} field is used, then it will use the following
+   *     fields:
+   *     <UL>
+   *       <LI>
+   *         {@code result-code} -- An integer field whose value is the numeric
+   *         representation of the result code for the sort processing.
+   *       </LI>
+   *       <LI>
+   *         {@code attribute-name} -- An optional string field whose value is
+   *         the name of the attribute with which the result code is most
+   *         closely associated.
+   *       </LI>
+   *     </UL>
+   *   </LI>
+   * </UL>
+   *
+   * @return  A JSON object that contains a representation of this control.
    */
   @Override()
   @NotNull()

Modified: trunk/src/com/unboundid/ldap/sdk/controls/SimplePagedResultsControl.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/controls/SimplePagedResultsControl.java	2022-04-11 15:08:04 UTC (rev 1536)
+++ trunk/src/com/unboundid/ldap/sdk/controls/SimplePagedResultsControl.java	2022-04-14 23:25:59 UTC (rev 1537)
@@ -543,7 +543,61 @@
 
 
   /**
-   * {@inheritDoc}
+   * Retrieves a representation of this simple paged results control as a JSON
+   * object.  The JSON object uses the following fields:
+   * <UL>
+   *   <LI>
+   *     {@code oid} -- A mandatory string field whose value is the object
+   *     identifier for this control.  For the simple paged results control, the
+   *     OID is "1.2.840.113556.1.4.319".
+   *   </LI>
+   *   <LI>
+   *     {@code control-name} -- An optional string field whose value is a
+   *     human-readable name for this control.  This field is only intended for
+   *     descriptive purposes, and when decoding a control, the {@code oid}
+   *     field should be used to identify the type of control.
+   *   </LI>
+   *   <LI>
+   *     {@code criticality} -- A mandatory Boolean field used to indicate
+   *     whether this control is considered critical.
+   *   </LI>
+   *   <LI>
+   *     {@code value-base64} -- An optional string field whose value is a
+   *     base64-encoded representation of the raw value for this simple paged
+   *     results control.  Exactly one of the {@code value-base64} and
+   *     {@code value-json} fields must be present.
+   *   </LI>
+   *   <LI>
+   *     {@code value-json} -- An optional JSON object field whose value is a
+   *     user-friendly representation of the value for this simple paged results
+   *     control.  Exactly one of the {@code value-base64} and
+   *     {@code value-json} fields must be present, and if the
+   *     {@code value-json} field is used, then it will use the following
+   *     fields:
+   *     <UL>
+   *       <LI>
+   *         {@code size} -- A mandatory integer field.  When used in a request
+   *         control, this represents the maximum number of entries that should
+   *         be returned in the next page of results.  When used in a response
+   *         control, it provides an estimate of the total number of entries
+   *         across all pages of the result set.
+   *       </LI>
+   *       <LI>
+   *         {@code cookie} -- An optional string field.  When used in a request
+   *         control, this should be empty when requesting the first page of
+   *         results, and the value of the {@code cookie} field returned in the
+   *         response control from the previous page of results.  For a response
+   *         control, this will be non-empty for all pages except the last page
+   *         of results.  The cookie value used in the JSON representation of
+   *         the control will be a base64-encoded representation of the raw
+   *         cookie value that would be used in the LDAP representation of the
+   *         control, and it must be treated as an opaque blob by the client.
+   *       </LI>
+   *     </UL>
+   *   </LI>
+   * </UL>
+   *
+   * @return  A JSON object that contains a representation of this control.
    */
   @Override()
   @NotNull()

Modified: trunk/src/com/unboundid/ldap/sdk/controls/SubtreeDeleteRequestControl.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/controls/SubtreeDeleteRequestControl.java	2022-04-11 15:08:04 UTC (rev 1536)
+++ trunk/src/com/unboundid/ldap/sdk/controls/SubtreeDeleteRequestControl.java	2022-04-14 23:25:59 UTC (rev 1537)
@@ -193,7 +193,29 @@
 
 
   /**
-   * {@inheritDoc}
+   * Retrieves a representation of this subtree delete request control as a
+   * JSON object.  The JSON object uses the following fields (note that since
+   * this control does not have a value, neither the {@code value-base64} nor
+   * {@code value-json} fields may be present):
+   * <UL>
+   *   <LI>
+   *     {@code oid} -- A mandatory string field whose value is the object
+   *     identifier for this control.  For the subtree delete request control,
+   *     the OID is "1.2.840.113556.1.4.805".
+   *   </LI>
+   *   <LI>
+   *     {@code control-name} -- An optional string field whose value is a
+   *     human-readable name for this control.  This field is only intended for
+   *     descriptive purposes, and when decoding a control, the {@code oid}
+   *     field should be used to identify the type of control.
+   *   </LI>
+   *   <LI>
+   *     {@code criticality} -- A mandatory Boolean field used to indicate
+   *     whether this control is considered critical.
+   *   </LI>
+   * </UL>
+   *
+   * @return  A JSON object that contains a representation of this control.
    */
   @Override()
   @NotNull()

Modified: trunk/src/com/unboundid/ldap/sdk/controls/VirtualListViewRequestControl.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/controls/VirtualListViewRequestControl.java	2022-04-11 15:08:04 UTC (rev 1536)
+++ trunk/src/com/unboundid/ldap/sdk/controls/VirtualListViewRequestControl.java	2022-04-14 23:25:59 UTC (rev 1537)
@@ -963,7 +963,90 @@
 
 
   /**
-   * {@inheritDoc}
+   * Retrieves a representation of this virtual list view request control as a
+   * JSON object.  The JSON object uses the following fields:
+   * <UL>
+   *   <LI>
+   *     {@code oid} -- A mandatory string field whose value is the object
+   *     identifier for this control.  For the virtual list view request
+   *     control, the OID is "2.16.840.1.113730.3.4.9".
+   *   </LI>
+   *   <LI>
+   *     {@code control-name} -- An optional string field whose value is a
+   *     human-readable name for this control.  This field is only intended for
+   *     descriptive purposes, and when decoding a control, the {@code oid}
+   *     field should be used to identify the type of control.
+   *   </LI>
+   *   <LI>
+   *     {@code criticality} -- A mandatory Boolean field used to indicate
+   *     whether this control is considered critical.
+   *   </LI>
+   *   <LI>
+   *     {@code value-base64} -- An optional string field whose value is a
+   *     base64-encoded representation of the raw value for this virtual list
+   *     view request control.  Exactly one of the {@code value-base64} and
+   *     {@code value-json} fields must be present.
+   *   </LI>
+   *   <LI>
+   *     {@code value-json} -- An optional JSON object field whose value is a
+   *     user-friendly representation of the value for this virtual list view
+   *     request control.  Exactly one of the {@code value-base64} and
+   *     {@code value-json} fields must be present, and if the
+   *     {@code value-json} field is used, then it will use the following
+   *     fields:
+   *     <UL>
+   *       <LI>
+   *         {@code target-offset} -- An optional integer field whose value is
+   *         the offset of the target entry within the result set, with the
+   *         first entry in the result set having an offset value of one.
+   *         Exactly one of the {@code target-offset} and
+   *         {@code assertion-value} fields must be provided.
+   *       </LI>
+   *       <LI>
+   *         {@code assertion-value} -- An optional string field that indicates
+   *         that the target entry should be the first one in the result set in
+   *         which the value of the primary sort attribute is greater than or
+   *         equal to the provided assertion value.  Exactly one of the
+   *         {@code target-offset} and {@code assertion-value} fields must be
+   *         provided.
+   *       </LI>
+   *       <LI>
+   *         {@code before-count} -- A mandatory integer field whose value is
+   *         the maximum number of entries before the target entry that should
+   *         be included in the page of results to return.
+   *       </LI>
+   *       <LI>
+   *         {@code after-count} -- A mandatory integer field whose value is
+   *         the maximum number of entries after the target entry that should
+   *         be included in the page of results to return.
+   *       </LI>
+   *       <LI>
+   *         {@code content-count} -- An optional integer field that represents
+   *         the estimated number of entries in the entire result set.  This
+   *         field may only be present when the {@code target-offset} field is
+   *         also provided, and its value may be absent or zero when retrieving
+   *         the first page of results, and it should be the
+   *         {@code content-count} value returned in the previous virtual list
+   *         view response control for all subsequent pages.
+   *       </LI>
+   *       <LI>
+   *         {@code context-id} -- An optional string field that represents an
+   *         opaque cookie that may be used to help the server continue a series
+   *         of searches using the virtual list view request control.  For the
+   *         first search in a series, this should be absent.  For all
+   *         subsequent requests in the series, it should be the
+   *         {@code context-id} value (if any) included in the response control
+   *         from the previous page of the series.  The context ID value used in
+   *         the JSON representation of the control will be a base64-encoded
+   *         representation of the raw cookie value that would be used in the
+   *         LDAP representation of the control, and it must be treated as an
+   *         opaque blob by the client.
+   *       </LI>
+   *     </UL>
+   *   </LI>
+   * </UL>
+   *
+   * @return  A JSON object that contains a representation of this control.
    */
   @Override()
   @NotNull()

Modified: trunk/src/com/unboundid/ldap/sdk/controls/VirtualListViewResponseControl.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/controls/VirtualListViewResponseControl.java	2022-04-11 15:08:04 UTC (rev 1536)
+++ trunk/src/com/unboundid/ldap/sdk/controls/VirtualListViewResponseControl.java	2022-04-14 23:25:59 UTC (rev 1537)
@@ -463,7 +463,66 @@
 
 
   /**
-   * {@inheritDoc}
+   * Retrieves a representation of this virtual list view response control as a
+   * JSON object.  The JSON object uses the following fields:
+   * <UL>
+   *   <LI>
+   *     {@code oid} -- A mandatory string field whose value is the object
+   *     identifier for this control.  For the virtual list view response
+   *     control, the OID is "2.16.840.1.113730.3.4.10".
+   *   </LI>
+   *   <LI>
+   *     {@code control-name} -- An optional string field whose value is a
+   *     human-readable name for this control.  This field is only intended for
+   *     descriptive purposes, and when decoding a control, the {@code oid}
+   *     field should be used to identify the type of control.
+   *   </LI>
+   *   <LI>
+   *     {@code criticality} -- A mandatory Boolean field used to indicate
+   *     whether this control is considered critical.
+   *   </LI>
+   *   <LI>
+   *     {@code value-base64} -- An optional string field whose value is a
+   *     base64-encoded representation of the raw value for this virtual list
+   *     view response control.  Exactly one of the {@code value-base64} and
+   *     {@code value-json} fields must be present.
+   *   </LI>
+   *   <LI>
+   *     {@code value-json} -- An optional JSON object field whose value is a
+   *     user-friendly representation of the value for this virtual list view
+   *     response control.  Exactly one of the {@code value-base64} and
+   *     {@code value-json} fields must be present, and if the
+   *     {@code va...
 
[truncated message content]

[ldap-sdk-commits] SF.net SVN: ldap-sdk:[1536] trunk

[<di...@us...>]

Revision: 1536
          http://sourceforge.net/p/ldap-sdk/code/1536
Author:   dirmgr
Date:     2022-04-11 15:08:04 +0000 (Mon, 11 Apr 2022)
Log Message:
-----------
Update the topology registry trust manager

Updated the topology registry trust manager to allow trusting a
certificate chain if either the peer certificate or any of its
issuers is found in the server's topology registry.  Previously, it
would only trust certificate chains in which the peer certificate
itself was found in the topology registry, and having an issuer
certificate present in the topology registry was not sufficient to
allow certificates signed by that issuer to be trusted.  The former
behavior is still available via a configuration option.

Updated the topology registry trust manager to make it possible to
ignore the certificate validity window for peer and issuer
certificates.  The certificate validity window is still respected by
default, but if the trust manager is configured to ignore that
window, then a certificate chain may be trusted even if the peer
or an issuer certificate is expired or not yet valid.

Modified Paths:
--------------
    trunk/docs/release-notes.html
    trunk/messages/unboundid-ldapsdk-unboundidds.properties
    trunk/src/com/unboundid/ldap/sdk/unboundidds/TopologyRegistryTrustManager.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/TopologyRegistryTrustManagerTestCase.java

Added Paths:
-----------
    trunk/src/com/unboundid/ldap/sdk/unboundidds/TopologyRegistryTrustManagerProperties.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/TopologyRegistryTrustManagerPropertiesTestCase.java

Modified: trunk/docs/release-notes.html
===================================================================
--- trunk/docs/release-notes.html	2022-04-04 23:37:37 UTC (rev 1535)
+++ trunk/docs/release-notes.html	2022-04-11 15:08:04 UTC (rev 1536)
@@ -62,6 +62,26 @@
                   assurance level is used, regardless of the server configuration.
                   <br><br>
                 </li>
+
+                <li>
+                  Updated the topology registry trust manager to allow trusting a certificate
+                  chain if either the peer certificate or any of its issuers is found in the
+                  server's topology registry.  Previously, it would only trust certificate chains
+                  in which the peer certificate itself was found in the topology registry, and
+                  having an issuer certificate present in the topology registry was not sufficient
+                  to allow certificates signed by that issuer to be trusted.  The former behavior
+                  is still available via a configuration option.
+                  <br><br>
+                </li>
+
+                <li>
+                  Updated the topology registry trust manager to make it possible to ignore the
+                  certificate validity window for peer and issuer certificates.  The certificate
+                  validity window is still respected by default, but if the trust manager is
+                  configured to ignore that window, then a certificate chain may be trusted even
+                  if the peer or an issuer certificate is expired or not yet valid.
+                  <br><br>
+                </li>
               </ul>
 
               <p></p>

Modified: trunk/messages/unboundid-ldapsdk-unboundidds.properties
===================================================================
--- trunk/messages/unboundid-ldapsdk-unboundidds.properties	2022-04-04 23:37:37 UTC (rev 1535)
+++ trunk/messages/unboundid-ldapsdk-unboundidds.properties	2022-04-11 15:08:04 UTC (rev 1536)
@@ -594,12 +594,15 @@
   issuer certificate ''{1}'' expired at {2}.
 ERR_TP_TM_PEER_NOT_FOUND=Peer certificate ''{0}'' is not trusted because it \
   was not found in the topology registry.
-ERR_TP_TM_MALFORMED_CONFIG=Unable to trust peer certificate ''{0}'' because \
-  an unrecoverable error was encountered while attempting to parse data read \
-  from configuration file ''{1}'':  {2}
-ERR_TP_TM_ERROR_READING_CONFIG_FILE=Unable to trust peer certificate ''{0}'' \
-  because an error occurred while attempting to read certificate information \
-  from the topology registry in configuration file ''{1}'':  {2}
+ERR_TP_TM_PEER_OR_ISSUERS_NOT_FOUND=The presented certificate chain is not \
+  trusted because neither peer certificate ''{0}'' nor any of its issuers \
+  were found in the topology registry.
+ERR_TP_TM_MALFORMED_CONFIG=Unable to trust the presented certificate chain \
+  because an unrecoverable error was encountered while attempting to parse \
+  data read from configuration file ''{0}'':  {1}
+ERR_TP_TM_ERROR_READING_CONFIG_FILE=Unable to trust the presented certificate \
+  chain because an error occurred while attempting to read certificate \
+  information from the topology registry in configuration file ''{0}'':  {1}
 ERR_LDAP_HANDLER_CANNOT_READ_CONFIG=An error occurred while attempting to \
   read the LDAP connection handler configuration entries from configuration \
   file ''{0}'':  {1}

Modified: trunk/src/com/unboundid/ldap/sdk/unboundidds/TopologyRegistryTrustManager.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/unboundidds/TopologyRegistryTrustManager.java	2022-04-04 23:37:37 UTC (rev 1535)
+++ trunk/src/com/unboundid/ldap/sdk/unboundidds/TopologyRegistryTrustManager.java	2022-04-11 15:08:04 UTC (rev 1536)
@@ -46,6 +46,7 @@
 import java.util.Collections;
 import java.util.HashSet;
 import java.util.Set;
+import java.util.concurrent.TimeUnit;
 import java.util.concurrent.atomic.AtomicLong;
 import java.util.concurrent.atomic.AtomicReference;
 import javax.net.ssl.X509TrustManager;
@@ -147,6 +148,18 @@
   @NotNull private final AtomicReference<Set<X509Certificate>>
        cachedCertificates;
 
+  // Indicates whether to ignore the validity window for issuer certificates
+  // when determining whether to trust a certificate chain.
+  private final boolean ignoreIssuerCertificateValidityWindow;
+
+  // Indicates whether to ignore the validity window for the peer certificate
+  // when determining whether to trust a certificate chain.
+  private final boolean ignorePeerCertificateValidityWindow;
+
+  // Indicates whether to require the peer certificate itself to be included in
+  // the topology registry for a certificate chain to be trusted.
+  private final boolean requirePeerCertificateInTopologyRegistry;
+
   // The configuration file from which the certificate records will be read.
   @NotNull private final File configurationFile;
 
@@ -161,7 +174,8 @@
    *
    * @param  configurationFile    The configuration file for the Ping Identity
    *                              Directory Server instance that holds the
-   *                              topology registry data.
+   *                              topology registry data.  It must not be
+   *                              {@code null}.
    * @param  cacheDurationMillis  The maximum length of time in milliseconds
    *                              that previously loaded certificates may be
    *                              cached.  If this is less than or equal to
@@ -170,9 +184,58 @@
   public TopologyRegistryTrustManager(@NotNull final File configurationFile,
                                       final long cacheDurationMillis)
   {
-    this.configurationFile = configurationFile;
-    this.cacheDurationMillis = cacheDurationMillis;
+    this(getDefaultProperties(configurationFile, cacheDurationMillis));
+  }
 
+
+
+  /**
+   * Retrieves the topology registry trust manager properties that should be
+   * used with the given configuration file and cache duration.
+   *
+   * @param  configurationFile    The configuration file for the Ping Identity
+   *                              Directory Server instance that holds the
+   *                              topology registry data.  It must not be
+   *                              {@code null}.
+   * @param  cacheDurationMillis  The maximum length of time in milliseconds
+   *                              that previously loaded certificates may be
+   *                              cached.  If this is less than or equal to
+   *                              zero, then certificates will not be cached.
+   *
+   * @return  The topology registry trust manager configuration properties that
+   *          should be used.
+   */
+  @NotNull()
+  private static TopologyRegistryTrustManagerProperties getDefaultProperties(
+               @NotNull final File configurationFile,
+               final long cacheDurationMillis)
+  {
+    final TopologyRegistryTrustManagerProperties properties =
+         new TopologyRegistryTrustManagerProperties(configurationFile);
+    properties.setCacheDuration(cacheDurationMillis, TimeUnit.MILLISECONDS);
+    return properties;
+  }
+
+
+
+  /**
+   * Creates a new instance of this trust manager with the provided properties.
+   *
+   * @param  properties  The properties to use to create this trust manager.
+   *                     It must not be {@code null}.
+   */
+  public TopologyRegistryTrustManager(
+              @NotNull final TopologyRegistryTrustManagerProperties properties)
+  {
+    configurationFile = properties.getConfigurationFile();
+    cacheDurationMillis = properties.getCacheDurationMillis();
+    requirePeerCertificateInTopologyRegistry =
+         properties.requirePeerCertificateInTopologyRegistry();
+    ignorePeerCertificateValidityWindow =
+         properties.ignorePeerCertificateValidityWindow();
+    ignoreIssuerCertificateValidityWindow =
+         properties.ignoreIssuerCertificateValidityWindow();
+
     cacheExpirationTime = new AtomicLong(0L);
     cachedCertificates = new AtomicReference<>(
          Collections.<X509Certificate>emptySet());
@@ -181,6 +244,89 @@
 
 
   /**
+   * Retrieves the server configuration file from which the topology registry
+   * certificates will be read.
+   *
+   * @return  The server configuration file from which the topology registry
+   *          certificates will be read.
+   */
+  @NotNull()
+  public File getConfigurationFile()
+  {
+    return configurationFile;
+  }
+
+
+
+  /**
+   * Retrieves the maximum length of time in milliseconds that cached topology
+   * registry information should be considered valid.
+   *
+   * @return  The maximum length of time in milliseconds that cached topology
+   *          registry information should be considered valid, or zero if
+   *          topology registry information should not be cached.
+   */
+  public long getCacheDurationMillis()
+  {
+    return cacheDurationMillis;
+  }
+
+
+
+  /**
+   * Indicates whether to require the peer certificate itself to be included in
+   * the topology registry for a certificate chain to be trusted.
+   *
+   * @return  {@code true} if a certificate chain may only be trusted if the
+   *          topology registry includes the peer certificate itself, or
+   *          {@code false} if a certificate chain may be trusted if the
+   *          topology registry contains the peer certificate or any of its
+   *          issuers.
+   */
+  public boolean requirePeerCertificateInTopologyRegistry()
+  {
+    return requirePeerCertificateInTopologyRegistry;
+  }
+
+
+
+  /**
+   * Indicates whether to ignore the validity window for the peer certificate
+   * when determining whether to trust a certificate chain.
+   *
+   * @return  {@code true} if a certificate chain may be considered trusted
+   *          even if the current time is outside the peer certificate's
+   *          validity window, or {@code false} if a certificate chain may only
+   *          be considered trusted if the current time is between the
+   *          {@code notBefore} and {@code notAfter} timestamps for the peer
+   *          certificate.
+   */
+  public boolean ignorePeerCertificateValidityWindow()
+  {
+    return ignorePeerCertificateValidityWindow;
+  }
+
+
+
+  /**
+   * Indicates whether to ignore the validity window for issuer certificates
+   * when determining whether to trust a certificate chain.
+   *
+   * @return  {@code true} if a certificate chain may be considered trusted
+   *          even if the current time is outside the any issuer certificate's
+   *          validity window, or {@code false} if a certificate chain may only
+   *          be considered trusted if the current time is between the
+   *          {@code notBefore} and {@code notAfter} timestamps for all issuer
+   *          certificates.
+   */
+  public boolean ignoreIssuerCertificateValidityWindow()
+  {
+    return ignoreIssuerCertificateValidityWindow;
+  }
+
+
+
+  /**
    * Checks to determine whether the provided client certificate chain should be
    * trusted.
    *
@@ -240,62 +386,80 @@
     }
 
 
-    // Validate that the peer certificate is currently within its validity
-    // window.
+    // If appropriate, validate that the peer certificate is currently within
+    // its validity window.
     final long currentTime = System.currentTimeMillis();
     final X509Certificate peerCert = chain[0];
-    if (currentTime < peerCert.getNotBefore().getTime())
+    if (! ignorePeerCertificateValidityWindow)
     {
-      throw new CertificateException(ERR_TR_TM_PEER_NOT_YET_VALID.get(
-           peerCert.getSubjectX500Principal().getName(X500Principal.RFC2253),
-           String.valueOf(peerCert.getNotBefore())));
-    }
-
-    if (currentTime > peerCert.getNotAfter().getTime())
-    {
-      throw new CertificateException(ERR_TR_TM_PEER_EXPIRED.get(
-           peerCert.getSubjectX500Principal().getName(X500Principal.RFC2253),
-           String.valueOf(peerCert.getNotAfter())));
-    }
-
-
-    // Validate that all of the issuer certificates are also valid.
-    for (int i=1; i < chain.length; i++)
-    {
-      final X509Certificate issuerCert = chain[i];
-      if (currentTime < issuerCert.getNotBefore().getTime())
+      if (currentTime < peerCert.getNotBefore().getTime())
       {
-        throw new CertificateException(ERR_TR_TM_ISSUER_NOT_YET_VALID.get(
+        throw new CertificateException(ERR_TR_TM_PEER_NOT_YET_VALID.get(
              peerCert.getSubjectX500Principal().getName(X500Principal.RFC2253),
-             issuerCert.getSubjectX500Principal().getName(
-                  X500Principal.RFC2253),
              String.valueOf(peerCert.getNotBefore())));
       }
 
-      if (currentTime > issuerCert.getNotAfter().getTime())
+      if (currentTime > peerCert.getNotAfter().getTime())
       {
-        throw new CertificateException(ERR_TR_TM_ISSUER_EXPIRED.get(
+        throw new CertificateException(ERR_TR_TM_PEER_EXPIRED.get(
              peerCert.getSubjectX500Principal().getName(X500Principal.RFC2253),
-             issuerCert.getSubjectX500Principal().getName(
-                  X500Principal.RFC2253),
              String.valueOf(peerCert.getNotAfter())));
       }
     }
 
 
-    // If the cache is valid and it contains the certificate, then we'll trust
-    // it.
-    if ((cacheExpirationTime.get() >= currentTime) &&
-         cachedCertificates.get().contains(peerCert))
+    // If appropriate, validate that all of the issuer certificates are also
+    // within their validity windows.
+    if (! ignoreIssuerCertificateValidityWindow)
     {
-      // The certificate is trusted.  Return without throwing an exception.
-      return;
+      for (int i=1; i < chain.length; i++)
+      {
+        final X509Certificate issuerCert = chain[i];
+        if (currentTime < issuerCert.getNotBefore().getTime())
+        {
+          throw new CertificateException(ERR_TR_TM_ISSUER_NOT_YET_VALID.get(
+               peerCert.getSubjectX500Principal().getName(
+                    X500Principal.RFC2253),
+               issuerCert.getSubjectX500Principal().getName(
+                    X500Principal.RFC2253),
+               String.valueOf(peerCert.getNotBefore())));
+        }
+
+        if (currentTime > issuerCert.getNotAfter().getTime())
+        {
+          throw new CertificateException(ERR_TR_TM_ISSUER_EXPIRED.get(
+               peerCert.getSubjectX500Principal().getName(
+                    X500Principal.RFC2253),
+               issuerCert.getSubjectX500Principal().getName(
+                    X500Principal.RFC2253),
+               String.valueOf(peerCert.getNotAfter())));
+        }
+      }
     }
 
 
-    // Read the config file and get the certificates it contains.
+    // If the cache is valid, then consult it to determine whether we should
+    // trust the certificate chain.
+    final Set<X509Certificate> cachedCerts = cachedCertificates.get();
+    if ((! cachedCerts.isEmpty()) && (cacheExpirationTime.get() >= currentTime))
+    {
+      if (mayTrustChainBasedOnCertificateSet(chain, cachedCerts))
+      {
+        return;
+      }
+    }
+
+
+    // If we've gotten here, then either caching is disabled, the cache is
+    // expired, or the presented chain can't be trusted based on the cached
+    // information.  In any case, read the configuration and extract all
+    // certificates from the topology registry.
     final Set<X509Certificate> topologyRegistryCertificates =
-         readTopologyRegistryCertificates(peerCert);
+         readTopologyRegistryCertificates();
+
+
+    // If we should cache topology registry data, then update it with the set
+    // of certificates we just read.
     if (cacheDurationMillis > 0L)
     {
       cachedCertificates.set(topologyRegistryCertificates);
@@ -302,25 +466,79 @@
       cacheExpirationTime.set(currentTime + cacheDurationMillis);
     }
 
-    if (topologyRegistryCertificates.contains(peerCert))
+
+    // Check to see if we should trust the certificate chain based on the
+    // topology registry data we just read.
+    if (mayTrustChainBasedOnCertificateSet(chain, topologyRegistryCertificates))
     {
-      // The certificate is trusted.  Return without throwing an exception.
       return;
     }
-    else
+
+
+    // If we've gotten here, then the chain can't be considered trusted.
+    if ((requirePeerCertificateInTopologyRegistry) || (chain.length == 1))
     {
       throw new CertificateException(ERR_TP_TM_PEER_NOT_FOUND.get(
            peerCert.getSubjectX500Principal().getName(X500Principal.RFC2253)));
     }
+    else
+    {
+      throw new CertificateException(ERR_TP_TM_PEER_OR_ISSUERS_NOT_FOUND.get(
+           peerCert.getSubjectX500Principal().getName(X500Principal.RFC2253)));
+    }
   }
 
 
 
   /**
+   * Indicates whether the provided certificate chain may be considered
+   * trusted using the given set of trusted certificates.
+   *
+   * @param  chain           The certificate chain for which to make the
+   *                         determination. It must not be {@code null} or
+   *                         empty.
+   * @param  certificateSet  The set of trusted certificates to use in making
+   *                         the determination.  It must not be {@code null}.
+   *
+   * @return  {@code true} if the presented certificate chain may be considered
+   *          trusted using the given set of trusted certificates, or
+   *          {@code false} if not.
+   */
+  private boolean mayTrustChainBasedOnCertificateSet(
+               @NotNull final X509Certificate[] chain,
+               @NotNull final Set<X509Certificate> certificateSet)
+  {
+    // First, check the peer certificate.
+    if (certificateSet.contains(chain[0]))
+    {
+      return true;
+    }
+
+
+    // If we don't require the peer certificate itself to be present in the
+    // topology registry, then check its issuer certificates.
+    if (! requirePeerCertificateInTopologyRegistry)
+    {
+      for (int i=1; i < chain.length; i++)
+      {
+        if (certificateSet.contains(chain[i]))
+        {
+          return true;
+        }
+      }
+    }
+
+
+    // If we've gotten here, then we can't trust the certificate chain based on
+    // information in the provided set of trusted certificates.
+    return false;
+  }
+
+
+
+  /**
    * Reads the certificates defined in the topology registry.
    *
-   * @param  peerCert  The peer certificate presented for evaluation.
-   *
    * @return  A set containing the certificates defined in the topology
    *          registry, or an empty set if no certificates are found.
    *
@@ -328,8 +546,7 @@
    *                                certificates from the topology registry.
    */
   @NotNull()
-  private Set<X509Certificate> readTopologyRegistryCertificates(
-                                    @NotNull final X509Certificate peerCert)
+  private Set<X509Certificate> readTopologyRegistryCertificates()
           throws CertificateException
   {
     try (LDIFReader ldifReader = new LDIFReader(configurationFile))
@@ -353,8 +570,6 @@
           {
             throw new CertificateException(
                  ERR_TP_TM_MALFORMED_CONFIG.get(
-                      peerCert.getSubjectX500Principal().getName(
-                           X500Principal.RFC2253),
                       configurationFile.getAbsolutePath(),
                       StaticUtils.getExceptionMessage(e)),
                  e);
@@ -383,8 +598,6 @@
       Debug.debugException(e);
       throw new CertificateException(
            ERR_TP_TM_ERROR_READING_CONFIG_FILE.get(
-                peerCert.getSubjectX500Principal().getName(
-                     X500Principal.RFC2253),
                 configurationFile.getAbsolutePath(),
                 StaticUtils.getExceptionMessage(e)),
            e);
@@ -451,4 +664,46 @@
   {
     return NO_CERTIFICATES;
   }
+
+
+
+  /**
+   * Retrieves a string representation of this topology registry trust manager
+   * instance.
+   *
+   * @return  A string representation of this topology registry trust manager
+   *          instance.
+   */
+  @Override()
+  @NotNull()
+  public String toString()
+  {
+    final StringBuilder buffer = new StringBuilder();
+    toString(buffer);
+    return buffer.toString();
+  }
+
+
+
+  /**
+   * Appends a string representation of this topology registry trust manager
+   * instance to the given buffer.
+   *
+   * @param  buffer  The buffer to which the string representation should be
+   *                 appended.
+   */
+  public void toString(@NotNull final StringBuilder buffer)
+  {
+    buffer.append("TopologyRegistryTrustManager(configurationFile='");
+    buffer.append(configurationFile.getAbsolutePath());
+    buffer.append("', cacheDurationMillis=");
+    buffer.append(cacheDurationMillis);
+    buffer.append(", requirePeerCertificateInTopologyRegistry=");
+    buffer.append(requirePeerCertificateInTopologyRegistry);
+    buffer.append(", ignorePeerCertificateValidityWindow=");
+    buffer.append(ignorePeerCertificateValidityWindow);
+    buffer.append(", ignoreIssuerCertificateValidityWindow=");
+    buffer.append(ignoreIssuerCertificateValidityWindow);
+    buffer.append(')');
+  }
 }

Added: trunk/src/com/unboundid/ldap/sdk/unboundidds/TopologyRegistryTrustManagerProperties.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/unboundidds/TopologyRegistryTrustManagerProperties.java	                        (rev 0)
+++ trunk/src/com/unboundid/ldap/sdk/unboundidds/TopologyRegistryTrustManagerProperties.java	2022-04-11 15:08:04 UTC (rev 1536)
@@ -0,0 +1,405 @@
+/*
+ * Copyright 2022 Ping Identity Corporation
+ * All Rights Reserved.
+ */
+/*
+ * Copyright 2022 Ping Identity Corporation
+ *
+ * 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
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/*
+ * Copyright (C) 2022 Ping Identity Corporation
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License (GPLv2 only)
+ * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, see <http://www.gnu.org/licenses>.
+ */
+package com.unboundid.ldap.sdk.unboundidds;
+
+
+
+import java.io.File;
+import java.io.Serializable;
+import java.util.concurrent.TimeUnit;
+
+import com.unboundid.util.Mutable;
+import com.unboundid.util.NotNull;
+import com.unboundid.util.ThreadSafety;
+import com.unboundid.util.ThreadSafetyLevel;
+import com.unboundid.util.Validator;
+
+
+
+/**
+ * This class defines a number of configuration properties that may be used by
+ * the {@link TopologyRegistryTrustManager}.
+ * <BR>
+ * <BLOCKQUOTE>
+ *   <B>NOTE:</B>  This class, and other classes within the
+ *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
+ *   supported for use against Ping Identity, UnboundID, and
+ *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
+ *   for proprietary functionality or for external specifications that are not
+ *   considered stable or mature enough to be guaranteed to work in an
+ *   interoperable way with other types of LDAP servers.
+ * </BLOCKQUOTE>
+ */
+@Mutable()
+@ThreadSafety(level=ThreadSafetyLevel.NOT_THREADSAFE)
+public final class TopologyRegistryTrustManagerProperties
+       implements Serializable
+{
+  /**
+   * The default cache duration in milliseconds.
+   */
+  private static final long DEFAULT_CACHE_DURATION_MILLIS =
+       TimeUnit.MINUTES.toMillis(5L);
+
+
+
+  /**
+   * The serial version UID for this serializable class.
+   */
+  private static final long serialVersionUID = -4753111539481801666L;
+
+
+
+  // Indicates whether to ignore the validity window for issuer certificates
+  // when determining whether to trust a certificate chain.
+  private boolean ignoreIssuerCertificateValidityWindow;
+
+  // Indicates whether to ignore the validity window for the peer certificate
+  // when determining whether to trust a certificate chain.
+  private boolean ignorePeerCertificateValidityWindow;
+
+  // Indicates whether to require the peer certificate itself to be included in
+  // the topology registry for a certificate chain to be trusted.
+  private boolean requirePeerCertificateInTopologyRegistry;
+
+  // The server configuration file from which the topology registry certificates
+  // will be read.
+  @NotNull private File configurationFile;
+
+  // The maximum length of time in milliseconds that previously loaded
+  // certificates may be cached.
+  private long cacheDurationMillis;
+
+
+
+  /**
+   * Creates a new topology registry trust manager properties object with the
+   * specified configuration file and the default settings for all other
+   * properties.  Default settings include:
+   * <UL>
+   *   <LI>cacheDurationMillis -- 300,000 (five minutes)</LI>
+   *   <LI>requirePeerCertificateInTopologyRegistry -- false</LI>
+   *   <LI>ignorePeerCertificateValidityWindow -- false</LI>
+   *   <LI>ignoreIssuerCertificateValidityWindow -- false</LI>
+   * </UL>
+   *
+   * @param  configurationFilePath  The path to the server configuration file
+   *                                from which the topology registry
+   *                                certificates will be read.  It must not be
+   *                                {@code null}, and the file must exist.
+   */
+  public TopologyRegistryTrustManagerProperties(
+              @NotNull final String configurationFilePath)
+  {
+    this(new File(configurationFilePath));
+  }
+
+
+
+  /**
+   * Creates a new topology registry trust manager properties object with the
+   * specified configuration file and the default settings for all other
+   * properties.  Default settings include:
+   * <UL>
+   *   <LI>cacheDurationMillis -- 300,000 (five minutes)</LI>
+   *   <LI>requirePeerCertificateInTopologyRegistry -- false</LI>
+   *   <LI>ignorePeerCertificateValidityWindow -- false</LI>
+   *   <LI>ignoreIssuerCertificateValidityWindow -- false</LI>
+   * </UL>
+   *
+   * @param  configurationFile  The server configuration file from which the
+   *                            topology registry certificates will be read.  It
+   *                            must not be {@code null}, and the file must
+   *                            exist.
+   */
+  public TopologyRegistryTrustManagerProperties(
+              @NotNull final File configurationFile)
+  {
+    Validator.ensureNotNull(configurationFile,
+         "TopologyRegistryTrustManagerProperties.configurationFile must not " +
+              "be null.");
+
+    this.configurationFile = configurationFile;
+
+    cacheDurationMillis = DEFAULT_CACHE_DURATION_MILLIS;
+    requirePeerCertificateInTopologyRegistry = false;
+    ignorePeerCertificateValidityWindow = false;
+    ignoreIssuerCertificateValidityWindow = false;
+  }
+
+
+
+  /**
+   * Retrieves the server configuration file from which the topology registry
+   * certificates will be read.
+   *
+   * @return  The server configuration file from which the topology registry
+   *          certificates will be read.
+   */
+  @NotNull()
+  public File getConfigurationFile()
+  {
+    return configurationFile;
+  }
+
+
+
+  /**
+   * Specifies the server configuration file from which the topology registry
+   * certificates will be read.
+   *
+   * @param  configurationFile  The server configuration file from which the
+   *                            topology registry certificates will be read.  It
+   *                            must not be {@code null}, and the file must
+   *                            exist.
+   */
+  public void setConfigurationFile(@NotNull final File configurationFile)
+  {
+    Validator.ensureNotNull(configurationFile,
+         "TopologyRegistryTrustManagerProperties.configurationFile must not " +
+              "be null.");
+
+    this.configurationFile = configurationFile;
+  }
+
+
+
+  /**
+   * Retrieves the maximum length of time in milliseconds that cached topology
+   * registry information should be considered valid.
+   *
+   * @return  The maximum length of time in milliseconds that cached topology
+   *          registry information should be considered valid, or zero if
+   *          topology registry information should not be cached.
+   */
+  public long getCacheDurationMillis()
+  {
+    return cacheDurationMillis;
+  }
+
+
+
+  /**
+   * Specifies the maximum length of time that cached topology registry
+   * information should be considered valid.
+   *
+   * @param  cacheDurationValue     The cache duration value to use with the
+   *                                given time unit.  If this is less than or
+   *                                equal to zero, then topology registry
+   *                                information will not be cached.
+   * @param  cacheDurationTimeUnit  The time unit to use with the given value.
+   *                                It must not be {@code null}.
+   */
+  public void setCacheDuration(final long cacheDurationValue,
+                               @NotNull final TimeUnit cacheDurationTimeUnit)
+  {
+    Validator.ensureNotNullWithMessage(cacheDurationTimeUnit,
+         "TopologyRegistryTrustManagerProperties.setCacheDuration." +
+              "cacheDurationTimeUnit must not be null.");
+
+    if (cacheDurationValue <= 0L)
+    {
+      cacheDurationMillis = 0L;
+    }
+    else
+    {
+      cacheDurationMillis = cacheDurationTimeUnit.toMillis(cacheDurationValue);
+    }
+  }
+
+
+
+  /**
+   * Indicates whether to require the peer certificate itself to be included in
+   * the topology registry for a certificate chain to be trusted.
+   *
+   * @return  {@code true} if a certificate chain may only be trusted if the
+   *          topology registry includes the peer certificate itself, or
+   *          {@code false} if a certificate chain may be trusted if the
+   *          topology registry contains the peer certificate or any of its
+   *          issuers.
+   */
+  public boolean requirePeerCertificateInTopologyRegistry()
+  {
+    return requirePeerCertificateInTopologyRegistry;
+  }
+
+
+
+  /**
+   * Specifies whether to require the peer certificate itself to be included in
+   * the topology registry for a certificate chain to be trusted.
+   *
+   * @param  requirePeerCertificateInTopologyRegistry
+   *              Indicates whether to require the peer certificate itself to be
+   *              included in the topology registry for a certificate chain to
+   *              be trusted.  If this is {@code true}, then a certificate chain
+   *              may be trusted only if the topology registry contains the
+   *              peer certificate itself.  If this is {@code false}, then a
+   *              certificate chain may be trusted if the topology registry
+   *              contains the peer certificate or any of its issuers.
+   */
+  public void setRequirePeerCertificateInTopologyRegistry(
+                   final boolean requirePeerCertificateInTopologyRegistry)
+  {
+    this.requirePeerCertificateInTopologyRegistry =
+         requirePeerCertificateInTopologyRegistry;
+  }
+
+
+
+  /**
+   * Indicates whether to ignore the validity window for the peer certificate
+   * when determining whether to trust a certificate chain.
+   *
+   * @return  {@code true} if a certificate chain may be considered trusted
+   *          even if the current time is outside the peer certificate's
+   *          validity window, or {@code false} if a certificate chain may only
+   *          be considered trusted if the current time is between the
+   *          {@code notBefore} and {@code notAfter} timestamps for the peer
+   *          certificate.
+   */
+  public boolean ignorePeerCertificateValidityWindow()
+  {
+    return ignorePeerCertificateValidityWindow;
+  }
+
+
+
+  /**
+   * Indicates whether to ignore the validity window for the peer certificate
+   * when determining whether to trust a certificate chain.
+   *
+   * @param  ignorePeerCertificateValidityWindow
+   *              Specifies whether to ignore the validity window for the peer
+   *              certificate when determining whether to trust a certificate
+   *              chain.  If this is {@code true}, then a certificate chain may
+   *              be trusted even if the current time is outside the peer
+   *              certificate's validity window.  If this is {@code false}, then
+   *              a certificate chain may only be trusted if the current time is
+   *              between the {@code notBefore} and {@code notAfter} timestamps
+   *              for the peer certificate.
+   */
+  public void setIgnorePeerCertificateValidityWindow(
+                   final boolean ignorePeerCertificateValidityWindow)
+  {
+    this.ignorePeerCertificateValidityWindow =
+         ignorePeerCertificateValidityWindow;
+  }
+
+
+
+  /**
+   * Indicates whether to ignore the validity window for issuer certificates
+   * when determining whether to trust a certificate chain.
+   *
+   * @return  {@code true} if a certificate chain may be considered trusted
+   *          even if the current time is outside the any issuer certificate's
+   *          validity window, or {@code false} if a certificate chain may only
+   *          be considered trusted if the current time is between the
+   *          {@code notBefore} and {@code notAfter} timestamps for all issuer
+   *          certificates.
+   */
+  public boolean ignoreIssuerCertificateValidityWindow()
+  {
+    return ignoreIssuerCertificateValidityWindow;
+  }
+
+
+
+  /**
+   * Indicates whether to ignore the validity window for the issuer certificates
+   * when determining whether to trust a certificate chain.
+   *
+   * @param  ignoreIssuerCertificateValidityWindow
+   *              Specifies whether to ignore the validity window for issuer
+   *              certificates when determining whether to trust a certificate
+   *              chain.  If this is {@code true}, then a certificate chain may
+   *              be trusted even if the current time is outside any issuer
+   *              certificate's validity window.  If this is {@code false}, then
+   *              a certificate chain may only be trusted if the current time is
+   *              between the {@code notBefore} and {@code notAfter} timestamps
+   *              for all issuer certificate.
+   */
+  public void setIgnoreIssuerCertificateValidityWindow(
+                   final boolean ignoreIssuerCertificateValidityWindow)
+  {
+    this.ignoreIssuerCertificateValidityWindow =
+         ignoreIssuerCertificateValidityWindow;
+  }
+
+
+
+  /**
+   * Retrieves a string representation of the topology registry trust manager
+   * properties.
+   *
+   * @return  A string representation of the topology registry trust manager
+   *          properties.
+   */
+  @Override()
+  @NotNull()
+  public String toString()
+  {
+    final StringBuilder buffer = new StringBuilder();
+    toString(buffer);
+    return buffer.toString();
+  }
+
+
+
+  /**
+   * Appends a string representation of the topology registry trust manager
+   * properties to the given buffer.
+   *
+   * @param  buffer  The buffer to which the string representation should be
+   *                 appended.
+   */
+  public void toString(@NotNull final StringBuilder buffer)
+  {
+    buffer.append("TopologyRegistryTrustManagerProperties(configurationFile='");
+    buffer.append(configurationFile.getAbsolutePath());
+    buffer.append("', cacheDurationMillis=");
+    buffer.append(cacheDurationMillis);
+    buffer.append(", requirePeerCertificateInTopologyRegistry=");
+    buffer.append(requirePeerCertificateInTopologyRegistry);
+    buffer.append(", ignorePeerCertificateValidityWindow=");
+    buffer.append(ignorePeerCertificateValidityWindow);
+    buffer.append(", ignoreIssuerCertificateValidityWindow=");
+    buffer.append(ignoreIssuerCertificateValidityWindow);
+    buffer.append(')');
+  }
+}

Added: trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/TopologyRegistryTrustManagerPropertiesTestCase.java
===================================================================
--- trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/TopologyRegistryTrustManagerPropertiesTestCase.java	                        (rev 0)
+++ trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/TopologyRegistryTrustManagerPropertiesTestCase.java	2022-04-11 15:08:04 UTC (rev 1536)
@@ -0,0 +1,389 @@
+/*
+ * Copyright 2022 Ping Identity Corporation
+ * All Rights Reserved.
+ */
+/*
+ * Copyright 2022 Ping Identity Corporation
+ *
+ * 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
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/*
+ * Copyright (C) 2022 Ping Identity Corporation
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License (GPLv2 only)
+ * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, see <http://www.gnu.org/licenses>.
+ */
+package com.unboundid.ldap.sdk.unboundidds;
+
+
+
+import java.io.File;
+import java.util.concurrent.TimeUnit;
+
+import org.testng.annotations.Test;
+
+import com.unboundid.ldap.sdk.LDAPSDKTestCase;
+
+
+
+/**
+ * This class provides a set of test cases for the topology registry trust
+ * manager properties.
+ */
+public final class TopologyRegistryTrustManagerPropertiesTestCase
+       extends LDAPSDKTestCase
+{
+  /**
+   * Tests the default values for all properties.
+   *
+   * @throws  Exception  If an unexpected problem occurs.
+   */
+  @Test()
+  public void testDefaultProperties()
+         throws Exception
+  {
+    final File f = createTempFile();
+    final TopologyRegistryTrustManagerProperties properties =
+         new TopologyRegistryTrustManagerProperties(f.getAbsolutePath());
+
+    assertEquals(properties.getConfigurationFile(), f);
+
+    assertEquals(properties.getCacheDurationMillis(), 300_000L);
+
+    assertFalse(properties.requirePeerCertificateInTopologyRegistry());
+
+    assertFalse(properties.ignorePeerCertificateValidityWindow());
+
+    assertFalse(properties.ignoreIssuerCertificateValidityWindow());
+
+    assertNotNull(properties.toString());
+    assertFalse(properties.toString().isEmpty());
+  }
+
+
+
+  /**
+   * Tests the properties for the configuration file.
+   *
+   * @throws  Exception  If an unexpected problem occurs.
+   */
+  @Test()
+  public void testConfigurationFile()
+         throws Exception
+  {
+    final File originalFile = createTempFile();
+    final TopologyRegistryTrustManagerProperties properties =
+         new TopologyRegistryTrustManagerProperties(originalFile);
+
+    assertEquals(properties.getConfigurationFile(), originalFile);
+
+    assertEquals(properties.getCacheDurationMillis(), 300_000L);
+
+    assertFalse(properties.requirePeerCertificateInTopologyRegistry());
+
+    assertFalse(properties.ignorePeerCertificateValidityWindow());
+
+    assertFalse(properties.ignoreIssuerCertificateValidityWindow());
+
+    assertNotNull(properties.toString());
+    assertFalse(properties.toString().isEmpty());
+
+
+    final File newFile = createTempFile();
+    properties.setConfigurationFile(newFile);
+
+    assertEquals(properties.getConfigurationFile(), newFile);
+
+    assertEquals(properties.getCacheDurationMillis(), 300_000L);
+
+    assertFalse(properties.requirePeerCertificateInTopologyRegistry());
+
+    assertFalse(properties.ignorePeerCertificateValidityWindow());
+
+    assertFalse(properties.ignoreIssuerCertificateValidityWindow());
+
+    assertNotNull(properties.toString());
+    assertFalse(properties.toString().isEmpty());
+  }
+
+
+
+  /**
+   * Tests the properties for the cache duration.
+   *
+   * @throws  Exception  If an unexpected problem occurs.
+   */
+  @Test()
+  public void testCacheDuration()
+         throws Exception
+  {
+    final File f = createTempFile();
+    final TopologyRegistryTrustManagerProperties properties =
+         new TopologyRegistryTrustManagerProperties(f);
+
+    assertEquals(properties.getConfigurationFile(), f);
+
+    assertEquals(properties.getCacheDurationMillis(), 300_000L);
+
+    assertFalse(properties.requirePeerCertificateInTopologyRegistry());
+
+    assertFalse(properties.ignorePeerCertificateValidityWindow());
+
+    assertFalse(properties.ignoreIssuerCertificateValidityWindow());
+
+    assertNotNull(properties.toString());
+    assertFalse(properties.toString().isEmpty());
+
+
+    properties.setCacheDuration(0L, TimeUnit.MILLISECONDS);
+
+    assertEquals(properties.getConfigurationFile(), f);
+
+    assertEquals(properties.getCacheDurationMillis(), 0L);
+
+    assertFalse(properties.requirePeerCertificateInTopologyRegistry());
+
+    assertFalse(properties.ignorePeerCertificateValidityWindow());
+
+    assertFalse(properties.ignoreIssuerCertificateValidityWindow());
+
+    assertNotNull(properties.toString());
+    assertFalse(properties.toString().isEmpty());
+
+
+    properties.setCacheDuration(123L, TimeUnit.MINUTES);
+
+    assertEquals(properties.getConfigurationFile(), f);
+
+    assertEquals(properties.getCacheDurationMillis(), (123L * 60_000L));
+
+    assertFalse(properties.requirePeerCertificateInTopologyRegistry());
+
+    assertFalse(properties.ignorePeerCertificateValidityWindow());
+
+    assertFalse(properties.ignoreIssuerCertificateValidityWindow());
+
+    assertNotNull(properties.toString());
+    assertFalse(properties.toString().isEmpty());
+
+
+    properties.setCacheDuration(-1L, TimeUnit.MINUTES);
+
+    assertEquals(properties.getConfigurationFile(), f);
+
+    assertEquals(properties.getCacheDurationMillis(), 0L);
+
+    assertFalse(properties.requirePeerCertificateInTopologyRegistry());
+
+    assertFalse(properties.ignorePeerCertificateValidityWindow());
+
+    assertFalse(properties.ignoreIssuerCertificateValidityWindow());
+
+    assertNotNull(properties.toString());
+    assertFalse(properties.toString().isEmpty());
+  }
+
+
+
+  /**
+   * Tests the properties requiring the peer certificate to be present in the
+   * topology registry.
+   *
+   * @throws  Exception  If an unexpected problem occurs.
+   */
+  @Test()
+  public void testRequirePeerCertificateInTopologyRegistry()
+         throws Exception
+  {
+    final File f = createTempFile();
+    final TopologyRegistryTrustManagerProperties properties =
+         new TopologyRegistryTrustManagerProperties(f);
+
+    assertEquals(properties.getConfigurationFile(), f);
+
+    assertEquals(properties.getCacheDurationMillis(), 300_000L);
+
+    assertFalse(properties.requirePeerCertificateInTopologyRegistry());
+
+    assertFalse(properties.ignorePeerCertificateValidityWindow());
+
+    assertFalse(properties.ignoreIssuerCertificateValidityWindow());
+
+    assertNotNull(properties.toString());
+    assertFalse(properties.toString().isEmpty());
+
+
+    properties.setRequirePeerCertificateInTopologyRegistry(true);
+
+    assertEquals(properties.getConfigurationFile(), f);
+
+    assertEquals(properties.getCacheDurationMillis(), 300_000L);
+
+    assertTrue(properties.requirePeerCertificateInTopologyRegistry());
+
+    assertFalse(properties.ignorePeerCertificateValidityWindow());
+
+    assertFalse(properties.ignoreIssuerCertificateValidityWindow());
+
+    assertNotNull(properties.toString());
+    assertFalse(properties.toString().isEmpty());
+
+
+    properties.setRequirePeerCertificateInTopologyRegistry(false);
+
+    assertEquals(properties.getConfigurationFile(), f);
+
+    assertEquals(properties.getCacheDurationMillis(), 300_000L);
+
+    assertFalse(properties.requirePeerCertificateInTopologyRegistry());
+
+    assertFalse(properties.ignorePeerCertificateValidityWindow());
+
+    assertFalse(properties.ignoreIssuerCertificateValidityWindow());
+
+    assertNotNull(properties.toString());
+    assertFalse(properties.toString().isEmpty());
+  }
+
+
+
+  /**
+   * Tests the properties for ignoring peer certificate validity.
+   *
+   * @throws  Exception  If an unexpected problem occurs.
+   */
+  @Test()
+  public void testIgnorePeerCertificateValidityWindow()
+         throws Exception
+  {
+    final File f = createTempFile();
+    final TopologyRegistryTrustManagerProperties properties =
+         new TopologyRegistryTrustManagerProperties(f);
+
+    assertEquals(properties.getConfigurationFile(), f);
+
+    assertEquals(properties.getCacheDurationMillis(), 300_000L);
+
+    assertFalse(properties.requirePeerCertificateInTopologyRegistry());
+
+    assertFalse(properties.ignorePeerCertificateValidityWindow());
+
+    assertFalse(properties.ignoreIssuerCertificateValidityWindow());
+
+    assertNotNull(properties.toString());
+    assertFalse(properties.toString().isEmpty());
+
+
+    properties.setIgnorePeerCertificateValidityWindow(true);
+
+    assertEquals(properties.getConfigurationFile(), f);
+
+    assertEquals(properties.getCacheDurationMillis(), 300_000L);
+
+    assertFalse(properties.requirePeerCertificateInTopologyRegistry());
+
+    assertTrue(properties.ignorePeerCertificateValidityWindow());
+
+    assertFalse(properties.ignoreIssuerCertificateValidityWindow());
+
+    assertNotNull(properties.toString());
+    assertFalse(properties.toString().isEmpty());
+
+
+    properties.setIgnorePeerCertificateValidityWindow(false);
+
+    assertEquals(properties.getConfigurationFile(), f);
+
+    assertEquals(properties.getCacheDurationMillis(), 300_000L);
+
+    assertFalse(properties.requirePeerCertificateInTopologyRegistry());
+
+    assertFalse(properties.ignorePeerCertificateValidityWindow());
+
+    assertFalse(properties.ignoreIssuerCertificateValidityWindow());
+
+    assertNotNull(properties.toString());
+    assertFalse(properties.toString().isEmpty());
+  }
+
+
+
+  /**
+   * Tests the properties for ignoring issuer certificate validity.
+   *
+   * @throws  Exception  If an unexpected problem occurs.
+   */
+  @Test()
+  public void testIgnoreIssuerCertificateValidityWindow()
+         throws Exception
+  {
+    final File f = createTempFile();
+    final TopologyRegistryTrustManagerProperties properties =
+         new TopologyRegistryTrustManagerProperties(f);
+
+    assertEquals(properties.getConfigurationFile(), f);
+
+    assertEquals(properties.getCacheDurationMillis(), 300_000L);
+
+    assertFalse(properties.requirePeerCertificateInTopologyRegistry());
+
+    assertFalse(properties.ignorePeerCertificateValidityWindow());
+
+    assertFalse(properties.ignoreIssuerCertificateValidityWindow());
+
+    assertNotNull(properties.toString());
+    assertFalse(properties.toString().isEmpty());
+
+
+    properties.setIgnoreIssuerCertificateValidityWindow(true);
+
+    assertEquals(properties.getConfigurationFile(), f);
+
+    assertEquals(properties.getCacheDurationMillis(), 300_000L);
+
+    assertFalse(properties.requirePeerCertificateInTopologyRegistry());
+
+    assertFalse(properties.ignorePeerCertificateValidityWindow());
+
+    assertTrue(properties.ignoreIssuerCertificateValidityWindow());
+
+    assertNotNull(properties.toString());
+    assertFalse(properties.toString().isEmpty());
+
+
+    properties.setIgnoreIssuerCertificateValidityWindow(false);
+
+    assertEquals(properties.getConfigurationFile(), f);
+
+    assertEquals(properties.getCacheDurationMillis(), 300_000L);
+
+    assertFalse(properties.requirePeerCertificateInTopologyRegistry());
+
+    assertFalse(properties.ignorePeerCertificateValidityWindow());
+
+    assertFalse(properties.ignoreIssuerCertificateValidityWindow());
+
+    assertNotNull(properties.toString());
+    assertFalse(properties.toString().isEmpty());
+  }
+}

Modified: trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/TopologyRegistryTrustManagerTestCase.java
===================================================================
--- trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/TopologyRegistryTrustManagerTestCase.java	2022-04-04 23:37:37 UTC (rev 1535)
+++ trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/TopologyRegistryTrustManagerTestCase.java	2022-04-11 15:08:04 UTC (rev 1536)
@@ -148,6 +148,14 @@
       // Create a trust manager and SSL util configuration.
       final TopologyRegistryTrustManager trustManager =
            new TopologyRegistryTrustManager(configFile, 300_000L);
+      assertEquals(trustManager.getConfigurationFile(), configFile);
+      assertEquals(trustManager.getCacheDurationMillis(), 300_000L);
+      assertFalse(trustManager.requirePeerCertificateInTopologyRegistry());
+      assertFalse(trustManager.ignorePeerCertificateValidityWindow());
+      assertFalse(trustManager.ignoreIssuerCertificateValidityWindow());
+      assertNotNull(trustManager.toString());
+      assertFalse(trustManager.toString().isEmpty());
+
       final SSLUtil sslUtil = new SSLUtil(null, trustManager);
 
       // Perform an initial test to ensure that the connection succeeds when
@@ -211,6 +219,369 @@
 
 
   /**
+   * Tests the case in which the client is presented with a certificate chain
+   * that contains a peer certificate that is not in the topology registry and
+   * an issuer certificate that is in the registry when we will trust issuer
+   * certificates.
+   *
+   * @throws  Exception  If an unexpected problem occurs.
+   */
+  @Test()
+  public void testIssuerCertificateTrustAllowed()
+         throws Exception
+  {
+    final File caKeyStore = createTempFile();
+    assertTrue(caKeyStore.delete());
+
+    final ByteArrayOutputStream out = new ByteArrayOutputStream();
+    ResultCode resultCode = ManageCertificates.main(null, out, out,
+         "generate-self-signed-certificate",
+         "--keystore", caKeyStore.getAbsolutePath(),
+         "--keystore-password", "password",
+         "--alias", "ca-cert",
+         "--subject-dn", "CN=CA,O=Example Corp,C=US");
+    assertEquals(resultCode, ResultCode.SUCCESS,
+         "Failed to generate a self-signed CA certificate:" + StaticUtils.EOL +
+              StaticUtils.toUTF8String(out.toByteArray()));
+
+    final File caCertFile = createTempFile();
+    assertTrue(caCertFile.delete());
+
+    out.reset();
+    resultCode = ManageCertificates.main(null, out, out,
+         "export-certificate",
+         "--keystore", caKeyStore.getAbsolutePath(),
+         "--keystore-password", "password",
+         "--alias", "ca-cert",
+         "--output-format", "PEM",
+         "--output-file", caCertFile.getAbsolutePath());
+    assertEquals(resultCode, ResultCode.SUCCESS,
+         "Failed to export the CA certificate:" + StaticUtils.EOL +
+              StaticUtils.toUTF8String(out.toByteArray()));
+
+    final File serverKeyStore = createTempFile();
+    assertTrue(serverKeyStore.delete());
+
+    final File csrFile = createTempFile();
+    assertTrue(csrFile.delete());
+
+    out.reset();
+    resultCode = ManageCertificates.main(null, out, out,
+         "generate-certificate-signing-request",
+         "--keystore", serverKeyStore.getAbsolutePath(),
+         "--keystore-password", "password",
+         "--alias", "server-cert",
+         "--subject-DN", "CN=ds.example.com,O=Example Corp,C=US",
+         "--output-file", csrFile.getAbsolutePath(),
+         "--output-format", "PEM");
+    assertEquals(resultCode, ResultCode.SUCCESS,
+         "Failed to generate a certificate signing request:" + StaticUtils.EOL +
+              StaticUtils.toUTF8String(out.toByteArray()));
+
+    final File certFile = createTempFile();
+    assertTrue(certFile.delete());
+
+    out.reset();
+    resultCode = ManageCertificates.main(null, out, out,
+         "sign-certificate-signing-request",
+         "--keystore", caKeyStore.getAbsolutePath(),
+         "--keystore-password", "password",
+         "--request-input-file", csrFile.getAbsolutePath(),
+         "--signing-certificate-alias", "ca-cert",
+         "--certificate-output-file", certFile.getAbsolutePath(),
+         "--output-format", "PEM",
+         "--no-prompt");
+    assertEquals(resultCode, ResultCode.SUCCESS,
+         "Failed to sign a certificate signing request:" + StaticUtils.EOL +
+              StaticUtils.toUTF8String(out.toByteArray()));
+
+    out.reset();
+    resultCode = ManageCertificates.main(null, out, out,
+         "import-certificate",
+         "--keystore", serverKeyStore.getAbsolutePath(),
+         "--keystore-password", "password",
+         "--certificate-file", certFile.getAbsolutePath(),
+         "--certificate-file", caCertFile.getAbsolutePath(),
+         "--alias", "server-cert",
+         "--no-prompt");
+    assertEquals(resultCode, ResultCode.SUCCESS,
+         "Failed to import the signed certificate:" + StaticUtils.EOL +
+              StaticUtils.toUTF8String(out.toByteArray()));
+
+    final List<String> caCertLines = StaticUtils.readFileLines(caCertFile);
+
+    try (InMemoryDirectoryServer ds = getDS(serverKeyStore))
+    {
+      // Create a configuration file to use for the test.
+      final File configFile = generateConfigFile(caCertLines, null);
+
+      // Create a trust manager and SSL util configuration.
+      final TopologyRegistryTrustManager trustManager =
+           new TopologyRegistryTrustManager(configFile, 300_000L);
+      final SSLUtil sslUtil = new SSLUtil(null, trustManager);
+
+      // Perform an initial test to ensure that the connection succeeds when
+      // the configuration is not cached.
+      try (LDAPConnection conn = new LDAPConnection(
+           sslUtil.createSSLSocketFactory(), "localhost", ds.getListenPort()))
+      {
+        assertNotNull(conn.getRootDSE());
+      }
+
+      // Perform another test to ensure that the connection succeeds when the
+      // configuration is cached.
+      try (LDAPConnection conn = new LDAPConnection(
+           sslUtil.createSSLSocketFactory(), "localhost", ds.getListenPort()))
+      {
+        assertNotNull(conn.getRootDSE());
+      }
+    }
+  }
+
+
+
+  /**
+   * Tests the case in which the client is presented with a certificate chain
+   * that contains a peer certificate that is not in the topology registry and
+   * an issuer certificate that is in the registry when we will not trust issuer
+   * certificates.
+   *
+   * @throws  Exception  If an unexpected problem occurs.
+   */
+  @Test()
+  public void testIssuerCertificateTrustNotAllowed()
+         throws Exception
+  {
+    final File caKeyStore = createTempFile();
+    assertTrue(caKeyStore.delete());
+
+    final ByteArrayOutputStream out = new ByteArrayOutputStream();
+    ResultCode resultCode = ManageCertificates.main(null, out, out,
+         "generate-self-signed-certificate",
+         "--keystore", caKeyStore.getAbsolutePath(),
+         "--keystore-password", "password",
+         "--alias", "ca-cert",
+         "--subject-dn", "CN=CA,O=Example Corp,C=US");
+    assertEquals(resultCode, ResultCode.SUCCESS,
+         "Failed to generate a self-signed CA certificate:" + StaticUtils.EOL +
+              StaticUtils.toUTF8String(out.toByteArray()));
+
+    final File caCertFile = createTempFile();
+    assertTrue(caCertFile.delete());
+
+    out.reset();
+    resultCode = ManageCertificates.main(null, out, out,
+         "export-certificate",
+         "--keystore", caKeyStore.getAbsolutePath(),
+         "--keystore-password", "password",
+         "--alias", "ca-cert",
+         "--output-format", "PEM",
+         "--output-file", caCertFile.getAbsolutePath());
+    assertEquals(resultCode, ResultCode.SUCCESS,
+         "Failed to export the CA certificate:" + StaticUtils.EOL +
+              StaticUtils.toUTF8String(out.toByteArray()));
+
+    final File serverKeyStore = createTempFile();
+    assertTrue(serverKeyStore.delete());
+
+    final File csrFile = createTempFile();
+    assertTrue(csrFile.delete());
+
+    out.reset();
+    resultCode = ManageCertificates.main(null, out, out,
+         "generate-certificate-signing-request",
+         "--keystore", serverKeyStore.getAbsolutePath(),
+         "--keystore-password", "password",
+         "--alias", "server-cert",
+         "--subject-DN", "CN=ds.example.com,O=Example Corp,C=US",
+         "--output-file", csrFile.getAbsolutePath(),
+         "--output-format", "PEM");
+    assertEquals(resultCode, ResultCode.SUCCESS,
+         "Failed to generate a certificate signing request:" + StaticUtils.EOL +
+              StaticUtils.toUTF8String(out.toByteArray()));
+
+    final File certFile = createTempFile();
+    assertTrue(certFile.delete());
+
+    out.reset();
+    resultCode = ManageCertificates.main(null, out, out,
+         "sign-certificate-signing-request",
+         "--keystore", caKeyStore.getAbsolutePath(),
+         "--keystore-password", "password",
+         "--request-input-file", csrFile.getAbsolutePath(),
+         "--signing-certificate-alias", "ca-cert",
+         "--certificate-output-file", certFile.getAbsolutePath(),
+         "--output-format", "PEM",
+         "--no-prompt");
+    assertEquals(resultCode, ResultCode.SUCCESS,
+         "Failed to sign a ...
 
[truncated message content]

[ldap-sdk-commits] SF.net SVN: ldap-sdk:[1535] trunk/tests/unit/src/com/unboundid

[<di...@us...>]

Revision: 1535
          http://sourceforge.net/p/ldap-sdk/code/1535
Author:   dirmgr
Date:     2022-04-04 23:37:37 +0000 (Mon, 04 Apr 2022)
Log Message:
-----------
Eliminate a non-ASCII character in a comment

Updated a comment in a unit test source file to eliminate the use of
a non-ASCII character.  Although non-ASCII characters are perfectly
valid in Java source files, they can potentially cause issues with
some tools.

A new unit test has been added to ensure that none of the LDAP SDK
source code (whether in the LDAP SDK itself or the unit tests) will
be allowed to include non-ASCII characters in the future.

Modified Paths:
--------------
    trunk/tests/unit/src/com/unboundid/ldap/sdk/SourceCodeSanityCheckTestCase.java
    trunk/tests/unit/src/com/unboundid/util/ByteStringBufferTestCase.java

Modified: trunk/tests/unit/src/com/unboundid/ldap/sdk/SourceCodeSanityCheckTestCase.java
===================================================================
--- trunk/tests/unit/src/com/unboundid/ldap/sdk/SourceCodeSanityCheckTestCase.java	2022-04-04 23:23:00 UTC (rev 1534)
+++ trunk/tests/unit/src/com/unboundid/ldap/sdk/SourceCodeSanityCheckTestCase.java	2022-04-04 23:37:37 UTC (rev 1535)
@@ -88,6 +88,7 @@
     ensureNoTrailingWhitespace(f, fileLines, errorMessages);
     ensureNoTabs(f, fileLines, errorMessages);
     ensureAcceptableLineLengths(f, fileLines, errorMessages);
+    ensureNoNonASCIICharacters(f, fileLines, errorMessages);
 
     failIfNecessary(f, errorMessages);
   }
@@ -113,6 +114,7 @@
     ensureNoTrailingWhitespace(f, fileLines, errorMessages);
     ensureNoTabs(f, fileLines, errorMessages);
     ensureAcceptableLineLengths(f, fileLines, errorMessages);
+    ensureNoNonASCIICharacters(f, fileLines, errorMessages);
 
     failIfNecessary(f, errorMessages);
   }
@@ -464,6 +466,33 @@
 
 
   /**
+   * Ensures that none of the lines of the file includes any non-ASCII
+   * characters.
+   *
+   * @param  f              The file being processed.
+   * @param  fileLines      The lines that make up the file.
+   * @param  errorMessages  A list to which any error messages should be added.
+   */
+  private static void ensureNoNonASCIICharacters(final File f,
+               final List<String> fileLines,
+               final List<String> errorMessages)
+  {
+    int lineNumber=1;
+    for (final String line : fileLines)
+    {
+      if (! StaticUtils.isASCIIString(line))
+      {
+        errorMessages.add("Line " + lineNumber +
+             " includes one or more non-ASCII characters.");
+      }
+
+      lineNumber++;
+    }
+  }
+
+
+
+  /**
    * Throws an assertion error if the provided list of error messages is not
    * empty.
    *

Modified: trunk/tests/unit/src/com/unboundid/util/ByteStringBufferTestCase.java
===================================================================
--- trunk/tests/unit/src/com/unboundid/util/ByteStringBufferTestCase.java	2022-04-04 23:23:00 UTC (rev 1534)
+++ trunk/tests/unit/src/com/unboundid/util/ByteStringBufferTestCase.java	2022-04-04 23:37:37 UTC (rev 1535)
@@ -5252,7 +5252,7 @@
     buffer.insertCodePoint(1, "\u00F1".codePointAt(0));
 
     // Latin capital letter OO
-    buffer.insertCodePoint(buffer.length(), "\uA74E".codePointAt(0)); // bñaOO
+    buffer.insertCodePoint(buffer.length(), "\uA74E".codePointAt(0));
 
     // Deseret capital letter long I
     buffer.insertCodePoint(0, "\uD801\uDC00".codePointAt(0));

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

[ldap-sdk-commits] SF.net SVN: ldap-sdk:[1534] trunk

[<di...@us...>]

Revision: 1534
          http://sourceforge.net/p/ldap-sdk/code/1534
Author:   dirmgr
Date:     2022-04-04 23:23:00 +0000 (Mon, 04 Apr 2022)
Log Message:
-----------
JSON control support for ldapsearch & ldapmodify

Updated the ldapsearch and ldapmodify command-line tools to add
support for JSON-formatted request and response controls.  If the
--useJSONFormattedRequestControls argument is provided, requests
sent to the server will include a JSON-formatted request control
with appropriate encodings for any other request controls to be
included in the request.  Any JSON-formatted response control
received from the server will automatically have its embedded
controls extracted and processed as if they had been returned with
their regular LDAP encodings.

Modified Paths:
--------------
    trunk/docs/release-notes.html
    trunk/messages/unboundid-ldapsdk-tools.properties
    trunk/src/com/unboundid/ldap/sdk/unboundidds/tools/LDAPModify.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/tools/LDAPSearch.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/tools/ResultUtils.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/tools/LDAPModifyTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/tools/LDAPSearchTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/tools/ResultUtilsTestCase.java

Modified: trunk/docs/release-notes.html
===================================================================
--- trunk/docs/release-notes.html	2022-04-04 14:57:54 UTC (rev 1533)
+++ trunk/docs/release-notes.html	2022-04-04 23:23:00 UTC (rev 1534)
@@ -40,6 +40,18 @@
                 </li>
 
                 <li>
+                  Updated the ldapsearch and ldapmodify command-line tools to add support for
+                  JSON-formatted request and response controls.  If the
+                  --useJSONFormattedRequestControls argument is provided, requests sent to the
+                  server will include a JSON-formatted request control with appropriate encodings
+                  for any other request controls to be included in the request.  Any
+                  JSON-formatted response control received from the server will automatically have
+                  its embedded controls extracted and processed as if they had been returned with
+                  their regular LDAP encodings.
+                  <br><br>
+                </li>
+
+                <li>
                   Fixed an issue with the way the parallel-update tool created assured replication
                   request controls when an explicit local or remote assurance level was specified.
                   Previously, it would only specify a minimum assurance level without specifying a

Modified: trunk/messages/unboundid-ldapsdk-tools.properties
===================================================================
--- trunk/messages/unboundid-ldapsdk-tools.properties	2022-04-04 14:57:54 UTC (rev 1533)
+++ trunk/messages/unboundid-ldapsdk-tools.properties	2022-04-04 23:23:00 UTC (rev 1534)
@@ -1059,6 +1059,8 @@
 INFO_RESULT_UTILS_JOIN_MATCHED_DN=Join Matched DN:  {0}
 INFO_RESULT_UTILS_JOIN_REFERRAL_URL=Join Referral URL:  {0}
 INFO_RESULT_UTILS_JOINED_WITH_ENTRY_HEADER=Joined With Entry:
+INFO_RESULT_UTILS_JSON_FORMATTED_HEADER=JSON-Formatted Response Control:
+INFO_RESULT_UTILS_JSON_FORMATTED_EMBEDDED_CONTROL_HEADER=Embedded Control JSON:
 INFO_RESULT_UTILS_MATCHING_ENTRY_COUNT_HEADER=Matching Entry Count Response \
   Control:
 INFO_RESULT_UTILS_MATCHING_ENTRY_COUNT_TYPE_EXAMINED=Count Type:  Examined
@@ -2140,6 +2142,12 @@
   search operation even if it cannot do so efficiently using server indexes.  \
   The requester must have either the unindexed-search or \
   unindexed-search-with-control privilege.
+INFO_LDAPSEARCH_ARG_DESCRIPTION_USE_JSON_FORMATTED_CONTROLS=Indicates that \
+  any request controls should be encapsulated in a JSON-formatted request \
+  control.  Even if there wouldn''t otherwise be any request controls, an \
+  empty JSON-formatted request control will be included to indicate that the \
+  server should encapsulate any response controls in a JSON-formatted \
+  response control.
 INFO_LDAPSEARCH_ARG_DESCRIPTION_EXCLUDE_ATTRIBUTE=Specifies the name or OID \
   of an attribute that should be excluded from search result entries.  This \
   argument may be provided multiple times to specify multiple attributes to \
@@ -3978,6 +3986,12 @@
   all modify requests.
 INFO_PARALLEL_UPDATE_ARG_DESC_MODIFY_DN_CONTROL=Include the specified control \
   in all modify DN requests.
+INFO_LDAPMODIFY_ARG_DESCRIPTION_USE_JSON_FORMATTED_CONTROLS=Indicates that \
+  any request controls should be encapsulated in a JSON-formatted request \
+  control.  Even if there wouldn''t otherwise be any request controls, an \
+  empty JSON-formatted request control will be included to indicate that the \
+  server should encapsulate any response controls in a JSON-formatted \
+  response control.
 ERR_PARALLEL_UPDATE_CANNOT_CREATE_POOL=ERROR:  Unable to create the \
   connection pool to use for processing requests:  {0}
 ERR_PARALLEL_UPDATE_ERROR_CREATING_LOG_WRITER=ERROR:  Unable to create the \

Modified: trunk/src/com/unboundid/ldap/sdk/unboundidds/tools/LDAPModify.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/unboundidds/tools/LDAPModify.java	2022-04-04 14:57:54 UTC (rev 1533)
+++ trunk/src/com/unboundid/ldap/sdk/unboundidds/tools/LDAPModify.java	2022-04-04 23:23:00 UTC (rev 1534)
@@ -112,6 +112,10 @@
 import com.unboundid.ldap.sdk.unboundidds.controls.
             IgnoreNoUserModificationRequestControl;
 import com.unboundid.ldap.sdk.unboundidds.controls.
+            JSONFormattedControlDecodeBehavior;
+import com.unboundid.ldap.sdk.unboundidds.controls.JSONFormattedRequestControl;
+import com.unboundid.ldap.sdk.unboundidds.controls.JSONFormattedResponseControl;
+import com.unboundid.ldap.sdk.unboundidds.controls.
             NameWithEntryUUIDRequestControl;
 import com.unboundid.ldap.sdk.unboundidds.controls.NoOpRequestControl;
 import com.unboundid.ldap.sdk.unboundidds.controls.
@@ -315,6 +319,7 @@
   @Nullable private BooleanArgument serverSideSubtreeDelete = null;
   @Nullable private BooleanArgument suppressReferentialIntegrityUpdates = null;
   @Nullable private BooleanArgument useAdministrativeSession = null;
+  @Nullable private BooleanArgument useJSONFormattedRequestControls = null;
   @Nullable private BooleanArgument usePasswordPolicyControl = null;
   @Nullable private BooleanArgument useTransaction = null;
   @Nullable private BooleanArgument verbose = null;
@@ -1282,6 +1287,20 @@
     parser.addArgument(modifyDNControl);
 
 
+    useJSONFormattedRequestControls = new BooleanArgument(null,
+         "useJSONFormattedRequestControls", 1,
+         INFO_LDAPMODIFY_ARG_DESCRIPTION_USE_JSON_FORMATTED_CONTROLS.get());
+    useJSONFormattedRequestControls.addLongIdentifier(
+         "use-json-formatted-request-controls", true);
+    useJSONFormattedRequestControls.addLongIdentifier(
+         "useJSONFormattedControls", true);
+    useJSONFormattedRequestControls.addLongIdentifier(
+         "use-json-formatted-controls", true);
+    useJSONFormattedRequestControls.setArgumentGroupName(
+         INFO_LDAPSEARCH_ARG_GROUP_CONTROLS.get());
+    parser.addArgument(useJSONFormattedRequestControls);
+
+
     ratePerSecond = new IntegerArgument('r', "ratePerSecond", false, 1,
          INFO_PLACEHOLDER_NUM.get(),
          INFO_LDAPMODIFY_ARG_DESCRIPTION_RATE_PER_SECOND.get(), 1,
@@ -1593,6 +1612,14 @@
            suppressTypes));
     }
 
+    if (useJSONFormattedRequestControls.isPresent())
+    {
+      final JSONFormattedRequestControl jsonFormattedRequestControl =
+           JSONFormattedRequestControl.createWithControls(true, bindControls);
+      bindControls.clear();
+      bindControls.add(jsonFormattedRequestControl);
+    }
+
     return bindControls;
   }
 
@@ -2612,7 +2639,9 @@
         }
       }
 
+      searchResult = LDAPSearch.handleJSONEncodedResponseControls(searchResult);
 
+
       // If we've gotten here, then the search was successful.  Check to see if
       // any of the modifications failed, and if so then update the result code
       // accordingly.
@@ -3245,6 +3274,36 @@
       modifyControls.add(c);
       modifyDNControls.add(c);
     }
+
+
+    if (useJSONFormattedRequestControls.isPresent())
+    {
+      final JSONFormattedRequestControl jsonFormattedAddRequestControl =
+           JSONFormattedRequestControl.createWithControls(true, addControls);
+      addControls.clear();
+      addControls.add(jsonFormattedAddRequestControl);
+
+      final JSONFormattedRequestControl jsonFormattedDeleteRequestControl =
+           JSONFormattedRequestControl.createWithControls(true, deleteControls);
+      deleteControls.clear();
+      deleteControls.add(jsonFormattedDeleteRequestControl);
+
+      final JSONFormattedRequestControl jsonFormattedModifyRequestControl =
+           JSONFormattedRequestControl.createWithControls(true, modifyControls);
+      modifyControls.clear();
+      modifyControls.add(jsonFormattedModifyRequestControl);
+
+      final JSONFormattedRequestControl jsonFormattedModifyDNRequestControl =
+           JSONFormattedRequestControl.createWithControls(true,
+                modifyDNControls);
+      modifyDNControls.clear();
+      modifyDNControls.add(jsonFormattedModifyDNRequestControl);
+
+      final JSONFormattedRequestControl jsonFormattedSearchRequestControl =
+           JSONFormattedRequestControl.createWithControls(true, searchControls);
+      searchControls.clear();
+      searchControls.add(jsonFormattedSearchRequestControl);
+    }
   }
 
 
@@ -3514,7 +3573,9 @@
       addResult = le.toLDAPResult();
     }
 
+    addResult = handleJSONEncodedResponseControls(addResult);
 
+
     // Display information about the result.
     displayResult(addResult, useTransaction.isPresent());
 
@@ -3641,7 +3702,9 @@
       deleteResult = le.toLDAPResult();
     }
 
+    deleteResult = handleJSONEncodedResponseControls(deleteResult);
 
+
     // Display information about the result.
     displayResult(deleteResult, useTransaction.isPresent());
 
@@ -3727,7 +3790,7 @@
 
 
     // Evaluate the result of the subtree delete.
-    final LDAPResult finalResult;
+    LDAPResult finalResult;
     if (subtreeDeleterResult.completelySuccessful())
     {
       final long entriesDeleted = subtreeDeleterResult.getEntriesDeleted();
@@ -3828,7 +3891,9 @@
            StaticUtils.NO_STRINGS, StaticUtils.NO_CONTROLS);
     }
 
+    finalResult = handleJSONEncodedResponseControls(finalResult);
 
+
     // Display information about the final result.
     displayResult(finalResult, useTransaction.isPresent());
 
@@ -3969,7 +4034,9 @@
       modifyResult = le.toLDAPResult();
     }
 
+    modifyResult = handleJSONEncodedResponseControls(modifyResult);
 
+
     // Display information about the result.
     displayResult(modifyResult, useTransaction.isPresent());
 
@@ -4156,7 +4223,9 @@
       modifyDNResult = le.toLDAPResult();
     }
 
+    modifyDNResult = handleJSONEncodedResponseControls(modifyDNResult);
 
+
     // Display information about the result.
     displayResult(modifyDNResult, useTransaction.isPresent());
 
@@ -4382,6 +4451,62 @@
 
 
   /**
+   * Examines the provided LDAP result to see if it includes a JSONf-formatted
+   * response control.  If so, then its embedded controls will be extracted and
+   * a new LDAP result will be returned with those extracted controls instead
+   * of the JSON-formatted response control.  Otherwise, the provided LDAP
+   * result will be returned.
+   *
+   * @param  ldapResult  The LDAP result to be handled.  It must not be
+   *                     {@code null}.
+   *
+   * @return  A new LDAP result with the controls extracted from a
+   *          JSON-formatted response control, or the original LDAP result if
+   *          it did not include a JSON-formatted response control.
+   */
+  @NotNull()
+  static LDAPResult handleJSONEncodedResponseControls(
+              @NotNull final LDAPResult ldapResult)
+  {
+    try
+    {
+      final JSONFormattedResponseControl jsonFormattedResponseControl =
+           JSONFormattedResponseControl.get(ldapResult);
+      if (jsonFormattedResponseControl == null)
+      {
+        return ldapResult;
+      }
+
+      final JSONFormattedControlDecodeBehavior decodeBehavior =
+           new JSONFormattedControlDecodeBehavior();
+      decodeBehavior.setThrowOnUnparsableObject(false);
+      decodeBehavior.setThrowOnInvalidCriticalControl(false);
+      decodeBehavior.setThrowOnInvalidNonCriticalControl(false);
+      decodeBehavior.setThrowOnInvalidNonCriticalControl(false);
+      decodeBehavior.setAllowEmbeddedJSONFormattedControl(true);
+      decodeBehavior.setStrict(false);
+
+      final List<Control> decodedControls =
+           jsonFormattedResponseControl.decodeEmbeddedControls(
+                decodeBehavior, null);
+
+      return new LDAPResult(ldapResult.getMessageID(),
+           ldapResult.getResultCode(),
+           ldapResult.getDiagnosticMessage(),
+           ldapResult.getMatchedDN(),
+           ldapResult.getReferralURLs(),
+           StaticUtils.toArray(decodedControls, Control.class));
+    }
+    catch (final LDAPException e)
+    {
+      Debug.debugException(e);
+      return ldapResult;
+    }
+  }
+
+
+
+  /**
    * {@inheritDoc}
    */
   @Override()

Modified: trunk/src/com/unboundid/ldap/sdk/unboundidds/tools/LDAPSearch.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/unboundidds/tools/LDAPSearch.java	2022-04-04 14:57:54 UTC (rev 1533)
+++ trunk/src/com/unboundid/ldap/sdk/unboundidds/tools/LDAPSearch.java	2022-04-04 23:23:00 UTC (rev 1534)
@@ -111,6 +111,10 @@
 import com.unboundid.ldap.sdk.unboundidds.controls.GetServerIDRequestControl;
 import com.unboundid.ldap.sdk.unboundidds.controls.
             GetUserResourceLimitsRequestControl;
+import com.unboundid.ldap.sdk.unboundidds.controls.
+            JSONFormattedControlDecodeBehavior;
+import com.unboundid.ldap.sdk.unboundidds.controls.JSONFormattedRequestControl;
+import com.unboundid.ldap.sdk.unboundidds.controls.JSONFormattedResponseControl;
 import com.unboundid.ldap.sdk.unboundidds.controls.JoinBaseDN;
 import com.unboundid.ldap.sdk.unboundidds.controls.JoinRequestControl;
 import com.unboundid.ldap.sdk.unboundidds.controls.JoinRequestValue;
@@ -234,6 +238,7 @@
   @Nullable private BooleanArgument suppressBase64EncodedValueComments = null;
   @Nullable private BooleanArgument teeResultsToStandardOut = null;
   @Nullable private BooleanArgument useAdministrativeSession = null;
+  @Nullable private BooleanArgument useJSONFormattedRequestControls = null;
   @Nullable private BooleanArgument usePasswordPolicyControl = null;
   @Nullable private BooleanArgument terse = null;
   @Nullable private BooleanArgument typesOnly = null;
@@ -1177,6 +1182,19 @@
          INFO_LDAPSEARCH_ARG_GROUP_CONTROLS.get());
     parser.addArgument(virtualListView);
 
+    useJSONFormattedRequestControls = new BooleanArgument(null,
+         "useJSONFormattedRequestControls", 1,
+         INFO_LDAPSEARCH_ARG_DESCRIPTION_USE_JSON_FORMATTED_CONTROLS.get());
+    useJSONFormattedRequestControls.addLongIdentifier(
+         "use-json-formatted-request-controls", true);
+    useJSONFormattedRequestControls.addLongIdentifier(
+         "useJSONFormattedControls", true);
+    useJSONFormattedRequestControls.addLongIdentifier(
+         "use-json-formatted-controls", true);
+    useJSONFormattedRequestControls.setArgumentGroupName(
+         INFO_LDAPSEARCH_ARG_GROUP_CONTROLS.get());
+    parser.addArgument(useJSONFormattedRequestControls);
+
     excludeAttribute = new StringArgument(null, "excludeAttribute", false, 0,
          INFO_PLACEHOLDER_ATTR.get(),
          INFO_LDAPSEARCH_ARG_DESCRIPTION_EXCLUDE_ATTRIBUTE.get());
@@ -1458,6 +1476,14 @@
            suppressTypes));
     }
 
+    if (useJSONFormattedRequestControls.isPresent())
+    {
+      final JSONFormattedRequestControl jsonFormattedRequestControl =
+           JSONFormattedRequestControl.createWithControls(true, bindControls);
+      bindControls.clear();
+      bindControls.add(jsonFormattedRequestControl);
+    }
+
     return bindControls;
   }
 
@@ -3008,6 +3034,8 @@
             searchResult = pool.search(searchRequest);
           }
 
+          searchResult = handleJSONEncodedResponseControls(searchResult);
+
           if (searchResult.getEntryCount() > 0)
           {
             totalEntries += searchResult.getEntryCount();
@@ -3365,6 +3393,14 @@
       controls.add(new PermitUnindexedSearchRequestControl());
     }
 
+    if (useJSONFormattedRequestControls.isPresent())
+    {
+      final JSONFormattedRequestControl jsonFormattedRequestControl =
+           JSONFormattedRequestControl.createWithControls(true, controls);
+      controls.clear();
+      controls.add(jsonFormattedRequestControl);
+    }
+
     return controls;
   }
 
@@ -3525,6 +3561,66 @@
 
 
   /**
+   * Examines the provided search result to see if it includes a JSONf-formatted
+   * response control.  If so, then its embedded controls will be extracted and
+   * a new search result will be returned with those extracted controls instead
+   * of the JSON-formatted response control.  Otherwise, the provided search
+   * result will be returned.
+   *
+   * @param  searchResult  The search result to be handled.  It must not be
+   *                       {@code null}.
+   *
+   * @return  A new search result with the controls extracted from a
+   *          JSON-formatted response control, or the original search result if
+   *          it did not include a JSON-formatted response control.
+   */
+  @NotNull()
+  static SearchResult handleJSONEncodedResponseControls(
+              @NotNull final SearchResult searchResult)
+  {
+    try
+    {
+      final JSONFormattedResponseControl jsonFormattedResponseControl =
+           JSONFormattedResponseControl.get(searchResult);
+      if (jsonFormattedResponseControl == null)
+      {
+        return searchResult;
+      }
+
+      final JSONFormattedControlDecodeBehavior decodeBehavior =
+           new JSONFormattedControlDecodeBehavior();
+      decodeBehavior.setThrowOnUnparsableObject(false);
+      decodeBehavior.setThrowOnInvalidCriticalControl(false);
+      decodeBehavior.setThrowOnInvalidNonCriticalControl(false);
+      decodeBehavior.setThrowOnInvalidNonCriticalControl(false);
+      decodeBehavior.setAllowEmbeddedJSONFormattedControl(true);
+      decodeBehavior.setStrict(false);
+
+      final List<Control> decodedControls =
+           jsonFormattedResponseControl.decodeEmbeddedControls(
+                decodeBehavior, null);
+
+      return new SearchResult(searchResult.getMessageID(),
+           searchResult.getResultCode(),
+           searchResult.getDiagnosticMessage(),
+           searchResult.getMatchedDN(),
+           searchResult.getReferralURLs(),
+           searchResult.getSearchEntries(),
+           searchResult.getSearchReferences(),
+           searchResult.getEntryCount(),
+           searchResult.getReferenceCount(),
+           StaticUtils.toArray(decodedControls, Control.class));
+    }
+    catch (final LDAPException e)
+    {
+      Debug.debugException(e);
+      return searchResult;
+    }
+  }
+
+
+
+  /**
    * {@inheritDoc}
    */
   @Override()

Modified: trunk/src/com/unboundid/ldap/sdk/unboundidds/tools/ResultUtils.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/unboundidds/tools/ResultUtils.java	2022-04-04 14:57:54 UTC (rev 1533)
+++ trunk/src/com/unboundid/ldap/sdk/unboundidds/tools/ResultUtils.java	2022-04-04 23:23:00 UTC (rev 1534)
@@ -102,6 +102,7 @@
             IntermediateClientResponseValue;
 import com.unboundid.ldap.sdk.unboundidds.controls.JoinedEntry;
 import com.unboundid.ldap.sdk.unboundidds.controls.JoinResultControl;
+import com.unboundid.ldap.sdk.unboundidds.controls.JSONFormattedResponseControl;
 import com.unboundid.ldap.sdk.unboundidds.controls.
             MatchingEntryCountResponseControl;
 import com.unboundid.ldap.sdk.unboundidds.controls.PasswordPolicyErrorType;
@@ -133,6 +134,7 @@
 import com.unboundid.util.StaticUtils;
 import com.unboundid.util.ThreadSafety;
 import com.unboundid.util.ThreadSafetyLevel;
+import com.unboundid.util.json.JSONObject;
 
 import static com.unboundid.ldap.sdk.unboundidds.tools.ToolMessages.*;
 
@@ -813,6 +815,11 @@
     {
       addJoinResultControl(lines, c, prefix, maxWidth);
     }
+    else if (oid.equals(
+         JSONFormattedResponseControl.JSON_FORMATTED_RESPONSE_OID))
+    {
+      addJSONFormattedResponseControl(lines, c, prefix, maxWidth);
+    }
     else if (oid.equals(MatchingEntryCountResponseControl.
          MATCHING_ENTRY_COUNT_RESPONSE_OID))
     {
@@ -2568,6 +2575,58 @@
 
   /**
    * Adds a multi-line string representation of the provided control, which is
+   * expected to be a JSON-formatted response control, to the given list.
+   *
+   * @param  lines     The list to which the lines should be added.
+   * @param  c         The control to be formatted.
+   * @param  prefix    The prefix to use for each line.
+   * @param  maxWidth  The maximum length of each line in characters, including
+   *                   the comment prefix and indent.
+   */
+  private static void addJSONFormattedResponseControl(
+                           @NotNull final List<String> lines,
+                           @NotNull final Control c,
+                           @NotNull final String prefix,
+                           final int maxWidth)
+  {
+    final JSONFormattedResponseControl decoded;
+    try
+    {
+      decoded = new JSONFormattedResponseControl(c.getOID(), c.isCritical(),
+           c.getValue());
+    }
+    catch (final Exception e)
+    {
+      Debug.debugException(e);
+      addGenericResponseControl(lines, c, prefix, maxWidth);
+      return;
+    }
+
+    wrap(lines, INFO_RESULT_UTILS_JSON_FORMATTED_HEADER.get(), prefix,
+         maxWidth);
+
+    final String indentPrefix = prefix + "     ";
+    final String doubleIndentPrefix = indentPrefix + "     ";
+    wrap(lines, INFO_RESULT_UTILS_RESPONSE_CONTROL_OID.get(c.getOID()),
+         indentPrefix, maxWidth);
+
+    for (final JSONObject responseControlObject : decoded.getControlObjects())
+    {
+      wrap(lines,
+           INFO_RESULT_UTILS_JSON_FORMATTED_EMBEDDED_CONTROL_HEADER.get(),
+           indentPrefix, maxWidth);
+      for (final String jsonLine :
+           StaticUtils.stringToLines(responseControlObject.toMultiLineString()))
+      {
+        lines.add(doubleIndentPrefix + jsonLine);
+      }
+    }
+  }
+
+
+
+  /**
+   * Adds a multi-line string representation of the provided control, which is
    * expected to be a matching entry count response control, to the given list.
    *
    * @param  lines     The list to which the lines should be added.

Modified: trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/tools/LDAPModifyTestCase.java
===================================================================
--- trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/tools/LDAPModifyTestCase.java	2022-04-04 14:57:54 UTC (rev 1533)
+++ trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/tools/LDAPModifyTestCase.java	2022-04-04 23:23:00 UTC (rev 1534)
@@ -48,15 +48,20 @@
 
 import org.testng.annotations.Test;
 
+import com.unboundid.asn1.ASN1OctetString;
 import com.unboundid.ldap.listener.InMemoryDirectoryServer;
 import com.unboundid.ldap.listener.InMemoryDirectoryServerConfig;
+import com.unboundid.ldap.sdk.Control;
 import com.unboundid.ldap.sdk.ExtendedResult;
 import com.unboundid.ldap.sdk.LDAPConnection;
 import com.unboundid.ldap.sdk.LDAPException;
+import com.unboundid.ldap.sdk.LDAPResult;
 import com.unboundid.ldap.sdk.LDAPSDKTestCase;
 import com.unboundid.ldap.sdk.OperationType;
 import com.unboundid.ldap.sdk.ResultCode;
 import com.unboundid.ldap.sdk.extensions.NoticeOfDisconnectionExtendedResult;
+import com.unboundid.ldap.sdk.unboundidds.controls.GetServerIDResponseControl;
+import com.unboundid.ldap.sdk.unboundidds.controls.JSONFormattedResponseControl;
 import com.unboundid.ldap.sdk.unboundidds.controls.
             PasswordUpdateBehaviorRequestControl;
 import com.unboundid.ldap.sdk.unboundidds.extensions.
@@ -1866,7 +1871,8 @@
          "--usePasswordPolicyControl",
          "--suppressOperationalAttributeUpdates", "last-access-time",
          "--suppressOperationalAttributeUpdates", "last-login-time",
-         "--suppressOperationalAttributeUpdates", "last-login-ip");
+         "--suppressOperationalAttributeUpdates", "last-login-ip",
+         "--useJSONFormattedRequestControls");
   }
 
 
@@ -1915,7 +1921,8 @@
          "--replicationRepair",
          "--operationPurpose", "testAddControls",
          "--getPasswordValidationDetails",
-         "--allowUndelete");
+         "--allowUndelete",
+         "--useJSONFormattedRequestControls");
   }
 
 
@@ -1956,7 +1963,8 @@
          "--replicationRepair",
          "--hardDelete",
          "--serverSideSubtreeDelete",
-         "--operationPurpose", "testAddControls");
+         "--operationPurpose", "testAddControls",
+         "--useJSONFormattedRequestControls");
   }
 
 
@@ -1999,7 +2007,8 @@
          "--softDelete",
          "--operationPurpose", "testAddControls",
          "--retireCurrentPassword",
-         "--getPasswordValidationDetails");
+         "--getPasswordValidationDetails",
+         "--useJSONFormattedRequestControls");
 
 
     in = getInputStream(
@@ -2053,7 +2062,8 @@
          "--assuredReplicationRemoteLevel", "processed-all-remote-servers",
          "--assuredReplicationTimeout", "30s",
          "--replicationRepair",
-         "--operationPurpose", "testAddControls");
+         "--operationPurpose", "testAddControls",
+         "--useJSONFormattedRequestControls");
   }
 
 
@@ -3220,4 +3230,182 @@
          "--routeToBackendSet", "malformed",
          "--ldifFile", ldifFile.getAbsolutePath());
   }
+
+
+
+  /**
+   * Tests the behavior of the {@code handleJSONEncodedResponseControls} method
+   * for an LDAP result that does not have any controls.
+   *
+   * @throws  Exception  If an unexpected problem occurs.
+   */
+  @Test()
+  public void testHandleJSONEncodedResponseControlsNoControls()
+         throws Exception
+  {
+    final String[] referralURLs =
+    {
+      "ldap://ds1.example.com:389/",
+      "ldap://ds2.example.com:389/"
+    };
+
+    final LDAPResult originalResult = new LDAPResult(1, ResultCode.SUCCESS,
+         "diagnosticMessage", "dc=matched,dc=dn", referralURLs,
+         StaticUtils.NO_CONTROLS);
+
+    final LDAPResult processedResult =
+         LDAPModify.handleJSONEncodedResponseControls(originalResult);
+
+    assertNotNull(processedResult);
+
+    assertEquals(processedResult.getMessageID(), 1);
+
+    assertEquals(processedResult.getResultCode(), ResultCode.SUCCESS);
+
+    assertEquals(processedResult.getDiagnosticMessage(), "diagnosticMessage");
+
+    assertEquals(processedResult.getMatchedDN(), "dc=matched,dc=dn");
+
+    assertEquals(processedResult.getReferralURLs(), referralURLs);
+
+    assertEquals(processedResult.getResponseControls().length, 0);
+  }
+
+
+
+  /**
+   * Tests the behavior of the {@code handleJSONEncodedResponseControls} method
+   * for an LDAP result that includes a control that isn't a JSON-formatted
+   * response control.
+   *
+   * @throws  Exception  If an unexpected problem occurs.
+   */
+  @Test()
+  public void testHandleJSONEncodedResponseControlsNonJSONFormattedControl()
+         throws Exception
+  {
+    final String[] referralURLs =
+    {
+      "ldap://ds1.example.com:389/",
+      "ldap://ds2.example.com:389/"
+    };
+
+    final LDAPResult originalResult = new LDAPResult(1, ResultCode.SUCCESS,
+         "diagnosticMessage", "dc=matched,dc=dn", referralURLs,
+         new Control[] { new GetServerIDResponseControl("serverID") });
+
+    final LDAPResult processedResult =
+         LDAPModify.handleJSONEncodedResponseControls(originalResult);
+
+    assertNotNull(processedResult);
+
+    assertEquals(processedResult.getMessageID(), 1);
+
+    assertEquals(processedResult.getResultCode(), ResultCode.SUCCESS);
+
+    assertEquals(processedResult.getDiagnosticMessage(), "diagnosticMessage");
+
+    assertEquals(processedResult.getMatchedDN(), "dc=matched,dc=dn");
+
+    assertEquals(processedResult.getReferralURLs(), referralURLs);
+
+    assertEquals(processedResult.getResponseControls()[0].getOID(),
+         GetServerIDResponseControl.GET_SERVER_ID_RESPONSE_OID);
+  }
+
+
+
+  /**
+   * Tests the behavior of the {@code handleJSONEncodedResponseControls} method
+   * for an LDAP result that includes a control that is a valid JSON-formatted
+   * response control.
+   *
+   * @throws  Exception  If an unexpected problem occurs.
+   */
+  @Test()
+  public void testHandleJSONEncodedResponseControlsValidJSONFormattedControl()
+         throws Exception
+  {
+    final String[] referralURLs =
+    {
+      "ldap://ds1.example.com:389/",
+      "ldap://ds2.example.com:389/"
+    };
+
+    final Control[] originalResponseControls =
+    {
+      JSONFormattedResponseControl.createWithControls(
+           new GetServerIDResponseControl("serverID"))
+    };
+
+    final LDAPResult originalResult = new LDAPResult(1, ResultCode.SUCCESS,
+         "diagnosticMessage", "dc=matched,dc=dn", referralURLs,
+         originalResponseControls);
+
+    final LDAPResult processedResult =
+         LDAPModify.handleJSONEncodedResponseControls(originalResult);
+
+    assertNotNull(processedResult);
+
+    assertEquals(processedResult.getMessageID(), 1);
+
+    assertEquals(processedResult.getResultCode(), ResultCode.SUCCESS);
+
+    assertEquals(processedResult.getDiagnosticMessage(), "diagnosticMessage");
+
+    assertEquals(processedResult.getMatchedDN(), "dc=matched,dc=dn");
+
+    assertEquals(processedResult.getReferralURLs(), referralURLs);
+
+    assertEquals(processedResult.getResponseControls()[0].getOID(),
+         GetServerIDResponseControl.GET_SERVER_ID_RESPONSE_OID);
+  }
+
+
+
+  /**
+   * Tests the behavior of the {@code handleJSONEncodedResponseControls} method
+   * for an LDAP result that includes a control that is a malformed
+   * JSON-formatted response control.
+   *
+   * @throws  Exception  If an unexpected problem occurs.
+   */
+  @Test()
+  public void testHandleJSONEncodedResponseControlsInvalidJSONFormattedControl()
+         throws Exception
+  {
+    final String[] referralURLs =
+    {
+      "ldap://ds1.example.com:389/",
+      "ldap://ds2.example.com:389/"
+    };
+
+    final Control[] originalResponseControls =
+    {
+      new Control(JSONFormattedResponseControl.JSON_FORMATTED_RESPONSE_OID,
+           false, new ASN1OctetString("this is a malformed value"))
+    };
+
+    final LDAPResult originalResult = new LDAPResult(1, ResultCode.SUCCESS,
+         "diagnosticMessage", "dc=matched,dc=dn", referralURLs,
+         originalResponseControls);
+
+    final LDAPResult processedResult =
+         LDAPModify.handleJSONEncodedResponseControls(originalResult);
+
+    assertNotNull(processedResult);
+
+    assertEquals(processedResult.getMessageID(), 1);
+
+    assertEquals(processedResult.getResultCode(), ResultCode.SUCCESS);
+
+    assertEquals(processedResult.getDiagnosticMessage(), "diagnosticMessage");
+
+    assertEquals(processedResult.getMatchedDN(), "dc=matched,dc=dn");
+
+    assertEquals(processedResult.getReferralURLs(), referralURLs);
+
+    assertEquals(processedResult.getResponseControls()[0].getOID(),
+         JSONFormattedResponseControl.JSON_FORMATTED_RESPONSE_OID);
+  }
 }

Modified: trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/tools/LDAPSearchTestCase.java
===================================================================
--- trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/tools/LDAPSearchTestCase.java	2022-04-04 14:57:54 UTC (rev 1533)
+++ trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/tools/LDAPSearchTestCase.java	2022-04-04 23:23:00 UTC (rev 1534)
@@ -50,15 +50,20 @@
 import org.testng.annotations.BeforeClass;
 import org.testng.annotations.Test;
 
+import com.unboundid.asn1.ASN1OctetString;
 import com.unboundid.ldap.listener.InMemoryDirectoryServer;
+import com.unboundid.ldap.sdk.Control;
 import com.unboundid.ldap.sdk.DeleteRequest;
 import com.unboundid.ldap.sdk.Entry;
 import com.unboundid.ldap.sdk.LDAPConnection;
 import com.unboundid.ldap.sdk.LDAPSDKTestCase;
 import com.unboundid.ldap.sdk.ResultCode;
+import com.unboundid.ldap.sdk.SearchResult;
 import com.unboundid.ldap.sdk.Version;
 import com.unboundid.ldap.sdk.controls.ManageDsaITRequestControl;
 import com.unboundid.ldap.sdk.extensions.NoticeOfDisconnectionExtendedResult;
+import com.unboundid.ldap.sdk.unboundidds.controls.GetServerIDResponseControl;
+import com.unboundid.ldap.sdk.unboundidds.controls.JSONFormattedResponseControl;
 import com.unboundid.ldif.LDIFReader;
 import com.unboundid.util.PassphraseEncryptedInputStream;
 import com.unboundid.util.PasswordReader;
@@ -452,6 +457,7 @@
          "--suppressOperationalAttributeUpdates", "last-access-time",
          "--suppressOperationalAttributeUpdates", "last-login-time",
          "--suppressOperationalAttributeUpdates", "last-login-ip",
+         "--useJSONFormattedRequestControls",
          "--dontWrap",
          "--dereferencePolicy", "always",
          "(objectClass=*)",
@@ -512,6 +518,7 @@
          "--suppressOperationalAttributeUpdates", "lastmod",
          "--realAttributesOnly",
          "--rejectUnindexedSearch",
+         "--useJSONFormattedRequestControls",
          "--wrapColumn", "0",
          "--dereferencePolicy", "search",
          "(objectClass=*)",
@@ -2522,4 +2529,209 @@
          "(uid=nonexistent)");
     assertEquals(resultCode, ResultCode.NO_RESULTS_RETURNED);
   }
+
+
+
+  /**
+   * Tests the behavior of the {@code handleJSONEncodedResponseControls} method
+   * for a search result that does not have any controls.
+   *
+   * @throws  Exception  If an unexpected problem occurs.
+   */
+  @Test()
+  public void testHandleJSONEncodedResponseControlsNoControls()
+         throws Exception
+  {
+    final String[] referralURLs =
+    {
+      "ldap://ds1.example.com:389/",
+      "ldap://ds2.example.com:389/"
+    };
+
+    final SearchResult originalSearchResult = new SearchResult(1,
+         ResultCode.SUCCESS, "diagnosticMessage", "dc=matched,dc=dn",
+         referralURLs, 1, 2, StaticUtils.NO_CONTROLS);
+
+    final SearchResult processedSearchResult =
+         LDAPSearch.handleJSONEncodedResponseControls(originalSearchResult);
+
+    assertNotNull(processedSearchResult);
+
+    assertEquals(processedSearchResult.getMessageID(), 1);
+
+    assertEquals(processedSearchResult.getResultCode(), ResultCode.SUCCESS);
+
+    assertEquals(processedSearchResult.getDiagnosticMessage(),
+         "diagnosticMessage");
+
+    assertEquals(processedSearchResult.getMatchedDN(), "dc=matched,dc=dn");
+
+    assertEquals(processedSearchResult.getReferralURLs(), referralURLs);
+
+    assertEquals(processedSearchResult.getEntryCount(), 1);
+
+    assertEquals(processedSearchResult.getReferenceCount(), 2);
+
+    assertEquals(processedSearchResult.getResponseControls().length, 0);
+  }
+
+
+
+  /**
+   * Tests the behavior of the {@code handleJSONEncodedResponseControls} method
+   * for a search result that includes a control that isn't a JSON-formatted
+   * response control.
+   *
+   * @throws  Exception  If an unexpected problem occurs.
+   */
+  @Test()
+  public void testHandleJSONEncodedResponseControlsNonJSONFormattedControl()
+         throws Exception
+  {
+    final String[] referralURLs =
+    {
+      "ldap://ds1.example.com:389/",
+      "ldap://ds2.example.com:389/"
+    };
+
+    final SearchResult originalSearchResult = new SearchResult(1,
+         ResultCode.SUCCESS, "diagnosticMessage", "dc=matched,dc=dn",
+         referralURLs, 1, 2,
+         new Control[] { new GetServerIDResponseControl("serverID") });
+
+    final SearchResult processedSearchResult =
+         LDAPSearch.handleJSONEncodedResponseControls(originalSearchResult);
+
+    assertNotNull(processedSearchResult);
+
+    assertEquals(processedSearchResult.getMessageID(), 1);
+
+    assertEquals(processedSearchResult.getResultCode(), ResultCode.SUCCESS);
+
+    assertEquals(processedSearchResult.getDiagnosticMessage(),
+         "diagnosticMessage");
+
+    assertEquals(processedSearchResult.getMatchedDN(), "dc=matched,dc=dn");
+
+    assertEquals(processedSearchResult.getReferralURLs(), referralURLs);
+
+    assertEquals(processedSearchResult.getEntryCount(), 1);
+
+    assertEquals(processedSearchResult.getReferenceCount(), 2);
+
+    assertEquals(processedSearchResult.getResponseControls().length, 1);
+
+    assertEquals(processedSearchResult.getResponseControls()[0].getOID(),
+         GetServerIDResponseControl.GET_SERVER_ID_RESPONSE_OID);
+  }
+
+
+
+  /**
+   * Tests the behavior of the {@code handleJSONEncodedResponseControls} method
+   * for a search result that includes a control that is a valid JSON-formatted
+   * response control.
+   *
+   * @throws  Exception  If an unexpected problem occurs.
+   */
+  @Test()
+  public void testHandleJSONEncodedResponseControlsValidJSONFormattedControl()
+         throws Exception
+  {
+    final String[] referralURLs =
+    {
+      "ldap://ds1.example.com:389/",
+      "ldap://ds2.example.com:389/"
+    };
+
+    final Control[] originalResponseControls =
+    {
+      JSONFormattedResponseControl.createWithControls(
+           new GetServerIDResponseControl("serverID"))
+    };
+
+    final SearchResult originalSearchResult = new SearchResult(1,
+         ResultCode.SUCCESS, "diagnosticMessage", "dc=matched,dc=dn",
+         referralURLs, 1, 2, originalResponseControls);
+
+    final SearchResult processedSearchResult =
+         LDAPSearch.handleJSONEncodedResponseControls(originalSearchResult);
+
+    assertNotNull(processedSearchResult);
+
+    assertEquals(processedSearchResult.getMessageID(), 1);
+
+    assertEquals(processedSearchResult.getResultCode(), ResultCode.SUCCESS);
+
+    assertEquals(processedSearchResult.getDiagnosticMessage(),
+         "diagnosticMessage");
+
+    assertEquals(processedSearchResult.getMatchedDN(), "dc=matched,dc=dn");
+
+    assertEquals(processedSearchResult.getReferralURLs(), referralURLs);
+
+    assertEquals(processedSearchResult.getEntryCount(), 1);
+
+    assertEquals(processedSearchResult.getReferenceCount(), 2);
+
+    assertEquals(processedSearchResult.getResponseControls().length, 1);
+
+    assertEquals(processedSearchResult.getResponseControls()[0].getOID(),
+         GetServerIDResponseControl.GET_SERVER_ID_RESPONSE_OID);
+  }
+
+
+
+  /**
+   * Tests the behavior of the {@code handleJSONEncodedResponseControls} method
+   * for a search result that includes a control that is a malformed
+   * JSON-formatted response control.
+   *
+   * @throws  Exception  If an unexpected problem occurs.
+   */
+  @Test()
+  public void testHandleJSONEncodedResponseControlsInvalidJSONFormattedControl()
+         throws Exception
+  {
+    final String[] referralURLs =
+    {
+      "ldap://ds1.example.com:389/",
+      "ldap://ds2.example.com:389/"
+    };
+
+    final Control[] originalResponseControls =
+    {
+      new Control(JSONFormattedResponseControl.JSON_FORMATTED_RESPONSE_OID,
+           false, new ASN1OctetString("this is a malformed value"))
+    };
+
+    final SearchResult originalSearchResult = new SearchResult(1,
+         ResultCode.SUCCESS, "diagnosticMessage", "dc=matched,dc=dn",
+         referralURLs, 1, 2, originalResponseControls);
+
+    final SearchResult processedSearchResult =
+         LDAPSearch.handleJSONEncodedResponseControls(originalSearchResult);
+
+    assertNotNull(processedSearchResult);
+
+    assertEquals(processedSearchResult.getMessageID(), 1);
+
+    assertEquals(processedSearchResult.getResultCode(), ResultCode.SUCCESS);
+
+    assertEquals(processedSearchResult.getDiagnosticMessage(),
+         "diagnosticMessage");
+
+    assertEquals(processedSearchResult.getMatchedDN(), "dc=matched,dc=dn");
+
+    assertEquals(processedSearchResult.getReferralURLs(), referralURLs);
+
+    assertEquals(processedSearchResult.getEntryCount(), 1);
+
+    assertEquals(processedSearchResult.getReferenceCount(), 2);
+
+    assertEquals(processedSearchResult.getResponseControls().length, 1);
+
+    assertEquals(processedSearchResult.getResponseControls()[0].getOID(),
+         JSONFormattedResponseControl.JSON_FORMATTED_RESPONSE_OID);
+  }
 }

Modified: trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/tools/ResultUtilsTestCase.java
===================================================================
--- trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/tools/ResultUtilsTestCase.java	2022-04-04 14:57:54 UTC (rev 1533)
+++ trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/tools/ResultUtilsTestCase.java	2022-04-04 23:23:00 UTC (rev 1534)
@@ -106,6 +106,7 @@
             IntermediateClientResponseControl;
 import com.unboundid.ldap.sdk.unboundidds.controls.
             IntermediateClientResponseValue;
+import com.unboundid.ldap.sdk.unboundidds.controls.JSONFormattedResponseControl;
 import com.unboundid.ldap.sdk.unboundidds.controls.JoinedEntry;
 import com.unboundid.ldap.sdk.unboundidds.controls.JoinResultControl;
 import com.unboundid.ldap.sdk.unboundidds.controls.
@@ -1751,6 +1752,40 @@
          });
 
 
+    // A valid JSON-formatted response control.
+    resultList.add(
+         new Object[]
+         {
+              JSONFormattedResponseControl.createWithControls(
+                   new GetServerIDResponseControl("serverID")),
+           Arrays.asList(
+                "#      JSON-Formatted Response Control:",
+                "#           OID:  " + JSONFormattedResponseControl.
+                     JSON_FORMATTED_RESPONSE_OID,
+                "#           Embedded Control JSON:",
+                "#                { \"oid\":\"1.3.6.1.4.1.30221.2.5.15\",",
+                "#                  \"control-name\":" +
+                     "\"Get Server ID Response Control\",",
+                "#                  \"criticality\":false,",
+                "#                  \"value-json\":{ \"server-id\":" +
+                     "\"serverID\" } }")
+         });
+
+
+    // An invalid JSON-formatted control.
+    resultList.add(
+         new Object[]
+         {
+           new Control(
+                JSONFormattedResponseControl.JSON_FORMATTED_RESPONSE_OID),
+           Arrays.asList(
+                "#      Response Control:",
+                "#           OID:  " + JSONFormattedResponseControl.
+                     JSON_FORMATTED_RESPONSE_OID,
+                "#           Is Critical:  false")
+         });
+
+
     // A valid matching entry count response control for an examined count.
     resultList.add(
          new Object[]

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

[ldap-sdk-commits] SF.net SVN: ldap-sdk:[1533] trunk/src/com/unboundid/ldap/sdk/unboundidds/ controls

[<di...@us...>]

Revision: 1533
          http://sourceforge.net/p/ldap-sdk/code/1533
Author:   dirmgr
Date:     2022-04-04 14:57:54 +0000 (Mon, 04 Apr 2022)
Log Message:
-----------
Eliminate an unused variable & fix Javadoc typo

Eliminated an unused variable and fixed a Javadoc typo in support
for JSON-formatted request and response controls.

Modified Paths:
--------------
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedResponseControl.java

Modified: trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedRequestControl.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedRequestControl.java	2022-04-03 17:15:44 UTC (rev 1532)
+++ trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedRequestControl.java	2022-04-04 14:57:54 UTC (rev 1533)
@@ -156,7 +156,7 @@
    *                         value.
    * @param  controlObjects  A collection of JSON objects representing the
    *                         controls to include in the request.  It must not
-   *                         be {@ocde null}, but may be empty.
+   *                         be {@code null}, but may be empty.
    */
   private JSONFormattedRequestControl(final boolean isCritical,
                @Nullable final JSONObject encodedValue,
@@ -246,7 +246,6 @@
     }
 
 
-    final List<Control> controlList = new ArrayList<>(controls);
     final List<JSONObject> controlObjects = new ArrayList<>(controls.size());
     for (final Control c : controls)
     {

Modified: trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedResponseControl.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedResponseControl.java	2022-04-03 17:15:44 UTC (rev 1532)
+++ trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedResponseControl.java	2022-04-04 14:57:54 UTC (rev 1533)
@@ -162,7 +162,7 @@
    *                         value.
    * @param  controlObjects  A collection of JSON objects representing the
    *                         response controls generated by the server.  It
-   *                         must not be {@ocde null}, and should not be empty.
+   *                         must not be {@code null}, and should not be empty.
    */
   private JSONFormattedResponseControl(
                @NotNull final JSONObject encodedValue,
@@ -209,7 +209,6 @@
   public static JSONFormattedResponseControl createWithControls(
               @NotNull final Collection<Control> controls)
   {
-    final List<Control> controlList = new ArrayList<>(controls);
     final List<JSONObject> controlObjects = new ArrayList<>(controls.size());
     for (final Control c : controls)
     {

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

[ldap-sdk-commits] SF.net SVN: ldap-sdk:[1532] trunk/src/com/unboundid/ldap/sdk/unboundidds/ controls/JSONFormattedControlDecodeBehavior.java

[<di...@us...>]

Revision: 1532
          http://sourceforge.net/p/ldap-sdk/code/1532
Author:   dirmgr
Date:     2022-04-03 17:15:44 +0000 (Sun, 03 Apr 2022)
Log Message:
-----------
Fix a typo in a Javadoc comment

Fixed a comment in a Javadoc comment in which a closing square
bracket was inadvertently used in place of a closing curly brace.

Modified Paths:
--------------
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedControlDecodeBehavior.java

Modified: trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedControlDecodeBehavior.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedControlDecodeBehavior.java	2022-04-03 17:12:46 UTC (rev 1531)
+++ trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedControlDecodeBehavior.java	2022-04-03 17:15:44 UTC (rev 1532)
@@ -301,7 +301,7 @@
    * @param  allowEmbeddedJSONFormattedControl  Indicates whether to allow a
    *                                            JSON-formatted request or
    *                                            response control.  If this is
-   *                                            {@code true], then an embedded
+   *                                            {@code true}, then an embedded
    *                                            JSON-formatted control will
    *                                            either result in an exception
    *                                            (if the embedded control is

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

[ldap-sdk-commits] SF.net SVN: ldap-sdk:[1531] trunk

[<di...@us...>]

Revision: 1531
          http://sourceforge.net/p/ldap-sdk/code/1531
Author:   dirmgr
Date:     2022-04-03 17:12:46 +0000 (Sun, 03 Apr 2022)
Log Message:
-----------
Handle embedded JSON-formatted controls

Updated support for JSON-formatted request and response controls to
make it possible to disallow embedded JSON-formatted request and
response controls.  This is the new default behavior, and if the
embedded control is critical, then an attempt to decode the embedded
controls will result in an exception, while if the embedded control
is non-critical, then it will be ignored with a non-fatal error
message.  The JSONFormattedControlDecodeBehavior class has been
updated to make it possible to choose between this behavior and the
former behavior of allowing JSON-formatted request and response
controls to embed other JSON-formatted request and response
controls.

Modified Paths:
--------------
    trunk/messages/unboundid-ldapsdk-unboundid-controls.properties
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedControlDecodeBehavior.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedResponseControl.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedControlDecodeBehaviorTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedResponseControlTestCase.java

Modified: trunk/messages/unboundid-ldapsdk-unboundid-controls.properties
===================================================================
--- trunk/messages/unboundid-ldapsdk-unboundid-controls.properties	2022-04-02 19:10:18 UTC (rev 1530)
+++ trunk/messages/unboundid-ldapsdk-unboundid-controls.properties	2022-04-03 17:12:46 UTC (rev 1531)
@@ -1222,6 +1222,9 @@
 ERR_JSON_FORMATTED_REQUEST_UNRECOGNIZED_FIELD=Unable to decode the provided \
   control as a JSON-formatted request control because the value includes \
   unrecognized field ''{0}''.
+ERR_JSON_FORMATTED_REQUEST_DISALLOWED_EMBEDDED_CONTROL=JSON-formatted request \
+  controls are not permitted to include embedded JSON-formatted request \
+  controls.
 INFO_CONTROL_NAME_JSON_FORMATTED_REQUEST=JSON-Formatted Request Control
 ERR_JSON_FORMATTED_REQUEST_DECODE_VALUE_MISSING_CONTROLS=Unable to decode \
   JSON object {0} as a JSON-formatted request control because the value \
@@ -1256,6 +1259,9 @@
 ERR_JSON_FORMATTED_RESPONSE_UNRECOGNIZED_FIELD=Unable to decode the provided \
   control as a JSON-formatted response control because the value includes \
   unrecognized field ''{0}''.
+ERR_JSON_FORMATTED_RESPONSE_DISALLOWED_EMBEDDED_CONTROL=JSON-formatted \
+  response controls are not permitted to include embedded JSON-formatted \
+  response controls.
 INFO_CONTROL_NAME_JSON_FORMATTED_RESPONSE=JSON-Formatted Response Control
 ERR_JSON_FORMATTED_RESPONSE_DECODE_VALUE_MISSING_CONTROLS=Unable to decode \
   JSON object {0} as a JSON-formatted response control because the value \

Modified: trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedControlDecodeBehavior.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedControlDecodeBehavior.java	2022-04-02 19:10:18 UTC (rev 1530)
+++ trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedControlDecodeBehavior.java	2022-04-03 17:12:46 UTC (rev 1531)
@@ -74,6 +74,10 @@
 
 
 
+  // Indicates whether to allow embedded JSON-formatted request or response
+  // controls.
+  private boolean allowEmbeddedJSONFormattedControl;
+
   // Indicates whether to use strict mode when decoding controls.
   private boolean strict;
 
@@ -100,6 +104,8 @@
    *   <LI>{@code throwOnUnparsableObject} is set to {@code true}</LI>
    *   <LI>{@code throwOnInvalidCriticalControl} is set to {@code true}</LI>
    *   <LI>{@code throwOnInvalidNonCriticalControl} is set to {@code true}</LI>
+   *   <LI>{@code allowEmbeddedJSONFormattedControl} is set to
+   *       {@code false}</LI>
    *   <LI>{@code strict} is set to {@code false}</LI>
    * </UL>
    */
@@ -108,6 +114,7 @@
     throwOnUnparsableObject = true;
     throwOnInvalidCriticalControl = true;
     throwOnInvalidNonCriticalControl = true;
+    allowEmbeddedJSONFormattedControl = false;
     strict = false;
   }
 
@@ -266,6 +273,57 @@
 
 
   /**
+   * Indicates whether to allow a JSON-formatted request or response control to
+   * include another JSON-formatted request or response control in the set of
+   * embedded controls.  If embedded JSON-formatted controls are not allowed,
+   * then the attempt to decode will throw an exception if the control is
+   * critical, or it will be ignored with a non-fatal error message if the
+   * control is non-critical.
+   *
+   * @return  {@code true} if embedded JSON-formatted request or response
+   *          controls should be allowed, or {@code false} if not.
+   */
+  public boolean allowEmbeddedJSONFormattedControl()
+  {
+    return allowEmbeddedJSONFormattedControl;
+  }
+
+
+
+  /**
+   * Specifies whether to allow a JSON-formatted request or response control to
+   * include another JSON-formatted request or response control in the set of
+   * embedded controls.  If embedded JSON-formatted controls are not allowed,
+   * then the attempt to decode will throw an exception if the control is
+   * critical, or it will be ignored with a non-fatal error message if the
+   * control is non-critical.
+   *
+   * @param  allowEmbeddedJSONFormattedControl  Indicates whether to allow a
+   *                                            JSON-formatted request or
+   *                                            response control.  If this is
+   *                                            {@code true], then an embedded
+   *                                            JSON-formatted control will
+   *                                            either result in an exception
+   *                                            (if the embedded control is
+   *                                            critical) or cause it to be
+   *                                            ignored with a non-fatal error
+   *                                            message (if it is not critical).
+   *                                            If this is {@code false}, then
+   *                                            the JSON-formatted control will
+   *                                            be included directly in the list
+   *                                            of decoded controls that is
+   *                                            returned without attempting to
+   *                                            extract its embedded controls.
+   */
+  public void setAllowEmbeddedJSONFormattedControl(
+                   final boolean allowEmbeddedJSONFormattedControl)
+  {
+    this.allowEmbeddedJSONFormattedControl = allowEmbeddedJSONFormattedControl;
+  }
+
+
+
+  /**
    * Indicates whether to use strict mode when parsing JSON objects as controls.
    * This may include throwing an exception if a JSON object contains any
    * unrecognized fields, or if the object violates any other control-specific
@@ -334,6 +392,8 @@
     buffer.append(throwOnInvalidCriticalControl);
     buffer.append(", throwOnInvalidNonCriticalControl=");
     buffer.append(throwOnInvalidNonCriticalControl);
+    buffer.append(", allowEmbeddedJSONFormattedControl=");
+    buffer.append(allowEmbeddedJSONFormattedControl);
     buffer.append(", strict=");
     buffer.append(strict);
     buffer.append(')');

Modified: trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedRequestControl.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedRequestControl.java	2022-04-02 19:10:18 UTC (rev 1530)
+++ trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedRequestControl.java	2022-04-03 17:12:46 UTC (rev 1531)
@@ -513,6 +513,28 @@
       }
 
 
+      // If the control is itself an embedded JSON-formatted request control,
+      // see how we should handle it.
+      if (jsonControl.getOID().equals(JSON_FORMATTED_REQUEST_OID))
+      {
+        if (! behavior.allowEmbeddedJSONFormattedControl())
+        {
+          final String message =
+               ERR_JSON_FORMATTED_REQUEST_DISALLOWED_EMBEDDED_CONTROL.get();
+          if (jsonControl.getCriticality())
+          {
+            fatalMessages.add(message);
+          }
+          else if (nonFatalDecodeMessages != null)
+          {
+            nonFatalDecodeMessages.add(message);
+          }
+
+          continue;
+        }
+      }
+
+
       // Try to actually decode the JSON object as a control, potentially using
       // control-specific logic based on its OID.
       try

Modified: trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedResponseControl.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedResponseControl.java	2022-04-02 19:10:18 UTC (rev 1530)
+++ trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedResponseControl.java	2022-04-03 17:12:46 UTC (rev 1531)
@@ -475,6 +475,28 @@
       }
 
 
+      // If the control is itself an embedded JSON-formatted response control,
+      // see how we should handle it.
+      if (jsonControl.getOID().equals(JSON_FORMATTED_RESPONSE_OID))
+      {
+        if (! behavior.allowEmbeddedJSONFormattedControl())
+        {
+          final String message =
+               ERR_JSON_FORMATTED_RESPONSE_DISALLOWED_EMBEDDED_CONTROL.get();
+          if (jsonControl.getCriticality())
+          {
+            fatalMessages.add(message);
+          }
+          else if (nonFatalDecodeMessages != null)
+          {
+            nonFatalDecodeMessages.add(message);
+          }
+
+          continue;
+        }
+      }
+
+
       // Try to actually decode the JSON object as a control, potentially using
       // control-specific logic based on its OID.
       try

Modified: trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedControlDecodeBehaviorTestCase.java
===================================================================
--- trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedControlDecodeBehaviorTestCase.java	2022-04-02 19:10:18 UTC (rev 1530)
+++ trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedControlDecodeBehaviorTestCase.java	2022-04-03 17:12:46 UTC (rev 1531)
@@ -68,6 +68,8 @@
 
     assertTrue(behavior.throwOnInvalidNonCriticalControl());
 
+    assertFalse(behavior.allowEmbeddedJSONFormattedControl());
+
     assertFalse(behavior.strict());
 
     assertNotNull(behavior.toString());
@@ -91,6 +93,7 @@
     assertTrue(behavior.throwOnUnparsableObject());
     assertTrue(behavior.throwOnInvalidCriticalControl());
     assertTrue(behavior.throwOnInvalidNonCriticalControl());
+    assertFalse(behavior.allowEmbeddedJSONFormattedControl());
     assertFalse(behavior.strict());
     assertNotNull(behavior.toString());
 
@@ -98,6 +101,7 @@
     assertFalse(behavior.throwOnUnparsableObject());
     assertTrue(behavior.throwOnInvalidCriticalControl());
     assertTrue(behavior.throwOnInvalidNonCriticalControl());
+    assertFalse(behavior.allowEmbeddedJSONFormattedControl());
     assertFalse(behavior.strict());
     assertNotNull(behavior.toString());
 
@@ -105,6 +109,7 @@
     assertTrue(behavior.throwOnUnparsableObject());
     assertTrue(behavior.throwOnInvalidCriticalControl());
     assertTrue(behavior.throwOnInvalidNonCriticalControl());
+    assertFalse(behavior.allowEmbeddedJSONFormattedControl());
     assertFalse(behavior.strict());
     assertNotNull(behavior.toString());
   }
@@ -127,6 +132,7 @@
     assertTrue(behavior.throwOnUnparsableObject());
     assertTrue(behavior.throwOnInvalidCriticalControl());
     assertTrue(behavior.throwOnInvalidNonCriticalControl());
+    assertFalse(behavior.allowEmbeddedJSONFormattedControl());
     assertFalse(behavior.strict());
     assertNotNull(behavior.toString());
 
@@ -134,6 +140,7 @@
     assertTrue(behavior.throwOnUnparsableObject());
     assertFalse(behavior.throwOnInvalidCriticalControl());
     assertTrue(behavior.throwOnInvalidNonCriticalControl());
+    assertFalse(behavior.allowEmbeddedJSONFormattedControl());
     assertFalse(behavior.strict());
     assertNotNull(behavior.toString());
 
@@ -141,6 +148,7 @@
     assertTrue(behavior.throwOnUnparsableObject());
     assertTrue(behavior.throwOnInvalidCriticalControl());
     assertTrue(behavior.throwOnInvalidNonCriticalControl());
+    assertFalse(behavior.allowEmbeddedJSONFormattedControl());
     assertFalse(behavior.strict());
     assertNotNull(behavior.toString());
   }
@@ -163,6 +171,7 @@
     assertTrue(behavior.throwOnUnparsableObject());
     assertTrue(behavior.throwOnInvalidCriticalControl());
     assertTrue(behavior.throwOnInvalidNonCriticalControl());
+    assertFalse(behavior.allowEmbeddedJSONFormattedControl());
     assertFalse(behavior.strict());
     assertNotNull(behavior.toString());
 
@@ -170,6 +179,7 @@
     assertTrue(behavior.throwOnUnparsableObject());
     assertTrue(behavior.throwOnInvalidCriticalControl());
     assertFalse(behavior.throwOnInvalidNonCriticalControl());
+    assertFalse(behavior.allowEmbeddedJSONFormattedControl());
     assertFalse(behavior.strict());
     assertNotNull(behavior.toString());
 
@@ -177,6 +187,7 @@
     assertTrue(behavior.throwOnUnparsableObject());
     assertTrue(behavior.throwOnInvalidCriticalControl());
     assertTrue(behavior.throwOnInvalidNonCriticalControl());
+    assertFalse(behavior.allowEmbeddedJSONFormattedControl());
     assertFalse(behavior.strict());
     assertNotNull(behavior.toString());
   }
@@ -184,6 +195,45 @@
 
 
   /**
+   * Test the methods for manipulating the
+   * {@code allowEmbeddedJSONFormattedControl}  variable.
+   *
+   * @throws  Exception  If an unexpected problem occurs.
+   */
+  @Test()
+  public void testAllowEmbeddedJSONFormattedControl()
+         throws Exception
+  {
+    final JSONFormattedControlDecodeBehavior behavior =
+         new JSONFormattedControlDecodeBehavior();
+
+    assertTrue(behavior.throwOnUnparsableObject());
+    assertTrue(behavior.throwOnInvalidCriticalControl());
+    assertTrue(behavior.throwOnInvalidNonCriticalControl());
+    assertFalse(behavior.allowEmbeddedJSONFormattedControl());
+    assertFalse(behavior.strict());
+    assertNotNull(behavior.toString());
+
+    behavior.setAllowEmbeddedJSONFormattedControl(true);
+    assertTrue(behavior.throwOnUnparsableObject());
+    assertTrue(behavior.throwOnInvalidCriticalControl());
+    assertTrue(behavior.throwOnInvalidNonCriticalControl());
+    assertTrue(behavior.allowEmbeddedJSONFormattedControl());
+    assertFalse(behavior.strict());
+    assertNotNull(behavior.toString());
+
+    behavior.setAllowEmbeddedJSONFormattedControl(false);
+    assertTrue(behavior.throwOnUnparsableObject());
+    assertTrue(behavior.throwOnInvalidCriticalControl());
+    assertTrue(behavior.throwOnInvalidNonCriticalControl());
+    assertFalse(behavior.allowEmbeddedJSONFormattedControl());
+    assertFalse(behavior.strict());
+    assertNotNull(behavior.toString());
+  }
+
+
+
+  /**
    * Test the methods for manipulating the {@code strict}  variable.
    *
    * @throws  Exception  If an unexpected problem occurs.
@@ -198,6 +248,7 @@
     assertTrue(behavior.throwOnUnparsableObject());
     assertTrue(behavior.throwOnInvalidCriticalControl());
     assertTrue(behavior.throwOnInvalidNonCriticalControl());
+    assertFalse(behavior.allowEmbeddedJSONFormattedControl());
     assertFalse(behavior.strict());
     assertNotNull(behavior.toString());
 
@@ -205,6 +256,7 @@
     assertTrue(behavior.throwOnUnparsableObject());
     assertTrue(behavior.throwOnInvalidCriticalControl());
     assertTrue(behavior.throwOnInvalidNonCriticalControl());
+    assertFalse(behavior.allowEmbeddedJSONFormattedControl());
     assertTrue(behavior.strict());
     assertNotNull(behavior.toString());
 
@@ -212,6 +264,7 @@
     assertTrue(behavior.throwOnUnparsableObject());
     assertTrue(behavior.throwOnInvalidCriticalControl());
     assertTrue(behavior.throwOnInvalidNonCriticalControl());
+    assertFalse(behavior.allowEmbeddedJSONFormattedControl());
     assertFalse(behavior.strict());
     assertNotNull(behavior.toString());
   }

Modified: trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedRequestControlTestCase.java
===================================================================
--- trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedRequestControlTestCase.java	2022-04-02 19:10:18 UTC (rev 1530)
+++ trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedRequestControlTestCase.java	2022-04-03 17:12:46 UTC (rev 1531)
@@ -1544,4 +1544,96 @@
     // exception.
     JSONFormattedRequestControl.decodeJSONControl(controlObject, false);
   }
+
+
+
+  /**
+   * Tests the behavior when trying to decode a JSON-formatted request control
+   * with an embedded JSON-formatted request control.
+   *
+   * @throws  Exception  If an unexpected problem occurs.
+   */
+  @Test()
+  public void testEmbeddedJSONFormattedRequestControl()
+         throws Exception
+  {
+    // Create controls to use for testing.
+    final JSONFormattedRequestControl embeddedCriticalControl =
+         JSONFormattedRequestControl.createEmptyControl(true);
+    final JSONFormattedRequestControl embeddedNonCriticalControl =
+         JSONFormattedRequestControl.createEmptyControl(false);
+
+    final JSONFormattedRequestControl controlWithEmbeddedCriticalControl =
+         JSONFormattedRequestControl.createWithControls(true,
+              embeddedCriticalControl);
+    final JSONFormattedRequestControl controlWithEmbeddedNonCriticalControl =
+         JSONFormattedRequestControl.createWithControls(true,
+              embeddedNonCriticalControl);
+
+
+    // Create a decode behavior with the default settings.  Make sure that
+    // embedded JSON-formatted controls are not allowed by default.
+    final JSONFormattedControlDecodeBehavior decodeBehavior =
+         new JSONFormattedControlDecodeBehavior();
+    assertFalse(decodeBehavior.allowEmbeddedJSONFormattedControl());
+
+
+    // Try to decode the embedded controls for a JSON-formatted request control
+    // that has an embedded critical JSON-formatted request control.  This
+    // should result in an exception.
+    final List<String> nonFatalDecodeMessages = new ArrayList<>();
+    try
+    {
+      controlWithEmbeddedCriticalControl.decodeEmbeddedControls(
+           decodeBehavior, nonFatalDecodeMessages);
+      fail("Expected an exception when trying to decode embedded controls " +
+           "that included a critical JSON-formatted request control.");
+    }
+    catch (final LDAPException e)
+    {
+      assertEquals(e.getResultCode(), ResultCode.DECODING_ERROR);
+      assertTrue(nonFatalDecodeMessages.isEmpty());
+    }
+
+
+    // Try to decode the embedded controls for a JSON-formatted request control
+    // that has an embedded non-critical JSON-formatted request control.  This
+    // should cause the control to be ignored with a non-fatal decode error.
+    List<Control> embeddedControls =
+         controlWithEmbeddedNonCriticalControl.decodeEmbeddedControls(
+              decodeBehavior, nonFatalDecodeMessages);
+    assertTrue(embeddedControls.isEmpty());
+    assertFalse(nonFatalDecodeMessages.isEmpty());
+    nonFatalDecodeMessages.clear();
+
+
+    // Change the decode behavior to allow embedded JSON-formatted request
+    // controls.
+    decodeBehavior.setAllowEmbeddedJSONFormattedControl(true);
+    assertTrue(decodeBehavior.allowEmbeddedJSONFormattedControl());
+
+
+    // Verify that we can now extract an embedded critical JSON-formatted
+    // request control.
+    embeddedControls =
+         controlWithEmbeddedCriticalControl.decodeEmbeddedControls(
+              decodeBehavior, nonFatalDecodeMessages);
+    assertEquals(embeddedControls.size(), 1);
+    assertEquals(embeddedControls.get(0).getOID(),
+         JSONFormattedRequestControl.JSON_FORMATTED_REQUEST_OID);
+    assertTrue(embeddedControls.get(0).isCritical());
+    assertTrue(nonFatalDecodeMessages.isEmpty());
+
+
+    // Verify that we can now extract an embedded non-critical JSON-formatted
+    // request control.
+    embeddedControls =
+         controlWithEmbeddedNonCriticalControl.decodeEmbeddedControls(
+              decodeBehavior, nonFatalDecodeMessages);
+    assertEquals(embeddedControls.size(), 1);
+    assertEquals(embeddedControls.get(0).getOID(),
+         JSONFormattedRequestControl.JSON_FORMATTED_REQUEST_OID);
+    assertFalse(embeddedControls.get(0).isCritical());
+    assertTrue(nonFatalDecodeMessages.isEmpty());
+  }
 }

Modified: trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedResponseControlTestCase.java
===================================================================
--- trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedResponseControlTestCase.java	2022-04-02 19:10:18 UTC (rev 1530)
+++ trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedResponseControlTestCase.java	2022-04-03 17:12:46 UTC (rev 1531)
@@ -1495,4 +1495,96 @@
       assertEquals(e.getResultCode(), ResultCode.DECODING_ERROR);
     }
   }
+
+
+
+  /**
+   * Tests the behavior when trying to decode a JSON-formatted response control
+   * with an embedded JSON-formatted response control.
+   *
+   * @throws  Exception  If an unexpected problem occurs.
+   */
+  @Test()
+  public void testEmbeddedJSONFormattedResponseControl()
+         throws Exception
+  {
+    // Create controls to use for testing.
+    final JSONFormattedResponseControl embeddedNonCriticalControl =
+         JSONFormattedResponseControl.createWithControls(
+              new PasswordExpiredControl());
+    final JSONFormattedResponseControl embeddedCriticalControl =
+         new JSONFormattedResponseControl(embeddedNonCriticalControl.getOID(),
+              true, embeddedNonCriticalControl.getValue());
+
+    final JSONFormattedResponseControl controlWithEmbeddedCriticalControl =
+         JSONFormattedResponseControl.createWithControls(
+              embeddedCriticalControl);
+    final JSONFormattedResponseControl controlWithEmbeddedNonCriticalControl =
+         JSONFormattedResponseControl.createWithControls(
+              embeddedNonCriticalControl);
+
+
+    // Create a decode behavior with the default settings.  Make sure that
+    // embedded JSON-formatted controls are not allowed by default.
+    final JSONFormattedControlDecodeBehavior decodeBehavior =
+         new JSONFormattedControlDecodeBehavior();
+    assertFalse(decodeBehavior.allowEmbeddedJSONFormattedControl());
+
+
+    // Try to decode the embedded controls for a JSON-formatted response control
+    // that has an embedded critical JSON-formatted response control.  This
+    // should result in an exception.
+    final List<String> nonFatalDecodeMessages = new ArrayList<>();
+    try
+    {
+      controlWithEmbeddedCriticalControl.decodeEmbeddedControls(
+           decodeBehavior, nonFatalDecodeMessages);
+      fail("Expected an exception when trying to decode embedded controls " +
+           "that included a critical JSON-formatted response control.");
+    }
+    catch (final LDAPException e)
+    {
+      assertEquals(e.getResultCode(), ResultCode.DECODING_ERROR);
+      assertTrue(nonFatalDecodeMessages.isEmpty());
+    }
+
+
+    // Try to decode the embedded controls for a JSON-formatted response control
+    // that has an embedded non-critical JSON-formatted response control.  This
+    // should cause the control to be ignored with a non-fatal decode error.
+    List<Control> embeddedControls =
+         controlWithEmbeddedNonCriticalControl.decodeEmbeddedControls(
+              decodeBehavior, nonFatalDecodeMessages);
+    assertTrue(embeddedControls.isEmpty());
+    assertFalse(nonFatalDecodeMessages.isEmpty());
+    nonFatalDecodeMessages.clear();
+
+
+    // Change the decode behavior to allow embedded JSON-formatted response
+    // controls.
+    decodeBehavior.setAllowEmbeddedJSONFormattedControl(true);
+    assertTrue(decodeBehavior.allowEmbeddedJSONFormattedControl());
+
+
+    // Verify that we can now extract an embedded critical JSON-formatted
+    // response control.
+    embeddedControls =
+         controlWithEmbeddedCriticalControl.decodeEmbeddedControls(
+              decodeBehavior, nonFatalDecodeMessages);
+    assertEquals(embeddedControls.size(), 1);
+    assertEquals(embeddedControls.get(0).getOID(),
+         JSONFormattedResponseControl.JSON_FORMATTED_RESPONSE_OID);
+    assertTrue(nonFatalDecodeMessages.isEmpty());
+
+
+    // Verify that we can now extract an embedded non-critical JSON-formatted
+    // response control.
+    embeddedControls =
+         controlWithEmbeddedNonCriticalControl.decodeEmbeddedControls(
+              decodeBehavior, nonFatalDecodeMessages);
+    assertEquals(embeddedControls.size(), 1);
+    assertEquals(embeddedControls.get(0).getOID(),
+         JSONFormattedResponseControl.JSON_FORMATTED_RESPONSE_OID);
+    assertTrue(nonFatalDecodeMessages.isEmpty());
+  }
 }

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

[ldap-sdk-commits] SF.net SVN: ldap-sdk:[1530] trunk

[<di...@us...>]

Revision: 1530
          http://sourceforge.net/p/ldap-sdk/code/1530
Author:   dirmgr
Date:     2022-04-02 19:10:18 +0000 (Sat, 02 Apr 2022)
Log Message:
-----------
Add JSONFormattedResponseControl.get methods

Updated the JSONFormattedResponseControl class to add several static
get methods that can be used to extract a JSON-formatted response
control from an LDAPResult, SearchResultEntry,
SearchResultReference, or IntermediateResponse.

Modified Paths:
--------------
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedResponseControl.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedResponseControlTestCase.java

Modified: trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedResponseControl.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedResponseControl.java	2022-04-02 00:06:05 UTC (rev 1529)
+++ trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedResponseControl.java	2022-04-02 19:10:18 UTC (rev 1530)
@@ -45,9 +45,13 @@
 import com.unboundid.asn1.ASN1OctetString;
 import com.unboundid.ldap.sdk.Control;
 import com.unboundid.ldap.sdk.DecodeableControl;
+import com.unboundid.ldap.sdk.IntermediateResponse;
 import com.unboundid.ldap.sdk.JSONControlDecodeHelper;
 import com.unboundid.ldap.sdk.LDAPException;
+import com.unboundid.ldap.sdk.LDAPResult;
 import com.unboundid.ldap.sdk.ResultCode;
+import com.unboundid.ldap.sdk.SearchResultEntry;
+import com.unboundid.ldap.sdk.SearchResultReference;
 import com.unboundid.util.Debug;
 import com.unboundid.util.NotMutable;
 import com.unboundid.util.NotNull;
@@ -524,6 +528,138 @@
 
 
   /**
+   * Extracts a JSON-formatted control from the provided LDAP result.
+   *
+   * @param  result  The LDAP result from which to retrieve the JSON-formatted
+   *                 response control.
+   *
+   * @return  The JSON-formatted response control contained in the provided
+   *          LDAP result, or {@code null} if the result did not contain a
+   *          JSON-formatted response control.
+   *
+   * @throws  LDAPException  If a problem is encountered while attempting to
+   *                         decode the JSON-formatted response control
+   *                         contained in the provided LDAP result.
+   */
+  @Nullable()
+  public static JSONFormattedResponseControl get(
+              @NotNull final LDAPResult result)
+         throws LDAPException
+  {
+    return get(result.getResponseControl(JSON_FORMATTED_RESPONSE_OID));
+  }
+
+
+
+  /**
+   * Extracts a JSON-formatted control from the provided search result entry.
+   *
+   * @param  entry  The search result entry from which to retrieve the
+   *                JSON-formatted response control.
+   *
+   * @return  The JSON-formatted response control contained in the provided
+   *          search result entry, or {@code null} if the entry did not contain
+   *          a JSON-formatted response control.
+   *
+   * @throws  LDAPException  If a problem is encountered while attempting to
+   *                         decode the JSON-formatted response control
+   *                         contained in the provided search result entry.
+   */
+  @Nullable()
+  public static JSONFormattedResponseControl get(
+              @NotNull final SearchResultEntry entry)
+         throws LDAPException
+  {
+    return get(entry.getControl(JSON_FORMATTED_RESPONSE_OID));
+  }
+
+
+
+  /**
+   * Extracts a JSON-formatted control from the provided search result
+   * reference.
+   *
+   * @param  reference  The search result reference from which to retrieve the
+   *                    JSON-formatted response control.
+   *
+   * @return  The JSON-formatted response control contained in the provided
+   *          search result reference, or {@code null} if the reference did not
+   *          contain a JSON-formatted response control.
+   *
+   * @throws  LDAPException  If a problem is encountered while attempting to
+   *                         decode the JSON-formatted response control
+   *                         contained in the provided search result reference.
+   */
+  @Nullable()
+  public static JSONFormattedResponseControl get(
+              @NotNull final SearchResultReference reference)
+         throws LDAPException
+  {
+    return get(reference.getControl(JSON_FORMATTED_RESPONSE_OID));
+  }
+
+
+
+  /**
+   * Extracts a JSON-formatted control from the provided intermediate response.
+   *
+   * @param  response  The intermediate response from which to retrieve the
+   *                   JSON-formatted response control.
+   *
+   * @return  The JSON-formatted response control contained in the provided
+   *          intermediate response, or {@code null} if the response did not
+   *          contain a JSON-formatted response control.
+   *
+   * @throws  LDAPException  If a problem is encountered while attempting to
+   *                         decode the JSON-formatted response control
+   *                         contained in the provided intermediate response.
+   */
+  @Nullable()
+  public static JSONFormattedResponseControl get(
+              @NotNull final IntermediateResponse response)
+         throws LDAPException
+  {
+    return get(response.getControl(JSON_FORMATTED_RESPONSE_OID));
+  }
+
+
+
+  /**
+   * Retrieves the provided control as a JSON-formatted response control.
+   *
+   * @param  c  The control to retrieve as a JSON-formatted response control.
+   *            It may optionally be {@code null}.
+   *
+   * @return  A JSON-formatted response control that is a representation of the
+   *          provided control, or {@code null} if the provided control is
+   *          {@code null}.
+   *
+   * @throws  LDAPException  If the provided control cannot be parsed as a valid
+   *                         JSON-formatted response control.
+   */
+  @Nullable()
+  private static JSONFormattedResponseControl get(@Nullable final Control c)
+          throws LDAPException
+  {
+    if (c == null)
+    {
+      return null;
+    }
+
+    if (c instanceof JSONFormattedResponseControl)
+    {
+      return (JSONFormattedResponseControl) c;
+    }
+    else
+    {
+      return new JSONFormattedResponseControl(c.getOID(), c.isCritical(),
+           c.getValue());
+    }
+  }
+
+
+
+  /**
    * {@inheritDoc}
    */
   @Override()

Modified: trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedResponseControlTestCase.java
===================================================================
--- trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedResponseControlTestCase.java	2022-04-02 00:06:05 UTC (rev 1529)
+++ trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedResponseControlTestCase.java	2022-04-02 19:10:18 UTC (rev 1530)
@@ -45,11 +45,17 @@
 
 import com.unboundid.asn1.ASN1OctetString;
 import com.unboundid.ldap.sdk.Control;
+import com.unboundid.ldap.sdk.Entry;
+import com.unboundid.ldap.sdk.IntermediateResponse;
 import com.unboundid.ldap.sdk.LDAPException;
+import com.unboundid.ldap.sdk.LDAPResult;
 import com.unboundid.ldap.sdk.LDAPSDKTestCase;
 import com.unboundid.ldap.sdk.ResultCode;
+import com.unboundid.ldap.sdk.SearchResultEntry;
+import com.unboundid.ldap.sdk.SearchResultReference;
 import com.unboundid.ldap.sdk.controls.PasswordExpiredControl;
 import com.unboundid.util.Base64;
+import com.unboundid.util.StaticUtils;
 import com.unboundid.util.json.JSONArray;
 import com.unboundid.util.json.JSONField;
 import com.unboundid.util.json.JSONObject;
@@ -1114,4 +1120,379 @@
     // exception.
     JSONFormattedResponseControl.decodeJSONControl(controlObject, false);
   }
+
+
+
+  /**
+   * Test the behavior of the {@code get} method that takes an
+   * {@code LDAPResult} argument.
+   *
+   * @throws  Exception  If an unexpected problem occurs.
+   */
+  @Test()
+  public void testGetLDAPResult()
+         throws Exception
+  {
+    // Test with a result that doesn't have any controls.
+    LDAPResult result = new LDAPResult(1, ResultCode.SUCCESS);
+    JSONFormattedResponseControl responseControl =
+         JSONFormattedResponseControl.get(result);
+    assertNull(responseControl);
+
+
+    // Test with a result that has controls, but not any JSON-formatted
+    // response controls.
+    result = new LDAPResult(1, ResultCode.SUCCESS, null, null, null,
+         Arrays.asList(
+              new Control("1.2.3.4", false),
+              new Control("1.2.3.5", false)));
+    responseControl = JSONFormattedResponseControl.get(result);
+    assertNull(responseControl);
+
+
+    // Test with a result has a JSON-formatted response control that is already
+    // a decoded instance of that class.
+    JSONFormattedResponseControl jsonFormattedResponseControl =
+         JSONFormattedResponseControl.createWithControls(
+              new PasswordExpiredControl());
+    result = new LDAPResult(1, ResultCode.SUCCESS, null, null, null,
+         Arrays.asList(
+              new Control("1.2.3.4", false),
+              jsonFormattedResponseControl,
+              new Control("1.2.3.5", false)));
+    responseControl = JSONFormattedResponseControl.get(result);
+    assertNotNull(responseControl);
+    List<Control> decodedControls = responseControl.decodeEmbeddedControls(
+         new JSONFormattedControlDecodeBehavior(), null);
+    assertEquals(decodedControls.size(), 1);
+    assertTrue(decodedControls.get(0) instanceof PasswordExpiredControl);
+
+
+    // Test with a result has a JSON-formatted response control that is a
+    // generic control that can be successfully decoded as a JSON-formatted
+    // response control.
+    result = new LDAPResult(1, ResultCode.SUCCESS, null, null, null,
+         Arrays.asList(
+              new Control("1.2.3.4", false),
+              new Control(jsonFormattedResponseControl.getOID(),
+                   jsonFormattedResponseControl.isCritical(),
+                   jsonFormattedResponseControl.getValue()),
+              new Control("1.2.3.5", false)));
+    responseControl = JSONFormattedResponseControl.get(result);
+    assertNotNull(responseControl);
+    decodedControls = responseControl.decodeEmbeddedControls(
+         new JSONFormattedControlDecodeBehavior(), null);
+    assertEquals(decodedControls.size(), 1);
+    assertTrue(decodedControls.get(0) instanceof PasswordExpiredControl);
+
+
+    // Test with a result has a JSON-formatted response control that is a
+    // generic control that cannot be successfully decoded as a JSON-formatted
+    // response control
+    result = new LDAPResult(1, ResultCode.SUCCESS, null, null, null,
+         Arrays.asList(
+              new Control("1.2.3.4", false),
+              new Control(jsonFormattedResponseControl.getOID(),
+                   jsonFormattedResponseControl.isCritical(),
+                   new ASN1OctetString("not a valid value")),
+              new Control("1.2.3.5", false)));
+    try
+    {
+      JSONFormattedResponseControl.get(result);
+      fail("Expected an exception when trying to obtain a JSON-formatted " +
+           "response control from a result with a malformed version of the " +
+           "control.");
+    }
+    catch (final LDAPException e)
+    {
+      assertEquals(e.getResultCode(), ResultCode.DECODING_ERROR);
+    }
+  }
+
+
+
+  /**
+   * Test the behavior of the {@code get} method that takes a
+   * {@code SearchResultEntry} argument.
+   *
+   * @throws  Exception  If an unexpected problem occurs.
+   */
+  @Test()
+  public void testGetSearchResultEntry()
+         throws Exception
+  {
+    // Test with an entry that doesn't have any controls.
+    final Entry e = new Entry(
+         "dn: dc=example,dc=com",
+         "objectClass: top",
+         "objectClass: domain",
+         "dc: example");
+    SearchResultEntry entry = new SearchResultEntry(e);
+    JSONFormattedResponseControl responseControl =
+         JSONFormattedResponseControl.get(entry);
+    assertNull(responseControl);
+
+
+    // Test with an entry that has controls, but not any JSON-formatted
+    // response controls.
+    entry = new SearchResultEntry(e,
+         new Control("1.2.3.4", false),
+         new Control("1.2.3.5", false));
+    responseControl = JSONFormattedResponseControl.get(entry);
+    assertNull(responseControl);
+
+
+    // Test with an entry has a JSON-formatted response control that is already
+    // a decoded instance of that class.
+    JSONFormattedResponseControl jsonFormattedResponseControl =
+         JSONFormattedResponseControl.createWithControls(
+              new PasswordExpiredControl());
+    entry = new SearchResultEntry(e,
+         new Control("1.2.3.4", false),
+         jsonFormattedResponseControl,
+         new Control("1.2.3.5", false));
+    responseControl = JSONFormattedResponseControl.get(entry);
+    assertNotNull(responseControl);
+    List<Control> decodedControls = responseControl.decodeEmbeddedControls(
+         new JSONFormattedControlDecodeBehavior(), null);
+    assertEquals(decodedControls.size(), 1);
+    assertTrue(decodedControls.get(0) instanceof PasswordExpiredControl);
+
+
+    // Test with an entry has a JSON-formatted response control that is a
+    // generic control that can be successfully decoded as a JSON-formatted
+    // response control.
+    entry = new SearchResultEntry(e,
+         new Control("1.2.3.4", false),
+         new Control(jsonFormattedResponseControl.getOID(),
+              jsonFormattedResponseControl.isCritical(),
+              jsonFormattedResponseControl.getValue()),
+         new Control("1.2.3.5", false));
+    responseControl = JSONFormattedResponseControl.get(entry);
+    assertNotNull(responseControl);
+    decodedControls = responseControl.decodeEmbeddedControls(
+         new JSONFormattedControlDecodeBehavior(), null);
+    assertEquals(decodedControls.size(), 1);
+    assertTrue(decodedControls.get(0) instanceof PasswordExpiredControl);
+
+
+    // Test with an entry has a JSON-formatted response control that is a
+    // generic control that cannot be successfully decoded as a JSON-formatted
+    // response control
+    entry = new SearchResultEntry(e,
+         new Control("1.2.3.4", false),
+         new Control(jsonFormattedResponseControl.getOID(),
+              jsonFormattedResponseControl.isCritical(),
+              new ASN1OctetString("not a valid value")),
+         new Control("1.2.3.5", false));
+    try
+    {
+      JSONFormattedResponseControl.get(entry);
+      fail("Expected an exception when trying to obtain a JSON-formatted " +
+           "response control from an entry with a malformed version of the " +
+           "control.");
+    }
+    catch (final LDAPException le)
+    {
+      assertEquals(le.getResultCode(), ResultCode.DECODING_ERROR);
+    }
+  }
+
+
+
+  /**
+   * Test the behavior of the {@code get} method that takes a
+   * {@code SearchResultReference} argument.
+   *
+   * @throws  Exception  If an unexpected problem occurs.
+   */
+  @Test()
+  public void testGetSearchResultReference()
+         throws Exception
+  {
+    // Test with a reference that doesn't have any controls.
+    final String[] referralURLs =
+    {
+      "ldap://ds1.example.com:389/",
+      "ldap://ds2.example.com:389/"
+    };
+    SearchResultReference reference =
+         new SearchResultReference(referralURLs, StaticUtils.NO_CONTROLS);
+    JSONFormattedResponseControl responseControl =
+         JSONFormattedResponseControl.get(reference);
+    assertNull(responseControl);
+
+
+    // Test with a reference that has controls, but not any JSON-formatted
+    // response controls.
+    reference = new SearchResultReference(referralURLs,
+         new Control[]
+         {
+           new Control("1.2.3.4", false),
+           new Control("1.2.3.5", false)
+         });
+    responseControl = JSONFormattedResponseControl.get(reference);
+    assertNull(responseControl);
+
+
+    // Test with a reference has a JSON-formatted response control that is
+    // already a decoded instance of that class.
+    JSONFormattedResponseControl jsonFormattedResponseControl =
+         JSONFormattedResponseControl.createWithControls(
+              new PasswordExpiredControl());
+    reference = new SearchResultReference(referralURLs,
+         new Control[]
+         {
+           new Control("1.2.3.4", false),
+           jsonFormattedResponseControl,
+           new Control("1.2.3.5", false)
+         });
+    responseControl = JSONFormattedResponseControl.get(reference);
+    assertNotNull(responseControl);
+    List<Control> decodedControls = responseControl.decodeEmbeddedControls(
+         new JSONFormattedControlDecodeBehavior(), null);
+    assertEquals(decodedControls.size(), 1);
+    assertTrue(decodedControls.get(0) instanceof PasswordExpiredControl);
+
+
+    // Test with a reference has a JSON-formatted response control that is a
+    // generic control that can be successfully decoded as a JSON-formatted
+    // response control.
+    reference = new SearchResultReference(referralURLs,
+         new Control[]
+         {
+           new Control("1.2.3.4", false),
+           new Control(jsonFormattedResponseControl.getOID(),
+                jsonFormattedResponseControl.isCritical(),
+                jsonFormattedResponseControl.getValue()),
+           new Control("1.2.3.5", false)
+         });
+    responseControl = JSONFormattedResponseControl.get(reference);
+    assertNotNull(responseControl);
+    decodedControls = responseControl.decodeEmbeddedControls(
+         new JSONFormattedControlDecodeBehavior(), null);
+    assertEquals(decodedControls.size(), 1);
+    assertTrue(decodedControls.get(0) instanceof PasswordExpiredControl);
+
+
+    // Test with a reference has a JSON-formatted response control that is a
+    // generic control that cannot be successfully decoded as a JSON-formatted
+    // response control
+    reference = new SearchResultReference(referralURLs,
+         new Control[]
+         {
+           new Control("1.2.3.4", false),
+           new Control(jsonFormattedResponseControl.getOID(),
+                jsonFormattedResponseControl.isCritical(),
+                new ASN1OctetString("not a valid value")),
+           new Control("1.2.3.5", false)
+         });
+    try
+    {
+      JSONFormattedResponseControl.get(reference);
+      fail("Expected an exception when trying to obtain a JSON-formatted " +
+           "response control from a reference with a malformed version of " +
+           "the control.");
+    }
+    catch (final LDAPException e)
+    {
+      assertEquals(e.getResultCode(), ResultCode.DECODING_ERROR);
+    }
+  }
+
+
+
+  /**
+   * Test the behavior of the {@code get} method that takes an
+   * {@code IntermediateResponse} argument.
+   *
+   * @throws  Exception  If an unexpected problem occurs.
+   */
+  @Test()
+  public void testGetIntermediateResponse()
+         throws Exception
+  {
+    // Test with a response that doesn't have any controls.
+    IntermediateResponse response = new IntermediateResponse("1.1.1.1", null);
+    JSONFormattedResponseControl responseControl =
+         JSONFormattedResponseControl.get(response);
+    assertNull(responseControl);
+
+
+    // Test with a response that has controls, but not any JSON-formatted
+    // response controls.
+    response = new IntermediateResponse("1.1.1.1", null,
+         new Control[]
+         {
+           new Control("1.2.3.4", false),
+           new Control("1.2.3.5", false)
+         });
+    responseControl = JSONFormattedResponseControl.get(response);
+    assertNull(responseControl);
+
+
+    // Test with a response has a JSON-formatted response control that is
+    // already a decoded instance of that class.
+    JSONFormattedResponseControl jsonFormattedResponseControl =
+         JSONFormattedResponseControl.createWithControls(
+              new PasswordExpiredControl());
+    response = new IntermediateResponse("1.1.1.1", null,
+         new Control[]
+         {
+           new Control("1.2.3.4", false),
+           jsonFormattedResponseControl,
+           new Control("1.2.3.5", false)
+         });
+    responseControl = JSONFormattedResponseControl.get(response);
+    assertNotNull(responseControl);
+    List<Control> decodedControls = responseControl.decodeEmbeddedControls(
+         new JSONFormattedControlDecodeBehavior(), null);
+    assertEquals(decodedControls.size(), 1);
+    assertTrue(decodedControls.get(0) instanceof PasswordExpiredControl);
+
+
+    // Test with a response has a JSON-formatted response control that is a
+    // generic control that can be successfully decoded as a JSON-formatted
+    // response control.
+    response = new IntermediateResponse("1.1.1.1", null,
+         new Control[]
+         {
+           new Control("1.2.3.4", false),
+           new Control(jsonFormattedResponseControl.getOID(),
+                jsonFormattedResponseControl.isCritical(),
+                jsonFormattedResponseControl.getValue()),
+           new Control("1.2.3.5", false)
+         });
+    responseControl = JSONFormattedResponseControl.get(response);
+    assertNotNull(responseControl);
+    decodedControls = responseControl.decodeEmbeddedControls(
+         new JSONFormattedControlDecodeBehavior(), null);
+    assertEquals(decodedControls.size(), 1);
+    assertTrue(decodedControls.get(0) instanceof PasswordExpiredControl);
+
+
+    // Test with a response has a JSON-formatted response control that is a
+    // generic control that cannot be successfully decoded as a JSON-formatted
+    // response control
+    response = new IntermediateResponse("1.1.1.1", null,
+         new Control[]
+         {
+           new Control("1.2.3.4", false),
+           new Control(jsonFormattedResponseControl.getOID(),
+                jsonFormattedResponseControl.isCritical(),
+                new ASN1OctetString("not a valid value")),
+           new Control("1.2.3.5", false)
+         });
+    try
+    {
+      JSONFormattedResponseControl.get(response);
+      fail("Expected an exception when trying to obtain a JSON-formatted " +
+           "response control from a response with a malformed version of " +
+           "the control.");
+    }
+    catch (final LDAPException e)
+    {
+      assertEquals(e.getResultCode(), ResultCode.DECODING_ERROR);
+    }
+  }
 }

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

[ldap-sdk-commits] SF.net SVN: ldap-sdk:[1529] trunk

[<di...@us...>]

Revision: 1529
          http://sourceforge.net/p/ldap-sdk/code/1529
Author:   dirmgr
Date:     2022-04-02 00:06:05 +0000 (Sat, 02 Apr 2022)
Log Message:
-----------
Add support for JSON-formatted controls

Added client-side support for a new JSON-formatted request control
that can be used to send request controls to a server encoded as
JSON objects rather than using their native LDAP encodings.  Also,
added client-side support for a new JSON-formatted response control
that can be used to receive JSON-encoded response controls from the
server.

Modified Paths:
--------------
    trunk/docs/ldap-oid-reference.html
    trunk/docs/release-notes.html
    trunk/messages/unboundid-ldapsdk-unboundid-controls.properties
    trunk/resource/oid-registry.json
    trunk/src/com/unboundid/ldap/sdk/Control.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/ControlHelper.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetRecentLoginHistoryRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetRecentLoginHistoryResponseControl.java

Added Paths:
-----------
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedControlDecodeBehavior.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedResponseControl.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedControlDecodeBehaviorTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedResponseControlTestCase.java

Modified: trunk/docs/ldap-oid-reference.html
===================================================================
--- trunk/docs/ldap-oid-reference.html	2022-03-31 21:24:35 UTC (rev 1528)
+++ trunk/docs/ldap-oid-reference.html	2022-04-02 00:06:05 UTC (rev 1529)
@@ -2412,6 +2412,16 @@
                   <td>Ping Identity Directory Server</td>
                 </tr>
                 <tr>
+                  <td>1.3.6.1.4.1.30221.2.5.64</td>
+                  <td>JSON-formatted Request Control</td>
+                  <td>Ping Identity Directory Server</td>
+                </tr>
+                <tr>
+                  <td>1.3.6.1.4.1.30221.2.5.65</td>
+                  <td>JSON-formatted Response Control</td>
+                  <td>Ping Identity Directory Server</td>
+                </tr>
+                <tr>
                   <td>1.3.6.1.4.1.30221.2.6.1</td>
                   <td>Start Batched Transaction Extended Request</td>
                   <td>Ping Identity Directory Server</td>

Modified: trunk/docs/release-notes.html
===================================================================
--- trunk/docs/release-notes.html	2022-03-31 21:24:35 UTC (rev 1528)
+++ trunk/docs/release-notes.html	2022-04-02 00:06:05 UTC (rev 1529)
@@ -19,7 +19,6 @@
                   <br><br>
                 </li>
 
-              <ul>
                 <li>
                   Added support for encoding controls to JSON objects, and for decoding JSON
                   objects as controls.  There is a generic JSON representation that works for all
@@ -32,6 +31,15 @@
                 </li>
 
                 <li>
+                  Added client-side support for a new JSON-formatted request control that can be
+                  used to send request controls to a server encoded as JSON objects rather than
+                  using their native LDAP encodings.  Also, added client-side support for a new
+                  JSON-formatted response control that can be used to receive JSON-encoded
+                  response controls from the server.
+                  <br><br>
+                </li>
+
+                <li>
                   Fixed an issue with the way the parallel-update tool created assured replication
                   request controls when an explicit local or remote assurance level was specified.
                   Previously, it would only specify a minimum assurance level without specifying a

Modified: trunk/messages/unboundid-ldapsdk-unboundid-controls.properties
===================================================================
--- trunk/messages/unboundid-ldapsdk-unboundid-controls.properties	2022-03-31 21:24:35 UTC (rev 1528)
+++ trunk/messages/unboundid-ldapsdk-unboundid-controls.properties	2022-04-02 00:06:05 UTC (rev 1529)
@@ -1207,3 +1207,68 @@
 ERR_GET_RECENT_LOGIN_HISTORY_RESPONSE_JSON_UNRECOGNIZED_FIELD=Unable to \
   decode JSON object {0} as a get recent login history response control \
   because the value includes unrecognized field ''{1}''.
+ERR_JSON_FORMATTED_REQUEST_VALUE_NOT_JSON=Unable to decode the provided \
+  control as a JSON-formatted request control because the control value \
+  cannot parsed as a JSON object.
+ERR_JSON_FORMATTED_REQUEST_VALUE_MISSING_CONTROLS=Unable to decode the \
+  provided control as a JSON-formatted request control because the value \
+  object is missing the required ''{0}'' array field.
+ERR_JSON_FORMATTED_REQUEST_VALUE_NOT_CONTROL=Unable to decode the provided \
+  control as a JSON-formatted request control because ''{0}'' value {1} \
+  cannot be parsed as a JSON-formatted control:  {2}
+ERR_JSON_FORMATTED_REQUEST_VALUE_CONTROL_NOT_OBJECT=Unable to decode the \
+  provided control as a JSON-formatted request control because the value \
+  object includes an item in the ''{0}'' array that is not a JSON object.
+ERR_JSON_FORMATTED_REQUEST_UNRECOGNIZED_FIELD=Unable to decode the provided \
+  control as a JSON-formatted request control because the value includes \
+  unrecognized field ''{0}''.
+INFO_CONTROL_NAME_JSON_FORMATTED_REQUEST=JSON-Formatted Request Control
+ERR_JSON_FORMATTED_REQUEST_DECODE_VALUE_MISSING_CONTROLS=Unable to decode \
+  JSON object {0} as a JSON-formatted request control because the value \
+  object is missing the required ''{1}'' array field.
+ERR_JSON_FORMATTED_REQUEST_DECODE_VALUE_NOT_CONTROL=Unable to decode JSON \
+  object {0} as a JSON-formatted request control because ''{1}'' value {2} \
+  cannot be parsed as a JSON-formatted control:  {3}
+ERR_JSON_FORMATTED_REQUEST_DECODE_VALUE_CONTROL_NOT_OBJECT=Unable to decode \
+  JSON object {0} as a JSON-formatted request control because the value \
+  object contains an item in the ''{1}'' array field that is not a JSON object.
+ERR_JSON_FORMATTED_REQUEST_DECODE_UNRECOGNIZED_FIELD=Unable to decode JSON \
+  object {0} as a JSON-formatted request control because the value object \
+  includes unrecognized field ''{1}''.
+ERR_JSON_FORMATTED_RESPONSE_NO_VALUE=Unable to decode the provided control as \
+  a JSON-formatted response control because the provided control did not have \
+  a value.
+ERR_JSON_FORMATTED_RESPONSE_VALUE_NOT_JSON=Unable to decode the provided \
+  control as a JSON-formatted response control because the control value \
+  cannot parsed as a JSON object.
+ERR_JSON_FORMATTED_RESPONSE_VALUE_MISSING_CONTROLS=Unable to decode the \
+  provided control as a JSON-formatted response control because the value \
+  object is missing the required ''{0}'' array field.
+ERR_JSON_FORMATTED_RESPONSE_VALUE_EMPTY_CONTROLS=Unable to decode the \
+  provided control as a JSON-formatted response control because the value \
+  object contains an empty ''{0}'' array field.
+ERR_JSON_FORMATTED_RESPONSE_VALUE_NOT_CONTROL=Unable to decode the provided \
+  control as a JSON-formatted response control because ''{0}'' value {1} \
+  cannot be parsed as a JSON-formatted control:  {2}
+ERR_JSON_FORMATTED_RESPONSE_VALUE_CONTROL_NOT_OBJECT=Unable to decode the \
+  provided control as a JSON-formatted response control because the value \
+  object includes an item in the ''{0}'' array that is not a JSON object.
+ERR_JSON_FORMATTED_RESPONSE_UNRECOGNIZED_FIELD=Unable to decode the provided \
+  control as a JSON-formatted response control because the value includes \
+  unrecognized field ''{0}''.
+INFO_CONTROL_NAME_JSON_FORMATTED_RESPONSE=JSON-Formatted Response Control
+ERR_JSON_FORMATTED_RESPONSE_DECODE_VALUE_MISSING_CONTROLS=Unable to decode \
+  JSON object {0} as a JSON-formatted response control because the value \
+  object is missing the required ''{1}'' array field.
+ERR_JSON_FORMATTED_RESPONSE_DECODE_VALUE_EMPTY_CONTROLS=Unable to decode \
+  JSON object {0} as a JSON-formatted response control because the value \
+  object contains an empty ''{1}'' array field.
+ERR_JSON_FORMATTED_RESPONSE_DECODE_VALUE_NOT_CONTROL=Unable to decode JSON \
+  object {0} as a JSON-formatted response control because ''{1}'' value {2} \
+  cannot be parsed as a JSON-formatted control:  {3}
+ERR_JSON_FORMATTED_RESPONSE_DECODE_VALUE_CONTROL_NOT_OBJECT=Unable to decode \
+  JSON object {0} as a JSON-formatted response control because the value \
+  object contains an item in the ''{1}'' array field that is not a JSON object.
+ERR_JSON_FORMATTED_RESPONSE_DECODE_UNRECOGNIZED_FIELD=Unable to decode JSON \
+  object {0} as a JSON-formatted response control because the value object \
+  includes unrecognized field ''{1}''.

Modified: trunk/resource/oid-registry.json
===================================================================
--- trunk/resource/oid-registry.json	2022-03-31 21:24:35 UTC (rev 1528)
+++ trunk/resource/oid-registry.json	2022-04-02 00:06:05 UTC (rev 1529)
@@ -475,6 +475,8 @@
 { "oid":"1.3.6.1.4.1.30221.2.5.60", "name":"OAuth Scopes", "type":"Request Control", "origin":"Ping Identity Directory Server" }
 { "oid":"1.3.6.1.4.1.30221.2.5.61", "name":"Get Recent Login History", "type":"Request Control", "origin":"Ping Identity Directory Server" }
 { "oid":"1.3.6.1.4.1.30221.2.5.62", "name":"Get Recent Login History", "type":"Request Control", "origin":"Ping Identity Directory Server" }
+{ "oid":"1.3.6.1.4.1.30221.2.5.64", "name":"JSON-formatted", "type":"Request Control", "origin":"Ping Identity Directory Server" }
+{ "oid":"1.3.6.1.4.1.30221.2.5.65", "name":"JSON-formatted", "type":"Response Control", "origin":"Ping Identity Directory Server" }
 { "oid":"1.3.6.1.4.1.30221.2.6.1", "name":"Start Batched Transaction", "type":"Extended Request", "origin":"Ping Identity Directory Server" }
 { "oid":"1.3.6.1.4.1.30221.2.6.2", "name":"End Batched Transaction", "type":"Extended Request", "origin":"Ping Identity Directory Server" }
 { "oid":"1.3.6.1.4.1.30221.2.6.3", "name":"Start Interactive Transaction", "type":"Extended Request", "origin":"Ping Identity Directory Server" }

Modified: trunk/src/com/unboundid/ldap/sdk/Control.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/Control.java	2022-03-31 21:24:35 UTC (rev 1528)
+++ trunk/src/com/unboundid/ldap/sdk/Control.java	2022-04-02 00:06:05 UTC (rev 1529)
@@ -121,6 +121,8 @@
             IntermediateClientRequestControl;
 import com.unboundid.ldap.sdk.unboundidds.controls.
             IntermediateClientResponseControl;
+import com.unboundid.ldap.sdk.unboundidds.controls.JSONFormattedRequestControl;
+import com.unboundid.ldap.sdk.unboundidds.controls.JSONFormattedResponseControl;
 import com.unboundid.ldap.sdk.unboundidds.controls.JoinRequestControl;
 import com.unboundid.ldap.sdk.unboundidds.controls.JoinResultControl;
 import com.unboundid.ldap.sdk.unboundidds.controls.
@@ -910,7 +912,10 @@
    * base64-encoded representation of the value.  Subclasses may override this
    * method to provide a control-specific encoding, and they may use the
    * {@code value-json} field as an alternative to {@code value-base64} to
-   * provide a more user-friendly representation of the value.
+   * provide a more user-friendly representation of the value.  There may also
+   * be an optional {@code control-name} field that provides a user-friendly
+   * name for the control, but that field is only intended for descriptive
+   * purposes and should not be used in the course of decoding a control.
    *
    * @return  A representation of this control as a JSON object.
    */
@@ -1154,6 +1159,14 @@
           return JoinResultControl.decodeJSONControl(controlObject, strict);
         }
 
+      case JSONFormattedRequestControl.JSON_FORMATTED_REQUEST_OID:
+        return JSONFormattedRequestControl.decodeJSONControl(
+             controlObject, strict);
+
+      case JSONFormattedResponseControl.JSON_FORMATTED_RESPONSE_OID:
+        return JSONFormattedResponseControl.decodeJSONControl(
+             controlObject, strict);
+
       case ManageDsaITRequestControl.MANAGE_DSA_IT_REQUEST_OID:
         return ManageDsaITRequestControl.decodeJSONControl(
              controlObject, strict);

Modified: trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/ControlHelper.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/ControlHelper.java	2022-03-31 21:24:35 UTC (rev 1528)
+++ trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/ControlHelper.java	2022-04-02 00:06:05 UTC (rev 1529)
@@ -122,6 +122,9 @@
     Control.registerDecodeableControl("1.3.6.1.4.1.30221.2.5.9",
          packageNameDot + "JoinResultControl");
 
+    Control.registerDecodeableControl("1.3.6.1.4.1.30221.2.5.65",
+         packageNameDot + "JSONFormattedResponseControl");
+
     Control.registerDecodeableControl("1.3.6.1.4.1.30221.2.5.37",
          packageNameDot + "MatchingEntryCountResponseControl");
 

Modified: trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetRecentLoginHistoryRequestControl.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetRecentLoginHistoryRequestControl.java	2022-03-31 21:24:35 UTC (rev 1528)
+++ trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetRecentLoginHistoryRequestControl.java	2022-04-02 00:06:05 UTC (rev 1529)
@@ -71,7 +71,7 @@
  * This control has an OID of 1.3.6.1.4.1.30221.2.5.61 and no value.  The
  * criticality may be either {@code true} or {@code false}.
  *
- * @see  GetRecentLoginHistoryRequestControl
+ * @see  GetRecentLoginHistoryResponseControl
  */
 @NotMutable()
 @ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
@@ -79,8 +79,8 @@
        extends Control
 {
   /**
-   * The OID (1.3.6.1.4.1.30221.2.5.61) for the get password policy state issues
-   * request control.
+   * The OID (1.3.6.1.4.1.30221.2.5.61) for the get recent login history request
+   * control.
    */
   @NotNull public static final  String GET_RECENT_LOGIN_HISTORY_REQUEST_OID =
        "1.3.6.1.4.1.30221.2.5.61";

Modified: trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetRecentLoginHistoryResponseControl.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetRecentLoginHistoryResponseControl.java	2022-03-31 21:24:35 UTC (rev 1528)
+++ trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetRecentLoginHistoryResponseControl.java	2022-04-02 00:06:05 UTC (rev 1529)
@@ -107,7 +107,7 @@
        implements DecodeableControl
 {
   /**
-   * The OID (1.3.6.1.4.1.30221.2.5.62) for the get password policy state issues
+   * The OID (1.3.6.1.4.1.30221.2.5.62) for the get recent login history
    * response control.
    */
   @NotNull public static final String GET_RECENT_LOGIN_HISTORY_RESPONSE_OID =

Added: trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedControlDecodeBehavior.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedControlDecodeBehavior.java	                        (rev 0)
+++ trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedControlDecodeBehavior.java	2022-04-02 00:06:05 UTC (rev 1529)
@@ -0,0 +1,341 @@
+/*
+ * Copyright 2022 Ping Identity Corporation
+ * All Rights Reserved.
+ */
+/*
+ * Copyright 2022 Ping Identity Corporation
+ *
+ * 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
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/*
+ * Copyright (C) 2022 Ping Identity Corporation
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License (GPLv2 only)
+ * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, see <http://www.gnu.org/licenses>.
+ */
+package com.unboundid.ldap.sdk.unboundidds.controls;
+
+
+
+import java.io.Serializable;
+
+import com.unboundid.util.Mutable;
+import com.unboundid.util.NotNull;
+import com.unboundid.util.ThreadSafety;
+import com.unboundid.util.ThreadSafetyLevel;
+
+
+
+/**
+ * This enum defines options for the behaviors that should be used when trying
+ * to decode JSON objects embedded in a {@link JSONFormattedRequestControl} or
+ * {@link JSONFormattedResponseControl} as
+ * {@link com.unboundid.ldap.sdk.Control} objects.
+ * <BR>
+ * <BLOCKQUOTE>
+ *   <B>NOTE:</B>  This class, and other classes within the
+ *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
+ *   supported for use against Ping Identity, UnboundID, and
+ *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
+ *   for proprietary functionality or for external specifications that are not
+ *   considered stable or mature enough to be guaranteed to work in an
+ *   interoperable way with other types of LDAP servers.
+ * </BLOCKQUOTE>
+ */
+@Mutable()
+@ThreadSafety(level=ThreadSafetyLevel.NOT_THREADSAFE)
+public final class JSONFormattedControlDecodeBehavior
+       implements Serializable
+{
+  /**
+   * The serial verison UID for this serizlizable class.
+   */
+  private static final long serialVersionUID = -1035196310465374381L;
+
+
+
+  // Indicates whether to use strict mode when decoding controls.
+  private boolean strict;
+
+  // Indicates whether to throw an exception when encountering an object that
+  // has the proper basic formatting for a JSON control with a criticality of
+  // true, but that cannot actually be decoded as a valid control.
+  private boolean throwOnInvalidCriticalControl;
+
+  // Indicates whether to throw an exception when encountering an object that
+  // has the proper basic formatting for a JSON control with a criticality of
+  // false, but that cannot actually be decoded as a valid control.
+  private boolean throwOnInvalidNonCriticalControl;
+
+  // Indicates whether to throw an exception when encountering an object that
+  // does not meet the basic requirements for a JSON-formatted control.
+  private boolean throwOnUnparsableObject;
+
+
+
+  /**
+   * Creates a new instance of this behavior with the default configuration.
+   * The default configuration is as follows:
+   * <UL>
+   *   <LI>{@code throwOnUnparsableObject} is set to {@code true}</LI>
+   *   <LI>{@code throwOnInvalidCriticalControl} is set to {@code true}</LI>
+   *   <LI>{@code throwOnInvalidNonCriticalControl} is set to {@code true}</LI>
+   *   <LI>{@code strict} is set to {@code false}</LI>
+   * </UL>
+   */
+  public JSONFormattedControlDecodeBehavior()
+  {
+    throwOnUnparsableObject = true;
+    throwOnInvalidCriticalControl = true;
+    throwOnInvalidNonCriticalControl = true;
+    strict = false;
+  }
+
+
+
+  /**
+   * Indicates whether to throw an exception if the JSON-formatted request or
+   * response control includes a JSON object that does not meet the basic
+   * requirements for representing a valid JSON-formatted control, including
+   * controls without the required {@code oid} and {@code criticality} fields,
+   * and controls with both {@code value-base64} and {@code value-json} fields.
+   * If strict mode is enabled, then this also includes unrecognized top-level
+   * fields.
+   *
+   * @return  {@code true} if an exception should be thrown if a JSON-formatted
+   *          request or response control includes a JSON object that does not
+   *          meet the basic requirements for representing a valid
+   *          JSON-formatted control, or {@code false} if any such JSON objects
+   *          should simply be ignored.
+   */
+  public boolean throwOnUnparsableObject()
+  {
+    return throwOnUnparsableObject;
+  }
+
+
+
+  /**
+   * Specifies whether to throw an exception if the JSON-formatted request or
+   * response control includes a JSON object that does not meet the basic
+   * requirements for representing a valid JSON-formatted control, including
+   * controls without the required {@code oid} and {@code criticality} fields,
+   * and controls with both {@code value-base64} and {@code value-json} fields.
+   * If strict mode is enabled, then this also includes unrecognized top-level
+   * fields.
+   *
+   * @param  throwOnUnparsableObject  Indicates whether to throw an exception
+   *                                  for any JSON object that does not meet
+   *                                  the basic requirements for a
+   *                                  JSON-formatted control.  If this is
+   *                                  {@code true}, then an exception will be
+   *                                  thrown if any such JSON object is
+   *                                  encountered.  If this is {@code false},
+   *                                  any such JSON objects will be ignored.
+   */
+  public void setThrowOnUnparsableObject(final boolean throwOnUnparsableObject)
+  {
+    this.throwOnUnparsableObject = throwOnUnparsableObject;
+  }
+
+
+
+  /**
+   * Indicates whether to throw an exception if the JSON-formatted request or
+   * response control includes a JSON object that at least meets the basic
+   * requirements for a JSON-formatted control with a criticality of
+   * {@code true}, but that cannot be parsed as a valid {@code Control} instance
+   * for some reason.  This may include a control with an OID for which
+   * specific decoding support has been implemented but a problem is encountered
+   * while trying to decode the JSON object as a control of that type, or a
+   * control with an OID for which no specific decoding has been implemented but
+   * includes a value specified using the {@code value-json} format.
+   *
+   * @return  {@code true} if an exception should be thrown if a critical
+   *          control cannot be decoded as a valid control instance, or
+   *          {@code false} if any such controls should be ignored.
+   */
+  public boolean throwOnInvalidCriticalControl()
+  {
+    return throwOnInvalidCriticalControl;
+  }
+
+
+
+  /**
+   * Specifies whether to throw an exception if the JSON-formatted request or
+   * response control includes a JSON object that at least meets the basic
+   * requirements for a JSON-formatted control with a criticality of
+   * {@code true}, but that cannot be parsed as a valid {@code Control} instance
+   * for some reason.  This may include a control with an OID for which
+   * specific decoding support has been implemented but a problem is encountered
+   * while trying to decode the JSON object as a control of that type, or a
+   * control with an OID for which no specific decoding has been implemented but
+   * includes a value specified using the {@code value-json} format.
+   *
+   * @param  throwOnInvalidCriticalControl  Indicates whether to throw an
+   *                                        exception for any well-formed JSON
+   *                                        object with a criticality of
+   *                                        {@code true} that cannot be parsed
+   *                                        as a {@code Control}.  If this is
+   *                                        {@code true}, then an exception will
+   *                                        be thrown if any such object is
+   *                                        encountered.  If this is
+   *                                        {@code false}, then any such JSON
+   *                                        objects will be ignored.
+   */
+  public void setThrowOnInvalidCriticalControl(
+                   final boolean throwOnInvalidCriticalControl)
+  {
+    this.throwOnInvalidCriticalControl = throwOnInvalidCriticalControl;
+  }
+
+
+
+  /**
+   * Indicates whether to throw an exception if the JSON-formatted request or
+   * response control includes a JSON object that at least meets the basic
+   * requirements for a JSON-formatted control with a criticality of
+   * {@code false}, but that cannot be parsed as a valid {@code Control}
+   * instance for some reason.  This may include a control with an OID for which
+   * specific decoding support has been implemented but a problem is encountered
+   * while trying to decode the JSON object as a control of that type, or a
+   * control with an OID for which no specific decoding has been implemented but
+   * includes a value specified using the {@code value-json} format.
+   *
+   * @return  {@code true} if an exception should be thrown if a non-critical
+   *          control cannot be decoded as a valid control instance, or
+   *          {@code false} if any such controls should be ignored.
+   */
+  public boolean throwOnInvalidNonCriticalControl()
+  {
+    return throwOnInvalidNonCriticalControl;
+  }
+
+
+
+  /**
+   * Specifies whether to throw an exception if the JSON-formatted request or
+   * response control includes a JSON object that at least meets the basic
+   * requirements for a JSON-formatted control with a criticality of
+   * {@code false}, but that cannot be parsed as a valid {@code Control}
+   * instance for some reason.  This may include a control with an OID for which
+   * specific decoding support has been implemented but a problem is encountered
+   * while trying to decode the JSON object as a control of that type, or a
+   * control with an OID for which no specific decoding has been implemented but
+   * includes a value specified using the {@code value-json} format.
+   *
+   * @param  throwOnInvalidNonCriticalControl  Indicates whether to throw an
+   *                                           exception for any well-formed
+   *                                           JSON object with a criticality of
+   *                                           {@code false} that cannot be
+   *                                           parsed as a {@code Control}.  If
+   *                                           this is {@code true}, then an
+   *                                           exception will be thrown if any
+   *                                           such object is encountered.  If
+   *                                           this is {@code false}, then any
+   *                                           such JSON objects will be
+   *                                           ignored.
+   */
+  public void setThrowOnInvalidNonCriticalControl(
+                   final boolean throwOnInvalidNonCriticalControl)
+  {
+    this.throwOnInvalidNonCriticalControl = throwOnInvalidNonCriticalControl;
+  }
+
+
+
+  /**
+   * Indicates whether to use strict mode when parsing JSON objects as controls.
+   * This may include throwing an exception if a JSON object contains any
+   * unrecognized fields, or if the object violates any other control-specific
+   * constraints.
+   *
+   * @return  {@code true} if strict mode should be used when parsing JSON
+   *          objects as controls, or {@code false} if a lenient mode should be
+   *          used.
+   */
+  public boolean strict()
+  {
+    return strict;
+  }
+
+
+
+  /**
+   * Specifies whether to use strict mode when parsing JSON objects as controls.
+   * This may include throwing an exception if a JSON object contains any
+   * unrecognized fields, or if the object violates any other control-specific
+   * constraints.
+   *
+   * @param  strict  Indicates whether to use strict mode when parsing JSON
+   *                 objects as controls.  If this is {@code true}, then strict
+   *                 mode will be used.  If this is {@code false}, then a more
+   *                 lenient mode will be used.
+   */
+  public void setStrict(final boolean strict)
+  {
+    this.strict = strict;
+  }
+
+
+
+  /**
+   * Retrieves a string representation of this JSON-formatted control decode
+   * behavior.
+   *
+   * @return  A string representation of this JSON-formatted control decode
+   *          behavior.
+   */
+  @Override()
+  @NotNull()
+  public String toString()
+  {
+    final StringBuilder buffer = new StringBuilder();
+    toString(buffer);
+    return buffer.toString();
+  }
+
+
+
+  /**
+   * Appends a string representation of this JSON-formatted control decode
+   * behavior to the provided buffer.
+   *
+   * @param  buffer  The buffer to which the string representation should be
+   *                 appended.
+   */
+  public void toString(@NotNull final StringBuilder buffer)
+  {
+    buffer.append(
+         "JSONFormattedControlDecodeBehavior(throwOnUnparsableObject=");
+    buffer.append(throwOnUnparsableObject);
+    buffer.append(", throwOnInvalidCriticalControl=");
+    buffer.append(throwOnInvalidCriticalControl);
+    buffer.append(", throwOnInvalidNonCriticalControl=");
+    buffer.append(throwOnInvalidNonCriticalControl);
+    buffer.append(", strict=");
+    buffer.append(strict);
+    buffer.append(')');
+  }
+}

Added: trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedRequestControl.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedRequestControl.java	                        (rev 0)
+++ trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedRequestControl.java	2022-04-02 00:06:05 UTC (rev 1529)
@@ -0,0 +1,743 @@
+/*
+ * Copyright 2022 Ping Identity Corporation
+ * All Rights Reserved.
+ */
+/*
+ * Copyright 2022 Ping Identity Corporation
+ *
+ * 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
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/*
+ * Copyright (C) 2022 Ping Identity Corporation
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License (GPLv2 only)
+ * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, see <http://www.gnu.org/licenses>.
+ */
+package com.unboundid.ldap.sdk.unboundidds.controls;
+
+
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.List;
+
+import com.unboundid.asn1.ASN1OctetString;
+import com.unboundid.ldap.sdk.Control;
+import com.unboundid.ldap.sdk.JSONControlDecodeHelper;
+import com.unboundid.ldap.sdk.LDAPException;
+import com.unboundid.ldap.sdk.ResultCode;
+import com.unboundid.util.Debug;
+import com.unboundid.util.NotMutable;
+import com.unboundid.util.NotNull;
+import com.unboundid.util.Nullable;
+import com.unboundid.util.StaticUtils;
+import com.unboundid.util.ThreadSafety;
+import com.unboundid.util.ThreadSafetyLevel;
+import com.unboundid.util.json.JSONArray;
+import com.unboundid.util.json.JSONField;
+import com.unboundid.util.json.JSONObject;
+import com.unboundid.util.json.JSONValue;
+
+import static com.unboundid.ldap.sdk.unboundidds.controls.ControlMessages.*;
+
+
+
+/**
+ * This class provides an implementation of a request control that may be used
+ * to encapsulate a set of zero or more other controls represented as JSON
+ * objects, and to indicate that the server should return any response controls
+ * in a {@link JSONFormattedResponseControl}.
+ * <BR>
+ * <BLOCKQUOTE>
+ *   <B>NOTE:</B>  This class, and other classes within the
+ *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
+ *   supported for use against Ping Identity, UnboundID, and
+ *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
+ *   for proprietary functionality or for external specifications that are not
+ *   considered stable or mature enough to be guaranteed to work in an
+ *   interoperable way with other types of LDAP servers.
+ * </BLOCKQUOTE>
+ * <BR>
+ * This control has an OID of 1.3.6.1.4.1.30221.2.5.64, and it may optionally
+ * take a value.  If the control is provided without a value, then it merely
+ * indicates that the server should return response controls in a
+ * {@code JSONFormattedResponseControl}.  If the control has a value, then that
+ * value should be a JSON object that contains a single field,
+ * {@code controls}, whose value is an array of the JSON representations of the
+ * request controls that should be sent to the server.  The JSON representations
+ * of the controls is the one generated by the {@link Control#toJSONControl()}
+ * method, and is the one expected by the {@link Control#decodeJSONControl}
+ * method.  In particular, each control should have at least an {@code oid}
+ * field that specifies the OID for the control, and a {@code criticality} field
+ * that indicates whether the control is considered critical.  If the control
+ * has a value, then either the {@code value-base64} field should be used to
+ * provide a base64-encoded representation of the value, or
+ * the {@code value-json} field should be used to provide a JSON-formatted
+ * representation of the value for controls that support it.
+ * <BR><BR>
+ * The criticality for this control should generally be {@code true}, especially
+ * if it embeds any controls with a criticality of {@code true}.  Any controls
+ * embedded in the value of this control will be processed by the server with
+ * the criticality of that embedded control.
+ *
+ * @see  JSONFormattedResponseControl
+ */
+@NotMutable()
+@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
+public final class JSONFormattedRequestControl
+       extends Control
+{
+  /**
+   * The OID (1.3.6.1.4.1.30221.2.5.64) for the JSON-formatted request control.
+   */
+  @NotNull public static final  String JSON_FORMATTED_REQUEST_OID =
+       "1.3.6.1.4.1.30221.2.5.64";
+
+
+
+  /**
+   * The name of the field used to hold the array of embedded controls in the
+   * JSON representation of this control.
+   */
+  @NotNull private static final String JSON_FIELD_CONTROLS = "controls";
+
+
+
+  /**
+   * The serial version UID for this serializable class.
+   */
+  private static final long serialVersionUID = -1165320564468120423L;
+
+
+
+  // A JSON object with an encoded representation of the value for this control.
+  @Nullable private final JSONObject encodedValue;
+
+  // A list of the JSON objects representing embedded controls within this
+  // request control.
+  @NotNull private final List<JSONObject> controlObjects;
+
+
+
+  /**
+   * Creates a new instance of this control with the specified criticality and
+   * set of controls.
+   *
+   * @param  isCritical      Indicates whether the control should be considered
+   *                         critical.  This should generally be {@code true},
+   *                         although it is acceptable for it to be
+   *                         {@code false} if there are no embedded controls,
+   *                         or if all of the embedded controls have a
+   *                         criticality of {@code false}.
+   * @param  encodedValue    A JSON object with an encoded representation of
+   *                         the value for this control.  It may be
+   *                         {@code null} if the control should not have a
+   *                         value.
+   * @param  controlObjects  A collection of JSON objects representing the
+   *                         controls to include in the request.  It must not
+   *                         be {@ocde null}, but may be empty.
+   */
+  private JSONFormattedRequestControl(final boolean isCritical,
+               @Nullable final JSONObject encodedValue,
+               @NotNull final List<JSONObject> controlObjects)
+  {
+    super(JSON_FORMATTED_REQUEST_OID, isCritical,
+         ((encodedValue == null)
+              ? null :
+              new ASN1OctetString(encodedValue.toSingleLineString())));
+
+    this.encodedValue = encodedValue;
+    this.controlObjects = controlObjects;
+  }
+
+
+
+  /**
+   * Creates a new {@code JSONFormattedRequestControl} without any embedded
+   * controls.  This may be used to indicate that no request controls are
+   * needed, but the server should return any response controls in a
+   * {@link JSONFormattedResponseControl}.
+   *
+   * @param  isCritical  Indicates whether this control should be considered
+   *                     critical.
+   *
+   * @return  The {@code JSONFormattedRequestControl} that was created.
+   */
+  @NotNull()
+  public static JSONFormattedRequestControl createEmptyControl(
+              final boolean isCritical)
+  {
+    return new JSONFormattedRequestControl(isCritical, null,
+         Collections.<JSONObject>emptyList());
+  }
+
+
+
+  /**
+   * Creates a new {@code JSONFormattedRequestControl} with the provided set of
+   * embedded controls.
+   *
+   * @param  isCritical  Indicates whether the control should be considered
+   *                     critical.  This should generally be {@code true},
+   *                     although it is acceptable for it to be {@code false} if
+   *                     there are no embedded controls, or if all of the
+   *                     embedded controls have a criticality of {@code false}.
+   * @param  controls    The collection of controls to embed within this
+   *                     request control.  This may be {@code null} or empty if
+   *                     the request should not have any embedded controls.
+   *
+   * @return  The {@code JSONFormattedRequestControl} that was created.
+   */
+  @NotNull()
+  public static JSONFormattedRequestControl createWithControls(
+              final boolean isCritical,
+              @Nullable final Control... controls)
+  {
+    return createWithControls(isCritical, StaticUtils.toList(controls));
+  }
+
+
+
+  /**
+   * Creates a new {@code JSONFormattedRequestControl} with the provided set of
+   * embedded controls.
+   *
+   * @param  isCritical  Indicates whether the control should be considered
+   *                     critical.  This should generally be {@code true},
+   *                     although it is acceptable for it to be {@code false} if
+   *                     there are no embedded controls, or if all of the
+   *                     embedded controls have a criticality of {@code false}.
+   * @param  controls    The collection of controls to embed within this
+   *                     request control.  This may be {@code null} or empty if
+   *                     the request should not have any embedded controls.
+   *
+   * @return  The {@code JSONFormattedRequestControl} that was created.
+   */
+  @NotNull()
+  public static JSONFormattedRequestControl createWithControls(
+              final boolean isCritical,
+              @Nullable final Collection<Control> controls)
+  {
+    if ((controls == null) || controls.isEmpty())
+    {
+      return new JSONFormattedRequestControl(isCritical, null,
+           Collections.<JSONObject>emptyList());
+    }
+
+
+    final List<Control> controlList = new ArrayList<>(controls);
+    final List<JSONObject> controlObjects = new ArrayList<>(controls.size());
+    for (final Control c : controls)
+    {
+      controlObjects.add(c.toJSONControl());
+    }
+
+    final JSONObject encodedValue = new JSONObject(
+         new JSONField(JSON_FIELD_CONTROLS, new JSONArray(controlObjects)));
+
+    return new JSONFormattedRequestControl(isCritical, encodedValue,
+         Collections.unmodifiableList(controlObjects));
+  }
+
+
+
+  /**
+   * Creates a new {@code JSONFormattedRequestControl} with the provided set of
+   * embedded JSON objects.
+   *
+   * @param  isCritical      Indicates whether the control should be considered
+   *                         critical.  This should generally be {@code true},
+   *                         although it is acceptable for it to be
+   *                         {@code false} if there are no embedded controls, or
+   *                         if all of the embedded controls have a criticality
+   *                         of {@code false}.
+   * @param  controlObjects  The collection of JSON objects that represent the
+   *                         encoded controls to embed within this request
+   *                         control.  This may be {@code null} or empty if the
+   *                         request should not have any embedded controls.
+   *                         Note that no attempt will be made to validate the
+   *                         JSON objects as controls.
+   *
+   * @return  The {@code JSONFormattedRequestControl} that was created.
+   */
+  @NotNull()
+  public static JSONFormattedRequestControl createWithControlObjects(
+              final boolean isCritical,
+              @Nullable final JSONObject... controlObjects)
+  {
+    return createWithControlObjects(isCritical,
+         StaticUtils.toList(controlObjects));
+  }
+
+
+
+  /**
+   * Creates a new {@code JSONFormattedRequestControl} with the provided set of
+   * embedded JSON objects.
+   *
+   * @param  isCritical      Indicates whether the control should be considered
+   *                         critical.  This should generally be {@code true},
+   *                         although it is acceptable for it to be
+   *                         {@code false} if there are no embedded controls, or
+   *                         if all of the embedded controls have a criticality
+   *                         of {@code false}.
+   * @param  controlObjects  The collection of JSON objects that represent the
+   *                         encoded controls to embed within this request.
+   *                         This may be {@code null} or empty if the request
+   *                         control should not have any embedded controls.
+   *                         Note that no attempt will be made to validate the
+   *                         JSON objects as controls.
+   *
+   * @return  The {@code JSONFormattedRequestControl} that was created.
+   */
+  @NotNull()
+  public static JSONFormattedRequestControl createWithControlObjects(
+              final boolean isCritical,
+              @Nullable final Collection<JSONObject> controlObjects)
+  {
+    if ((controlObjects == null) || controlObjects.isEmpty())
+    {
+      return new JSONFormattedRequestControl(isCritical, null,
+           Collections.<JSONObject>emptyList());
+    }
+
+
+    final List<JSONObject> controlObjectList = new ArrayList<>(controlObjects);
+    final JSONObject encodedValue = new JSONObject(
+         new JSONField(JSON_FIELD_CONTROLS, new JSONArray(controlObjectList)));
+
+    return new JSONFormattedRequestControl(isCritical, encodedValue,
+         Collections.unmodifiableList(controlObjectList));
+  }
+
+
+
+  /**
+   * Creates a new instance of this control that is decoded from the provided
+   * generic control.  Note that if the provided control has a value, it will be
+   * validated to ensure that it is a JSON object containing only a
+   * {@code controls} field whose value is an array of JSON objects that appear
+   * to be well-formed generic JSON controls, but it will not make any attempt
+   * to validate in a control-specific manner.
+   *
+   * @param  control  The control to decode as a JSON-formatted request control.
+   *
+   * @throws LDAPException  If a problem is encountered while attempting to
+   *                         decode the provided control as a JSON-formatted
+   *                         request control.
+   */
+  public JSONFormattedRequestControl(@NotNull final Control control)
+         throws LDAPException
+  {
+    super(control);
+
+    final ASN1OctetString rawValue = control.getValue();
+    if (rawValue == null)
+    {
+      encodedValue = null;
+      controlObjects = Collections.emptyList();
+      return;
+    }
+
+    try
+    {
+      encodedValue = new JSONObject(rawValue.stringValue());
+    }
+    catch (final Exception e)
+    {
+      Debug.debugException(e);
+      throw new LDAPException(ResultCode.DECODING_ERROR,
+           ERR_JSON_FORMATTED_REQUEST_VALUE_NOT_JSON.get(), e);
+    }
+
+
+    final List<String> unrecognizedFields =
+           JSONControlDecodeHelper.getControlObjectUnexpectedFields(
+                encodedValue, JSON_FIELD_CONTROLS);
+    if (! unrecognizedFields.isEmpty())
+    {
+      throw new LDAPException(ResultCode.DECODING_ERROR,
+           ERR_JSON_FORMATTED_REQUEST_UNRECOGNIZED_FIELD.get(
+                unrecognizedFields.get(0)));
+    }
+
+
+    final List<JSONValue> controlValues =
+         encodedValue.getFieldAsArray(JSON_FIELD_CONTROLS);
+    if (controlValues == null)
+    {
+      throw new LDAPException(ResultCode.DECODING_ERROR,
+           ERR_JSON_FORMATTED_REQUEST_VALUE_MISSING_CONTROLS.get(
+                JSON_FIELD_CONTROLS));
+    }
+
+    if (controlValues.isEmpty())
+    {
+      controlObjects = Collections.emptyList();
+      return;
+    }
+
+    final List<JSONObject> controlObjectsList =
+         new ArrayList<>(controlValues.size());
+    for (final JSONValue controlValue : controlValues)
+    {
+      if (controlValue instanceof JSONObject)
+      {
+        final JSONObject embeddedControlObject = (JSONObject) controlValue;
+
+        try
+        {
+          new JSONControlDecodeHelper(embeddedControlObject, true, true, false);
+          controlObjectsList.add(embeddedControlObject);
+        }
+        catch (final LDAPException e)
+        {
+          Debug.debugException(e);
+          throw new LDAPException(ResultCode.DECODING_ERROR,
+               ERR_JSON_FORMATTED_REQUEST_VALUE_NOT_CONTROL.get(
+                    JSON_FIELD_CONTROLS,
+                    embeddedControlObject.toSingleLineString(),
+                    e.getMessage()),
+               e);
+        }
+      }
+      else
+      {
+        throw new LDAPException(ResultCode.DECODING_ERROR,
+             ERR_JSON_FORMATTED_REQUEST_VALUE_CONTROL_NOT_OBJECT.get(
+                  JSON_FIELD_CONTROLS));
+      }
+    }
+
+
+    controlObjects = Collections.unmodifiableList(controlObjectsList);
+  }
+
+
+
+  /**
+   * Retrieves a list of the JSON objects that represent the embedded request
+   * controls.  These JSON objects may not have been validated to ensure that
+   * they represent valid controls.
+   *
+   * @return  A list of the JSON objects that represent the embedded request
+   *          controls.  It may be empty if there are no embedded request
+   *          controls.
+   */
+  @NotNull()
+  public List<JSONObject> getControlObjects()
+  {
+    return controlObjects;
+  }
+
+
+
+  /**
+   * Attempts to retrieve a decoded representation of the embedded request
+   * controls using the specified behavior.
+   *
+   * @param  behavior                The behavior to use when parsing JSON
+   *                                 objects as controls.  It must not be
+   *                                 {@code null}.
+   * @param  nonFatalDecodeMessages  An optional list that may be updated with
+   *                                 messages about any JSON objects that could
+   *                                 not be parsed as valid controls, but that
+   *                                 should not result in an exception as per
+   *                                 the provided behavior.  This may be
+   *                                 {@code null} if no such messages are
+   *                                 desired.  If it is non-{@code null}, then
+   *                                 the list must be updatable.
+   *
+   * @return  A decoded representation of the embedded request controls, or an
+   *          empty list if there are no embedded request controls or if none of
+   *          the embedded JSON objects can be parsed as valid controls but that
+   *          should not result in an exception as per the provided behavior.
+   *
+   * @throws  LDAPException  If any of the JSON objects cannot be parsed as a
+   *                         valid control
+   */
+  @NotNull()
+  public synchronized List<Control> decodeEmbeddedControls(
+              @NotNull final JSONFormattedControlDecodeBehavior behavior,
+              @Nullable final List<String> nonFatalDecodeMessages)
+         throws LDAPException
+  {
+    // Iterate through the controls and try to decode them.
+    final List<Control> controlList = new ArrayList<>(controlObjects.size());
+    final List<String> fatalMessages = new ArrayList<>(controlObjects.size());
+    for (final JSONObject controlObject : controlObjects)
+    {
+      // First, try to decode the JSON object as a generic control without any
+      // specific decoding based on its OID.
+      final JSONControlDecodeHelper jsonControl;
+      try
+      {
+        jsonControl = new JSONControlDecodeHelper(controlObject,
+             behavior.strict(), true, false);
+      }
+      catch (final LDAPException e)
+      {
+        Debug.debugException(e);
+
+        if (behavior.throwOnUnparsableObject())
+        {
+          fatalMessages.add(e.getMessage());
+        }
+        else if (nonFatalDecodeMessages != null)
+        {
+          nonFatalDecodeMessages.add(e.getMessage());
+        }
+
+        continue;
+      }
+
+
+      // Try to actually decode the JSON object as a control, potentially using
+      // control-specific logic based on its OID.
+      try
+      {
+        controlList.add(Control.decodeJSONControl(controlObject,
+             behavior.strict(), true));
+      }
+      catch (final LDAPException e)
+      {
+        Debug.debugException(e);
+
+        if (jsonControl.getCriticality())
+        {
+          if (behavior.throwOnInvalidCriticalControl())
+          {
+            fatalMessages.add(e.getMessage());
+          }
+          else if (nonFatalDecodeMessages != null)
+          {
+            nonFatalDecodeMessages.add(e.getMessage());
+          }
+        }
+        else
+        {
+          if (behavior.throwOnInvalidNonCriticalControl())
+          {
+            fatalMessages.add(e.getMessage());
+          }
+          else if (nonFatalDecodeMessages != null)
+          {
+            nonFatalDecodeMessages.add(e.getMessage());
+          }
+        }
+      }
+    }
+
+
+    //  If there are any fatal messages, then we'll throw an exception with
+    //  them.
+    if (! fatalMessages.isEmpty())
+    {
+      throw new LDAPException(ResultCode.DECODING_ERROR,
+           StaticUtils.concatenateStrings(fatalMessages));
+    }
+
+
+    return Collections.unmodifiableList(controlList);
+  }
+
+
+
+  /**
+   * {@inheritDoc}
+   */
+  @Override()
+  @NotNull()
+  public String getControlName()
+  {
+    return INFO_CONTROL_NAME_JSON_FORMATTED_REQUEST.get();
+  }
+
+
+
+  /**
+   * {@inheritDoc}
+   */
+  @Override()
+  @NotNull()
+  public JSONObject toJSONControl()
+  {
+    if (encodedValue == null)
+    {
+      return new JSONObject(
+           new JSONField(JSONControlDecodeHelper.JSON_FIELD_OID,
+                JSON_FORMATTED_REQUEST_OID),
+           new JSONField(JSONControlDecodeHelper.JSON_FIELD_CONTROL_NAME,
+                INFO_CONTROL_NAME_JSON_FORMATTED_REQUEST.get()),
+           new JSONField(JSONControlDecodeHelper.JSON_FIELD_CRITICALITY,
+                isCritical()));
+    }
+    else
+    {
+      return new JSONObject(
+           new JSONField(JSONControlDecodeHelper.JSON_FIELD_OID,
+                JSON_FORMATTED_REQUEST_OID),
+           new JSONField(JSONControlDecodeHelper.JSON_FIELD_CONTROL_NAME,
+                INFO_CONTROL_NAME_JSON_FORMATTED_REQUEST.get()),
+           new JSONField(JSONControlDecodeHelper.JSON_FIELD_CRITICALITY,
+                isCritical()),
+           new JSONField(JSONControlDecodeHelper.JSON_FIELD_VALUE_JSON,
+                encodedValue));
+    }
+  }
+
+
+
+  /**
+   * Attempts to decode the provided object as a JSON representation of a
+   * JSON-formatted request control.
+   *
+   * @param  controlObject  The JSON object to be decoded.  It must not be
+   *                        {@code null}.
+   * @param  strict         Indicates whether to use strict mode when decoding
+   *                        the provided JSON object.  If this is {@code true},
+   *                        then this method will throw an exception if the
+   *                        provided JSON object contains any unrecognized
+   *                        fields.  If this is {@code false}, then unrecognized
+   *                        fields will be ignored.
+   *
+   * @return  The JSON-formatted request control that was decoded from the
+   *          provided JSON object.
+   *
+   * @throws  LDAPException  If the provided JSON object cannot be parsed as a
+   *                         valid JSON-formatted request control.
+   */
+  @NotNull()
+  public static JSONFormattedRequestControl decodeJSONControl(
+              @NotNull final JSONObject controlObject,
+              final boolean strict)
+         throws LDAPException
+  {
+    final JSONControlDecodeHelper jsonControl = new JSONControlDecodeHelper(
+         controlObject, strict, true, false);
+
+    final ASN1OctetString rawValue = jsonControl.getRawValue();
+    if (rawValue != null)
+    {
+      return new JSONFormattedRequestControl(new Control(
+           jsonControl.getOID(), jsonControl.getCriticality(), rawValue));
+    }
+
+
+    final JSONObject valueObject = jsonControl.getValueObject();
+    if (valueObject == null)
+    {
+      return new JSONFormattedRequestControl(jsonControl.getCriticality(), null,
+           Collections.<JSONObject>emptyList());
+    }
+
+
+    final List<JSONValue> controlValues =
+         valueObject.getFieldAsArray(JSON_FIELD_CONTROLS);
+    if (controlValues == null)
+    {
+      throw new LDAPException(ResultCode.DECODING_ERROR,
+           ERR_JSON_FORMATTED_REQUEST_DECODE_VALUE_MISSING_CONTROLS.get(
+                controlObject.toSingleLineString(), JSON_FIELD_CONTROLS));
+    }
+
+    if (controlValues.isEmpty())
+    {
+      return new JSONFormattedRequestControl(jsonControl.getCriticality(),
+           valueObject, Collections.<JSONObject>emptyList());
+    }
+
+    final List<JSONObject> controlObjectsList =
+         new ArrayList<>(controlValues.size());
+    for (final JSONValue controlValue : controlValues)
+    {
+      if (controlValue instanceof JSONObject)
+      {
+        final JSONObject embeddedControlObject = (JSONObject) controlValue;
+
+        try
+        {
+          new JSONControlDecodeHelper(embeddedControlObject, strict, true,
+               false);
+          controlObjectsList.add(embeddedControlObject);
+        }
+        catch (final LDAPException e)
+        {
+          Debug.debugException(e);
+          throw new LDAPException(ResultCode.DECODING_ERROR,
+               ERR_JSON_FORMATTED_REQUEST_DECODE_VALUE_NOT_CONTROL.get(
+                    controlObject.toSingleLineString(), JSON_FIELD_CONTROLS,
+                    embeddedControlObject.toSingleLineString(), e.getMessage()),
+               e);
+        }
+      }
+      else
+      {
+        throw new LDAPException(ResultCode.DECODING_ERROR,
+             ERR_JSON_FORMATTED_REQUEST_DECODE_VALUE_CONTROL_NOT_OBJECT.get(
+                  controlObject.toSingleLineString(),
+                  JSON_FIELD_CONTROLS));
+      }
+    }
+
+
+    if (strict)
+    {
+      final List<String> unrecognizedFields =
+           JSONControlDecodeHelper.getControlObjectUnexpectedFields(
+                valueObject, JSON_FIELD_CONTROLS);
+      if (! unrecognizedFields.isEmpty())
+      {
+        throw new LDAPException(ResultCode.DECODING_ERROR,
+             ERR_JSON_FORMATTED_REQUEST_DECODE_UNRECOGNIZED_FIELD.get(
+                  controlObject.toSingleLineString(),
+                  unrecognizedFields.get(0)));
+      }
+    }
+
+
+    return new JSONFormattedRequestControl(jsonControl.getCriticality(),
+         valueObject, Collections.unmodifiableList(controlObjectsList));
+  }
+
+
+
+  /**
+   * {@inheritDoc}
+   */
+  @Override()
+  public void toString(@NotNull final StringBuilder buffer)
+  {
+    buffer.append("JSONFormattedRequestControl(isCritical=");
+    buffer.append(isCritical());
+
+    if (encodedValue != null)
+    {
+      buffer.append(", valueObject=");
+      encodedValue.toSingleLineString(buffer);
+    }
+
+    buffer.append(')');
+  }
+}

Added: trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedResponseControl.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedResponseControl.java	                        (rev 0)
+++ trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JSONFormattedResponseControl.java	2022-04-02 00:06:05 UTC (rev 1529)
@@ -0,0 +1,679 @@
+/*
+ * Copyright 2022 Ping Identity Corporation
+ * All Rights Reserved.
+ */
+/*
+ * Copyright 2022 Ping Identity Corporation
+ *
+ * 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
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/*
+ * Copyright (C) 2022 Ping Identity Corporation
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License (GPLv2 only)
+ * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, see <http://www.gnu.org/licenses>.
+ */
+package com.unboundid.ldap.sdk.unboundidds.controls;
+
+
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.List;
+
+import com.unboundid.asn1.ASN1OctetString;
+import com.unboundid.ldap.sdk.Control;
+import com.unboundid.ldap.sdk.DecodeableControl;
+import com.unboundid.ldap.sdk.JSONControlDecodeHelper;
+import com.unboundid.ldap.sdk.LDAPException;
+import com.unb...
 
[truncated message content]

[ldap-sdk-commits] SF.net SVN: ldap-sdk:[1528] trunk

[<di...@us...>]

Revision: 1528
          http://sourceforge.net/p/ldap-sdk/code/1528
Author:   dirmgr
Date:     2022-03-31 21:24:35 +0000 (Thu, 31 Mar 2022)
Log Message:
-----------
Don't hide a StartTLS error with another exception

Fixed an issue that could occasionally cause the LDAP SDK to hide
the cause of a StartTLS failure with a second, less useful
exception.

Modified Paths:
--------------
    trunk/docs/release-notes.html
    trunk/src/com/unboundid/ldap/sdk/LDAPConnectionReader.java

Modified: trunk/docs/release-notes.html
===================================================================
--- trunk/docs/release-notes.html	2022-03-31 20:41:22 UTC (rev 1527)
+++ trunk/docs/release-notes.html	2022-03-31 21:24:35 UTC (rev 1528)
@@ -14,6 +14,13 @@
 
               <ul>
                 <li>
+                  Fixed an issue that could occasionally cause the LDAP SDK to hide the cause of a
+                  StartTLS failure with a second, less useful exception.
+                  <br><br>
+                </li>
+
+              <ul>
+                <li>
                   Added support for encoding controls to JSON objects, and for decoding JSON
                   objects as controls.  There is a generic JSON representation that works for all
                   controls (in which the JSON object includes just an OID, criticality, and a

Modified: trunk/src/com/unboundid/ldap/sdk/LDAPConnectionReader.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/LDAPConnectionReader.java	2022-03-31 20:41:22 UTC (rev 1527)
+++ trunk/src/com/unboundid/ldap/sdk/LDAPConnectionReader.java	2022-03-31 21:24:35 UTC (rev 1528)
@@ -971,9 +971,11 @@
       // process so that it'll be more responsive.  The original SO_TIMEOUT will
       // be restored after the TLS negotiation.
       final int originalSOTimeout = InternalSDKHelper.getSoTimeout(connection);
+      boolean revertSOTimeout = false;
       try
       {
         InternalSDKHelper.setSoTimeout(connection, 50);
+        revertSOTimeout = true;
 
         while (true)
         {
@@ -987,6 +989,7 @@
           {
             if (startTLSException == null)
             {
+              revertSOTimeout = false;
               throw new LDAPException(ResultCode.LOCAL_ERROR,
                    ERR_CONNREADER_STARTTLS_FAILED_NO_EXCEPTION.get());
             }
@@ -994,6 +997,7 @@
             {
               final Exception e = startTLSException;
               startTLSException = null;
+              revertSOTimeout = false;
 
               throw new LDAPException(ResultCode.LOCAL_ERROR,
                    ERR_CONNREADER_STARTTLS_FAILED.get(
@@ -1002,12 +1006,15 @@
             }
           }
 
-          startTLSSleeper.sleep(10);
+          startTLSSleeper.sleep(1);
         }
       }
       finally
       {
-        InternalSDKHelper.setSoTimeout(connection, originalSOTimeout);
+        if (revertSOTimeout)
+        {
+          InternalSDKHelper.setSoTimeout(connection, originalSOTimeout);
+        }
       }
     }
   }

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

[ldap-sdk-commits] SF.net SVN: ldap-sdk:[1527] trunk

[<di...@us...>]

Revision: 1527
          http://sourceforge.net/p/ldap-sdk/code/1527
Author:   dirmgr
Date:     2022-03-31 20:41:22 +0000 (Thu, 31 Mar 2022)
Log Message:
-----------
Add JSON encodings for controls

Added support for encoding controls to JSON objects, and for
decoding JSON objects as controls.  There is a generic JSON
representation that works for all controls (in which the JSON object
includes just an OID, criticality, and a base64-encoded
representation of the raw value, if there is a value), but most
controls that take a value have a more user-friendly encoding with
the value expressed as a JSON object with fields for each of the
elements of the control value.

Modified Paths:
--------------
    trunk/docs/release-notes.html
    trunk/messages/unboundid-ldapsdk-controls.properties
    trunk/messages/unboundid-ldapsdk-ldap.properties
    trunk/messages/unboundid-ldapsdk-unboundid-controls.properties
    trunk/src/com/unboundid/ldap/sdk/Control.java
    trunk/src/com/unboundid/ldap/sdk/controls/AssertionRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/AuthorizationIdentityRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/AuthorizationIdentityResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/DraftLDUPSubentriesRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/ManageDsaITRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/MatchedValuesRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/PasswordExpiredControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/PasswordExpiringControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/PermissiveModifyRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/PostReadRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/PostReadResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/PreReadRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/PreReadResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/ProxiedAuthorizationV1RequestControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/ProxiedAuthorizationV2RequestControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/ServerSideSortRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/ServerSideSortResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/SimplePagedResultsControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/SubtreeDeleteRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/VirtualListViewRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/controls/VirtualListViewResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/AccountUsableRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/AccountUsableResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/AdministrativeOperationRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/AssuredReplicationLocalLevel.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/AssuredReplicationRemoteLevel.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/AssuredReplicationRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/AssuredReplicationResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/ExcludeBranchRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/ExtendedSchemaInfoRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GeneratePasswordRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GeneratePasswordResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetAuthorizationEntryRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetAuthorizationEntryResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetBackendSetIDRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetBackendSetIDResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetEffectiveRightsRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetPasswordPolicyStateIssuesRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetPasswordPolicyStateIssuesResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetRecentLoginHistoryRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetRecentLoginHistoryResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetServerIDRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetServerIDResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetUserResourceLimitsRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/GetUserResourceLimitsResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/HardDeleteRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/IgnoreNoUserModificationRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/IntermediateClientRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/IntermediateClientResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JoinRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JoinResultControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/JoinRule.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/MatchingEntryCountRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/MatchingEntryCountResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/NameWithEntryUUIDRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/NoOpRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/OperationPurposeRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/OverrideSearchLimitsRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/PasswordPolicyRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/PasswordPolicyResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/PasswordUpdateBehaviorRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/PasswordValidationDetailsRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/PasswordValidationDetailsResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/PermitUnindexedSearchRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/PurgePasswordRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/RealAttributesOnlyRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/RejectUnindexedSearchRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/ReplicationRepairRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/RetainIdentityRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/RetirePasswordRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/ReturnConflictEntriesRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/RouteToBackendSetRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/RouteToServerRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/SoftDeleteRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/SoftDeleteResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/SoftDeletedEntryAccessRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/SuppressOperationalAttributeUpdateRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/SuppressReferentialIntegrityUpdatesRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/UndeleteRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/UniquenessRequestControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/UniquenessResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/UnsolicitedCancelResponseControl.java
    trunk/src/com/unboundid/ldap/sdk/unboundidds/controls/VirtualAttributesOnlyRequestControl.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/ControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/TestDecodeableControl.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/controls/AssertionRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/controls/AuthorizationIdentityRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/controls/AuthorizationIdentityResponseControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/controls/DraftLDUPSubentriesRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/controls/ManageDsaITRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/controls/MatchedValuesRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/controls/PasswordExpiredControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/controls/PasswordExpiringControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/controls/PermissiveModifyRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/controls/PostReadRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/controls/PostReadResponseControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/controls/PreReadRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/controls/PreReadResponseControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/controls/ProxiedAuthorizationV1RequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/controls/ProxiedAuthorizationV2RequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/controls/ServerSideSortRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/controls/ServerSideSortResponseControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/controls/SimplePagedResultsControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/controls/SubtreeDeleteRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/controls/VirtualListViewRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/controls/VirtualListViewResponseControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/AccountUsableRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/AccountUsableResponseControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/AdministrativeOperationRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/AssuredReplicationLocalLevelTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/AssuredReplicationRemoteLevelTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/AssuredReplicationRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/AssuredReplicationResponseControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/ExcludeBranchRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/ExtendedSchemaInfoRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/GeneratePasswordRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/GeneratePasswordResponseControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/GetAuthorizationEntryRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/GetAuthorizationEntryResponseControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/GetBackendSetIDRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/GetBackendSetIDResponseControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/GetEffectiveRightsRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/GetPasswordPolicyStateIssuesRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/GetPasswordPolicyStateIssuesResponseControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/GetRecentLoginHistoryRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/GetRecentLoginHistoryResponseControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/GetServerIDRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/GetServerIDResponseControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/GetUserResourceLimitsRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/GetUserResourceLimitsResponseControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/HardDeleteRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/IgnoreNoUserModificationRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/IntermediateClientRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/IntermediateClientResponseControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/JoinRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/JoinResultControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/JoinRuleTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/MatchingEntryCountRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/MatchingEntryCountResponseControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/NameWithEntryUUIDRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/NoOpRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/OperationPurposeRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/OverrideSearchLimitsRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/PasswordPolicyRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/PasswordPolicyResponseControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/PasswordUpdateBehaviorRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/PasswordValidationDetailsRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/PasswordValidationDetailsResponseControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/PermitUnindexedSearchRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/PurgePasswordRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/RealAttributesOnlyRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/RejectUnindexedSearchRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/ReplicationRepairRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/RetainIdentityRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/RetirePasswordRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/RouteToBackendSetRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/RouteToServerRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/SoftDeleteRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/SoftDeleteResponseControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/SoftDeletedEntryAccessRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/SuppressOperationalAttributeUpdateRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/SuppressReferentialIntegrityUpdatesRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/UndeleteRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/UniquenessRequestControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/UniquenessResponseControlTestCase.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/unboundidds/controls/UnsolicitedCancelResponseControlTestCase.java

Added Paths:
-----------
    trunk/src/com/unboundid/ldap/sdk/JSONControlDecodeHelper.java
    trunk/tests/unit/src/com/unboundid/ldap/sdk/JSONControlDecodeHelperTestCase.java

Modified: trunk/docs/release-notes.html
===================================================================
--- trunk/docs/release-notes.html	2022-03-22 00:24:12 UTC (rev 1526)
+++ trunk/docs/release-notes.html	2022-03-31 20:41:22 UTC (rev 1527)
@@ -14,6 +14,17 @@
 
               <ul>
                 <li>
+                  Added support for encoding controls to JSON objects, and for decoding JSON
+                  objects as controls.  There is a generic JSON representation that works for all
+                  controls (in which the JSON object includes just an OID, criticality, and a
+                  base64-encoded representation of the raw value, if there is a value), but most
+                  controls that take a value have a more user-friendly encoding with the value
+                  expressed as a JSON object with fields for each of the elements of the control
+                  value.
+                  <br><br>
+                </li>
+
+                <li>
                   Fixed an issue with the way the parallel-update tool created assured replication
                   request controls when an explicit local or remote assurance level was specified.
                   Previously, it would only specify a minimum assurance level without specifying a

Modified: trunk/messages/unboundid-ldapsdk-controls.properties
===================================================================
--- trunk/messages/unboundid-ldapsdk-controls.properties	2022-03-22 00:24:12 UTC (rev 1526)
+++ trunk/messages/unboundid-ldapsdk-controls.properties	2022-03-31 20:41:22 UTC (rev 1527)
@@ -43,10 +43,25 @@
 ERR_ASSERT_CANNOT_DECODE=The provided control cannot be decoded as an \
   assertion request control because an error occurred while attempting to \
   decode the assertion filter from the value:  {0}
+ERR_ASSERT_JSON_CONTROL_MISSING_FILTER=Unable to decode JSON object {0} as \
+  an assertion request control because the value object is missing the \
+  ''{1}'' field needed to specify the assertion filter.
+ERR_ASSERT_JSON_CONTROL_INVALID_FILTER=Unable to decode JSON object {0} as \
+  an assertion request control because filter string ''{1}'' cannot be \
+  parsed as a valid LDAP filter.
+ERR_ASSERT_JSON_CONTROL_UNRECOGNIZED_FIELD=Unable to decode JSON object {0} \
+  as an assertion request control because the value object contains \
+  unrecognized field ''{1}''.
 ERR_AUTHZID_REQUEST_HAS_VALUE=The provided control cannot be decoded as an \
   authorization identity request control because it has a value.
 ERR_AUTHZID_RESPONSE_NO_VALUE=The provided control cannot be decoded as an \
   authorization identity response control because it does not have a value.
+ERR_AUTHZID_RESPONSE_JSON_MISSING_AUTHZ_ID=Unable to decode JSON object {0} \
+  as an authorization identity response control because the value object is \
+  missing the ''{1}'' field needed to specify the authorization identity.
+ERR_AUTHZID_RESPONSE_JSON_CONTROL_UNRECOGNIZED_FIELD=Unable to decode JSON \
+  object {0} as an authorization identity response control because the value \
+  object contains unrecognized field ''{1}''.
 ERR_ECN_NO_VALUE=The provided control cannot be decoded as an entry change \
   notification control because it does not have a value.
 ERR_ECN_VALUE_NOT_SEQUENCE=Unable to decode the value as an entry change \
@@ -107,6 +122,20 @@
 ERR_MV_REQUEST_CANNOT_DECODE=The provided control cannot be decoded as a \
   matched values request control because an error occurred while attempting to \
   decode the value:  {0}
+ERR_MV_REQUEST_JSON_NO_FILTERS=Unable to decode JSON object {0} as a matched \
+  values request control because it is missing array field ''{1}'' needed to \
+  specify the matched values filters.
+ERR_MV_REQUEST_JSON_EMPTY_FILTERS=Unable to decode JSON object {0} as a \
+  matched values request control because the ''{1}'' array is empty.
+ERR_MV_REQUEST_JSON_INVALID_FILTER=Unable to decode JSON object {0} as a \
+  matched values request control because ''{1}'' value ''{2}'' cannot be \
+  parsed as a valid matched values filter:  {3}
+ERR_MV_REQUEST_JSON_FILTER_NOT_STRING=Unable to decode JSON object {0} as a \
+  matched values request control because the ''{1}'' array has a value that \
+  is not a string.
+ERR_MV_REQUEST_JSON_UNRECOGNIZED_FIELD=Unable to decode JSON object {0} as a \
+  matched values request control because the value includes unrecognized \
+  filed ''{1}''.
 ERR_PW_EXPIRED_NO_VALUE=The provided control cannot be decoded as a password \
   expired response control because it does not have a value.
 ERR_PW_EXPIRED_VALUE_NOT_INTEGER=The provided control cannot be decoded as a \
@@ -117,6 +146,12 @@
 ERR_PW_EXPIRING_VALUE_NOT_INTEGER=The provided control cannot be decoded as a \
   password expiring response control because the control value could not be \
   parsed as an integer.
+ERR_PW_EXPIRING_JSON_MISSING_SECONDS_UNTIL_EXPIRATION=Unable to decode JSON \
+  object {0} as a password expiring response control because the value is \
+  missing required field ''{1}''.
+ERR_PW_EXPIRING_JSON_UNRECOGNIZED_FIELD=Unable to decode JSON object {0} as a \
+  password expiring response control because the value includes unrecognized \
+  field ''{1}''.
 ERR_PSEARCH_NO_VALUE=The provided control cannot be decoded as a persistent \
   search request control because it does not have a value.
 ERR_PSEARCH_CANNOT_DECODE=The provided control cannot be decoded as a \
@@ -127,6 +162,12 @@
 ERR_POST_READ_REQUEST_CANNOT_DECODE=The provided control cannot be decoded as \
   a post-read request control because an error occurred while attempting to \
   decode the value:  {0}
+ERR_POST_READ_REQUEST_JSON_ATTR_NOT_STRING=Unable to decode JSON object {0} \
+  as a post-read request control because it includes a ''{1}'' value that \
+  is not a string.
+ERR_POST_READ_REQUEST_JSON_UNRECOGNIZED_FIELD=Unable to decode JSON object \
+  {0} as a post-read request control because the value includes unrecognized \
+  field ''{1}''.
 ERR_POST_READ_RESPONSE_NO_VALUE=The provided control cannot be decoded as a \
   post-read response control because it does not have a value.
 ERR_POST_READ_RESPONSE_VALUE_NOT_SEQUENCE=The control value could not be \
@@ -137,11 +178,29 @@
   not be decoded as an ASN.1 sequence:  {0}
 ERR_POST_READ_RESPONSE_ATTR_NOT_SEQUENCE=An attribute element could not be \
   decoded as an ASN.1 sequence:  {0}
+ERR_POST_READ_RESPONSE_JSON_DN_NOT_STRING=Unable to decode JSON object {0} as \
+  a post-read response control because the value of the ''{1}'' field is not \
+  a string.
+ERR_POST_READ_RESPONSE_JSON_ATTR_VALUE_NOT_STRING=Unable to decode JSON \
+  object {0} as a post-read response control because the ''{1}'' array has \
+  a value that is not a string.
+ERR_POST_READ_RESPONSE_JSON_ATTR_VALUE_NOT_ARRAY=Unable to decode JSON \
+  object {0} as a post-read response control because the value of the ''{1}'' \
+  field (which is presumed to represent an attribute) is not an array.
+ERR_POST_READ_RESPONSE_JSON_MISSING_DN=Unable to decode JSON object {0} as a \
+  post-read response control because it is missing the ''{1}'' field needed \
+  to specify the entry DN.
 ERR_PRE_READ_REQUEST_NO_VALUE=The provided control cannot be decoded as a \
   pre-read request control because it does not have a value.
 ERR_PRE_READ_REQUEST_CANNOT_DECODE=The provided control cannot be decoded as \
   a pre-read request control because an error occurred while attempting to \
   decode the value:  {0}
+ERR_PRE_READ_REQUEST_JSON_ATTR_NOT_STRING=Unable to decode JSON object {0} \
+  as a pre-read request control because it includes a ''{1}'' value that \
+  is not a string.
+ERR_PRE_READ_REQUEST_JSON_UNRECOGNIZED_FIELD=Unable to decode JSON object \
+  {0} as a pre-read request control because the value includes unrecognized \
+  field ''{1}''.
 ERR_PRE_READ_RESPONSE_NO_VALUE=The provided control cannot be decoded as a \
   pre-read response control because it does not have a value.
 ERR_PRE_READ_RESPONSE_VALUE_NOT_SEQUENCE=The control value could not be \
@@ -152,18 +211,59 @@
   not be decoded as an ASN.1 sequence:  {0}
 ERR_PRE_READ_RESPONSE_ATTR_NOT_SEQUENCE=An attribute element could not be \
   decoded as an ASN.1 sequence:  {0}
+ERR_PRE_READ_RESPONSE_JSON_DN_NOT_STRING=Unable to decode JSON object {0} as \
+  a pre-read response control because the value of the ''{1}'' field is not \
+  a string.
+ERR_PRE_READ_RESPONSE_JSON_ATTR_VALUE_NOT_STRING=Unable to decode JSON \
+  object {0} as a pre-read response control because the ''{1}'' array has \
+  a value that is not a string.
+ERR_PRE_READ_RESPONSE_JSON_ATTR_VALUE_NOT_ARRAY=Unable to decode JSON \
+  object {0} as a pre-read response control because the value of the ''{1}'' \
+  field (which is presumed to represent an attribute) is not an array.
+ERR_PRE_READ_RESPONSE_JSON_MISSING_DN=Unable to decode JSON object {0} as a \
+  pre-read response control because it is missing the ''{1}'' field needed \
+  to specify the entry DN.
 ERR_PROXY_V1_NO_VALUE=The provided control cannot be decoded as a proxied \
   authorization v1 request control because it does not have a value.
 ERR_PROXYV1_DECODE_ERROR=The provided control cannot be decoded as a proxied \
   authorization v1 request control because an error occurred while \
   attempting to decode the control value:  {0}
+ERR_PROXYV1_JSON_MISSING_AUTHZ_DN=Unable to decode JSON object {0} as a \
+  proxied authorization v1 request control because the value is missing \
+  field ''{1}'' needed to specify the authorization DN.
+ERR_PROXYV1_JSON_UNRECOGNIZED_FIELD=Unable to decode JSON object {0} as a \
+  proxied authorization v1 request control because the value includes \
+  unexpected field ''{1}''.
 ERR_PROXY_V2_NO_VALUE=The provided control cannot be decoded as a proxied \
   authorization v2 request control because it does not have a value.
+ERR_PROXYV2_JSON_MISSING_AUTHZ_ID=Unable to decode JSON object {0} as a \
+  proxied authorization v2 request control because the value is missing \
+  field ''{1}'' needed to specify the authorization ID.
+ERR_PROXYV2_JSON_UNRECOGNIZED_FIELD=Unable to decode JSON object {0} as a \
+  proxied authorization v2 request control because the value includes \
+  unexpected field ''{1}''.
 ERR_SORT_REQUEST_NO_VALUE=The provided control cannot be decoded as a \
   server-side sort request control because it does not have a value.
 ERR_SORT_REQUEST_CANNOT_DECODE=The provided control cannot be decoded as a \
   server-side sort request control because an error occurred while attempting \
   to decode the control value:  {0}
+ERR_SORT_REQUEST_JSON_MISSING_SORT_KEYS=Unable to decode JSON object {0} as a \
+  server-side sort request control because the value is missing the \
+  required ''{1}'' array field.
+ERR_SORT_REQUEST_JSON_EMPTY_SORT_KEYS=Unable to decode JSON object {0} as a \
+  server-side sort request control because the ''{1}'' array is empty.
+ERR_SORT_REQUEST_JSON_SORT_KEY_MISSING_FIELD=Unable to decode JSON object {0} \
+  as a server-side sort request control because a ''{1}'' object is missing \
+  required field ''{2}''.
+ERR_SORT_REQUEST_JSON_UNRECOGNIZED_SORT_KEY_FIELD=Unable to decode JSON \
+  object {0} as a server-side sort request control because a ''{1}'' object \
+  includes unrecognized field ''{2}''.
+ERR_SORT_REQUEST_JSON_SORT_KEY_VALUE_NOT_OBJECT=Unable to decode JSON object \
+  {0} as a server-side sort request control because the ''{1}'' array has a \
+  value that is not an object.
+ERR_SORT_REQUEST_JSON_UNRECOGNIZED_FIELD=Unable to decode JSON object {0} as \
+  a server-side sort request control because the value includes unrecognized \
+  field ''{1}''.
 ERR_SORT_RESPONSE_NO_VALUE=No control value was provided, so it could not be \
   decoded as a server-side sort response control.
 ERR_SORT_RESPONSE_VALUE_NOT_SEQUENCE=Unable to decode the value of the \
@@ -173,6 +273,12 @@
   {0,number,0}).
 ERR_SORT_RESPONSE_FIRST_NOT_ENUM=Unable to decode the first element of the \
   provided control as a result code enumerated element:  {0}
+ERR_SORT_RESPONSE_JSON_MISSING_RESULT_CODE=Unable to decode JSON object {0} \
+  as a server-side sort response control because the value is missing \
+  required integer field ''{1}''
+ERR_SORT_RESPONSE_JSON_UNRECOGNIZED_FIELD=Unable to decode JSON object {0} \
+  as a server-side sort response control because the value includes \
+  unrecognized field ''{1}''.
 ERR_PAGED_RESULTS_NO_VALUE=No control value was provided, so it could not be \
   decoded as a simple paged results response control.
 ERR_PAGED_RESULTS_VALUE_NOT_SEQUENCE=Unable to decode the value of the \
@@ -181,6 +287,15 @@
   simple paged results value sequence (expected 2, got {0,number,0}).
 ERR_PAGED_RESULTS_FIRST_NOT_INTEGER=Unable to decode the first element of the \
   simple paged results value sequence as an integer:  {0}
+ERR_PAGED_RESULTS_JSON_MISSING_PAGE_SIZE=Unable to decode JSON object {0} as \
+  a simple paged results control because the value is missing the required \
+  ''{1}'' integer field.
+ERR_PAGED_RESULTS_JSON_COOKIE_NOT_BASE64=Unable to decode JSON object {0} as \
+  a simple paged results control because the ''{1}'' value is not a valid \
+  base64-encoded string.
+ERR_PAGED_RESULTS_JSON_UNRECOGNIZED_FIELD=Unable to decode JSON object {0} as \
+  a simple paged results control because the value includes unrecognized \
+  field ''{1}''.
 ERR_SORT_KEY_NOT_SEQUENCE=The provided ASN.1 element cannot be decoded as a \
   sort key because it could not be parsed as an ASN.1 sequence:  {0}
 ERR_SORT_KEY_INVALID_ELEMENT_COUNT=The provided ASN.1 element cannot be \
@@ -209,6 +324,25 @@
 ERR_VLV_REQUEST_CANNOT_DECODE=The provided control cannot be decoded as a \
   virtual list view request control because an error occurred while attempting \
   to decode the control value:  {0}
+ERR_VLV_REQUEST_JSON_NEITHER_OFFSET_NOR_VALUE=Unable to decode JSON object \
+  {0} as a virtual list view request control because the value does not \
+  contain either the ''{1}'' or the ''{2}'' field.  Exactly one of those \
+  fields must be present.
+ERR_VLV_REQUEST_JSON_BOTH_OFFSET_AND_VALUE=Unable to decode JSON object {0} \
+  as a virtual list view request control because the value contains both the \
+  ''{1}'' and ''{2}'' fields.  Exactly one of those fields must be present.
+ERR_VLV_REQUEST_JSON_MISSING_FIELD=Unable to decode JSON object {0} as a \
+  virtual list view request control because the value is missing the \
+  required ''{1}'' field.
+ERR_VLV_REQUEST_JSON_CONTENT_COUNT_WITH_ASSERTION_VALUE=Unable to decode JSON \
+  object {0} as a virtual list view request control because the ''{1}'' field \
+  may not be used in conjunction with the ''{2}'' field.
+ERR_VLV_REQUEST_JSON_CONTEXT_ID_NOT_BASE64=Unable to decode JSON object {0} \
+  as a virtual list view request control because the value of the ''{1}'' \
+  field cannot be base64-decoded.
+ERR_VLV_REQUEST_JSON_UNRECOGNIZED_FIELD=Unable to decode JSON object {0} as a \
+  virtual list view request control because the value includes unrecognized \
+  field ''{1}''.
 ERR_VLV_RESPONSE_NO_VALUE=No control value was provided, so it could not be \
   decoded as a virtual list view response control.
 ERR_VLV_RESPONSE_VALUE_NOT_SEQUENCE=Unable to decode the value of the \
@@ -221,6 +355,15 @@
   provided control as an integer element:  {0}
 ERR_VLV_RESPONSE_THIRD_NOT_ENUM=Unable to decode the third element of the \
   provided control as an enumerated element:  {0}
+ERR_VLV_RESPONSE_JSON_MISSING_FIELD=Unable to decode JSON object {0} as a \
+  virtual list view response control because the value is missing required \
+  field ''{1}''.
+ERR_VLV_RESPONSE_JSON_CONTEXT_ID_NOT_BASE64=Unable to decode JSON object {0} \
+  as a virtual list view response control because the ''{1}'' value cannot be \
+  base64-decoded.
+ERR_VLV_RESPONSE_JSON_UNRECOGNIZED_FIELD=Unable to decode JSON object {0} \
+  as a virtual list view response control because the value includes \
+  unrecognized field ''{1}''.
 INFO_CONTROL_NAME_ASSERTION_REQUEST=Assertion Request Control
 INFO_CONTROL_NAME_AUTHZID_REQUEST=Authorization Identity Request Control
 INFO_CONTROL_NAME_AUTHZID_RESPONSE=Authorization Identity Response Control

Modified: trunk/messages/unboundid-ldapsdk-ldap.properties
===================================================================
--- trunk/messages/unboundid-ldapsdk-ldap.properties	2022-03-22 00:24:12 UTC (rev 1526)
+++ trunk/messages/unboundid-ldapsdk-ldap.properties	2022-03-31 20:41:22 UTC (rev 1527)
@@ -92,6 +92,7 @@
 ERR_CONTROLS_DECODE_ELEMENT_NOT_SEQUENCE=Unable to decode the provided \
   sequence as a set of controls because one of the elements could not be \
   decoded as a control sequence:  {0}
+
 ERR_DELETE_INTERRUPTED=Delete processing was interrupted while waiting for a \
   response from server {0}.
 ERR_DN_ENDS_WITH_COMMA=Unable to parse string ''{0}'' as a DN because it ends \
@@ -888,4 +889,32 @@
 ERR_SCRAM_SERVER_FINAL_MESSAGE_INCORRECT_VERIFIER=Unable to process the {0} \
   bind because the server final message ''{1}'' had a base64-encoded server \
   verifier of ''{2}'', but a verifier of ''{3}'' was expected.
+ERR_CONTROL_JSON_OBJECT_MISSING_OID=Unable to decode JSON object {0} as a \
+  valid control because it does not have the required ''{1}'' string field \
+  needed to specify the control OID.
+ERR_CONTROL_JSON_UNABLE_TO_SUPPORT_VALUE_JSON=Unable to decode JSON object \
+  {0} as a valid control because the ''{1}'' field cannot be used for a \
+  control with OID ''{2}'' because no control-specific decoding is available \
+  for that OID.  In this case, the ''{3}'' field may be used to provide a \
+  base64-encoded representation of the value.
+ERR_JSON_CONTROL_MISSING_OID=Unable to decode JSON object {0} as a valid \
+  control because it does not have the required ''{1}'' string field needed \
+  to specify the control OID.
+ERR_JSON_CONTROL_MISSING_CRITICALITY=Unable to decode JSON object {0} as a \
+  valid control because it does not have the required ''{1}'' Boolean field \
+  needed to specify the control criticality.
+ERR_JSON_CONTROL_MISSING_VALUE=Unable to decode JSON object {0} as a valid \
+  control because it does not have either the ''{1}'' field or the ''{2}'' \
+  field needed to specify the control value.
+ERR_JSON_CONTROL_DISALLOWED_VALUE=Unable to decode JSON object {0} as a valid \
+  control because it includes a value, but this control is not allowed to \
+  have a value.
+ERR_JSON_CONTROL_VALUE_CONFLICT=Unable to decode JSON object {0} as a valid \
+  control because it includes both the ''{1}'' and ''{2}'' fields.  Only \
+  one of those fields may be present.
+ERR_JSON_CONTROL_VALUE_NOT_VALID_BASE64=Unable to decode JSON object {0} as \
+  a valid control because the value of the ''{1}'' field is not valid \
+  base64-encoded data.
+ERR_JSON_CONTROL_UNEXPECTED_FIELD=Unable to decode JSON object {0} as a valid \
+  control because it contains unexpected field ''{1}''.
 

Modified: trunk/messages/unboundid-ldapsdk-unboundid-controls.properties
===================================================================
--- trunk/messages/unboundid-ldapsdk-unboundid-controls.properties	2022-03-22 00:24:12 UTC (rev 1526)
+++ trunk/messages/unboundid-ldapsdk-unboundid-controls.properties	2022-03-31 20:41:22 UTC (rev 1527)
@@ -73,6 +73,24 @@
 ERR_ACCOUNT_USABLE_RESPONSE_INVALID_TYPE=Unable to decode the provided control \
   as an account usable response control because the control value element had \
   an invalid BER type of {0}.
+ERR_ACCOUNT_USABLE_RESPONSE_JSON_MISSING_FIELD=Unable to decode JSON object \
+  {0} as an account usable response control because the value object is \
+  missing the required ''{1}'' field.
+ERR_ACCOUNT_USABLE_RESPONSE_JSON_USABLE_BOOLEAN_CONFLICT=Unable to decode \
+  JSON object {0} as an account usable response control because there is a \
+  conflict between elements in the control value.  If ''{1}'' is true, then \
+  ''{2}'' must be false.
+ERR_ACCOUNT_USABLE_RESPONSE_JSON_USABLE_INT_CONFLICT=Unable to decode \
+  JSON object {0} as an account usable response control because there is a \
+  conflict between elements in the control value.  If ''{1}'' is true, then \
+  ''{2}'' must not be present.
+ERR_ACCOUNT_USABLE_RESPONSE_JSON_UNUSABLE_CONFLICT=Unable to decode JSON \
+  object {0} as an account usable response control because there is a \
+  conflict between elements in the control value.  If ''{1}'' is false, then \
+  ''{2}'' must not be present.
+ERR_ACCOUNT_USABLE_RESPONSE_JSON_CONTROL_UNRECOGNIZED_FIELD=Unable to decode \
+  JSON object {0} as an account usable response control because the value \
+  has unrecognized field ''{1}''.
 ERR_GER_REQUEST_NO_VALUE=The provided control cannot be decoded as a get \
   effective rights request control because it does not have a value.
 ERR_GER_REQUEST_VALUE_NOT_SEQUENCE=The provided control cannot be decoded as \
@@ -84,6 +102,15 @@
 ERR_GER_REQUEST_CANNOT_DECODE=The provided control cannot be decoded as a get \
   effective rights control because an error occurred while attempting to \
   decode the target attributes:  {0}
+ERR_GER_REQUEST_JSON_MISSING_AUTHZ_ID=Unable to decode JSON object {0} as a \
+  get effective rights request control because the value is missing field \
+  ''{1}'' needed to specify the authorization ID.
+ERR_GER_REQUEST_JSON_ATTR_NOT_STRING=Unable to decode JSON object {0} as a \
+  get effective rights request control because the ''{1}'' array has a value \
+  that is not a string.
+ERR_GER_REQUEST_JSON_CONTROL_UNRECOGNIZED_FIELD=Unable to decode JSON object \
+  {0} as a get effective rights request control because the value includes \
+  unrecognized field ''{1}''.
 ERR_NOOP_REQUEST_HAS_VALUE=The provided control cannot be decoded as a no-op \
   request control because it has a value.
 ERR_PWP_REQUEST_HAS_VALUE=The provided control cannot be decoded as a password \
@@ -116,6 +143,21 @@
 ERR_PWP_RESPONSE_INVALID_TYPE=The provided control cannot be decoded as a \
   password policy response control because the value sequence contained an \
   element with an invalid type ({0}).
+ERR_PWP_RESPONSE_JSON_NO_RECOGNIZED_WARNING_TYPE=Unable to decode JSON object \
+  {0} as a password policy response control because it does not have a \
+  recognized warning type.
+ERR_PWP_RESPONSE_JSON_MULTIPLE_WARNING_TYPES=Unable to decode JSON object {0} \
+  as a password policy response control because it has multiple warning \
+  types, but only one is allowed.
+ERR_PWP_RESPONSE_JSON_UNRECOGNIZED_WARNING_FIELD=Unable to decode JSON object \
+  {0} as a password policy response control because the ''{1}'' object \
+  includes unrecognized field ''{2}''.
+ERR_PWP_RESPONSE_JSON_UNRECOGNIZED_ERROR_TYPE=Unable to decode JSON object \
+  {0} as a password policy response control because it has an unrecognized \
+  ''{1}'' value of ''{2}''.
+ERR_PWP_RESPONSE_JSON_UNRECOGNIZED_VALUE_FIELD=Unable to decode JSON object \
+  {0} as a password policy response control because the value includes \
+  unrecognized field ''{1}''.
 ERR_REAL_ATTRS_ONLY_REQUEST_HAS_VALUE=The provided control cannot be decoded \
   as a real attributes only request control because it has a value.
 ERR_TXN_REQUEST_CONTROL_NO_VALUE=The provided control cannot be decoded as a \
@@ -214,8 +256,20 @@
   Specification Response Control
 INFO_CONTROL_NAME_INTERMEDIATE_CLIENT_REQUEST=Intermediate Client Request \
   Control
+ERR_INTERMEDIATE_CLIENT_REQUEST_JSON_DS_VALUE_UNRECOGNIZED_FIELD=Unable to \
+  decode JSON object {0} as an intermediate client request control because a \
+  downstream request object included unrecognized field ''{1}''.
+ERR_INTERMEDIATE_CLIENT_REQUEST_JSON_VALUE_UNRECOGNIZED_FIELD=Unable to \
+  decode JSON object {0} as an intermediate client request control because \
+  the value included unrecognized field ''{1}''.
 INFO_CONTROL_NAME_INTERMEDIATE_CLIENT_RESPONSE=Intermediate Client Response \
   Control
+ERR_INTERMEDIATE_CLIENT_RESPONSE_JSON_US_VALUE_UNRECOGNIZED_FIELD=Unable to \
+  decode JSON object {0} as an intermediate client response control because \
+  an upstream request object included unrecognized field ''{1}''.
+ERR_INTERMEDIATE_CLIENT_RESPONSE_JSON_VALUE_UNRECOGNIZED_FIELD=Unable to \
+  decode JSON object {0} as an intermediate client response control because \
+  the value included unrecognized field ''{1}''.
 INFO_CONTROL_NAME_NOOP_REQUEST=No-Op Request Control
 INFO_CONTROL_NAME_PW_POLICY_REQUEST=Password Policy Request Control
 INFO_CONTROL_NAME_PW_POLICY_RESPONSE=Password Policy Response Control
@@ -228,21 +282,50 @@
 INFO_CONTROL_NAME_GET_AUTHORIZATION_ENTRY_RESPONSE=Get Authorization Entry \
   Response Control
 ERR_GET_AUTHORIZATION_ENTRY_REQUEST_INVALID_SEQUENCE_ELEMENT=Unable to decode \
-  the provided control as an authorization entry request control because the \
-  values sequence included an element with an invalid BER type {0}.
+  the provided control as a get authorization entry request control because \
+  the values sequence included an element with an invalid BER type {0}.
 ERR_GET_AUTHORIZATION_ENTRY_REQUEST_CANNOT_DECODE_VALUE=Unable to decode the \
-  provided control as an authorization entry request control:  {0}
+  provided control as a get authorization entry request control:  {0}
+ERR_GET_AUTHORIZATION_ENTRY_REQUEST_JSON_MISSING_FIELD=Unable to decode JSON \
+  object {0} as a get authorization entry request control because the value \
+  is missing required field ''{1}''.
+ERR_GET_AUTHORIZATION_ENTRY_REQUEST_JSON_ATTR_NOT_STRING=Unable to decode \
+  JSON object {0} as a get authorization entry request control because the \
+  ''{1}'' array includes a non-string value.
+ERR_GET_AUTHORIZATION_ENTRY_REQUEST_JSON_CONTROL_UNRECOGNIZED_FIELD=Unable to \
+  decode JSON object {0} as a get authorization entry request control because \
+  the value object includes unrecognized field ''{1}''.
 ERR_GET_AUTHORIZATION_ENTRY_RESPONSE_NO_VALUE=Unable to decode the provided \
-  control as an authorization entry response control because it does not have \
-  a value.
+  control as a get authorization entry response control because it does not \
+  have a value.
 ERR_GET_AUTHORIZATION_ENTRY_RESPONSE_INVALID_VALUE_TYPE=Unable to decode the \
-  provided control as an authorization entry response control because the \
+  provided control as a get authorization entry response control because the \
   control value sequence had an element with an invalid BER type of {0}.
 ERR_GET_AUTHORIZATION_ENTRY_RESPONSE_INVALID_ENTRY_TYPE=Unable to decode the \
-  provided control as an authorization entry response control because the \
+  provided control as a get authorization entry response control because the \
   control entry sequence had an element with an invalid BER type of {0}.
 ERR_GET_AUTHORIZATION_ENTRY_RESPONSE_CANNOT_DECODE_VALUE=Unable to decode the \
-  provided control as an authorization entry response control:  {0}
+  provided control as a get authorization entry response control:  {0}
+ERR_GET_AUTHORIZATION_ENTRY_RESPONSE_JSON_MISSING_FIELD=Unable to decode JSON \
+  object {0} as a get authorization entry response control because the value \
+  is missing required field ''{1}''.
+ERR_GET_AUTHORIZATION_ENTRY_RESPONSE_JSON_UNRECOGNIZED_FIELD=Unable to decode \
+  JSON object {0} as a get authorization entry response control because the \
+  value includes unrecognized field ''{1}''.
+ERR_GET_AUTHORIZATION_ENTRY_RESPONSE_JSON_DN_NOT_STRING=Unable to decode JSON \
+  object {0} as a get authorization entry response control because the \
+  ''{1}'' value in the ''{2}'' object is not a string.
+ERR_GET_AUTHORIZATION_ENTRY_RESPONSE_JSON_VALUE_NOT_STRING=Unable to decode \
+  JSON object {0} as a get authorization entry response control because the \
+  ''{1}'' array in the ''{2}'' object has a value that is not a string.
+ERR_GET_AUTHORIZATION_ENTRY_RESPONSE_JSON_ATTR_VALUE_NOT_ARRAY=Unable to \
+  decode JSON object {0} as a get authorization entry response control \
+  because the value of the ''{1}'' field in the ''{2}'' object is not an \
+  array.
+ERR_GET_AUTHORIZATION_ENTRY_REQUEST_JSON_ENTRY_MISSING_DN=Unable to decode \
+  JSON object {0} as a get authorization entry response control because the \
+  entry object in field ''{1}'' does not contain the required ''{2}'' field \
+  needed to specify the entry DN.
 ERR_UNSOLICITED_CANCEL_RESPONSE_HAS_VALUE=Unable to decode the provided \
   control as an unsolicited cancel response control because it had a value \
   but no value is allowed for this control.
@@ -254,6 +337,39 @@
 ERR_JOIN_RULE_CANNOT_DECODE=The join rule element could not be decoded:  {0}
 ERR_JOIN_RULE_DECODE_INVALID_TYPE=The join rule element could not be \
   decoded because it has an unrecognized BER type of {0}.
+ERR_JOIN_RULE_JSON_MISSING_TYPE=The object was missing the ''{0}'' field \
+  needed to specify the join rule type.
+ERR_JOIN_RULE_JSON_UNRECOGNIZED_TYPE=Unrecognized join rule type ''{0}''.
+ERR_JOIN_RULE_JSON_DN_MISSING_SOURCE_ATTR=A DN join rule was missing field \
+  ''{0}'' used to specify the source attribute.
+ERR_JOIN_RULE_JSON_UNRECOGNIZED_DN_FIELD=A DN join rule included unrecognized \
+  field ''{0}''.
+ERR_JOIN_RULE_JSON_REVERSE_DN_MISSING_TARGET_ATTR=A reverse DN join rule was \
+  missing field ''{0}'' used to specify the target attribute.
+ERR_JOIN_RULE_JSON_UNRECOGNIZED_REVERSE_DN_FIELD=A reverse DN join rule \
+  included unrecognized field ''{0}''.
+ERR_JOIN_RULE_JSON_EQUALITY_MISSING_FIELD=An equality join rule was missing \
+  required field ''{0}''.
+ERR_JOIN_RULE_JSON_UNRECOGNIZED_EQUALITY_FIELD=An equality join rule included \
+  unrecognized field ''{0}''.
+ERR_JOIN_RULE_JSON_CONTAINS_MISSING_FIELD=A contains join rule was missing \
+  required field ''{0}''.
+ERR_JOIN_RULE_JSON_UNRECOGNIZED_CONTAINS_FIELD=A contains join rule included \
+  unrecognized field ''{0}''.
+ERR_JOIN_RULE_JSON_AND_MISSING_RULES=An AND join rule was missing field \
+  ''{0}'' needed to specify the nested rules.
+ERR_JOIN_RULE_JSON_AND_EMPTY_RULES=An AND join rule had an empty ''{0}'' array.
+ERR_JOIN_RULE_JSON_AND_RULE_NOT_OBJECT=An AND join rule had an ''{0}'' array \
+  value that was not a JSON object.
+ERR_JOIN_RULE_JSON_UNRECOGNIZED_AND_FIELD=An AND join rule included \
+  unrecognized field ''{0}''.
+ERR_JOIN_RULE_JSON_OR_MISSING_RULES=An OR join rule was missing field ''{0}'' \
+  needed to specify the nested rules.
+ERR_JOIN_RULE_JSON_OR_EMPTY_RULES=An OR join rule had an empty ''{0}'' array.
+ERR_JOIN_RULE_JSON_OR_RULE_NOT_OBJECT=An OR join rule had an ''{0}'' array \
+  value that was not a JSON object.
+ERR_JOIN_RULE_JSON_UNRECOGNIZED_OR_FIELD=An OR join rule included \
+  unrecognized field ''{0}''.
 ERR_JOIN_BASE_DECODE_INVALID_TYPE=The join base DN element could not be \
   decoded because it has an unrecognized BER type of {0}.
 ERR_JOIN_REQUEST_VALUE_INVALID_ELEMENT_TYPE=The join request value sequence \
@@ -263,6 +379,32 @@
 ERR_JOIN_REQUEST_CONTROL_NO_VALUE=The provided control cannot be decoded as a \
   join request control because it does not have a value
 INFO_CONTROL_NAME_JOIN_REQUEST=Join Request Control
+ERR_JOIN_REQUEST_JSON_MISSING_FIELD=Unable to decode JSON object {0} as a \
+  join request control because the value is missing required field ''{1}''.
+ERR_JOIN_REQUEST_JSON_INVALID_JOIN_RULE=Unable to decode JSON object {0} as \
+  a join request control because it contains an invalid value for the \
+  ''{1}'' field:  {2}
+ERR_JOIN_REQUEST_JSON_DISALLOWED_BASE_DN_VALUE=Unable to decode JSON object \
+  {0} as a join request control because field ''{1}'' is not allowed to be \
+  provided with a ''{2}'' field value of ''{3}''.
+ERR_JOIN_REQUEST_JSON_MISSING_BASE_DN_VALUE=Unable to decode JSON object {0} \
+  as a join request control because it was missing field ''{1}'' that is \
+  required with a ''{2}'' value of ''{3}''.
+ERR_JOIN_REQUEST_JSON_INVALID_BASE_DN_TYPE=Unable to decode JSON object {0} \
+  as a join request control because it has invalid value ''{1}'' for field \
+  ''{2}''.  Allowed values are ''{3}'', ''{4}'', and ''{5}''.
+ERR_JOIN_REQUEST_JSON_INVALID_SCOPE=Unable to decode JSON object {0} as a \
+  join request control because it has invalid value ''{1}'' for field \
+  ''{2}''.  Allowed values are ''{3}'', ''{4}'', ''{5}'', and ''{6}''.
+ERR_JOIN_REQUEST_JSON_INVALID_DEREF=Unable to decode JSON object {0} as a \
+  join request control because it has invalid value ''{1}'' for field \
+  ''{2}''.  Allowed values are ''{3}'', ''{4}'', ''{5}'', and ''{6}''.
+ERR_JOIN_REQUEST_JSON_INVALID_FILTER=Unable to decode JSON object {0} as a \
+  join request control because it has invalid value ''{1}'' for field ''{2}''.
+ERR_JOIN_REQUEST_JSON_ATTR_NOT_STRING=Unable to decode JSON object {0} as a \
+  join request control because it has a ''{1}'' value that is not a string.
+ERR_JOIN_REQUEST_JSON_UNRECOGNIZED_FIELD=Unable to decode JSON object {0} as \
+  a join request control because the value has unrecognized field ''{1}''.
 ERR_JOINED_ENTRY_CANNOT_DECODE=Unable to decode an ASN.1 element as a joined \
   entry:  {0}
 ERR_JOIN_RESULT_NO_VALUE=Unable to decode a join result control because it \
@@ -272,8 +414,40 @@
 ERR_JOIN_RESULT_INVALID_ELEMENT_TYPE=The join result value sequence \
   included an element with an invalid BER type of {0}.
 INFO_CONTROL_NAME_JOIN_RESULT=Join Result Control
+ERR_JOIN_RESULT_JSON_MISSING_VALUE_FIELD=Unable to decode JSON object {0} as \
+  a join result control because the value is missing required field ''{1}''.
+ERR_JOIN_RESULT_JSON_REFERRAL_URL_NOT_STRING=Unable to decode JSON object {0} \
+  as a join result control because the ''{1}'' array contains an item that is \
+  not a string.
+ERR_JOIN_RESULT_JSON_ENTRY_NOT_OBJECT=Unable to decode JSON object {0} as a \
+  join result control because the ''{1}'' array contains an item that is \
+  not a JSON object.
+ERR_JOIN_RESULT_JSON_UNRECOGNIZED_FIELD=Unable to decode JSON object {0} as a \
+  join result control because the value includes unrecognized field ''{1}''.
+ERR_JOIN_RESULT_JSON_ENTRY_DN_NOT_STRING=Unable to decode JSON object {0} as \
+  a join result control because it contains an entry in which the ''{1}'' \
+  field value is not a string.
+ERR_JON_RESULT_JSON_ENTRY_NESTED_ENTRY_NOT_OBJECT=Unable to decode JSON \
+  object {0} as a join result control because it contains an entry with a \
+  ''{1}'' array value that is not a JSON object.
+ERR_JOIN_RESULT_JSON_ENTRY_NESTED_ENTRIES_NOT_ARRAY=Unable to decode JSON \
+  object {0} as a join result control because it contains an entry with a \
+  ''{1}'' field whose value is not an array.
+ERR_JOIN_RESULT_JSON_ENTRY_ATTR_VALUE_NOT_STRING=Unable to decode JSON object \
+  {0} as a join result control because it contains an entry with attribute \
+  ''{1}'' with an array value that is not a string.
+ERR_JOIN_RESULT_JSON_ENTRY_ATTR_VALUES_NOT_ARRAY=Unable to decode JSON object \
+  {0} as a join result control because it contains an entry with field \
+  ''{1}'' that is expected to be an attribute field but whose value is not an \
+  array.
+ERR_JON_RESULT_JSON_ENTRY_MISSING_DN=Unable to decode JSON object {0} as a \
+  join result control because it contains an entry that is missing the \
+  required ''{1}'' field.
 INFO_CONTROL_NAME_ADMINISTRATIVE_OPERATION_REQUEST=Administrative Operation \
   Request Control
+ERR_ADMIN_OP_REQUEST_JSON_CONTROL_UNRECOGNIZED_FIELD=Unable to decode JSON \
+  object {0} as an administrative operation request control because the value \
+  has unrecognized field ''{1}''.
 ERR_EXTENDED_SCHEMA_INFO_REQUEST_HAS_VALUE=The provided control cannot be \
   decoded as an extended schema info request control because it has a value.
 INFO_CONTROL_NAME_EXTENDED_SCHEMA_INFO=Extended Schema Info Request Control
@@ -283,6 +457,12 @@
 ERR_GET_SERVER_ID_RESPONSE_MISSING_VALUE=The provided control cannot be \
   decoded as a get server ID response control because it does not have a value.
 INFO_CONTROL_NAME_GET_SERVER_ID_RESPONSE=Get Server ID Response Control
+ERR_GET_SERVER_ID_RESPONSE_JSON_MISSING_SERVER_ID=Unable to decode JSON object \
+  {0} as a get server ID response control because the value is missing the \
+  ''{1}'' field needed to provide the server ID.
+ERR_GET_SERVER_ID_RESPONSE_JSON_UNRECOGNIZED_FIELD=Unable to decode JSON \
+  object {0} as a get server ID response control because the value includes \
+  unrecognized field ''{1}''.
 ERR_ROUTE_TO_SERVER_REQUEST_MISSING_VALUE=The provided control cannot be \
   decoded as a route to server request control because it does not have a \
   value.
@@ -296,6 +476,12 @@
   attempting to decode the provided control as a route to server request \
   control:  {0}
 INFO_CONTROL_NAME_ROUTE_TO_SERVER_REQUEST=Route to Server Request Control
+ERR_ROUTE_TO_SERVER_REQUEST_JSON_MISSING_FIELD=Unable to decode JSON object \
+  {0} as a route to server request control because the value is missing \
+  required field ''{1}''.
+ERR_ROUTE_TO_SERVER_REQUEST_JSON_UNRECOGNIZED_FIELD=Unable to decode JSON \
+  object {0} as a route to server request control because the value includes \
+  unrecognized field ''{1}''.
 ERR_EXCLUDE_BRANCH_MISSING_VALUE=The provided control cannot be decoded as an \
   exclude branch request control because it does not have a value.
 ERR_EXCLUDE_BRANCH_VALUE_NOT_SEQUENCE=The provided control cannot be decoded \
@@ -307,6 +493,18 @@
 ERR_EXCLUDE_BRANCH_ERROR_PARSING_VALUE=An error occurred while attempting to \
   decode the provided control as an exclude branch request control:  {0}
 INFO_CONTROL_NAME_EXCLUDE_BRANCH=Exclude Branch Request Control
+ERR_EXCLUDE_BRANCH_JSON_MISSING_BASE_DNS=Unable to decode JSON object {0} as \
+  an exclude branch request control because the value object is missing the \
+  ''{1}'' field needed to specify the exclude base DNs.
+ERR_EXCLUDE_BRANCH_JSON_EMPTY_BASE_DNS=Unable to decode JSON object {0} as \
+  an exclude branch request control because the value object has an empty set \
+  of base DNs.
+ERR_EXCLUDE_BRANCH_JSON_BASE_DN_NOT_STRING=Unable to decode JSON object {0} \
+  as an exclude branch request control because at least one of the ''{1}'' \
+  values is not a string.
+ERR_EXCLUDE_BRANCH_JSON_CONTROL_UNRECOGNIZED_FIELD=Unable to decode JSON \
+  object {0} as an exclude branch request control because the value object \
+  has unrecognized field ''{1}''.
 ERR_OP_PURPOSE_NO_VALUE=The provided control cannot be decoded as an \
   operation purpose request control because it does not have a value.
 ERR_OP_PURPOSE_VALUE_NOT_SEQUENCE=The provided control cannot be decoded as \
@@ -319,6 +517,13 @@
   decoded as an operation purpose request control because the value sequence \
   contains an element with an unsupported BER type of ''{0}''.
 INFO_CONTROL_NAME_OP_PURPOSE=Operation Purpose Request Control
+ERR_OP_PURPOSE_JSON_MISSING_FIELD=Unable to decode JSON object {0} as an \
+  operation purpose request control because the value does not include any of \
+  the ''{1}'', ''{2}'', ''{3}'', or ''{4}'' fields.  At least one of those \
+  fields must be present.
+ERR_OP_PURPOSE_JSON_UNRECOGNIZED_FIELD=Unable to decode JSON object {0} as an \
+  operation purpose request control because the value includes unrecognized \
+  field ''{1}''.
 ERR_SOFT_DELETE_REQUEST_UNSUPPORTED_VALUE_ELEMENT_TYPE=Unable to decode the \
   provided control as a soft delete request control because the value \
   sequence had an unexpected element with type {0}.
@@ -326,6 +531,12 @@
   control as a soft delete request control because an error occurred while \
   attempting to parse the value:  {0}
 INFO_CONTROL_NAME_SOFT_DELETE_REQUEST=Soft Delete Request Control
+ERR_SOFT_DELETE_REQUEST_JSON_VALUE_MISSING_FIELD=Unable to decode JSON object \
+  {0} as a soft delete request control because the value is missing \
+  required field ''{1}''.
+ERR_SOFT_DELETE_REQUEST_JSON_VALUE_UNRECOGNIZED_FIELD=Unable to decode JSON \
+  object {0} as a soft delete request control because the value includes \
+  unrecognized field ''{1}''.
 ERR_SOFT_DELETE_RESPONSE_NO_VALUE=Unable to decode the provided control as a \
   soft delete response control because it did not have a value.
 ERR_SOFT_DELETE_RESPONSE_VALUE_NOT_DN=Unable to decode the provided control \
@@ -332,6 +543,12 @@
   as a soft delete response control because the value could not be parsed as \
   a valid DN.
 INFO_CONTROL_NAME_SOFT_DELETE_RESPONSE=Soft Delete Response Control
+ERR_SOFT_DELETE_RESPONSE_JSON_MISSING_FIELD=Unable to decode JSON object {0} \
+  as a soft delete response control because the value is missing required \
+  field ''{1}''.
+ERR_SOFT_DELETE_RESPONSE_JSON_UNRECOGNIZED_FIELD=Unable to decode JSON object \
+  {0} as a soft delete response control because the value includes \
+  unrecognized field ''{1}''.
 ERR_HARD_DELETE_REQUEST_UNSUPPORTED_VALUE_ELEMENT_TYPE=Unable to decode the \
   provided control as a hard delete request control because the value \
   sequence had an unexpected element with type {0}.
@@ -354,6 +571,12 @@
   error occurred while attempting to parse the value:  {0}
 INFO_CONTROL_NAME_SOFT_DELETED_ACCESS_REQUEST=Soft-Deleted Entry Access \
   Request Control
+ERR_SOFT_DELETED_ACCESS_REQUEST_JSON_MISSING_FIELD=Unable to decode JSON \
+  object {0} as a soft-deleted entry access request control because the value \
+  is missing required field ''{1}''.
+ERR_SOFT_DELETED_ACCESS_REQUEST_JSON_UNRECOGNIZED_FIELD=Unable to decode JSON \
+  object {0} as a soft-deleted entry access request control because the value \
+  includes unrecognized field ''{1}''.
 ERR_GET_USER_RESOURCE_LIMITS_REQUEST_HAS_VALUE=The provided control cannot be \
   decoded as a get user resource limits request control because it has a value.
 ERR_GET_USER_RESOURCE_LIMITS_REQUEST_CANNOT_DECODE=An error occurred while \
@@ -360,6 +583,13 @@
   attempting to decode the get user resource limits request control value:  {0}
 INFO_CONTROL_NAME_GET_USER_RESOURCE_LIMITS_REQUEST=Get User Resource Limits \
   Request Control
+ERR_GET_USER_RESOURCE_LIMITS_REQUEST_JSON_MISSING_EXCLUDE_GROUPS=Unable to \
+  decode JSON object {0} as a get user resource limits request control \
+  because the value is missing field ''{1}'' needed to indicate whether to \
+  exclude group membership information from the response.
+ERR_GET_USER_RESOURCE_LIMITS_REQUEST_JSON_UNRECOGNIZED_FIELD=Unable to \
+  decode JSON object {0} as a get user resource limits request control \
+  because the value includes unrecognized field ''{1}''.
 ERR_GET_USER_RESOURCE_LIMITS_RESPONSE_MISSING_VALUE=The provided control \
   cannot be decoded as a get user resource limits control because it does not \
   have a value.
@@ -368,6 +598,21 @@
   error was encountered while decoding its value:  {0}
 INF...
 
[truncated message content]

[ldap-sdk-commits] SF.net SVN: ldap-sdk:[1526] trunk

[<di...@us...>]

Revision: 1526
          http://sourceforge.net/p/ldap-sdk/code/1526
Author:   dirmgr
Date:     2022-03-22 00:24:12 +0000 (Tue, 22 Mar 2022)
Log Message:
-----------
Set min & max assurance levels in parallel-update

Fixed an issue with the way the parallel-update tool created
assured replication request controls when an explicit local or
remote assurance level was specified.  Previously, it would only
specify a minimum assurance level without specifying a maximum
level.  If the server was already configured to use assured
replication with a higher assurance level than the client requested,
then the server's higher level would have overridden the level
requested by the client.  The tool will now specify both minimum and
maximum levels to ensure that the requested assurance level is used,
regardless of the server configuration.

Modified Paths:
--------------
    trunk/docs/release-notes.html
    trunk/src/com/unboundid/ldap/sdk/unboundidds/tools/ParallelUpdate.java

Modified: trunk/docs/release-notes.html
===================================================================
--- trunk/docs/release-notes.html	2022-03-16 17:07:58 UTC (rev 1525)
+++ trunk/docs/release-notes.html	2022-03-22 00:24:12 UTC (rev 1526)
@@ -6,9 +6,31 @@
 
               <h2>Release Notes</h2>
 
-              <h3>Version 6.0.4</h3>
+              <h3>Version 6.0.5</h3>
 
               <p>
+                The following changes were made between the 6.0.4 and 6.0.5 releases:
+              </p>
+
+              <ul>
+                <li>
+                  Fixed an issue with the way the parallel-update tool created assured replication
+                  request controls when an explicit local or remote assurance level was specified.
+                  Previously, it would only specify a minimum assurance level without specifying a
+                  maximum level.  If the server was already configured to use assured replication
+                  with a higher assurance level than the client requested, then the server's
+                  higher level would have overridden the level requested by the client.  The tool
+                  will now specify both minimum and maximum levels to ensure that the requested
+                  assurance level is used, regardless of the server configuration.
+                  <br><br>
+                </li>
+              </ul>
+
+              <p></p>
+
+
+
+              <p>
                 The following changes were made between the 6.0.3 and 6.0.4 releases:
               </p>
 

Modified: trunk/src/com/unboundid/ldap/sdk/unboundidds/tools/ParallelUpdate.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/unboundidds/tools/ParallelUpdate.java	2022-03-16 17:07:58 UTC (rev 1525)
+++ trunk/src/com/unboundid/ldap/sdk/unboundidds/tools/ParallelUpdate.java	2022-03-22 00:24:12 UTC (rev 1526)
@@ -1910,8 +1910,8 @@
       }
 
       final AssuredReplicationRequestControl c =
-           new AssuredReplicationRequestControl(true, localLevel, null,
-                remoteLevel, null, timeoutMillis, false);
+           new AssuredReplicationRequestControl(true, localLevel, localLevel,
+                remoteLevel, remoteLevel, timeoutMillis, false);
       addControls.add(c);
       deleteControls.add(c);
       modifyControls.add(c);

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

[ldap-sdk-commits] SF.net SVN: ldap-sdk:[1525] trunk

[<di...@us...>]

Revision: 1525
          http://sourceforge.net/p/ldap-sdk/code/1525
Author:   dirmgr
Date:     2022-03-16 17:07:58 +0000 (Wed, 16 Mar 2022)
Log Message:
-----------
Post-6.0.4 release updates

Updated the LDAP SDK so that new builds will have a version number
of 6.0.5.  Also, captured the public API exposed by the 6.0.4
release to ensure that we preserve backward compatibility with it.

Modified Paths:
--------------
    trunk/tests/unit/src/com/unboundid/ldap/sdk/APITestCase.java
    trunk/version.properties

Added Paths:
-----------
    trunk/resource/public-api-6.0.4.txt

Added: trunk/resource/public-api-6.0.4.txt
===================================================================
--- trunk/resource/public-api-6.0.4.txt	                        (rev 0)
+++ trunk/resource/public-api-6.0.4.txt	2022-03-16 17:07:58 UTC (rev 1525)
@@ -0,0 +1,16428 @@
+@Extensible class com.unboundid.ldap.listener.InMemoryExtendedOperationHandler constructor public com.unboundid.ldap.listener.InMemoryExtendedOperationHandler()
+@Extensible class com.unboundid.ldap.listener.InMemoryExtendedOperationHandler method public abstract com.unboundid.ldap.sdk.ExtendedResult processExtendedOperation(com.unboundid.ldap.listener.InMemoryRequestHandler,int,com.unboundid.ldap.sdk.ExtendedRequest)
+@Extensible class com.unboundid.ldap.listener.InMemoryExtendedOperationHandler method public abstract java.lang.String getExtendedOperationHandlerName()
+@Extensible class com.unboundid.ldap.listener.InMemoryExtendedOperationHandler method public abstract java.util.List<java.lang.String> getSupportedExtendedRequestOIDs()
+@Extensible class com.unboundid.ldap.listener.InMemoryExtendedOperationHandler method public java.lang.String toString()
+@Extensible class com.unboundid.ldap.listener.InMemoryPasswordEncoder constructor protected com.unboundid.ldap.listener.InMemoryPasswordEncoder(java.lang.String,com.unboundid.ldap.listener.PasswordEncoderOutputFormatter)
+@Extensible class com.unboundid.ldap.listener.InMemoryPasswordEncoder method protected abstract boolean passwordMatches(byte[],byte[],com.unboundid.ldap.sdk.ReadOnlyEntry) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.listener.InMemoryPasswordEncoder method protected abstract byte[] encodePassword(byte[],com.unboundid.ldap.sdk.ReadOnlyEntry,java.util.List<com.unboundid.ldap.sdk.Modification>) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.listener.InMemoryPasswordEncoder method protected abstract byte[] extractClearPassword(byte[],com.unboundid.ldap.sdk.ReadOnlyEntry) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.listener.InMemoryPasswordEncoder method protected abstract void ensurePreEncodedPasswordAppearsValid(byte[],com.unboundid.ldap.sdk.ReadOnlyEntry,java.util.List<com.unboundid.ldap.sdk.Modification>) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.listener.InMemoryPasswordEncoder method public abstract void toString(java.lang.StringBuilder)
+@Extensible class com.unboundid.ldap.listener.InMemoryPasswordEncoder method public final boolean clearPasswordMatchesEncodedPassword(com.unboundid.asn1.ASN1OctetString,com.unboundid.asn1.ASN1OctetString,com.unboundid.ldap.sdk.ReadOnlyEntry) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.listener.InMemoryPasswordEncoder method public final boolean passwordStartsWithPrefix(com.unboundid.asn1.ASN1OctetString)
+@Extensible class com.unboundid.ldap.listener.InMemoryPasswordEncoder method public final com.unboundid.asn1.ASN1OctetString encodePassword(com.unboundid.asn1.ASN1OctetString,com.unboundid.ldap.sdk.ReadOnlyEntry,java.util.List<com.unboundid.ldap.sdk.Modification>) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.listener.InMemoryPasswordEncoder method public final com.unboundid.asn1.ASN1OctetString extractClearPasswordFromEncodedPassword(com.unboundid.asn1.ASN1OctetString,com.unboundid.ldap.sdk.ReadOnlyEntry) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.listener.InMemoryPasswordEncoder method public final com.unboundid.ldap.listener.PasswordEncoderOutputFormatter getOutputFormatter()
+@Extensible class com.unboundid.ldap.listener.InMemoryPasswordEncoder method public final java.lang.String getPrefix()
+@Extensible class com.unboundid.ldap.listener.InMemoryPasswordEncoder method public final java.lang.String toString()
+@Extensible class com.unboundid.ldap.listener.InMemoryPasswordEncoder method public final void ensurePreEncodedPasswordAppearsValid(com.unboundid.asn1.ASN1OctetString,com.unboundid.ldap.sdk.ReadOnlyEntry,java.util.List<com.unboundid.ldap.sdk.Modification>) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.listener.InMemorySASLBindHandler constructor public com.unboundid.ldap.listener.InMemorySASLBindHandler()
+@Extensible class com.unboundid.ldap.listener.InMemorySASLBindHandler method public abstract com.unboundid.ldap.sdk.BindResult processSASLBind(com.unboundid.ldap.listener.InMemoryRequestHandler,int,com.unboundid.ldap.sdk.DN,com.unboundid.asn1.ASN1OctetString,java.util.List<com.unboundid.ldap.sdk.Control>)
+@Extensible class com.unboundid.ldap.listener.InMemorySASLBindHandler method public abstract java.lang.String getSASLMechanismName()
+@Extensible class com.unboundid.ldap.listener.InMemorySASLBindHandler method public java.lang.String toString()
+@Extensible class com.unboundid.ldap.listener.LDAPListenerRequestHandler constructor public com.unboundid.ldap.listener.LDAPListenerRequestHandler()
+@Extensible class com.unboundid.ldap.listener.LDAPListenerRequestHandler method public abstract com.unboundid.ldap.listener.LDAPListenerRequestHandler newInstance(com.unboundid.ldap.listener.LDAPListenerClientConnection) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.listener.LDAPListenerRequestHandler method public abstract com.unboundid.ldap.protocol.LDAPMessage processAddRequest(int,com.unboundid.ldap.protocol.AddRequestProtocolOp,java.util.List<com.unboundid.ldap.sdk.Control>)
+@Extensible class com.unboundid.ldap.listener.LDAPListenerRequestHandler method public abstract com.unboundid.ldap.protocol.LDAPMessage processBindRequest(int,com.unboundid.ldap.protocol.BindRequestProtocolOp,java.util.List<com.unboundid.ldap.sdk.Control>)
+@Extensible class com.unboundid.ldap.listener.LDAPListenerRequestHandler method public abstract com.unboundid.ldap.protocol.LDAPMessage processCompareRequest(int,com.unboundid.ldap.protocol.CompareRequestProtocolOp,java.util.List<com.unboundid.ldap.sdk.Control>)
+@Extensible class com.unboundid.ldap.listener.LDAPListenerRequestHandler method public abstract com.unboundid.ldap.protocol.LDAPMessage processDeleteRequest(int,com.unboundid.ldap.protocol.DeleteRequestProtocolOp,java.util.List<com.unboundid.ldap.sdk.Control>)
+@Extensible class com.unboundid.ldap.listener.LDAPListenerRequestHandler method public abstract com.unboundid.ldap.protocol.LDAPMessage processExtendedRequest(int,com.unboundid.ldap.protocol.ExtendedRequestProtocolOp,java.util.List<com.unboundid.ldap.sdk.Control>)
+@Extensible class com.unboundid.ldap.listener.LDAPListenerRequestHandler method public abstract com.unboundid.ldap.protocol.LDAPMessage processModifyDNRequest(int,com.unboundid.ldap.protocol.ModifyDNRequestProtocolOp,java.util.List<com.unboundid.ldap.sdk.Control>)
+@Extensible class com.unboundid.ldap.listener.LDAPListenerRequestHandler method public abstract com.unboundid.ldap.protocol.LDAPMessage processModifyRequest(int,com.unboundid.ldap.protocol.ModifyRequestProtocolOp,java.util.List<com.unboundid.ldap.sdk.Control>)
+@Extensible class com.unboundid.ldap.listener.LDAPListenerRequestHandler method public abstract com.unboundid.ldap.protocol.LDAPMessage processSearchRequest(int,com.unboundid.ldap.protocol.SearchRequestProtocolOp,java.util.List<com.unboundid.ldap.sdk.Control>)
+@Extensible class com.unboundid.ldap.listener.LDAPListenerRequestHandler method public void closeInstance()
+@Extensible class com.unboundid.ldap.listener.LDAPListenerRequestHandler method public void processAbandonRequest(int,com.unboundid.ldap.protocol.AbandonRequestProtocolOp,java.util.List<com.unboundid.ldap.sdk.Control>)
+@Extensible class com.unboundid.ldap.listener.LDAPListenerRequestHandler method public void processUnbindRequest(int,com.unboundid.ldap.protocol.UnbindRequestProtocolOp,java.util.List<com.unboundid.ldap.sdk.Control>)
+@Extensible class com.unboundid.ldap.listener.PasswordEncoderOutputFormatter constructor public com.unboundid.ldap.listener.PasswordEncoderOutputFormatter()
+@Extensible class com.unboundid.ldap.listener.PasswordEncoderOutputFormatter method public abstract byte[] format(byte[]) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.listener.PasswordEncoderOutputFormatter method public abstract byte[] unFormat(byte[]) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.listener.PasswordEncoderOutputFormatter method public abstract void toString(java.lang.StringBuilder)
+@Extensible class com.unboundid.ldap.listener.PasswordEncoderOutputFormatter method public final java.lang.String toString()
+@Extensible class com.unboundid.ldap.listener.interceptor.InMemoryOperationInterceptor constructor public com.unboundid.ldap.listener.interceptor.InMemoryOperationInterceptor()
+@Extensible class com.unboundid.ldap.listener.interceptor.InMemoryOperationInterceptor method public void processAddRequest(com.unboundid.ldap.listener.interceptor.InMemoryInterceptedAddRequest) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.listener.interceptor.InMemoryOperationInterceptor method public void processAddResult(com.unboundid.ldap.listener.interceptor.InMemoryInterceptedAddResult)
+@Extensible class com.unboundid.ldap.listener.interceptor.InMemoryOperationInterceptor method public void processCompareRequest(com.unboundid.ldap.listener.interceptor.InMemoryInterceptedCompareRequest) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.listener.interceptor.InMemoryOperationInterceptor method public void processCompareResult(com.unboundid.ldap.listener.interceptor.InMemoryInterceptedCompareResult)
+@Extensible class com.unboundid.ldap.listener.interceptor.InMemoryOperationInterceptor method public void processDeleteRequest(com.unboundid.ldap.listener.interceptor.InMemoryInterceptedDeleteRequest) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.listener.interceptor.InMemoryOperationInterceptor method public void processDeleteResult(com.unboundid.ldap.listener.interceptor.InMemoryInterceptedDeleteResult)
+@Extensible class com.unboundid.ldap.listener.interceptor.InMemoryOperationInterceptor method public void processExtendedRequest(com.unboundid.ldap.listener.interceptor.InMemoryInterceptedExtendedRequest) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.listener.interceptor.InMemoryOperationInterceptor method public void processExtendedResult(com.unboundid.ldap.listener.interceptor.InMemoryInterceptedExtendedResult)
+@Extensible class com.unboundid.ldap.listener.interceptor.InMemoryOperationInterceptor method public void processIntermediateResponse(com.unboundid.ldap.listener.interceptor.InMemoryInterceptedIntermediateResponse)
+@Extensible class com.unboundid.ldap.listener.interceptor.InMemoryOperationInterceptor method public void processModifyDNRequest(com.unboundid.ldap.listener.interceptor.InMemoryInterceptedModifyDNRequest) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.listener.interceptor.InMemoryOperationInterceptor method public void processModifyDNResult(com.unboundid.ldap.listener.interceptor.InMemoryInterceptedModifyDNResult)
+@Extensible class com.unboundid.ldap.listener.interceptor.InMemoryOperationInterceptor method public void processModifyRequest(com.unboundid.ldap.listener.interceptor.InMemoryInterceptedModifyRequest) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.listener.interceptor.InMemoryOperationInterceptor method public void processModifyResult(com.unboundid.ldap.listener.interceptor.InMemoryInterceptedModifyResult)
+@Extensible class com.unboundid.ldap.listener.interceptor.InMemoryOperationInterceptor method public void processSASLBindRequest(com.unboundid.ldap.listener.interceptor.InMemoryInterceptedSASLBindRequest) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.listener.interceptor.InMemoryOperationInterceptor method public void processSASLBindResult(com.unboundid.ldap.listener.interceptor.InMemoryInterceptedSASLBindResult)
+@Extensible class com.unboundid.ldap.listener.interceptor.InMemoryOperationInterceptor method public void processSearchEntry(com.unboundid.ldap.listener.interceptor.InMemoryInterceptedSearchEntry)
+@Extensible class com.unboundid.ldap.listener.interceptor.InMemoryOperationInterceptor method public void processSearchReference(com.unboundid.ldap.listener.interceptor.InMemoryInterceptedSearchReference)
+@Extensible class com.unboundid.ldap.listener.interceptor.InMemoryOperationInterceptor method public void processSearchRequest(com.unboundid.ldap.listener.interceptor.InMemoryInterceptedSearchRequest) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.listener.interceptor.InMemoryOperationInterceptor method public void processSearchResult(com.unboundid.ldap.listener.interceptor.InMemoryInterceptedSearchResult)
+@Extensible class com.unboundid.ldap.listener.interceptor.InMemoryOperationInterceptor method public void processSimpleBindRequest(com.unboundid.ldap.listener.interceptor.InMemoryInterceptedSimpleBindRequest) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.listener.interceptor.InMemoryOperationInterceptor method public void processSimpleBindResult(com.unboundid.ldap.listener.interceptor.InMemoryInterceptedSimpleBindResult)
+@Extensible class com.unboundid.ldap.matchingrules.AcceptAllSimpleMatchingRule constructor public com.unboundid.ldap.matchingrules.AcceptAllSimpleMatchingRule()
+@Extensible class com.unboundid.ldap.matchingrules.AcceptAllSimpleMatchingRule method public abstract com.unboundid.asn1.ASN1OctetString normalize(com.unboundid.asn1.ASN1OctetString)
+@Extensible class com.unboundid.ldap.matchingrules.AcceptAllSimpleMatchingRule method public abstract com.unboundid.asn1.ASN1OctetString normalizeSubstring(com.unboundid.asn1.ASN1OctetString,byte)
+@Extensible class com.unboundid.ldap.matchingrules.AcceptAllSimpleMatchingRule method public boolean matchesAnyValue(com.unboundid.asn1.ASN1OctetString,com.unboundid.asn1.ASN1OctetString[])
+@Extensible class com.unboundid.ldap.matchingrules.AcceptAllSimpleMatchingRule method public boolean matchesSubstring(com.unboundid.asn1.ASN1OctetString,com.unboundid.asn1.ASN1OctetString,com.unboundid.asn1.ASN1OctetString[],com.unboundid.asn1.ASN1OctetString)
+@Extensible class com.unboundid.ldap.matchingrules.AcceptAllSimpleMatchingRule method public boolean valuesMatch(com.unboundid.asn1.ASN1OctetString,com.unboundid.asn1.ASN1OctetString)
+@Extensible class com.unboundid.ldap.matchingrules.AcceptAllSimpleMatchingRule method public int compareValues(com.unboundid.asn1.ASN1OctetString,com.unboundid.asn1.ASN1OctetString)
+@Extensible class com.unboundid.ldap.matchingrules.MatchingRule constructor protected com.unboundid.ldap.matchingrules.MatchingRule()
+@Extensible class com.unboundid.ldap.matchingrules.MatchingRule field public static final byte SUBSTRING_TYPE_SUBANY
+@Extensible class com.unboundid.ldap.matchingrules.MatchingRule field public static final byte SUBSTRING_TYPE_SUBFINAL
+@Extensible class com.unboundid.ldap.matchingrules.MatchingRule field public static final byte SUBSTRING_TYPE_SUBINITIAL
+@Extensible class com.unboundid.ldap.matchingrules.MatchingRule method public abstract boolean matchesSubstring(com.unboundid.asn1.ASN1OctetString,com.unboundid.asn1.ASN1OctetString,com.unboundid.asn1.ASN1OctetString[],com.unboundid.asn1.ASN1OctetString) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.matchingrules.MatchingRule method public abstract boolean valuesMatch(com.unboundid.asn1.ASN1OctetString,com.unboundid.asn1.ASN1OctetString) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.matchingrules.MatchingRule method public abstract com.unboundid.asn1.ASN1OctetString normalize(com.unboundid.asn1.ASN1OctetString) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.matchingrules.MatchingRule method public abstract com.unboundid.asn1.ASN1OctetString normalizeSubstring(com.unboundid.asn1.ASN1OctetString,byte) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.matchingrules.MatchingRule method public abstract int compareValues(com.unboundid.asn1.ASN1OctetString,com.unboundid.asn1.ASN1OctetString) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.matchingrules.MatchingRule method public abstract java.lang.String getEqualityMatchingRuleName()
+@Extensible class com.unboundid.ldap.matchingrules.MatchingRule method public abstract java.lang.String getEqualityMatchingRuleOID()
+@Extensible class com.unboundid.ldap.matchingrules.MatchingRule method public abstract java.lang.String getOrderingMatchingRuleName()
+@Extensible class com.unboundid.ldap.matchingrules.MatchingRule method public abstract java.lang.String getOrderingMatchingRuleOID()
+@Extensible class com.unboundid.ldap.matchingrules.MatchingRule method public abstract java.lang.String getSubstringMatchingRuleName()
+@Extensible class com.unboundid.ldap.matchingrules.MatchingRule method public abstract java.lang.String getSubstringMatchingRuleOID()
+@Extensible class com.unboundid.ldap.matchingrules.MatchingRule method public boolean matchesAnyValue(com.unboundid.asn1.ASN1OctetString,com.unboundid.asn1.ASN1OctetString[]) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.matchingrules.MatchingRule method public java.lang.String getEqualityMatchingRuleNameOrOID()
+@Extensible class com.unboundid.ldap.matchingrules.MatchingRule method public java.lang.String getOrderingMatchingRuleNameOrOID()
+@Extensible class com.unboundid.ldap.matchingrules.MatchingRule method public java.lang.String getSubstringMatchingRuleNameOrOID()
+@Extensible class com.unboundid.ldap.matchingrules.MatchingRule method public static com.unboundid.ldap.matchingrules.MatchingRule getDefaultEqualityMatchingRule()
+@Extensible class com.unboundid.ldap.matchingrules.MatchingRule method public static com.unboundid.ldap.matchingrules.MatchingRule getDefaultOrderingMatchingRule()
+@Extensible class com.unboundid.ldap.matchingrules.MatchingRule method public static com.unboundid.ldap.matchingrules.MatchingRule getDefaultSubstringMatchingRule()
+@Extensible class com.unboundid.ldap.matchingrules.MatchingRule method public static com.unboundid.ldap.matchingrules.MatchingRule selectEqualityMatchingRule(java.lang.String)
+@Extensible class com.unboundid.ldap.matchingrules.MatchingRule method public static com.unboundid.ldap.matchingrules.MatchingRule selectEqualityMatchingRule(java.lang.String,com.unboundid.ldap.sdk.schema.Schema)
+@Extensible class com.unboundid.ldap.matchingrules.MatchingRule method public static com.unboundid.ldap.matchingrules.MatchingRule selectEqualityMatchingRule(java.lang.String,java.lang.String,com.unboundid.ldap.sdk.schema.Schema)
+@Extensible class com.unboundid.ldap.matchingrules.MatchingRule method public static com.unboundid.ldap.matchingrules.MatchingRule selectMatchingRuleForSyntax(java.lang.String)
+@Extensible class com.unboundid.ldap.matchingrules.MatchingRule method public static com.unboundid.ldap.matchingrules.MatchingRule selectOrderingMatchingRule(java.lang.String)
+@Extensible class com.unboundid.ldap.matchingrules.MatchingRule method public static com.unboundid.ldap.matchingrules.MatchingRule selectOrderingMatchingRule(java.lang.String,com.unboundid.ldap.sdk.schema.Schema)
+@Extensible class com.unboundid.ldap.matchingrules.MatchingRule method public static com.unboundid.ldap.matchingrules.MatchingRule selectOrderingMatchingRule(java.lang.String,java.lang.String,com.unboundid.ldap.sdk.schema.Schema)
+@Extensible class com.unboundid.ldap.matchingrules.MatchingRule method public static com.unboundid.ldap.matchingrules.MatchingRule selectSubstringMatchingRule(java.lang.String)
+@Extensible class com.unboundid.ldap.matchingrules.MatchingRule method public static com.unboundid.ldap.matchingrules.MatchingRule selectSubstringMatchingRule(java.lang.String,com.unboundid.ldap.sdk.schema.Schema)
+@Extensible class com.unboundid.ldap.matchingrules.MatchingRule method public static com.unboundid.ldap.matchingrules.MatchingRule selectSubstringMatchingRule(java.lang.String,java.lang.String,com.unboundid.ldap.sdk.schema.Schema)
+@Extensible class com.unboundid.ldap.matchingrules.SimpleMatchingRule constructor public com.unboundid.ldap.matchingrules.SimpleMatchingRule()
+@Extensible class com.unboundid.ldap.matchingrules.SimpleMatchingRule method public boolean matchesAnyValue(com.unboundid.asn1.ASN1OctetString,com.unboundid.asn1.ASN1OctetString[]) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.matchingrules.SimpleMatchingRule method public boolean matchesSubstring(com.unboundid.asn1.ASN1OctetString,com.unboundid.asn1.ASN1OctetString,com.unboundid.asn1.ASN1OctetString[],com.unboundid.asn1.ASN1OctetString) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.matchingrules.SimpleMatchingRule method public boolean valuesMatch(com.unboundid.asn1.ASN1OctetString,com.unboundid.asn1.ASN1OctetString) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.matchingrules.SimpleMatchingRule method public int compareValues(com.unboundid.asn1.ASN1OctetString,com.unboundid.asn1.ASN1OctetString) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.BindRequest constructor protected com.unboundid.ldap.sdk.BindRequest(com.unboundid.ldap.sdk.Control[])
+@Extensible class com.unboundid.ldap.sdk.BindRequest field protected static final com.unboundid.asn1.ASN1Integer VERSION_ELEMENT
+@Extensible class com.unboundid.ldap.sdk.BindRequest method protected abstract com.unboundid.ldap.sdk.BindResult process(com.unboundid.ldap.sdk.LDAPConnection,int) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.BindRequest method protected com.unboundid.ldap.sdk.LDAPResult process(com.unboundid.ldap.sdk.LDAPConnection,int) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.BindRequest method public abstract com.unboundid.ldap.sdk.BindRequest duplicate()
+@Extensible class com.unboundid.ldap.sdk.BindRequest method public abstract com.unboundid.ldap.sdk.BindRequest duplicate(com.unboundid.ldap.sdk.Control[])
+@Extensible class com.unboundid.ldap.sdk.BindRequest method public abstract java.lang.String getBindType()
+@Extensible class com.unboundid.ldap.sdk.BindRequest method public com.unboundid.ldap.sdk.BindRequest getRebindRequest(java.lang.String,int)
+@Extensible class com.unboundid.ldap.sdk.BindRequest method public com.unboundid.ldap.sdk.LDAPRequest duplicate()
+@Extensible class com.unboundid.ldap.sdk.BindRequest method public com.unboundid.ldap.sdk.LDAPRequest duplicate(com.unboundid.ldap.sdk.Control[])
+@Extensible class com.unboundid.ldap.sdk.BindRequest method public final com.unboundid.ldap.sdk.OperationType getOperationType()
+@Extensible class com.unboundid.ldap.sdk.BindResult constructor protected com.unboundid.ldap.sdk.BindResult(com.unboundid.ldap.sdk.BindResult)
+@Extensible class com.unboundid.ldap.sdk.BindResult constructor public com.unboundid.ldap.sdk.BindResult(com.unboundid.ldap.sdk.LDAPException)
+@Extensible class com.unboundid.ldap.sdk.BindResult constructor public com.unboundid.ldap.sdk.BindResult(com.unboundid.ldap.sdk.LDAPResult)
+@Extensible class com.unboundid.ldap.sdk.BindResult constructor public com.unboundid.ldap.sdk.BindResult(int,com.unboundid.ldap.sdk.ResultCode,java.lang.String,java.lang.String,java.lang.String[],com.unboundid.ldap.sdk.Control[])
+@Extensible class com.unboundid.ldap.sdk.BindResult constructor public com.unboundid.ldap.sdk.BindResult(int,com.unboundid.ldap.sdk.ResultCode,java.lang.String,java.lang.String,java.lang.String[],com.unboundid.ldap.sdk.Control[],com.unboundid.asn1.ASN1OctetString)
+@Extensible class com.unboundid.ldap.sdk.BindResult method public com.unboundid.asn1.ASN1OctetString getServerSASLCredentials()
+@Extensible class com.unboundid.ldap.sdk.BindResult method public void toString(java.lang.StringBuilder)
+@Extensible class com.unboundid.ldap.sdk.Control constructor protected com.unboundid.ldap.sdk.Control()
+@Extensible class com.unboundid.ldap.sdk.Control constructor protected com.unboundid.ldap.sdk.Control(com.unboundid.ldap.sdk.Control)
+@Extensible class com.unboundid.ldap.sdk.Control constructor public com.unboundid.ldap.sdk.Control(java.lang.String)
+@Extensible class com.unboundid.ldap.sdk.Control constructor public com.unboundid.ldap.sdk.Control(java.lang.String,boolean)
+@Extensible class com.unboundid.ldap.sdk.Control constructor public com.unboundid.ldap.sdk.Control(java.lang.String,boolean,com.unboundid.asn1.ASN1OctetString)
+@Extensible class com.unboundid.ldap.sdk.Control method public final boolean equals(java.lang.Object)
+@Extensible class com.unboundid.ldap.sdk.Control method public final boolean hasValue()
+@Extensible class com.unboundid.ldap.sdk.Control method public final boolean isCritical()
+@Extensible class com.unboundid.ldap.sdk.Control method public final com.unboundid.asn1.ASN1OctetString getValue()
+@Extensible class com.unboundid.ldap.sdk.Control method public final com.unboundid.asn1.ASN1Sequence encode()
+@Extensible class com.unboundid.ldap.sdk.Control method public final int hashCode()
+@Extensible class com.unboundid.ldap.sdk.Control method public final java.lang.String getOID()
+@Extensible class com.unboundid.ldap.sdk.Control method public final void writeTo(com.unboundid.asn1.ASN1Buffer)
+@Extensible class com.unboundid.ldap.sdk.Control method public java.lang.String getControlName()
+@Extensible class com.unboundid.ldap.sdk.Control method public java.lang.String toString()
+@Extensible class com.unboundid.ldap.sdk.Control method public static com.unboundid.asn1.ASN1Sequence encodeControls(com.unboundid.ldap.sdk.Control[])
+@Extensible class com.unboundid.ldap.sdk.Control method public static com.unboundid.ldap.sdk.Control decode(com.unboundid.asn1.ASN1Sequence) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.Control method public static com.unboundid.ldap.sdk.Control decode(java.lang.String,boolean,com.unboundid.asn1.ASN1OctetString) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.Control method public static com.unboundid.ldap.sdk.Control readFrom(com.unboundid.asn1.ASN1StreamReader) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.Control method public static com.unboundid.ldap.sdk.Control[] decodeControls(com.unboundid.asn1.ASN1Sequence) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.Control method public static void deregisterDecodeableControl(java.lang.String)
+@Extensible class com.unboundid.ldap.sdk.Control method public static void registerDecodeableControl(java.lang.String,com.unboundid.ldap.sdk.DecodeableControl)
+@Extensible class com.unboundid.ldap.sdk.Control method public static void registerDecodeableControl(java.lang.String,java.lang.String)
+@Extensible class com.unboundid.ldap.sdk.Control method public void toString(java.lang.StringBuilder)
+@Extensible class com.unboundid.ldap.sdk.ExtendedRequest constructor protected com.unboundid.ldap.sdk.ExtendedRequest(com.unboundid.ldap.sdk.ExtendedRequest)
+@Extensible class com.unboundid.ldap.sdk.ExtendedRequest constructor public com.unboundid.ldap.sdk.ExtendedRequest(java.lang.String)
+@Extensible class com.unboundid.ldap.sdk.ExtendedRequest constructor public com.unboundid.ldap.sdk.ExtendedRequest(java.lang.String,com.unboundid.asn1.ASN1OctetString)
+@Extensible class com.unboundid.ldap.sdk.ExtendedRequest constructor public com.unboundid.ldap.sdk.ExtendedRequest(java.lang.String,com.unboundid.asn1.ASN1OctetString,com.unboundid.ldap.sdk.Control[])
+@Extensible class com.unboundid.ldap.sdk.ExtendedRequest constructor public com.unboundid.ldap.sdk.ExtendedRequest(java.lang.String,com.unboundid.ldap.sdk.Control[])
+@Extensible class com.unboundid.ldap.sdk.ExtendedRequest field protected static final byte TYPE_EXTENDED_REQUEST_OID
+@Extensible class com.unboundid.ldap.sdk.ExtendedRequest field protected static final byte TYPE_EXTENDED_REQUEST_VALUE
+@Extensible class com.unboundid.ldap.sdk.ExtendedRequest method protected com.unboundid.ldap.sdk.ExtendedResult process(com.unboundid.ldap.sdk.LDAPConnection,int) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.ExtendedRequest method protected com.unboundid.ldap.sdk.LDAPResult process(com.unboundid.ldap.sdk.LDAPConnection,int) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.ExtendedRequest method public com.unboundid.asn1.ASN1Element encodeProtocolOp()
+@Extensible class com.unboundid.ldap.sdk.ExtendedRequest method public com.unboundid.ldap.sdk.ExtendedRequest duplicate()
+@Extensible class com.unboundid.ldap.sdk.ExtendedRequest method public com.unboundid.ldap.sdk.ExtendedRequest duplicate(com.unboundid.ldap.sdk.Control[])
+@Extensible class com.unboundid.ldap.sdk.ExtendedRequest method public com.unboundid.ldap.sdk.LDAPRequest duplicate()
+@Extensible class com.unboundid.ldap.sdk.ExtendedRequest method public com.unboundid.ldap.sdk.LDAPRequest duplicate(com.unboundid.ldap.sdk.Control[])
+@Extensible class com.unboundid.ldap.sdk.ExtendedRequest method public final boolean hasValue()
+@Extensible class com.unboundid.ldap.sdk.ExtendedRequest method public final byte getProtocolOpType()
+@Extensible class com.unboundid.ldap.sdk.ExtendedRequest method public final com.unboundid.asn1.ASN1OctetString getValue()
+@Extensible class com.unboundid.ldap.sdk.ExtendedRequest method public final com.unboundid.ldap.sdk.OperationType getOperationType()
+@Extensible class com.unboundid.ldap.sdk.ExtendedRequest method public final int getLastMessageID()
+@Extensible class com.unboundid.ldap.sdk.ExtendedRequest method public final java.lang.String getOID()
+@Extensible class com.unboundid.ldap.sdk.ExtendedRequest method public final void writeTo(com.unboundid.asn1.ASN1Buffer)
+@Extensible class com.unboundid.ldap.sdk.ExtendedRequest method public java.lang.String getExtendedRequestName()
+@Extensible class com.unboundid.ldap.sdk.ExtendedRequest method public void toCode(java.util.List<java.lang.String>,java.lang.String,int,boolean)
+@Extensible class com.unboundid.ldap.sdk.ExtendedRequest method public void toString(java.lang.StringBuilder)
+@Extensible class com.unboundid.ldap.sdk.ExtendedResult constructor protected com.unboundid.ldap.sdk.ExtendedResult(com.unboundid.ldap.sdk.ExtendedResult)
+@Extensible class com.unboundid.ldap.sdk.ExtendedResult constructor public com.unboundid.ldap.sdk.ExtendedResult(com.unboundid.ldap.sdk.LDAPException)
+@Extensible class com.unboundid.ldap.sdk.ExtendedResult constructor public com.unboundid.ldap.sdk.ExtendedResult(com.unboundid.ldap.sdk.LDAPResult)
+@Extensible class com.unboundid.ldap.sdk.ExtendedResult constructor public com.unboundid.ldap.sdk.ExtendedResult(int,com.unboundid.ldap.sdk.ResultCode,java.lang.String,java.lang.String,java.lang.String[],java.lang.String,com.unboundid.asn1.ASN1OctetString,com.unboundid.ldap.sdk.Control[])
+@Extensible class com.unboundid.ldap.sdk.ExtendedResult method public final boolean hasValue()
+@Extensible class com.unboundid.ldap.sdk.ExtendedResult method public final com.unboundid.asn1.ASN1OctetString getValue()
+@Extensible class com.unboundid.ldap.sdk.ExtendedResult method public final java.lang.String getOID()
+@Extensible class com.unboundid.ldap.sdk.ExtendedResult method public java.lang.String getExtendedResultName()
+@Extensible class com.unboundid.ldap.sdk.ExtendedResult method public java.lang.String toString()
+@Extensible class com.unboundid.ldap.sdk.ExtendedResult method public void toString(java.lang.StringBuilder)
+@Extensible class com.unboundid.ldap.sdk.IntermediateResponse constructor protected com.unboundid.ldap.sdk.IntermediateResponse(com.unboundid.ldap.sdk.IntermediateResponse)
+@Extensible class com.unboundid.ldap.sdk.IntermediateResponse constructor public com.unboundid.ldap.sdk.IntermediateResponse(int,java.lang.String,com.unboundid.asn1.ASN1OctetString)
+@Extensible class com.unboundid.ldap.sdk.IntermediateResponse constructor public com.unboundid.ldap.sdk.IntermediateResponse(int,java.lang.String,com.unboundid.asn1.ASN1OctetString,com.unboundid.ldap.sdk.Control[])
+@Extensible class com.unboundid.ldap.sdk.IntermediateResponse constructor public com.unboundid.ldap.sdk.IntermediateResponse(java.lang.String,com.unboundid.asn1.ASN1OctetString)
+@Extensible class com.unboundid.ldap.sdk.IntermediateResponse constructor public com.unboundid.ldap.sdk.IntermediateResponse(java.lang.String,com.unboundid.asn1.ASN1OctetString,com.unboundid.ldap.sdk.Control[])
+@Extensible class com.unboundid.ldap.sdk.IntermediateResponse field protected static final byte TYPE_INTERMEDIATE_RESPONSE_OID
+@Extensible class com.unboundid.ldap.sdk.IntermediateResponse field protected static final byte TYPE_INTERMEDIATE_RESPONSE_VALUE
+@Extensible class com.unboundid.ldap.sdk.IntermediateResponse method public final com.unboundid.asn1.ASN1OctetString getValue()
+@Extensible class com.unboundid.ldap.sdk.IntermediateResponse method public final com.unboundid.ldap.sdk.Control getControl(java.lang.String)
+@Extensible class com.unboundid.ldap.sdk.IntermediateResponse method public final com.unboundid.ldap.sdk.Control[] getControls()
+@Extensible class com.unboundid.ldap.sdk.IntermediateResponse method public final java.lang.String getOID()
+@Extensible class com.unboundid.ldap.sdk.IntermediateResponse method public final java.lang.String toString()
+@Extensible class com.unboundid.ldap.sdk.IntermediateResponse method public int getMessageID()
+@Extensible class com.unboundid.ldap.sdk.IntermediateResponse method public java.lang.String getIntermediateResponseName()
+@Extensible class com.unboundid.ldap.sdk.IntermediateResponse method public java.lang.String valueToString()
+@Extensible class com.unboundid.ldap.sdk.IntermediateResponse method public void toString(java.lang.StringBuilder)
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionLogger constructor public com.unboundid.ldap.sdk.LDAPConnectionLogger()
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionLogger method public void logAbandonRequest(com.unboundid.ldap.sdk.LDAPConnectionInfo,int,int,java.util.List<com.unboundid.ldap.sdk.Control>)
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionLogger method public void logAddRequest(com.unboundid.ldap.sdk.LDAPConnectionInfo,int,com.unboundid.ldap.sdk.ReadOnlyAddRequest)
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionLogger method public void logAddResult(com.unboundid.ldap.sdk.LDAPConnectionInfo,int,com.unboundid.ldap.sdk.LDAPResult)
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionLogger method public void logBindRequest(com.unboundid.ldap.sdk.LDAPConnectionInfo,int,com.unboundid.ldap.sdk.SASLBindRequest)
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionLogger method public void logBindRequest(com.unboundid.ldap.sdk.LDAPConnectionInfo,int,com.unboundid.ldap.sdk.SimpleBindRequest)
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionLogger method public void logBindResult(com.unboundid.ldap.sdk.LDAPConnectionInfo,int,com.unboundid.ldap.sdk.BindResult)
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionLogger method public void logCompareRequest(com.unboundid.ldap.sdk.LDAPConnectionInfo,int,com.unboundid.ldap.sdk.ReadOnlyCompareRequest)
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionLogger method public void logCompareResult(com.unboundid.ldap.sdk.LDAPConnectionInfo,int,com.unboundid.ldap.sdk.LDAPResult)
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionLogger method public void logConnect(com.unboundid.ldap.sdk.LDAPConnectionInfo,java.lang.String,java.net.InetAddress,int)
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionLogger method public void logConnectFailure(com.unboundid.ldap.sdk.LDAPConnectionInfo,java.lang.String,int,com.unboundid.ldap.sdk.LDAPException)
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionLogger method public void logDeleteRequest(com.unboundid.ldap.sdk.LDAPConnectionInfo,int,com.unboundid.ldap.sdk.ReadOnlyDeleteRequest)
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionLogger method public void logDeleteResult(com.unboundid.ldap.sdk.LDAPConnectionInfo,int,com.unboundid.ldap.sdk.LDAPResult)
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionLogger method public void logDisconnect(com.unboundid.ldap.sdk.LDAPConnectionInfo,java.lang.String,int,com.unboundid.ldap.sdk.DisconnectType,java.lang.String,java.lang.Throwable)
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionLogger method public void logExtendedRequest(com.unboundid.ldap.sdk.LDAPConnectionInfo,int,com.unboundid.ldap.sdk.ExtendedRequest)
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionLogger method public void logExtendedResult(com.unboundid.ldap.sdk.LDAPConnectionInfo,int,com.unboundid.ldap.sdk.ExtendedResult)
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionLogger method public void logIntermediateResponse(com.unboundid.ldap.sdk.LDAPConnectionInfo,int,com.unboundid.ldap.sdk.IntermediateResponse)
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionLogger method public void logModifyDNRequest(com.unboundid.ldap.sdk.LDAPConnectionInfo,int,com.unboundid.ldap.sdk.ReadOnlyModifyDNRequest)
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionLogger method public void logModifyDNResult(com.unboundid.ldap.sdk.LDAPConnectionInfo,int,com.unboundid.ldap.sdk.LDAPResult)
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionLogger method public void logModifyRequest(com.unboundid.ldap.sdk.LDAPConnectionInfo,int,com.unboundid.ldap.sdk.ReadOnlyModifyRequest)
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionLogger method public void logModifyResult(com.unboundid.ldap.sdk.LDAPConnectionInfo,int,com.unboundid.ldap.sdk.LDAPResult)
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionLogger method public void logSearchEntry(com.unboundid.ldap.sdk.LDAPConnectionInfo,int,com.unboundid.ldap.sdk.SearchResultEntry)
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionLogger method public void logSearchReference(com.unboundid.ldap.sdk.LDAPConnectionInfo,int,com.unboundid.ldap.sdk.SearchResultReference)
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionLogger method public void logSearchRequest(com.unboundid.ldap.sdk.LDAPConnectionInfo,int,com.unboundid.ldap.sdk.ReadOnlySearchRequest)
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionLogger method public void logSearchResult(com.unboundid.ldap.sdk.LDAPConnectionInfo,int,com.unboundid.ldap.sdk.SearchResult)
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionLogger method public void logUnbindRequest(com.unboundid.ldap.sdk.LDAPConnectionInfo,int,java.util.List<com.unboundid.ldap.sdk.Control>)
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionPoolHealthCheck constructor public com.unboundid.ldap.sdk.LDAPConnectionPoolHealthCheck()
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionPoolHealthCheck method public final java.lang.String toString()
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionPoolHealthCheck method public void ensureConnectionValidAfterAuthentication(com.unboundid.ldap.sdk.LDAPConnection,com.unboundid.ldap.sdk.BindResult) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionPoolHealthCheck method public void ensureConnectionValidAfterException(com.unboundid.ldap.sdk.LDAPConnection,com.unboundid.ldap.sdk.LDAPException) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionPoolHealthCheck method public void ensureConnectionValidForCheckout(com.unboundid.ldap.sdk.LDAPConnection) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionPoolHealthCheck method public void ensureConnectionValidForContinuedUse(com.unboundid.ldap.sdk.LDAPConnection) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionPoolHealthCheck method public void ensureConnectionValidForRelease(com.unboundid.ldap.sdk.LDAPConnection) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionPoolHealthCheck method public void ensureNewConnectionValid(com.unboundid.ldap.sdk.LDAPConnection) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionPoolHealthCheck method public void performPoolMaintenance(com.unboundid.ldap.sdk.AbstractConnectionPool)
+@Extensible class com.unboundid.ldap.sdk.LDAPConnectionPoolHealthCheck method public void toString(java.lang.StringBuilder)
+@Extensible class com.unboundid.ldap.sdk.LDAPRequest constructor protected com.unboundid.ldap.sdk.LDAPRequest(com.unboundid.ldap.sdk.Control[])
+@Extensible class com.unboundid.ldap.sdk.LDAPRequest method public abstract com.unboundid.ldap.sdk.OperationType getOperationType()
+@Extensible class com.unboundid.ldap.sdk.LDAPRequest method public abstract int getLastMessageID()
+@Extensible class com.unboundid.ldap.sdk.LDAPRequest method public abstract void toString(java.lang.StringBuilder)
+@Extensible class com.unboundid.ldap.sdk.LDAPRequest method public final boolean followReferrals(com.unboundid.ldap.sdk.LDAPConnection)
+@Extensible class com.unboundid.ldap.sdk.LDAPRequest method public final boolean hasControl()
+@Extensible class com.unboundid.ldap.sdk.LDAPRequest method public final boolean hasControl(java.lang.String)
+@Extensible class com.unboundid.ldap.sdk.LDAPRequest method public final com.unboundid.ldap.sdk.Control getControl(java.lang.String)
+@Extensible class com.unboundid.ldap.sdk.LDAPRequest method public final com.unboundid.ldap.sdk.Control[] getControls()
+@Extensible class com.unboundid.ldap.sdk.LDAPRequest method public final com.unboundid.ldap.sdk.IntermediateResponseListener getIntermediateResponseListener()
+@Extensible class com.unboundid.ldap.sdk.LDAPRequest method public final com.unboundid.ldap.sdk.ReferralConnector getReferralConnector(com.unboundid.ldap.sdk.LDAPConnection)
+@Extensible class com.unboundid.ldap.sdk.LDAPRequest method public final java.util.List<com.unboundid.ldap.sdk.Control> getControlList()
+@Extensible class com.unboundid.ldap.sdk.LDAPRequest method public final long getResponseTimeoutMillis(com.unboundid.ldap.sdk.LDAPConnection)
+@Extensible class com.unboundid.ldap.sdk.LDAPRequest method public final void setFollowReferrals(java.lang.Boolean)
+@Extensible class com.unboundid.ldap.sdk.LDAPRequest method public final void setIntermediateResponseListener(com.unboundid.ldap.sdk.IntermediateResponseListener)
+@Extensible class com.unboundid.ldap.sdk.LDAPRequest method public final void setReferralConnector(com.unboundid.ldap.sdk.ReferralConnector)
+@Extensible class com.unboundid.ldap.sdk.LDAPRequest method public final void setResponseTimeoutMillis(long)
+@Extensible class com.unboundid.ldap.sdk.LDAPRequest method public java.lang.String toString()
+@Extensible class com.unboundid.ldap.sdk.LDAPResult constructor protected com.unboundid.ldap.sdk.LDAPResult(com.unboundid.ldap.sdk.LDAPResult)
+@Extensible class com.unboundid.ldap.sdk.LDAPResult constructor public com.unboundid.ldap.sdk.LDAPResult(int,com.unboundid.ldap.sdk.ResultCode)
+@Extensible class com.unboundid.ldap.sdk.LDAPResult constructor public com.unboundid.ldap.sdk.LDAPResult(int,com.unboundid.ldap.sdk.ResultCode,java.lang.String,java.lang.String,java.lang.String[],com.unboundid.ldap.sdk.Control[])
+@Extensible class com.unboundid.ldap.sdk.LDAPResult constructor public com.unboundid.ldap.sdk.LDAPResult(int,com.unboundid.ldap.sdk.ResultCode,java.lang.String,java.lang.String,java.util.List<java.lang.String>,java.util.List<com.unboundid.ldap.sdk.Control>)
+@Extensible class com.unboundid.ldap.sdk.LDAPResult method public final boolean hasResponseControl()
+@Extensible class com.unboundid.ldap.sdk.LDAPResult method public final boolean hasResponseControl(java.lang.String)
+@Extensible class com.unboundid.ldap.sdk.LDAPResult method public final com.unboundid.ldap.sdk.Control getResponseControl(java.lang.String)
+@Extensible class com.unboundid.ldap.sdk.LDAPResult method public final com.unboundid.ldap.sdk.Control[] getResponseControls()
+@Extensible class com.unboundid.ldap.sdk.LDAPResult method public final com.unboundid.ldap.sdk.OperationType getOperationType()
+@Extensible class com.unboundid.ldap.sdk.LDAPResult method public final com.unboundid.ldap.sdk.ResultCode getResultCode()
+@Extensible class com.unboundid.ldap.sdk.LDAPResult method public final int getMessageID()
+@Extensible class com.unboundid.ldap.sdk.LDAPResult method public final java.lang.String getDiagnosticMessage()
+@Extensible class com.unboundid.ldap.sdk.LDAPResult method public final java.lang.String getMatchedDN()
+@Extensible class com.unboundid.ldap.sdk.LDAPResult method public final java.lang.String[] getReferralURLs()
+@Extensible class com.unboundid.ldap.sdk.LDAPResult method public java.lang.String getResultString()
+@Extensible class com.unboundid.ldap.sdk.LDAPResult method public java.lang.String toString()
+@Extensible class com.unboundid.ldap.sdk.LDAPResult method public void toString(java.lang.StringBuilder)
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection constructor public com.unboundid.ldap.sdk.MockableLDAPConnection(com.unboundid.ldap.sdk.LDAPConnection)
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.BindResult bind(com.unboundid.ldap.sdk.BindRequest) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.BindResult bind(java.lang.String,java.lang.String) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.CompareResult compare(com.unboundid.ldap.sdk.CompareRequest) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.CompareResult compare(com.unboundid.ldap.sdk.ReadOnlyCompareRequest) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.CompareResult compare(java.lang.String,java.lang.String,java.lang.String) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.ExtendedResult processExtendedOperation(com.unboundid.ldap.sdk.ExtendedRequest) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.ExtendedResult processExtendedOperation(java.lang.String) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.ExtendedResult processExtendedOperation(java.lang.String,com.unboundid.asn1.ASN1OctetString) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.LDAPResult add(com.unboundid.ldap.sdk.AddRequest) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.LDAPResult add(com.unboundid.ldap.sdk.Entry) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.LDAPResult add(com.unboundid.ldap.sdk.ReadOnlyAddRequest) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.LDAPResult add(java.lang.String,com.unboundid.ldap.sdk.Attribute...) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.LDAPResult add(java.lang.String,java.util.Collection<com.unboundid.ldap.sdk.Attribute>) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.LDAPResult add(java.lang.String...) throws com.unboundid.ldif.LDIFException,com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.LDAPResult delete(com.unboundid.ldap.sdk.DeleteRequest) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.LDAPResult delete(com.unboundid.ldap.sdk.ReadOnlyDeleteRequest) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.LDAPResult delete(java.lang.String) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.LDAPResult modify(com.unboundid.ldap.sdk.ModifyRequest) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.LDAPResult modify(com.unboundid.ldap.sdk.ReadOnlyModifyRequest) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.LDAPResult modify(java.lang.String,com.unboundid.ldap.sdk.Modification) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.LDAPResult modify(java.lang.String,com.unboundid.ldap.sdk.Modification...) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.LDAPResult modify(java.lang.String,java.util.List<com.unboundid.ldap.sdk.Modification>) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.LDAPResult modify(java.lang.String...) throws com.unboundid.ldif.LDIFException,com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.LDAPResult modifyDN(com.unboundid.ldap.sdk.ModifyDNRequest) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.LDAPResult modifyDN(com.unboundid.ldap.sdk.ReadOnlyModifyDNRequest) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.LDAPResult modifyDN(java.lang.String,java.lang.String,boolean) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.LDAPResult modifyDN(java.lang.String,java.lang.String,boolean,java.lang.String) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.RootDSE getRootDSE() throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.SearchResult search(com.unboundid.ldap.sdk.ReadOnlySearchRequest) throws com.unboundid.ldap.sdk.LDAPSearchException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.SearchResult search(com.unboundid.ldap.sdk.SearchRequest) throws com.unboundid.ldap.sdk.LDAPSearchException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.SearchResult search(com.unboundid.ldap.sdk.SearchResultListener,java.lang.String,com.unboundid.ldap.sdk.SearchScope,com.unboundid.ldap.sdk.DereferencePolicy,int,int,boolean,com.unboundid.ldap.sdk.Filter,java.lang.String...) throws com.unboundid.ldap.sdk.LDAPSearchException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.SearchResult search(com.unboundid.ldap.sdk.SearchResultListener,java.lang.String,com.unboundid.ldap.sdk.SearchScope,com.unboundid.ldap.sdk.DereferencePolicy,int,int,boolean,java.lang.String,java.lang.String...) throws com.unboundid.ldap.sdk.LDAPSearchException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.SearchResult search(com.unboundid.ldap.sdk.SearchResultListener,java.lang.String,com.unboundid.ldap.sdk.SearchScope,com.unboundid.ldap.sdk.Filter,java.lang.String...) throws com.unboundid.ldap.sdk.LDAPSearchException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.SearchResult search(com.unboundid.ldap.sdk.SearchResultListener,java.lang.String,com.unboundid.ldap.sdk.SearchScope,java.lang.String,java.lang.String...) throws com.unboundid.ldap.sdk.LDAPSearchException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.SearchResult search(java.lang.String,com.unboundid.ldap.sdk.SearchScope,com.unboundid.ldap.sdk.DereferencePolicy,int,int,boolean,com.unboundid.ldap.sdk.Filter,java.lang.String...) throws com.unboundid.ldap.sdk.LDAPSearchException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.SearchResult search(java.lang.String,com.unboundid.ldap.sdk.SearchScope,com.unboundid.ldap.sdk.DereferencePolicy,int,int,boolean,java.lang.String,java.lang.String...) throws com.unboundid.ldap.sdk.LDAPSearchException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.SearchResult search(java.lang.String,com.unboundid.ldap.sdk.SearchScope,com.unboundid.ldap.sdk.Filter,java.lang.String...) throws com.unboundid.ldap.sdk.LDAPSearchException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.SearchResult search(java.lang.String,com.unboundid.ldap.sdk.SearchScope,java.lang.String,java.lang.String...) throws com.unboundid.ldap.sdk.LDAPSearchException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.SearchResultEntry getEntry(java.lang.String) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.SearchResultEntry getEntry(java.lang.String,java.lang.String...) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.SearchResultEntry searchForEntry(com.unboundid.ldap.sdk.ReadOnlySearchRequest) throws com.unboundid.ldap.sdk.LDAPSearchException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.SearchResultEntry searchForEntry(com.unboundid.ldap.sdk.SearchRequest) throws com.unboundid.ldap.sdk.LDAPSearchException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.SearchResultEntry searchForEntry(java.lang.String,com.unboundid.ldap.sdk.SearchScope,com.unboundid.ldap.sdk.DereferencePolicy,int,boolean,com.unboundid.ldap.sdk.Filter,java.lang.String...) throws com.unboundid.ldap.sdk.LDAPSearchException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.SearchResultEntry searchForEntry(java.lang.String,com.unboundid.ldap.sdk.SearchScope,com.unboundid.ldap.sdk.DereferencePolicy,int,boolean,java.lang.String,java.lang.String...) throws com.unboundid.ldap.sdk.LDAPSearchException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.SearchResultEntry searchForEntry(java.lang.String,com.unboundid.ldap.sdk.SearchScope,com.unboundid.ldap.sdk.Filter,java.lang.String...) throws com.unboundid.ldap.sdk.LDAPSearchException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.SearchResultEntry searchForEntry(java.lang.String,com.unboundid.ldap.sdk.SearchScope,java.lang.String,java.lang.String...) throws com.unboundid.ldap.sdk.LDAPSearchException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.schema.Schema getSchema() throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public com.unboundid.ldap.sdk.schema.Schema getSchema(java.lang.String) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public final com.unboundid.ldap.sdk.LDAPConnection getWrappedConnection()
+@Extensible class com.unboundid.ldap.sdk.MockableLDAPConnection method public void close()
+@Extensible class com.unboundid.ldap.sdk.NameResolver constructor protected com.unboundid.ldap.sdk.NameResolver()
+@Extensible class com.unboundid.ldap.sdk.NameResolver method public abstract void toString(java.lang.StringBuilder)
+@Extensible class com.unboundid.ldap.sdk.NameResolver method public final java.lang.String toString()
+@Extensible class com.unboundid.ldap.sdk.NameResolver method public java.lang.String getCanonicalHostName(java.net.InetAddress)
+@Extensible class com.unboundid.ldap.sdk.NameResolver method public java.lang.String getHostName(java.net.InetAddress)
+@Extensible class com.unboundid.ldap.sdk.NameResolver method public java.net.InetAddress getByName(java.lang.String) throws java.net.UnknownHostException,java.lang.SecurityException
+@Extensible class com.unboundid.ldap.sdk.NameResolver method public java.net.InetAddress getLocalHost() throws java.net.UnknownHostException,java.lang.SecurityException
+@Extensible class com.unboundid.ldap.sdk.NameResolver method public java.net.InetAddress getLoopbackAddress()
+@Extensible class com.unboundid.ldap.sdk.NameResolver method public java.net.InetAddress[] getAllByName(java.lang.String) throws java.net.UnknownHostException,java.lang.SecurityException
+@Extensible class com.unboundid.ldap.sdk.NameResolver method public static void setJVMSuccessfulLookupCacheTTLSeconds(int)
+@Extensible class com.unboundid.ldap.sdk.NameResolver method public static void setJVMUnsuccessfulLookupCacheTTLSeconds(int)
+@Extensible class com.unboundid.ldap.sdk.PasswordProvider constructor public com.unboundid.ldap.sdk.PasswordProvider()
+@Extensible class com.unboundid.ldap.sdk.PasswordProvider method public abstract byte[] getPasswordBytes() throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.SASLBindRequest constructor protected com.unboundid.ldap.sdk.SASLBindRequest(com.unboundid.ldap.sdk.Control[])
+@Extensible class com.unboundid.ldap.sdk.SASLBindRequest field protected static final byte CRED_TYPE_SASL
+@Extensible class com.unboundid.ldap.sdk.SASLBindRequest method protected final com.unboundid.ldap.sdk.BindResult sendBindRequest(com.unboundid.ldap.sdk.LDAPConnection,java.lang.String,com.unboundid.asn1.ASN1OctetString,com.unboundid.ldap.sdk.Control[],long) throws com.unboundid.ldap.sdk.LDAPException
+@Extensible class com.unboundid.ldap.sdk.SASLBindRequest method protected final com.unboundid.ldap.sdk.BindResult sendMessage(com.unboundid.ldap.sdk.LDAPConnection,com.unboundid.ldap.protocol.LDAPMessage,long) throws com.unboundid.ldap.sdk....
 
[truncated message content]

[ldap-sdk-commits] SF.net SVN: ldap-sdk:[1524] tags/6.0.4/

[<di...@us...>]

Revision: 1524
          http://sourceforge.net/p/ldap-sdk/code/1524
Author:   dirmgr
Date:     2022-03-16 17:05:57 +0000 (Wed, 16 Mar 2022)
Log Message:
-----------
Create a tag for the 6.0.4 release

Added Paths:
-----------
    tags/6.0.4/

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

[ldap-sdk-commits] SF.net SVN: ldap-sdk:[1523] trunk/src/com/unboundid/ldap/sdk/unboundidds/ logs/v2/syntax/LogFieldSyntax.java

[<di...@us...>]

Revision: 1523
          http://sourceforge.net/p/ldap-sdk/code/1523
Author:   dirmgr
Date:     2022-03-15 15:48:18 +0000 (Tue, 15 Mar 2022)
Log Message:
-----------
Use base64url when generating log tokens

Updated the log field syntax logic used to generate tokens so that
it uses the base64url variant rather than standard base64, and
therefore uses '-' and '_' instead of '+' and '/'.  This is at least
better when tokenizing value components for DNs, where the plus sign
needs to be escaped because it may otherwise indicate the start of
the next RDN component.

Modified Paths:
--------------
    trunk/src/com/unboundid/ldap/sdk/unboundidds/logs/v2/syntax/LogFieldSyntax.java

Modified: trunk/src/com/unboundid/ldap/sdk/unboundidds/logs/v2/syntax/LogFieldSyntax.java
===================================================================
--- trunk/src/com/unboundid/ldap/sdk/unboundidds/logs/v2/syntax/LogFieldSyntax.java	2022-03-14 22:54:34 UTC (rev 1522)
+++ trunk/src/com/unboundid/ldap/sdk/unboundidds/logs/v2/syntax/LogFieldSyntax.java	2022-03-15 15:48:18 UTC (rev 1523)
@@ -1158,9 +1158,14 @@
       final byte[] digestBytes = sha256(concatBuffer);
 
 
-      // Base64-encode a portion of the digest to use as the token.
+      // Base64-encode a portion of the digest to use as the token.  Use the
+      // base64url syntax to avoid including the plus and slash characters,
+      // which might cause issues in certain cases (for example, the plus sign
+      // needs to be escaped in DNs because it would otherwise represent the
+      // start of the next component of a multivalued RDN).
       buffer.append(TOKEN_PREFIX_STRING);
-      Base64.encode(digestBytes, 0, TOKEN_DIGEST_BYTES_LENGTH, buffer);
+      Base64.urlEncode(digestBytes, 0, TOKEN_DIGEST_BYTES_LENGTH, buffer,
+           false);
       buffer.append(TOKEN_SUFFIX_STRING);
     }
     finally

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

[ldap-sdk-commits] SF.net SVN: ldap-sdk:[1522] trunk

[<di...@us...>]

Revision: 1522
          http://sourceforge.net/p/ldap-sdk/code/1522
Author:   dirmgr
Date:     2022-03-14 22:54:34 +0000 (Mon, 14 Mar 2022)
Log Message:
-----------
Allow SSL-prefixed cipher suites on IBM JVMs

Updated the logic used to select the default set of supported cipher
suites to no longer exclude suites starting with "SSL_" by default
on JVMs with a vendor string that includes "IBM".  IBM JVMs appear
to use the "SSL_" prefix for some or all cipher suites, including
those that are not associated with a legacy SSL protocol.  Also,
added a TLSCipherSuiteSelector.setAllowSSLPrefixedSuites method that
can be used to override the default behavior as needed.

Modified Paths:
--------------
    trunk/docs/release-notes.html
    trunk/src/com/unboundid/util/ssl/TLSCipherSuiteSelector.java
    trunk/tests/unit/src/com/unboundid/util/ssl/TLSCipherSuiteSelectorTestCase.java

Modified: trunk/docs/release-notes.html
===================================================================
--- trunk/docs/release-notes.html	2022-03-14 16:06:43 UTC (rev 1521)
+++ trunk/docs/release-notes.html	2022-03-14 22:54:34 UTC (rev 1522)
@@ -40,6 +40,16 @@
                 </li>
 
                 <li>
+                  Updated the logic used to select the default set of supported cipher suites to
+                  no longer exclude suites starting with "SSL_" by default on JVMs with a vendor
+                  string that includes "IBM".  IBM JVMs appear to use the "SSL_" prefix for some
+                  or all cipher suites, including those that are not associated with a legacy SSL
+                  protocol.  Also, added a TLSCipherSuiteSelector.setAllowSSLPrefixedSuites
+                  method that can be used to override the default behavior as needed.
+                  <br><br>
+                </li>
+
+                <li>
                   Updated the LDIF reader to support reading modifications with values read files
                   referenced by URL.  This was previously supported when reading LDIF entries or
                   add change records, but support for reading modification values from files had

Modified: trunk/src/com/unboundid/util/ssl/TLSCipherSuiteSelector.java
===================================================================
--- trunk/src/com/unboundid/util/ssl/TLSCipherSuiteSelector.java	2022-03-14 16:06:43 UTC (rev 1521)
+++ trunk/src/com/unboundid/util/ssl/TLSCipherSuiteSelector.java	2022-03-14 22:54:34 UTC (rev 1522)
@@ -84,9 +84,14 @@
  * TLS cipher suites is as follows:
  * <UL>
  *   <LI>
- *     Only cipher suites that use the TLS protocol will be recommended.  Legacy
- *     SSL suites will not be recommended, nor will any suites that use an
- *     unrecognized protocol.
+ *     In most JVMs, only cipher suites that use the TLS protocol will be
+ *     recommended (that is, suites that use a prefix of "TLS_"), and legacy SSL
+ *     suites (those that use a prefix of "SSL_") will not be recommended, nor
+ *     will any suites that use an unrecognized protocol.  Note that this
+ *     restriction will not be enforced for JVMs in which the vendor string
+ *     contains "IBM" (as they tend to use "SSL_" prefixes for most or all
+ *     cipher suites), or if the {@link #PROPERTY_ALLOW_SSL_PREFIX} system
+ *     property is set to {@code true}.
  *   </LI>
  *
  *   <LI>
@@ -176,6 +181,21 @@
 
 
   /**
+   * The name of a system property
+   * (com.unboundid.util.ssl.TLSCipherSuiteSelector.allowSSLPrefix) that can be
+   * used to indicate whether to recommend cipher suites that use a prefix of
+   * "SSL_" rather than "TLS_".  If this is not specified, then the default
+   * behavior will be to disable all suites with an "SSL_" prefix for all
+   * non-IBM JVMs, but to allow them for JVMs in which the vendor string
+   * contains "IBM", as they are known to use "SSL_" prefixes even for suites
+   * that are only in use in conjunction with TLS protocols.
+   */
+  @NotNull public static final String PROPERTY_ALLOW_SSL_PREFIX =
+       TLSCipherSuiteSelector.class.getName() + ".allowSSLPrefix";
+
+
+
+  /**
    * A flag that indicates whether to allow the RSA key exchange algorithm.
    */
   @NotNull private static final AtomicBoolean ALLOW_RSA_KEY_EXCHANGE =
@@ -192,6 +212,15 @@
 
 
 
+  /**
+   * A flag that indicates whether to allow cipher suites that use a prefix of
+   * "SSL_".
+   */
+  @NotNull private static final AtomicBoolean ALLOW_SSL_PREFIX =
+       new AtomicBoolean(false);
+
+
+
   static
   {
     final boolean allowRSA;
@@ -218,8 +247,35 @@
       allowSHA1 = false;
     }
 
+    final boolean allowSSLPrefix;
+    final String allowSSLPrefixPropertyValue =
+         StaticUtils.getSystemProperty(PROPERTY_ALLOW_SSL_PREFIX);
+    if (allowSSLPrefixPropertyValue != null)
+    {
+      allowSSLPrefix = allowSSLPrefixPropertyValue.equalsIgnoreCase("true");
+    }
+    else
+    {
+      final String javaVendorString =
+           StaticUtils.getSystemProperty("java.vendor");
+      final String jvmVendorString =
+           StaticUtils.getSystemProperty("java.vm.vendor");
+      if (((javaVendorString != null) &&
+              javaVendorString.toUpperCase().contains("IBM")) ||
+          ((jvmVendorString != null) &&
+              jvmVendorString.toUpperCase().contains("IBM")))
+      {
+        allowSSLPrefix = true;
+      }
+      else
+      {
+        allowSSLPrefix = false;
+      }
+    }
+
     ALLOW_RSA_KEY_EXCHANGE.set(allowRSA);
     ALLOW_SHA_1.set(allowSHA1);
+    ALLOW_SSL_PREFIX.set(allowSSLPrefix);
   }
 
 
@@ -540,7 +596,7 @@
   static ObjectPair<SortedSet<String>,SortedMap<String,List<String>>>
        selectCipherSuites(@NotNull final String[] cipherSuiteArray)
   {
-    return selectCipherSuites(cipherSuiteArray, false);
+    return selectCipherSuites(cipherSuiteArray, ALLOW_SSL_PREFIX.get());
   }
 
 
@@ -578,7 +634,6 @@
     final SortedMap<String,List<String>> nonRecommendedMap =
          new TreeMap<>(TLSCipherSuiteComparator.getInstance());
 
-    boolean anyTLSSuitesFound = false;
     for (final String cipherSuiteName : cipherSuiteArray)
     {
       String name =
@@ -603,12 +658,8 @@
       }
       else if (name.startsWith("TLS_") || name.startsWith("SSL_"))
       {
-        if (name.startsWith("TLS_"))
+        if (name.startsWith("SSL_"))
         {
-          anyTLSSuitesFound = true;
-        }
-        else
-        {
           name = "TLS_" + name.substring(4);
         }
 
@@ -794,15 +845,6 @@
       }
     }
 
-    if (recommendedSet.isEmpty() && (! anyTLSSuitesFound) &&
-         (! includeSSLSuites))
-    {
-      // We didn't find any suite names starting with "TLS_".  Assume that the
-      // JVM only reports suites that start with "SSL_" and try again, allowing
-      // those suites.
-      return selectCipherSuites(cipherSuiteArray, true);
-    }
-
     return new ObjectPair<>(recommendedSet, nonRecommendedMap);
   }
 
@@ -1042,6 +1084,40 @@
 
 
   /**
+   * Indicates whether cipher suites whose names start with "SSL_" should be
+   * recommended by default.
+   *
+   * @return  {@code true} if cipher suites prefixed with either "SSL_" or
+   *          "TLS_" should be recommended by default, or {@code false} if only
+   *          suites prefixed with "TLS_" should be recommended by default.
+   */
+  public static boolean allowSSLPrefixedSuites()
+  {
+    return ALLOW_SSL_PREFIX.get();
+  }
+
+
+
+  /**
+   * Specifies whether cipher suites whose names start with "SSL_" should be
+   * recommended by default.
+   *
+   * @param  allowSSLPrefix  Indicates whether cipher suites whose names start
+   *                         with "SSL_" should be recommended by default.  If
+   *                         this is {@code true}, then suites prefixed with
+   *                         either "TLS_" or "SSL_" may be recommended.  If
+   *                         this is {@code false}, then only suites prefixed
+   *                         with "TLS_" may be recommended.
+   */
+  public static void setAllowSSLPrefixedSuites(final boolean allowSSLPrefix)
+  {
+    ALLOW_SSL_PREFIX.set(allowSSLPrefix);
+    recompute();
+  }
+
+
+
+  /**
    * Retrieves the static instance of this TLS cipher suite selector.
    *
    * @return  The static instance of this TLS cipher suite selector.

Modified: trunk/tests/unit/src/com/unboundid/util/ssl/TLSCipherSuiteSelectorTestCase.java
===================================================================
--- trunk/tests/unit/src/com/unboundid/util/ssl/TLSCipherSuiteSelectorTestCase.java	2022-03-14 16:06:43 UTC (rev 1521)
+++ trunk/tests/unit/src/com/unboundid/util/ssl/TLSCipherSuiteSelectorTestCase.java	2022-03-14 22:54:34 UTC (rev 1522)
@@ -197,6 +197,26 @@
     {
       assertFalse(cipherSuite.endsWith("_SHA"));
     }
+
+
+    final boolean defaultAllowSSLPrefix =
+         TLSCipherSuiteSelector.allowSSLPrefixedSuites();
+
+    TLSCipherSuiteSelector.setAllowSSLPrefixedSuites(true);
+    assertTrue(TLSCipherSuiteSelector.allowSSLPrefixedSuites());
+    TLSCipherSuiteSelector.getRecommendedCipherSuites();
+
+    TLSCipherSuiteSelector.setAllowSSLPrefixedSuites(false);
+    assertFalse(TLSCipherSuiteSelector.allowSSLPrefixedSuites());
+    for (final String cipherSuite :
+         TLSCipherSuiteSelector.getRecommendedCipherSuites())
+    {
+      assertFalse(cipherSuite.toUpperCase().startsWith("SSL_"));
+    }
+
+    TLSCipherSuiteSelector.setAllowSSLPrefixedSuites(defaultAllowSSLPrefix);
+    assertEquals(TLSCipherSuiteSelector.allowSSLPrefixedSuites(),
+         defaultAllowSSLPrefix);
   }
 
 

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

[ldap-sdk-commits] SF.net SVN: ldap-sdk:[1521] trunk

[<di...@us...>]

Revision: 1521
          http://sourceforge.net/p/ldap-sdk/code/1521
Author:   dirmgr
Date:     2022-03-14 16:06:43 +0000 (Mon, 14 Mar 2022)
Log Message:
-----------
Support jssecacerts in JVM-default trust manager

Fixed an issue in the JVM-default trust manager implementation in
which it did not properly look for a trust store file named
"jssecacerts" in accordance with the JSSE specification.  It had
previously only looked for a file named "cacerts".

Modified Paths:
--------------
    trunk/docs/release-notes.html
    trunk/messages/unboundid-ldapsdk-ssl.properties
    trunk/src/com/unboundid/util/ssl/JVMDefaultTrustManager.java
    trunk/tests/unit/src/com/unboundid/util/ssl/JVMDefaultTrustManagerTestCase.java

Modified: trunk/docs/release-notes.html
===================================================================
--- trunk/docs/release-notes.html	2022-03-06 19:18:59 UTC (rev 1520)
+++ trunk/docs/release-notes.html	2022-03-14 16:06:43 UTC (rev 1521)
@@ -32,6 +32,14 @@
                 </li>
 
                 <li>
+                  Fixed an issue in the JVM-default trust manager implementation in which it did
+                  not properly look for a trust store file named "jssecacerts" in accordance with
+                  the JSSE specification.  It had previously only looked for a file named
+                  "cacerts".
+                  <br><br>
+                </li>
+
+                <li>
                   Updated the LDIF reader to support reading modifications with values read files
                   referenced by URL.  This was previously supported when reading LDIF entries or
                   add change records, but support for reading modification values from files had

Modified: trunk/messages/unboundid-ldapsdk-ssl.properties
===================================================================
--- trunk/messages/unboundid-ldapsdk-ssl.properties	2022-03-06 19:18:59 UTC (rev 1520)
+++ trunk/messages/unboundid-ldapsdk-ssl.properties	2022-03-14 16:06:43 UTC (rev 1521)
@@ -172,8 +172,8 @@
 ERR_JVM_DEFAULT_TRUST_MANAGER_CANNOT_ERROR_LOADING_KEYSTORE=Unable to parse \
   the contents of file ''{0}'' as a key store:  {1}
 ERR_JVM_DEFAULT_TRUST_MANAGER_CACERTS_NOT_FOUND_NO_EXCEPTION=Unable to locate \
-  the cacerts key store file containing the JVM''s default set of trusted \
-  issuers.
+  the jssecacerts or cacerts key store file containing the JVM''s default set \
+  of trusted issuers.
 ERR_JVM_DEFAULT_TRUST_MANAGER_CACERTS_NOT_FOUND_WITH_EXCEPTION=Unable to \
   locate a valid key store file containing the JVM''s default set of trusted \
   issuers.  One or more errors were encountered during processing.

Modified: trunk/src/com/unboundid/util/ssl/JVMDefaultTrustManager.java
===================================================================
--- trunk/src/com/unboundid/util/ssl/JVMDefaultTrustManager.java	2022-03-06 19:18:59 UTC (rev 1520)
+++ trunk/src/com/unboundid/util/ssl/JVMDefaultTrustManager.java	2022-03-14 16:06:43 UTC (rev 1521)
@@ -77,11 +77,19 @@
 
 /**
  * This class provides an implementation of a trust manager that relies on the
- * JVM's default set of trusted issuers.  This is generally found in the
- * {@code jre/lib/security/cacerts} or {@code lib/security/cacerts} file in the
- * Java installation (in both Sun/Oracle and IBM-based JVMs), but if neither of
- * those files exist (or if they cannot be parsed as a JKS or PKCS#12 keystore),
- * then we will search for the file below the Java home directory.
+ * JVM's default set of trusted issuers.
+ * <BR><BR>
+ * This implementation will first look for the trust store in the following
+ * locations within the Java installation, in the following order:
+ * <OL>
+ *   <LI>{@code lib/security/jssecacerts}</LI>
+ *   <LI>{@code jre/lib/security/jssecacerts}</LI>
+ *   <LI>{@code lib/security/cacerts}</LI>
+ *   <LI>{@code jre/lib/security/cacerts}</LI>
+ * </OL>
+ * If none of those files exist (or if they cannot be parsed as a JKS or PKCS
+ * #12 key store), then we will search for a {@code jssecacerts} or
+ * {@code cacerts} file below the Java home directory.
  */
 @NotMutable()
 @ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
@@ -462,6 +470,10 @@
                       @NotNull final File javaHomeDirectory)
           throws CertificateException
   {
+    final File libSecurityJSSECACerts = StaticUtils.constructPath(
+         javaHomeDirectory, "lib", "security", "jssecacerts");
+    final File jreLibSecurityJSSECACerts = StaticUtils.constructPath(
+         javaHomeDirectory, "jre", "lib", "security", "jssecacerts");
     final File libSecurityCACerts = StaticUtils.constructPath(javaHomeDirectory,
          "lib", "security", "cacerts");
     final File jreLibSecurityCACerts = StaticUtils.constructPath(
@@ -468,7 +480,7 @@
          javaHomeDirectory, "jre", "lib", "security", "cacerts");
 
     final ArrayList<File> tryFirstFiles =
-         new ArrayList<>(2 * FILE_EXTENSIONS.length + 2);
+         new ArrayList<>(4 * FILE_EXTENSIONS.length + 2);
     tryFirstFiles.add(libSecurityCACerts);
     tryFirstFiles.add(jreLibSecurityCACerts);
 
@@ -475,6 +487,10 @@
     for (final String extension : FILE_EXTENSIONS)
     {
       tryFirstFiles.add(
+           new File(libSecurityJSSECACerts.getAbsolutePath() + extension));
+      tryFirstFiles.add(
+           new File(jreLibSecurityJSSECACerts.getAbsolutePath() + extension));
+      tryFirstFiles.add(
            new File(libSecurityCACerts.getAbsolutePath() + extension));
       tryFirstFiles.add(
            new File(jreLibSecurityCACerts.getAbsolutePath() + extension));
@@ -561,7 +577,7 @@
     {
       if (f.isDirectory())
       {
-        final ObjectPair<KeyStore,File> p =searchForKeyStore(f, exceptions);
+        final ObjectPair<KeyStore,File> p = searchForKeyStore(f, exceptions);
         if (p != null)
         {
           return p;
@@ -570,7 +586,7 @@
       else
       {
         final String lowerName = StaticUtils.toLowerCase(f.getName());
-        if (lowerName.equals("cacerts"))
+        if (lowerName.equals("jssecacerts") || lowerName.equals("cacerts"))
         {
           try
           {
@@ -587,7 +603,8 @@
         {
           for (final String extension : FILE_EXTENSIONS)
           {
-            if (lowerName.equals("cacerts" + extension))
+            if (lowerName.equals("jssecacerts" + extension) ||
+                 lowerName.equals("cacerts" + extension))
             {
               try
               {

Modified: trunk/tests/unit/src/com/unboundid/util/ssl/JVMDefaultTrustManagerTestCase.java
===================================================================
--- trunk/tests/unit/src/com/unboundid/util/ssl/JVMDefaultTrustManagerTestCase.java	2022-03-06 19:18:59 UTC (rev 1520)
+++ trunk/tests/unit/src/com/unboundid/util/ssl/JVMDefaultTrustManagerTestCase.java	2022-03-14 16:06:43 UTC (rev 1521)
@@ -284,10 +284,36 @@
   public Iterator<Object[]> getValidTestPaths()
          throws Exception
   {
-    final ArrayList<Object[]> paths = new ArrayList<>(15);
+    final ArrayList<Object[]> paths = new ArrayList<>();
 
     paths.add(new Object[]
     {
+      new String[] { "lib", "security", "jssecacerts" }
+    });
+
+    for (final String extension : JVMDefaultTrustManager.FILE_EXTENSIONS)
+    {
+      paths.add(new Object[]
+      {
+        new String[] { "lib", "security", "jssecacerts" + extension }
+      });
+    }
+
+    paths.add(new Object[]
+    {
+      new String[] { "jre", "lib", "security", "jssecacerts" }
+    });
+
+    for (final String extension : JVMDefaultTrustManager.FILE_EXTENSIONS)
+    {
+      paths.add(new Object[]
+      {
+        new String[] { "jre", "lib", "security", "jssecacerts" + extension }
+      });
+    }
+
+    paths.add(new Object[]
+    {
       new String[] { "lib", "security", "cacerts" }
     });
 
@@ -314,6 +340,19 @@
 
     paths.add(new Object[]
     {
+      new String[] { "some", "unexpected", "dir", "jssecacerts" }
+    });
+
+    for (final String extension : JVMDefaultTrustManager.FILE_EXTENSIONS)
+    {
+      paths.add(new Object[]
+      {
+        new String[] { "some", "unexpected", "dir", "jssecacerts" + extension }
+      });
+    }
+
+    paths.add(new Object[]
+    {
       new String[] { "some", "unexpected", "dir", "cacerts" }
     });
 

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.