docs updated,

modules export added, Executors added to scale concurrent connections, Handled.java notification class added to single the request was already handled
KirstenAli · Dec 28, 2024 · a451e93 · a451e93
1 parent dd5b4b3
commit a451e93
Show file tree

Hide file tree

Showing 54 changed files with 4,271 additions and 235 deletions.
diff --git a/README.md b/README.md
@@ -19,7 +19,23 @@ This tutorial provides an overview of REST API endpoints using the Ra framework.
 
 ---
 
-### Start a web server and return an object with a single line of Java
+## Defining an Endpoint
+
+When using Ra, you can define an endpoint with the following syntax:
+
+```java
+verb("/endpoint", request -> {
+    // Do something cool with the request
+    // For example, parse data into an object, access query parameters, path variables, files, or form data, etc.
+
+    // Then return an object or a Path to a resource
+    return new MyObject();
+});
+```
+
+---
+
+### Start a web server, register an endpoint, and return a JSON response with a single line of Java
 ```java
 get("/getPerson/{id}", _ -> new Person("Alice", 30));
 ```

diff --git a/docs/allclasses-index.html b/docs/allclasses-index.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (22) on Sat Dec 28 00:05:57 GMT 2024 -->
+<!-- Generated by javadoc (22) on Sat Dec 28 17:51:30 GMT 2024 -->
 <title>All Classes and Interfaces</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
@@ -26,7 +26,7 @@
 <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
 <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
 <ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
-<li><a href="index.html">Overview</a></li>
+<li><a href="org.racore/module-summary.html">Module</a></li>
 <li>Package</li>
 <li>Class</li>
 <li><a href="overview-tree.html">Tree</a></li>
@@ -54,36 +54,38 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
 <div class="summary-table two-column-summary" aria-labelledby="all-classes-table-tab0">
 <div class="table-header col-first">Class</div>
 <div class="table-header col-last">Description</div>
-<div class="col-first even-row-color all-classes-table all-classes-table-tab4"><a href="org/racore/utils/CustomRequest.html" title="class in org.racore.utils">CustomRequest</a></div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab4"><a href="org.racore/org/racore/utils/CustomRequest.html" title="class in org.racore.utils">CustomRequest</a></div>
 <div class="col-last even-row-color all-classes-table all-classes-table-tab4">&nbsp;</div>
-<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/racore/Endpoint.html" title="class in org.racore">Endpoint</a></div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org.racore/org/racore/Endpoint.html" title="class in org.racore">Endpoint</a></div>
 <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
-<div class="col-first even-row-color all-classes-table all-classes-table-tab4"><a href="org/racore/EndpointHandler.html" title="class in org.racore">EndpointHandler</a></div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab4"><a href="org.racore/org/racore/EndpointHandler.html" title="class in org.racore">EndpointHandler</a></div>
 <div class="col-last even-row-color all-classes-table all-classes-table-tab4">&nbsp;</div>
-<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/racore/utils/FileUtils.html" title="class in org.racore.utils">FileUtils</a></div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org.racore/org/racore/utils/FileUtils.html" title="class in org.racore.utils">FileUtils</a></div>
 <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
-<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/racore/utils/FormDataExtractor.html" title="class in org.racore.utils">FormDataExtractor</a></div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org.racore/org/racore/utils/FormDataExtractor.html" title="class in org.racore.utils">FormDataExtractor</a></div>
 <div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
-<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/racore/utils/HttpExchangeRequestContext.html" title="class in org.racore.utils">HttpExchangeRequestContext</a></div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org.racore/org/racore/Handled.html" title="class in org.racore">Handled</a></div>
 <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
-<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="org/racore/Interceptor.html" title="interface in org.racore">Interceptor</a></div>
-<div class="col-last even-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
-<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/racore/utils/JsonUtils.html" title="class in org.racore.utils">JsonUtils</a></div>
-<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
-<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/racore/Main.html" title="class in org.racore">Main</a></div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org.racore/org/racore/utils/HttpExchangeRequestContext.html" title="class in org.racore.utils">HttpExchangeRequestContext</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="org.racore/org/racore/Interceptor.html" title="interface in org.racore">Interceptor</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org.racore/org/racore/utils/JsonUtils.html" title="class in org.racore.utils">JsonUtils</a></div>
 <div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
-<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/racore/Main.LoggingInterceptor.html" title="class in org.racore">Main.LoggingInterceptor</a></div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org.racore/org/racore/Main.html" title="class in org.racore">Main</a></div>
 <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
-<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/racore/Main.Person.html" title="class in org.racore">Main.Person</a></div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org.racore/org/racore/Main.LoggingInterceptor.html" title="class in org.racore">Main.LoggingInterceptor</a></div>
 <div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
