Jetty WebSocket API minor cleanups before Jetty-10 full release

jetty-websocket/websocket-jetty-api/src/main/java/module-info.java

@@ -16,12 +16,14 @@
 // ========================================================================
 //
 
+import org.eclipse.jetty.websocket.api.ExtensionConfig;
+
 module org.eclipse.jetty.websocket.jetty.api
 {
     exports org.eclipse.jetty.websocket.api;
     exports org.eclipse.jetty.websocket.api.annotations;
-    exports org.eclipse.jetty.websocket.api.extensions;
+    exports org.eclipse.jetty.websocket.api.exceptions;
     exports org.eclipse.jetty.websocket.api.util;
 
-    uses org.eclipse.jetty.websocket.api.extensions.ExtensionConfig.Parser;
+    uses ExtensionConfig.Parser;
 }

jetty-websocket/websocket-jetty-api/src/main/java/org/eclipse/jetty/websocket/api/CloseStatus.java

@@ -23,8 +23,8 @@ public class CloseStatus
     private static final int MAX_CONTROL_PAYLOAD = 125;
     public static final int MAX_REASON_PHRASE = MAX_CONTROL_PAYLOAD - 2;
 
-    private int code;
-    private String phrase;
+    private final int code;
+    private final String phrase;
 
     /**
      * Creates a reason for closing a web socket connection with the given code and reason phrase.

jetty-websocket/websocket-jetty-api/src/main/java/org/eclipse/jetty/websocket/api/extensions/ExtensionConfig.java → jetty-websocket/websocket-jetty-api/src/main/java/org/eclipse/jetty/websocket/api/ExtensionConfig.java

@@ -16,7 +16,7 @@
 // ========================================================================
 //
 
-package org.eclipse.jetty.websocket.api.extensions;
+package org.eclipse.jetty.websocket.api;
 
 import java.util.Map;
 import java.util.ServiceLoader;

jetty-websocket/websocket-jetty-api/src/main/java/org/eclipse/jetty/websocket/api/Frame.java

@@ -46,7 +46,7 @@ public static Type from(byte op)
             throw new IllegalArgumentException("OpCode " + op + " is not a valid Frame.Type");
         }
 
-        private byte opcode;
+        private final byte opcode;
 
         Type(byte code)
         {

jetty-websocket/websocket-jetty-api/src/main/java/org/eclipse/jetty/websocket/api/UpgradeRequest.java

@@ -24,8 +24,6 @@
 import java.util.List;
 import java.util.Map;
 
-import org.eclipse.jetty.websocket.api.extensions.ExtensionConfig;
-
 /**
  * The HTTP Upgrade to WebSocket Request
  */

jetty-websocket/websocket-jetty-api/src/main/java/org/eclipse/jetty/websocket/api/UpgradeResponse.java

@@ -22,8 +22,6 @@
 import java.util.Map;
 import java.util.Set;
 
-import org.eclipse.jetty.websocket.api.extensions.ExtensionConfig;
-
 /**
  * The HTTP Upgrade to WebSocket Response
  */

jetty-websocket/websocket-jetty-api/src/main/java/org/eclipse/jetty/websocket/api/WebSocketAdapter.java

@@ -39,14 +39,12 @@ public Session getSession()
 
     public boolean isConnected()
     {
-        Session sess = this.session;
-        return (sess != null) && (sess.isOpen());
+        return session.isOpen();
     }
 
     public boolean isNotConnected()
     {
-        Session sess = this.session;
-        return (sess == null) || (!sess.isOpen());
+        return !isConnected();
     }
 
     @Override

jetty-websocket/websocket-jetty-api/src/main/java/org/eclipse/jetty/websocket/api/BadPayloadException.java → jetty-websocket/websocket-jetty-api/src/main/java/org/eclipse/jetty/websocket/api/exceptions/BadPayloadException.java

@@ -16,7 +16,9 @@
 // ========================================================================
 //
 
