Fix #203. Clarify return value of getRequestParameterMap()

Signed-off-by: Mark Thomas <markt@apache.org>
jakartaee · May 14, 2020 · 4710b8f · 4710b8f
1 parent f593eb2
commit 4710b8f
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/api/client/src/main/java/jakarta/websocket/Session.java b/api/client/src/main/java/jakarta/websocket/Session.java
@@ -259,7 +259,10 @@ public interface Session extends Closeable {
     URI getRequestURI();
 
     /**
-     * Return the request parameters associated with the request this session was opened under.
+     * Return the request parameters associated with the request this session was opened under. The request parameters
+     * will have been part of the HTTP upgrade request which is limited by RFC 6455 to only use the HTTP GET method.
+     * Therefore, the parameters in the returned Map will be a representation of the parameters contained in the query
+     * string.
      *
      * @return the unmodifiable map of the request parameters.
      */