-<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/racore/utils/QueryParameterUtil.html" title="class in org.racore.utils">QueryParameterUtil</a></div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org.racore/org/racore/Main.Person.html" title="class in org.racore">Main.Person</a></div>
 <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
-<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/racore/RaConfig.html" title="class in org.racore">RaConfig</a></div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org.racore/org/racore/utils/QueryParameterUtil.html" title="class in org.racore.utils">QueryParameterUtil</a></div>
 <div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
-<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/racore/Request.html" title="class in org.racore">Request</a></div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org.racore/org/racore/RaConfig.html" title="class in org.racore">RaConfig</a></div>
 <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
-<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/racore/ServerRegistry.html" title="class in org.racore">ServerRegistry</a></div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org.racore/org/racore/Request.html" title="class in org.racore">Request</a></div>
 <div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org.racore/org/racore/ServerRegistry.html" title="class in org.racore">ServerRegistry</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
 </div>
 </div>
 </div>

diff --git a/docs/allpackages-index.html b/docs/allpackages-index.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (22) on Sat Dec 28 00:05:57 GMT 2024 -->
+<!-- Generated by javadoc (22) on Sat Dec 28 17:51:30 GMT 2024 -->
 <title>All Packages</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
@@ -26,7 +26,7 @@
 <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
 <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
 <ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
-<li><a href="index.html">Overview</a></li>
+<li><a href="org.racore/module-summary.html">Module</a></li>
 <li>Package</li>
 <li>Class</li>
 <li><a href="overview-tree.html">Tree</a></li>
@@ -52,9 +52,9 @@ <h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
 <div class="summary-table two-column-summary">
 <div class="table-header col-first">Package</div>
 <div class="table-header col-last">Description</div>
-<div class="col-first even-row-color"><a href="org/racore/package-summary.html">org.racore</a></div>
+<div class="col-first even-row-color"><a href="org.racore/org/racore/package-summary.html">org.racore</a></div>
 <div class="col-last even-row-color">&nbsp;</div>
-<div class="col-first odd-row-color"><a href="org/racore/utils/package-summary.html">org.racore.utils</a></div>
+<div class="col-first odd-row-color"><a href="org.racore/org/racore/utils/package-summary.html">org.racore.utils</a></div>
 <div class="col-last odd-row-color">&nbsp;</div>
 </div>
 </main>

diff --git a/docs/element-list b/docs/element-list
@@ -1,2 +1,3 @@
+module:org.racore
 org.racore
 org.racore.utils
diff --git a/docs/help-doc.html b/docs/help-doc.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (22) on Sat Dec 28 00:05:57 GMT 2024 -->
+<!-- Generated by javadoc (22) on Sat Dec 28 17:51:30 GMT 2024 -->
 <title>API Help</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
@@ -26,7 +26,7 @@
 <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
 <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
 <ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
-<li><a href="index.html">Overview</a></li>
+<li><a href="org.racore/module-summary.html">Module</a></li>
 <li>Package</li>
 <li>Class</li>
 <li><a href="overview-tree.html">Tree</a></li>
@@ -69,7 +69,7 @@ <h1 class="title">JavaDoc Help</h1>
 </li>
 <li><a href="#help-pages">Kinds of Pages</a>: 
 <ul class="help-subtoc">
-<li><a href="#overview">Overview</a></li>
+<li><a href="#module">Module</a></li>
 <li><a href="#package">Package</a></li>
 <li><a href="#class">Class or Interface</a></li>
 <li><a href="#doc-file">Other Files</a></li>
@@ -100,9 +100,14 @@ <h3>Search</h3>
 <div class="sub-title">
 <h2 id="help-pages">Kinds of Pages</h2>
 The following sections describe the different kinds of pages in this collection.
-<section class="help-section" id="overview">
-<h3>Overview</h3>
-<p>The <a href="index.html">Overview</a> page is the front page of this API document and provides a list of all packages with a summary for each.  This page can also contain an overall description of the set of packages.</p>
+<section class="help-section" id="module">
+<h3>Module</h3>
+<p>Each module has a page that contains a list of its packages, dependencies on other modules, and services, with a summary for each. These pages may contain the following categories:</p>
+<ul class="help-section-list">
+<li>Packages</li>
+<li>Modules</li>
+<li>Services</li>
+</ul>
 </section>
 <section class="help-section" id="package">
 <h3>Package</h3>

diff --git a/docs/index-files/index-1.html b/docs/index-files/index-1.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (22) on Sat Dec 28 00:05:57 GMT 2024 -->
+<!-- Generated by javadoc (22) on Sat Dec 28 17:51:30 GMT 2024 -->
 <title>A-Index</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
@@ -26,7 +26,7 @@
 <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
 <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
 <ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