-package org.eclipse.jetty.websocket.api;
+package org.eclipse.jetty.websocket.api.exceptions;
+
+import org.eclipse.jetty.websocket.api.StatusCode;
 
 /**
  * Exception to terminate the connection because it has received data within a frame payload that was not consistent with the requirements of that frame

jetty-websocket/websocket-jetty-api/src/main/java/org/eclipse/jetty/websocket/api/CloseException.java → jetty-websocket/websocket-jetty-api/src/main/java/org/eclipse/jetty/websocket/api/exceptions/CloseException.java

@@ -16,12 +16,12 @@
 // ========================================================================
 //
 
-package org.eclipse.jetty.websocket.api;
+package org.eclipse.jetty.websocket.api.exceptions;
 
 @SuppressWarnings("serial")
 public class CloseException extends WebSocketException
 {
-    private int statusCode;
+    private final int statusCode;
 
     public CloseException(int closeCode, String message)
     {

jetty-websocket/websocket-jetty-api/src/main/java/org/eclipse/jetty/websocket/api/InvalidWebSocketException.java → jetty-websocket/websocket-jetty-api/src/main/java/org/eclipse/jetty/websocket/api/exceptions/InvalidWebSocketException.java

@@ -16,8 +16,10 @@
 // ========================================================================
 //
 
-package org.eclipse.jetty.websocket.api;
+package org.eclipse.jetty.websocket.api.exceptions;
 
+import org.eclipse.jetty.websocket.api.WebSocketAdapter;
+import org.eclipse.jetty.websocket.api.WebSocketListener;
 import org.eclipse.jetty.websocket.api.annotations.WebSocket;
 
 /**

jetty-websocket/websocket-jetty-api/src/main/java/org/eclipse/jetty/websocket/api/MessageTooLargeException.java → jetty-websocket/websocket-jetty-api/src/main/java/org/eclipse/jetty/websocket/api/exceptions/MessageTooLargeException.java

@@ -16,7 +16,9 @@
 // ========================================================================
 //
 
-package org.eclipse.jetty.websocket.api;
+package org.eclipse.jetty.websocket.api.exceptions;
+
+import org.eclipse.jetty.websocket.api.StatusCode;
 
 /**
  * Exception when a message is too large for the internal buffers occurs and should trigger a connection close.

jetty-websocket/websocket-jetty-api/src/main/java/org/eclipse/jetty/websocket/api/PolicyViolationException.java → jetty-websocket/websocket-jetty-api/src/main/java/org/eclipse/jetty/websocket/api/exceptions/PolicyViolationException.java

@@ -16,7 +16,9 @@
 // ========================================================================
 //
 
-package org.eclipse.jetty.websocket.api;
+package org.eclipse.jetty.websocket.api.exceptions;
+
+import org.eclipse.jetty.websocket.api.StatusCode;
 
 /**
  * Exception when a violation of policy occurs and should trigger a connection close.

jetty-websocket/websocket-jetty-api/src/main/java/org/eclipse/jetty/websocket/api/ProtocolException.java → jetty-websocket/websocket-jetty-api/src/main/java/org/eclipse/jetty/websocket/api/exceptions/ProtocolException.java

@@ -16,7 +16,9 @@
 // ========================================================================
 //
 
-package org.eclipse.jetty.websocket.api;
+package org.eclipse.jetty.websocket.api.exceptions;
+
+import org.eclipse.jetty.websocket.api.StatusCode;
 
 /**
  * Per spec, a protocol error should result in a Close frame of status code 1002 (PROTOCOL_ERROR)

jetty-websocket/websocket-jetty-api/src/main/java/org/eclipse/jetty/websocket/api/UpgradeException.java → jetty-websocket/websocket-jetty-api/src/main/java/org/eclipse/jetty/websocket/api/exceptions/UpgradeException.java

@@ -16,7 +16,7 @@
 // ========================================================================
 //
 
-package org.eclipse.jetty.websocket.api;
+package org.eclipse.jetty.websocket.api.exceptions;
 
 import java.net.URI;
 

jetty-websocket/websocket-jetty-api/src/main/java/org/eclipse/jetty/websocket/api/WebSocketException.java → jetty-websocket/websocket-jetty-api/src/main/java/org/eclipse/jetty/websocket/api/exceptions/WebSocketException.java

@@ -16,7 +16,7 @@
 // ========================================================================
 //
 
-package org.eclipse.jetty.websocket.api;
+package org.eclipse.jetty.websocket.api.exceptions;
 
 /**
  * A recoverable exception within the websocket framework.

jetty-websocket/websocket-jetty-api/src/main/java/org/eclipse/jetty/websocket/api/WebSocketTimeoutException.java → jetty-websocket/websocket-jetty-api/src/main/java/org/eclipse/jetty/websocket/api/exceptions/WebSocketTimeoutException.java

@@ -16,7 +16,7 @@
 // ========================================================================
 //
 
-package org.eclipse.jetty.websocket.api;
+package org.eclipse.jetty.websocket.api.exceptions;
 
 /**
  * Exception thrown to indicate a connection I/O timeout.

jetty-websocket/websocket-jetty-api/src/main/java/org/eclipse/jetty/websocket/api/extensions/package-info.java → jetty-websocket/websocket-jetty-api/src/main/java/org/eclipse/jetty/websocket/api/exceptions/package-info.java

@@ -17,7 +17,7 @@
 //
 
 /**
- * Jetty WebSocket API : WebSocket Extension API
+ * Jetty WebSocket API : Exception Types
  */
