From 49234dcd95920d0bc5ee5607ffc60387b04e1888 Mon Sep 17 00:00:00 2001 From: Blake McBride Date: Wed, 1 Nov 2023 21:00:19 -0500 Subject: [PATCH] JavaDoc updates --- src/main/core/org/kissweb/RestServer.java | 2 ++ src/main/core/org/kissweb/RestServerBase.java | 4 ++++ 2 files changed, 6 insertions(+) diff --git a/src/main/core/org/kissweb/RestServer.java b/src/main/core/org/kissweb/RestServer.java index 8cf5e30..36bd619 100644 --- a/src/main/core/org/kissweb/RestServer.java +++ b/src/main/core/org/kissweb/RestServer.java @@ -27,6 +27,8 @@ * (2) Be sure to set the urlPattern. *

* (3) If basic authentication is being used, enable it by setting and set the username and password. + *

+ * (4) Since this will be Java code, Kiss will have to be rebuilt. */ @WebServlet(urlPatterns="/myservice") @MultipartConfig diff --git a/src/main/core/org/kissweb/RestServerBase.java b/src/main/core/org/kissweb/RestServerBase.java index 0ce2730..bd590e2 100644 --- a/src/main/core/org/kissweb/RestServerBase.java +++ b/src/main/core/org/kissweb/RestServerBase.java @@ -23,6 +23,10 @@ public abstract class RestServerBase extends HttpServlet { /** * Support for Basic Authentication. + *

+ * The way basic authentication works is that the client uses a URL with the following format:
+ * https://[username]:[password]@[full-URL]
+ * The username and password are validated against what is passed in. * * @param request * @param response