From e3a8cbfda97bf65295f18ef0618fd0e6b31f138a Mon Sep 17 00:00:00 2001
From: surovenko <98164430+surovenko@users.noreply.github.com>
Date: Thu, 29 Aug 2024 14:37:33 +0200
Subject: [PATCH] ConnectionString javadoc (#84)

* ConnectionString javadoc

* fixes by review

* fix javadoc

* fix unit test

* (2) fix unit test
---
 src/one/nio/net/ConnectionString.java      | 25 ++++++++++++++++++++++
 test/one/nio/net/ConnectionStringTest.java | 13 +++++++++++
 2 files changed, 38 insertions(+)

diff --git a/src/one/nio/net/ConnectionString.java b/src/one/nio/net/ConnectionString.java
index 43387c9..93fe648 100755
--- a/src/one/nio/net/ConnectionString.java
+++ b/src/one/nio/net/ConnectionString.java
@@ -32,6 +32,31 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
+/**
+ * Available HTTP params for configure directly in ConnectionString url:
+ * <ul>
+ * <li>keepalive            {@code true}</li>
+ * <li>bufferSize           {@code 8000}</li>
+ * <li>timeout              {@code 3000}</li>
+ * <li>readTimeout          {@code 3000}</li>
+ * <li>connectTimeout       {@code 1000}</li>
+ * <li>fifo                 {@code false}</li>
+ * <li>jmx                  {@code false}</li>
+ * <li>clientMinPoolSize    {@code 0}</li>
+ * <li>clientMaxPoolSize    {@code 5000}</li>
+ * <li>schedulingPolicy     {@code OTHER}</li>
+ * <li>tos                  {@code 0}</li>
+ * <li>recvBuf              {@code 0}</li>
+ * <li>sendBuf              {@code 0}</li>
+ * <li>backlog              {@code 128}</li>
+ * <li>selectors            {@code 0}</li>
+ * <li>minWorkers           {@code 0}</li>
+ * <li>maxWorkers           {@code 0}</li>
+ * <li>queueTime            {@code 0}</li>
+ * <li>closeSessions        {@code false}</li>
+ * <li>threadPriority       {@code Thread.NORM_PRIORITY}</li>
+ * </ul>
+ */
 public class ConnectionString {
     private static final Pattern INTERFACE_PATTERN = Pattern.compile("\\{(.+)\\}");
     private static final Map<String, Integer> WELL_KNOWN_PORTS = new HashMap<>();
diff --git a/test/one/nio/net/ConnectionStringTest.java b/test/one/nio/net/ConnectionStringTest.java
index baf4ba2..24d59c0 100755
--- a/test/one/nio/net/ConnectionStringTest.java
+++ b/test/one/nio/net/ConnectionStringTest.java
@@ -49,6 +49,19 @@ public void testConnectionStrings() {
         assertEquals("?", conn.getStringParam("question"));
         assertEquals(345, conn.getIntParam("int", 0));
 
+        conn = new ConnectionString("https://example.com?str=s&empty=&int=123");
+        assertEquals("example.com", conn.getHost());
+        assertEquals(443, conn.getPort());
+        assertEquals("?str=s&empty=&int=123", conn.getPath());
+        assertEquals("s", conn.getStringParam("str"));
+        assertEquals("", conn.getStringParam("empty", "def"));
+        assertEquals(123, conn.getIntParam("int", 0));
+
+        conn = new ConnectionString("https://example.com/somePath");
+        assertEquals("example.com", conn.getHost());
+        assertEquals(443, conn.getPort());
+        assertEquals("/somePath", conn.getPath());
+
         conn = new ConnectionString("socket://[::1]:12345?:=true");
         assertEquals("[::1]", conn.getHost());
         assertEquals(12345, conn.getPort());