-package org.eclipse.jetty.websocket.api.extensions;
+package org.eclipse.jetty.websocket.api.exceptions;
 

jetty-websocket/websocket-jetty-api/src/main/java/org/eclipse/jetty/websocket/api/util/WSURI.java

@@ -22,8 +22,6 @@
 import java.net.URISyntaxException;
 import java.util.Objects;
 
-// @checkstyle-disable-check : AbbreviationAsWordInNameCheck
-
 /**
  * Utility methods for converting a {@link URI} between a HTTP(S) and WS(S) URI.
  */

jetty-websocket/websocket-jetty-api/src/main/java/org/eclipse/jetty/websocket/api/WebSocketConstants.java → jetty-websocket/websocket-jetty-api/src/main/java/org/eclipse/jetty/websocket/api/util/WebSocketConstants.java

@@ -16,7 +16,7 @@
 // ========================================================================
 //
 
-package org.eclipse.jetty.websocket.api;
+package org.eclipse.jetty.websocket.api.util;
 
 public final class WebSocketConstants
 {

jetty-websocket/websocket-jetty-client/src/main/java/org/eclipse/jetty/websocket/client/ClientUpgradeRequest.java

@@ -31,9 +31,9 @@
 
 import org.eclipse.jetty.http.HttpHeader;
 import org.eclipse.jetty.http.HttpScheme;
+import org.eclipse.jetty.websocket.api.ExtensionConfig;
 import org.eclipse.jetty.websocket.api.UpgradeRequest;
 import org.eclipse.jetty.websocket.api.UpgradeResponse;
-import org.eclipse.jetty.websocket.api.extensions.ExtensionConfig;
 
 /**
  * Client based UpgradeRequest API

jetty-websocket/websocket-jetty-client/src/main/java/org/eclipse/jetty/websocket/client/impl/DelegatedJettyClientUpgradeRequest.java

@@ -32,8 +32,8 @@
 import org.eclipse.jetty.io.EndPoint;
 import org.eclipse.jetty.util.MultiMap;
 import org.eclipse.jetty.util.UrlEncoded;
+import org.eclipse.jetty.websocket.api.ExtensionConfig;
 import org.eclipse.jetty.websocket.api.UpgradeRequest;
-import org.eclipse.jetty.websocket.api.extensions.ExtensionConfig;
 import org.eclipse.jetty.websocket.core.client.CoreClientUpgradeRequest;
 
 import static java.nio.charset.StandardCharsets.UTF_8;

jetty-websocket/websocket-jetty-client/src/main/java/org/eclipse/jetty/websocket/client/impl/DelegatedJettyClientUpgradeResponse.java

@@ -26,8 +26,8 @@
 
 import org.eclipse.jetty.client.HttpResponse;
 import org.eclipse.jetty.http.HttpHeader;
+import org.eclipse.jetty.websocket.api.ExtensionConfig;
 import org.eclipse.jetty.websocket.api.UpgradeResponse;
-import org.eclipse.jetty.websocket.api.extensions.ExtensionConfig;
 
 /**
  * Representing the Jetty {@link org.eclipse.jetty.client.HttpClient}'s {@link org.eclipse.jetty.client.HttpResponse}

jetty-websocket/websocket-jetty-common/src/main/java/module-info.java

@@ -16,7 +16,7 @@
 // ========================================================================
 //
 
-import org.eclipse.jetty.websocket.api.extensions.ExtensionConfig;
+import org.eclipse.jetty.websocket.api.ExtensionConfig;
 import org.eclipse.jetty.websocket.common.ExtensionConfigParser;
 
 module org.eclipse.jetty.websocket.jetty.common

jetty-websocket/websocket-jetty-common/src/main/java/org/eclipse/jetty/websocket/common/ExtensionConfigParser.java

@@ -20,7 +20,7 @@
 
 import org.eclipse.jetty.websocket.core.ExtensionConfig;
 
-public class ExtensionConfigParser implements org.eclipse.jetty.websocket.api.extensions.ExtensionConfig.Parser
+public class ExtensionConfigParser implements org.eclipse.jetty.websocket.api.ExtensionConfig.Parser
 {
     /**
      * Parse a single parameterized name.

jetty-websocket/websocket-jetty-common/src/main/java/org/eclipse/jetty/websocket/common/JettyExtensionConfig.java

@@ -26,7 +26,7 @@
 /**
  * Represents an Extension Configuration, as seen during the connection Handshake process.
  */
-public class JettyExtensionConfig implements org.eclipse.jetty.websocket.api.extensions.ExtensionConfig
+public class JettyExtensionConfig implements org.eclipse.jetty.websocket.api.ExtensionConfig
 {
 
     private final ExtensionConfig config;

jetty-websocket/websocket-jetty-common/src/main/java/org/eclipse/jetty/websocket/common/JettyWebSocketFrameHandler.java

@@ -507,27 +507,27 @@ private void demand()
     public static Throwable convertCause(Throwable cause)
     {
         if (cause instanceof MessageTooLargeException)
-            return new org.eclipse.jetty.websocket.api.MessageTooLargeException(cause.getMessage(), cause);
+            return new org.eclipse.jetty.websocket.api.exceptions.MessageTooLargeException(cause.getMessage(), cause);
 
         if (cause instanceof ProtocolException)
-            return new org.eclipse.jetty.websocket.api.ProtocolException(cause.getMessage(), cause);
+            return new org.eclipse.jetty.websocket.api.exceptions.ProtocolException(cause.getMessage(), cause);
 
         if (cause instanceof BadPayloadException)
-            return new org.eclipse.jetty.websocket.api.BadPayloadException(cause.getMessage(), cause);
+            return new org.eclipse.jetty.websocket.api.exceptions.BadPayloadException(cause.getMessage(), cause);
 
         if (cause instanceof CloseException)
-            return new org.eclipse.jetty.websocket.api.CloseException(((CloseException)cause).getStatusCode(), cause.getMessage(), cause);
+            return new org.eclipse.jetty.websocket.api.exceptions.CloseException(((CloseException)cause).getStatusCode(), cause.getMessage(), cause);
 
         if (cause instanceof WebSocketTimeoutException)
-            return new org.eclipse.jetty.websocket.api.WebSocketTimeoutException(cause.getMessage(), cause);
+            return new org.eclipse.jetty.websocket.api.exceptions.WebSocketTimeoutException(cause.getMessage(), cause);
 
         if (cause instanceof InvalidSignatureException)
-            return new org.eclipse.jetty.websocket.api.InvalidWebSocketException(cause.getMessage(), cause);
+            return new org.eclipse.jetty.websocket.api.exceptions.InvalidWebSocketException(cause.getMessage(), cause);
 
         if (cause instanceof UpgradeException)
         {
             UpgradeException ue = (UpgradeException)cause;
-            return new org.eclipse.jetty.websocket.api.UpgradeException(ue.getRequestURI(), ue.getResponseStatusCode(), cause);
+            return new org.eclipse.jetty.websocket.api.exceptions.UpgradeException(ue.getRequestURI(), ue.getResponseStatusCode(), cause);
         }
 
         return cause;

jetty-websocket/websocket-jetty-common/src/main/java/org/eclipse/jetty/websocket/common/JettyWebSocketFrameHandlerMetadata.java

@@ -21,7 +21,7 @@
 import java.lang.invoke.MethodHandle;
 
 import org.eclipse.jetty.websocket.api.BatchMode;
-import org.eclipse.jetty.websocket.api.InvalidWebSocketException;
+import org.eclipse.jetty.websocket.api.exceptions.InvalidWebSocketException;
 import org.eclipse.jetty.websocket.core.Configuration;
 import org.eclipse.jetty.websocket.util.messages.MessageSink;
 

jetty-websocket/websocket-jetty-common/src/test/java/org/eclipse/jetty/websocket/common/LocalEndpointMetadataTest.java

@@ -18,7 +18,7 @@
 
 package org.eclipse.jetty.websocket.common;
 
-import org.eclipse.jetty.websocket.api.InvalidWebSocketException;
+import org.eclipse.jetty.websocket.api.exceptions.InvalidWebSocketException;
 import org.eclipse.jetty.websocket.util.DuplicateAnnotationException;
 import org.eclipse.jetty.websocket.util.InvalidSignatureException;
 import org.eclipse.jetty.websocket.util.messages.ByteArrayMessageSink;

jetty-websocket/websocket-jetty-server/src/main/java/org/eclipse/jetty/websocket/server/JettyServerUpgradeResponse.java

@@ -21,9 +21,9 @@
 import java.io.IOException;
 import java.util.List;
 
+import org.eclipse.jetty.websocket.api.ExtensionConfig;
 import org.eclipse.jetty.websocket.api.UpgradeRequest;
 import org.eclipse.jetty.websocket.api.UpgradeResponse;
-import org.eclipse.jetty.websocket.api.extensions.ExtensionConfig;
 
 public interface JettyServerUpgradeResponse extends UpgradeResponse
 {

jetty-websocket/websocket-jetty-server/src/main/java/org/eclipse/jetty/websocket/server/JettyWebSocketServerContainer.java

@@ -150,7 +150,7 @@ public void addMapping(String pathSpec, final Class<?> endpointClass)
             }
             catch (Exception e)
             {
-                throw new org.eclipse.jetty.websocket.api.WebSocketException("Unable to create instance of " + endpointClass.getName(), e);
+                throw new org.eclipse.jetty.websocket.api.exceptions.WebSocketException("Unable to create instance of " + endpointClass.getName(), e);
             }
         });
     }

