Fix #231 - Clarify how HTTP headers are exposed through the API

Signed-off-by: Mark Thomas <markt@apache.org>
jakartaee · May 7, 2020 · 2b25239 · 2b25239
1 parent 5426d2c
commit 2b25239
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 8 deletions.
diff --git a/api/client/src/main/java/jakarta/websocket/HandshakeResponse.java b/api/client/src/main/java/jakarta/websocket/HandshakeResponse.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018, 2019 Oracle and/or its affiliates and others.
+ * Copyright (c) 2018, 2020 Oracle and/or its affiliates and others.
  * All rights reserved.
  *
  * This program and the accompanying materials are made available under the
@@ -21,7 +21,7 @@
 import java.util.Map;
 
 /**
- * The handshake response represents the web socket-defined Http response that is the response to the opening handshake
+ * The handshake response represents the WebSocket-defined HTTP response that is the response to the opening handshake
  * request.
  *
  * @author dannycoward
@@ -34,9 +34,10 @@ public interface HandshakeResponse {
     static final String SEC_WEBSOCKET_ACCEPT = "Sec-WebSocket-Accept";
 
     /**
-     * Return the list of Http headers sent by the web socket server.
+     * Return the map of HTTP headers to header values sent by the WebSocket server. Note that the lookup of header
+     * names will be performed in a case insensitive manner.
      *
-     * @return the http headers .
+     * @return the HTTP headers.
      */
     Map<String, List<String>> getHeaders();
 }
diff --git a/api/server/src/main/java/jakarta/websocket/server/HandshakeRequest.java b/api/server/src/main/java/jakarta/websocket/server/HandshakeRequest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018, 2019 Oracle and/or its affiliates and others.
+ * Copyright (c) 2018, 2020 Oracle and/or its affiliates and others.
  * All rights reserved.
  *
  * This program and the accompanying materials are made available under the
@@ -23,7 +23,7 @@
 import java.util.Map;
 
 /**
- * The handshake request represents the web socket defined Http GET request for the opening handshake of a web socket
+ * The handshake request represents the WebSocket defined HTTP GET request for the opening handshake of a WebSocket
  * session.
  *
  * @author dannycoward
@@ -47,8 +47,8 @@ public interface HandshakeRequest {
     static String SEC_WEBSOCKET_EXTENSIONS = "Sec-WebSocket-Extensions";
 
     /**
-     * Return the read only Map of Http Headers that came with the handshake request. The header names are case
-     * insensitive.
+     * Return the read only map of HTTP headers to header values that came with the handshake request. Note that the
+     * lookup of header names will be performed in a case insensitive manner.
      *
      * @return the list of headers.
      */