-<li><a href="../index.html">Overview</a></li>
+<li><a href="../org.racore/module-summary.html">Module</a></li>
 <li>Package</li>
 <li>Class</li>
 <li><a href="../overview-tree.html">Tree</a></li>
@@ -51,7 +51,7 @@ <h1>Index</h1>
 <a href="index-1.html">A</a>&nbsp;<a href="index-2.html">C</a>&nbsp;<a href="index-3.html">D</a>&nbsp;<a href="index-4.html">E</a>&nbsp;<a href="index-5.html">F</a>&nbsp;<a href="index-6.html">G</a>&nbsp;<a href="index-7.html">H</a>&nbsp;<a href="index-8.html">I</a>&nbsp;<a href="index-9.html">J</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">O</a>&nbsp;<a href="index-13.html">P</a>&nbsp;<a href="index-14.html">Q</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">T</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a>
 <h2 class="title" id="I:A">A</h2>
 <dl class="index">
-<dt><a href="../org/racore/Endpoint.html#addInterceptor(org.racore.Interceptor)" class="member-name-link">addInterceptor(Interceptor)</a> - Static method in class org.racore.<a href="../org/racore/Endpoint.html" title="class in org.racore">Endpoint</a></dt>
+<dt><a href="../org.racore/org/racore/Endpoint.html#addInterceptor(org.racore.Interceptor)" class="member-name-link">addInterceptor(Interceptor)</a> - Static method in class org.racore.<a href="../org.racore/org/racore/Endpoint.html" title="class in org.racore">Endpoint</a></dt>
 <dd>&nbsp;</dd>
 </dl>
 <a href="index-1.html">A</a>&nbsp;<a href="index-2.html">C</a>&nbsp;<a href="index-3.html">D</a>&nbsp;<a href="index-4.html">E</a>&nbsp;<a href="index-5.html">F</a>&nbsp;<a href="index-6.html">G</a>&nbsp;<a href="index-7.html">H</a>&nbsp;<a href="index-8.html">I</a>&nbsp;<a href="index-9.html">J</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">O</a>&nbsp;<a href="index-13.html">P</a>&nbsp;<a href="index-14.html">Q</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">T</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a></main>

diff --git a/docs/index-files/index-10.html b/docs/index-files/index-10.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (22) on Sat Dec 28 00:05:57 GMT 2024 -->
+<!-- Generated by javadoc (22) on Sat Dec 28 17:51:30 GMT 2024 -->
 <title>L-Index</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
@@ -26,7 +26,7 @@
 <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
 <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
 <ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
-<li><a href="../index.html">Overview</a></li>
+<li><a href="../org.racore/module-summary.html">Module</a></li>
 <li>Package</li>
 <li>Class</li>
 <li><a href="../overview-tree.html">Tree</a></li>
@@ -51,7 +51,7 @@ <h1>Index</h1>
 <a href="index-1.html">A</a>&nbsp;<a href="index-2.html">C</a>&nbsp;<a href="index-3.html">D</a>&nbsp;<a href="index-4.html">E</a>&nbsp;<a href="index-5.html">F</a>&nbsp;<a href="index-6.html">G</a>&nbsp;<a href="index-7.html">H</a>&nbsp;<a href="index-8.html">I</a>&nbsp;<a href="index-9.html">J</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">O</a>&nbsp;<a href="index-13.html">P</a>&nbsp;<a href="index-14.html">Q</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">T</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a>
 <h2 class="title" id="I:L">L</h2>
 <dl class="index">
-<dt><a href="../org/racore/Main.LoggingInterceptor.html#%3Cinit%3E()" class="member-name-link">LoggingInterceptor()</a> - Constructor for class org.racore.<a href="../org/racore/Main.LoggingInterceptor.html" title="class in org.racore">Main.LoggingInterceptor</a></dt>
+<dt><a href="../org.racore/org/racore/Main.LoggingInterceptor.html#%3Cinit%3E()" class="member-name-link">LoggingInterceptor()</a> - Constructor for class org.racore.<a href="../org.racore/org/racore/Main.LoggingInterceptor.html" title="class in org.racore">Main.LoggingInterceptor</a></dt>
 <dd>&nbsp;</dd>
 </dl>
 <a href="index-1.html">A</a>&nbsp;<a href="index-2.html">C</a>&nbsp;<a href="index-3.html">D</a>&nbsp;<a href="index-4.html">E</a>&nbsp;<a href="index-5.html">F</a>&nbsp;<a href="index-6.html">G</a>&nbsp;<a href="index-7.html">H</a>&nbsp;<a href="index-8.html">I</a>&nbsp;<a href="index-9.html">J</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">O</a>&nbsp;<a href="index-13.html">P</a>&nbsp;<a href="index-14.html">Q</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">T</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a></main>