jetty-websocket/websocket-jetty-server/src/main/java/org/eclipse/jetty/websocket/server/internal/DelegatedServerUpgradeRequest.java

@@ -31,7 +31,7 @@
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpSession;
 
-import org.eclipse.jetty.websocket.api.extensions.ExtensionConfig;
+import org.eclipse.jetty.websocket.api.ExtensionConfig;
 import org.eclipse.jetty.websocket.common.JettyExtensionConfig;
 import org.eclipse.jetty.websocket.server.JettyServerUpgradeRequest;
 import org.eclipse.jetty.websocket.util.server.internal.ServerUpgradeRequest;

jetty-websocket/websocket-jetty-server/src/main/java/org/eclipse/jetty/websocket/server/internal/DelegatedServerUpgradeResponse.java

@@ -24,7 +24,7 @@
 import java.util.Set;
 import java.util.stream.Collectors;
 
-import org.eclipse.jetty.websocket.api.extensions.ExtensionConfig;
+import org.eclipse.jetty.websocket.api.ExtensionConfig;
 import org.eclipse.jetty.websocket.common.JettyExtensionConfig;
 import org.eclipse.jetty.websocket.server.JettyServerUpgradeResponse;
 import org.eclipse.jetty.websocket.util.server.internal.ServerUpgradeResponse;

jetty-websocket/websocket-jetty-server/src/test/java/org/eclipse/jetty/websocket/server/browser/BrowserDebugTool.java

@@ -37,7 +37,7 @@
 import org.eclipse.jetty.toolchain.test.MavenTestingUtils;
 import org.eclipse.jetty.util.resource.PathResource;
 import org.eclipse.jetty.util.resource.Resource;
-import org.eclipse.jetty.websocket.api.extensions.ExtensionConfig;
+import org.eclipse.jetty.websocket.api.ExtensionConfig;
 import org.eclipse.jetty.websocket.server.JettyServerUpgradeRequest;
 import org.eclipse.jetty.websocket.server.JettyServerUpgradeResponse;
 import org.eclipse.jetty.websocket.server.JettyWebSocketCreator;

jetty-websocket/websocket-jetty-tests/src/test/java/org/eclipse/jetty/websocket/tests/JettyWebSocketExtensionConfigTest.java

@@ -30,8 +30,8 @@
 import org.eclipse.jetty.server.Server;
 import org.eclipse.jetty.server.ServerConnector;
 import org.eclipse.jetty.servlet.ServletContextHandler;
+import org.eclipse.jetty.websocket.api.ExtensionConfig;
 import org.eclipse.jetty.websocket.api.Session;
-import org.eclipse.jetty.websocket.api.extensions.ExtensionConfig;
 import org.eclipse.jetty.websocket.client.ClientUpgradeRequest;
 import org.eclipse.jetty.websocket.client.JettyUpgradeListener;
 import org.eclipse.jetty.websocket.client.WebSocketClient;

jetty-websocket/websocket-jetty-tests/src/test/java/org/eclipse/jetty/websocket/tests/WebSocketOverHTTP2Test.java

@@ -59,7 +59,7 @@
 import org.eclipse.jetty.util.thread.QueuedThreadPool;
 import org.eclipse.jetty.websocket.api.Session;
 import org.eclipse.jetty.websocket.api.StatusCode;
-import org.eclipse.jetty.websocket.api.UpgradeException;
+import org.eclipse.jetty.websocket.api.exceptions.UpgradeException;
 import org.eclipse.jetty.websocket.client.WebSocketClient;
 import org.eclipse.jetty.websocket.server.JettyWebSocketServlet;
 import org.eclipse.jetty.websocket.server.JettyWebSocketServletFactory;

jetty-websocket/websocket-jetty-tests/src/test/java/org/eclipse/jetty/websocket/tests/client/ClientCloseTest.java

@@ -37,12 +37,12 @@
 import org.eclipse.jetty.servlet.ServletHolder;
 import org.eclipse.jetty.util.BlockingArrayQueue;
 import org.eclipse.jetty.websocket.api.Frame;
-import org.eclipse.jetty.websocket.api.MessageTooLargeException;
 import org.eclipse.jetty.websocket.api.Session;
 import org.eclipse.jetty.websocket.api.StatusCode;
 import org.eclipse.jetty.websocket.api.WebSocketFrameListener;
 import org.eclipse.jetty.websocket.api.WebSocketListener;
-import org.eclipse.jetty.websocket.api.WebSocketTimeoutException;
+import org.eclipse.jetty.websocket.api.exceptions.MessageTooLargeException;
+import org.eclipse.jetty.websocket.api.exceptions.WebSocketTimeoutException;
 import org.eclipse.jetty.websocket.api.util.WSURI;
 import org.eclipse.jetty.websocket.client.WebSocketClient;
 import org.eclipse.jetty.websocket.core.CloseStatus;