Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoakim Erdfelt2015-04-22 19:10:54 -0400
committerJoakim Erdfelt2015-04-22 19:11:01 -0400
commited22d7e0de4709f0a0cefb2090cf247451b0f4de (patch)
tree69aa23ba329c074670ddf8f7c7912c04fb29b791
parent6ec2a50cae29825bf884e17ed16b85b014702f1f (diff)
downloadorg.eclipse.jetty.project-ed22d7e0de4709f0a0cefb2090cf247451b0f4de.tar.gz
org.eclipse.jetty.project-ed22d7e0de4709f0a0cefb2090cf247451b0f4de.tar.xz
org.eclipse.jetty.project-ed22d7e0de4709f0a0cefb2090cf247451b0f4de.zip
464727 - Update Javadoc for Java 8 DocLint
-rw-r--r--jetty-fcgi/fcgi-server/src/main/java/org/eclipse/jetty/fcgi/server/proxy/FastCGIProxyServlet.java3
-rw-r--r--jetty-proxy/src/main/java/org/eclipse/jetty/proxy/AbstractProxyServlet.java1
-rw-r--r--jetty-proxy/src/main/java/org/eclipse/jetty/proxy/AsyncMiddleManServlet.java8
-rw-r--r--jetty-proxy/src/main/java/org/eclipse/jetty/proxy/AsyncProxyServlet.java2
-rw-r--r--jetty-proxy/src/main/java/org/eclipse/jetty/proxy/ProxyServlet.java2
-rw-r--r--jetty-security/src/main/java/org/eclipse/jetty/security/ConstraintAware.java4
-rw-r--r--jetty-security/src/main/java/org/eclipse/jetty/security/ConstraintSecurityHandler.java74
-rw-r--r--jetty-security/src/main/java/org/eclipse/jetty/security/IdentityService.java4
-rw-r--r--jetty-security/src/main/java/org/eclipse/jetty/security/PropertyUserStore.java17
-rw-r--r--jetty-security/src/main/java/org/eclipse/jetty/security/SecurityHandler.java12
-rw-r--r--jetty-security/src/main/java/org/eclipse/jetty/security/authentication/ClientCertAuthenticator.java13
-rw-r--r--jetty-security/src/main/java/org/eclipse/jetty/security/authentication/DeferredAuthentication.java2
-rw-r--r--jetty-security/src/main/java/org/eclipse/jetty/security/authentication/FormAuthenticator.java4
-rw-r--r--jetty-security/src/main/java/org/eclipse/jetty/security/authentication/LoginAuthenticator.java6
-rw-r--r--jetty-security/src/main/java/org/eclipse/jetty/security/authentication/SpnegoAuthenticator.java2
-rw-r--r--jetty-security/src/test/java/org/eclipse/jetty/security/ConstraintTest.java18
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/ClientContainer.java1
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/JsrExtension.java2
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/MessageHandlerWrapper.java2
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/AnnotatedEndpointMetadata.java2
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/JsrCallable.java1
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/JsrEvents.java2
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/JsrParamIdDecoder.java2
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageBinaryCallable.java5
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageBinaryStreamCallable.java3
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessagePongCallable.java1
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageTextCallable.java3
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageTextStreamCallable.java3
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/BooleanDecoder.java2
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/ByteDecoder.java2
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/CharacterDecoder.java2
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/DoubleDecoder.java2
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/IntegerDecoder.java2
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/ShortDecoder.java2
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/StringDecoder.java2
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/BooleanEncoder.java2
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/ByteEncoder.java2
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/CharacterEncoder.java2
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/DoubleEncoder.java2
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/FloatEncoder.java2
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/IntegerEncoder.java2
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/LongEncoder.java2
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/ShortEncoder.java2
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/StringEncoder.java2
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/metadata/CoderMetadata.java4
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/metadata/CoderMetadataSet.java2
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/metadata/DuplicateCoderException.java2
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/ConfiguratorTest.java2
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidCloseIntSocket.java1
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidErrorErrorSocket.java1
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidErrorExceptionSocket.java1
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidErrorIntSocket.java1
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidOpenCloseReasonSocket.java1
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidOpenIntSocket.java1
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidOpenSessionIntSocket.java2
-rw-r--r--jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/samples/ExtDecoder.java1
-rw-r--r--jetty-websocket/javax-websocket-server-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/server/ContainerDefaultConfigurator.java2
-rw-r--r--jetty-websocket/javax-websocket-server-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/server/deploy/WebSocketServerContainerInitializer.java9
-rw-r--r--jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/BasicEndpointTest.java2
-rw-r--r--jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/ConfiguratorTest.java4
-rw-r--r--jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidCloseIntSocket.java1
-rw-r--r--jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidErrorErrorSocket.java1
-rw-r--r--jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidErrorExceptionSocket.java1
-rw-r--r--jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidErrorIntSocket.java1
-rw-r--r--jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidOpenCloseReasonSocket.java1
-rw-r--r--jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidOpenIntSocket.java1
-rw-r--r--jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidOpenSessionIntSocket.java2
-rw-r--r--jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/echo/BasicEchoEndpointConfigContextListener.java2
-rw-r--r--jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/echo/BasicEchoEndpointContextListener.java2
-rw-r--r--jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/echo/BasicEchoSocketConfigContextListener.java2
-rw-r--r--jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/idletimeout/IdleTimeoutContextListener.java2
-rw-r--r--jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/BatchMode.java2
-rw-r--r--jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/RemoteEndpoint.java44
-rw-r--r--jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/Session.java7
-rw-r--r--jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/UpgradeResponse.java4
-rw-r--r--jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/WebSocketListener.java4
-rw-r--r--jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/OnWebSocketError.java1
-rw-r--r--jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/OnWebSocketFrame.java4
-rw-r--r--jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/extensions/Extension.java1
-rw-r--r--jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/extensions/ExtensionConfig.java1
-rw-r--r--jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/util/QuoteUtil.java1
-rw-r--r--jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/WebSocketClient.java1
-rw-r--r--jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/package-info.java7
-rw-r--r--jetty-websocket/websocket-client/src/test/java/org/eclipse/jetty/websocket/client/TomcatServerQuirksTest.java2
-rw-r--r--jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/LogicalConnection.java3
-rw-r--r--jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/WebSocketFrame.java3
-rw-r--r--jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/events/EventDriverFactory.java2
-rw-r--r--jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/events/annotated/AbstractMethodAnnotationScanner.java1
-rw-r--r--jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/frames/DataFrame.java3
-rw-r--r--jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/io/AbstractWebSocketConnection.java3
-rw-r--r--jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/io/FrameFlusher.java2
-rw-r--r--jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/io/IOState.java5
-rw-r--r--jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/scopes/WebSocketSessionScope.java2
-rw-r--r--jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/util/TextUtil.java1
-rw-r--r--jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/annotations/BadBinarySignatureSocket.java5
-rw-r--r--jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/annotations/BadDuplicateBinarySocket.java4
-rw-r--r--jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/annotations/BadDuplicateFrameSocket.java2
-rw-r--r--jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/annotations/BadTextSignatureSocket.java2
-rw-r--r--jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/annotations/FrameSocket.java1
-rw-r--r--jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/extensions/FragmentExtensionTest.java3
-rw-r--r--jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/extensions/IdentityExtensionTest.java1
-rw-r--r--jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/extensions/compress/DeflateFrameExtensionTest.java2
-rw-r--r--jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/extensions/compress/PerMessageDeflateExtensionTest.java1
-rw-r--r--jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/test/BlockheadServer.java2
-rw-r--r--jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/test/UnitGenerator.java2
-rw-r--r--jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/test/UnitParser.java1
-rw-r--r--jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/WebSocketHandshake.java5
-rw-r--r--jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/pathmap/PathMappings.java2
-rw-r--r--jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/IdleTimeoutTest.java1
-rw-r--r--jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/PerMessageDeflateExtensionTest.java1
-rw-r--r--jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/TooFastClientTest.java1
-rw-r--r--jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/WebSocketCloseTest.java2
-rw-r--r--jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/WebSocketInvalidVersionTest.java1
-rw-r--r--jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/WebSocketOverSSLTest.java3
-rw-r--r--jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/WebSocketServerSessionTest.java2
-rw-r--r--jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/WebSocketServletRFCTest.java5
-rw-r--r--jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/AbstractABCase.java2
-rw-r--r--jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase1.java16
-rw-r--r--jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase2.java11
-rw-r--r--jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase3.java7
-rw-r--r--jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase4.java10
-rw-r--r--jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase5.java21
-rw-r--r--jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase6.java13
-rw-r--r--jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase7.java12
-rw-r--r--jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase7_BadStatusCodes.java2
-rw-r--r--jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase7_GoodStatusCodes.java2
-rw-r--r--jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase9.java42
-rw-r--r--jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/helper/SafariD00.java4
-rw-r--r--jetty-websocket/websocket-servlet/src/main/java/org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.java1
-rw-r--r--jetty-websocket/websocket-servlet/src/main/java/org/eclipse/jetty/websocket/servlet/WebSocketCreator.java2
-rw-r--r--jetty-xml/src/main/java/org/eclipse/jetty/xml/XmlParser.java36
131 files changed, 441 insertions, 176 deletions
diff --git a/jetty-fcgi/fcgi-server/src/main/java/org/eclipse/jetty/fcgi/server/proxy/FastCGIProxyServlet.java b/jetty-fcgi/fcgi-server/src/main/java/org/eclipse/jetty/fcgi/server/proxy/FastCGIProxyServlet.java
index 2c6a8b812d..d80124e6e5 100644
--- a/jetty-fcgi/fcgi-server/src/main/java/org/eclipse/jetty/fcgi/server/proxy/FastCGIProxyServlet.java
+++ b/jetty-fcgi/fcgi-server/src/main/java/org/eclipse/jetty/fcgi/server/proxy/FastCGIProxyServlet.java
@@ -36,10 +36,9 @@ import org.eclipse.jetty.http.HttpFields;
import org.eclipse.jetty.http.HttpHeader;
import org.eclipse.jetty.http.HttpScheme;
import org.eclipse.jetty.proxy.AsyncProxyServlet;
-import org.eclipse.jetty.proxy.ProxyServlet;
/**
- * Specific implementation of {@link ProxyServlet.Transparent} for FastCGI.
+ * Specific implementation of {@link org.eclipse.jetty.proxy.AsyncProxyServlet.Transparent} for FastCGI.
* <p>
* This servlet accepts a HTTP request and transforms it into a FastCGI request
* that is sent to the FastCGI server specified in the <code>proxyTo</code>
diff --git a/jetty-proxy/src/main/java/org/eclipse/jetty/proxy/AbstractProxyServlet.java b/jetty-proxy/src/main/java/org/eclipse/jetty/proxy/AbstractProxyServlet.java
index ed4e68a9fb..20f8fa324f 100644
--- a/jetty-proxy/src/main/java/org/eclipse/jetty/proxy/AbstractProxyServlet.java
+++ b/jetty-proxy/src/main/java/org/eclipse/jetty/proxy/AbstractProxyServlet.java
@@ -185,6 +185,7 @@ public abstract class AbstractProxyServlet extends HttpServlet
* <p>
* The init parameters used to configure the {@link HttpClient} instance are:
* <table>
+ * <caption>Init Parameters</caption>
* <thead>
* <tr>
* <th>init-param</th>
diff --git a/jetty-proxy/src/main/java/org/eclipse/jetty/proxy/AsyncMiddleManServlet.java b/jetty-proxy/src/main/java/org/eclipse/jetty/proxy/AsyncMiddleManServlet.java
index c358fb2f34..c97891da95 100644
--- a/jetty-proxy/src/main/java/org/eclipse/jetty/proxy/AsyncMiddleManServlet.java
+++ b/jetty-proxy/src/main/java/org/eclipse/jetty/proxy/AsyncMiddleManServlet.java
@@ -197,8 +197,6 @@ public class AsyncMiddleManServlet extends AbstractProxyServlet
/**
* <p>Convenience extension of {@link AsyncMiddleManServlet} that offers transparent proxy functionalities.</p>
- *
- * @see TransparentDelegate
*/
public static class Transparent extends ProxyServlet
{
@@ -672,19 +670,19 @@ public class AsyncMiddleManServlet extends AbstractProxyServlet
* <p>Typical implementations:</p>
* <pre>
* // Identity transformation (no transformation, the input is copied to the output)
- * public void transform(ByteBuffer input, boolean finished, List<ByteBuffer> output)
+ * public void transform(ByteBuffer input, boolean finished, List&lt;ByteBuffer&gt; output)
* {
* output.add(input);
* }
*
* // Discard transformation (all input is discarded)
- * public void transform(ByteBuffer input, boolean finished, List<ByteBuffer> output)
+ * public void transform(ByteBuffer input, boolean finished, List&lt;ByteBuffer&gt; output)
* {
* // Empty
* }
*
* // Buffering identity transformation (all input is buffered aside until it is finished)
- * public void transform(ByteBuffer input, boolean finished, List<ByteBuffer> output)
+ * public void transform(ByteBuffer input, boolean finished, List&lt;ByteBuffer&gt; output)
* {
* ByteBuffer copy = ByteBuffer.allocate(input.remaining());
* copy.put(input).flip();
diff --git a/jetty-proxy/src/main/java/org/eclipse/jetty/proxy/AsyncProxyServlet.java b/jetty-proxy/src/main/java/org/eclipse/jetty/proxy/AsyncProxyServlet.java
index a371888b66..3e003d304f 100644
--- a/jetty-proxy/src/main/java/org/eclipse/jetty/proxy/AsyncProxyServlet.java
+++ b/jetty-proxy/src/main/java/org/eclipse/jetty/proxy/AsyncProxyServlet.java
@@ -101,8 +101,6 @@ public class AsyncProxyServlet extends ProxyServlet
/**
* <p>Convenience extension of {@link AsyncProxyServlet} that offers transparent proxy functionalities.</p>
- *
- * @see TransparentDelegate
*/
public static class Transparent extends AsyncProxyServlet
{
diff --git a/jetty-proxy/src/main/java/org/eclipse/jetty/proxy/ProxyServlet.java b/jetty-proxy/src/main/java/org/eclipse/jetty/proxy/ProxyServlet.java
index ac0c8efc53..15be874964 100644
--- a/jetty-proxy/src/main/java/org/eclipse/jetty/proxy/ProxyServlet.java
+++ b/jetty-proxy/src/main/java/org/eclipse/jetty/proxy/ProxyServlet.java
@@ -127,8 +127,6 @@ public class ProxyServlet extends AbstractProxyServlet
/**
* <p>Convenience extension of {@link ProxyServlet} that offers transparent proxy functionalities.</p>
- *
- * @see TransparentDelegate
*/
public static class Transparent extends ProxyServlet
{
diff --git a/jetty-security/src/main/java/org/eclipse/jetty/security/ConstraintAware.java b/jetty-security/src/main/java/org/eclipse/jetty/security/ConstraintAware.java
index a93166ca99..15f64dc430 100644
--- a/jetty-security/src/main/java/org/eclipse/jetty/security/ConstraintAware.java
+++ b/jetty-security/src/main/java/org/eclipse/jetty/security/ConstraintAware.java
@@ -21,9 +21,6 @@ package org.eclipse.jetty.security;
import java.util.List;
import java.util.Set;
-/**
- * @version $Rev: 4466 $ $Date: 2009-02-10 23:42:54 +0100 (Tue, 10 Feb 2009) $
- */
public interface ConstraintAware
{
List<ConstraintMapping> getConstraintMappings();
@@ -65,6 +62,7 @@ public interface ConstraintAware
/**
* See Servlet Spec 31, sec 13.8.4, pg 145
* Container must check if there are urls with uncovered http methods
+ * @return true if urls with uncovered http methods
*/
boolean checkPathsWithUncoveredHttpMethods();
}
diff --git a/jetty-security/src/main/java/org/eclipse/jetty/security/ConstraintSecurityHandler.java b/jetty-security/src/main/java/org/eclipse/jetty/security/ConstraintSecurityHandler.java
index fe9fef76d5..1e022fd363 100644
--- a/jetty-security/src/main/java/org/eclipse/jetty/security/ConstraintSecurityHandler.java
+++ b/jetty-security/src/main/java/org/eclipse/jetty/security/ConstraintSecurityHandler.java
@@ -50,14 +50,12 @@ import org.eclipse.jetty.util.log.Log;
import org.eclipse.jetty.util.log.Logger;
import org.eclipse.jetty.util.security.Constraint;
-/* ------------------------------------------------------------ */
/**
* ConstraintSecurityHandler
- *
+ * <p>
* Handler to enforce SecurityConstraints. This implementation is servlet spec
* 3.1 compliant and pre-computes the constraint combinations for runtime
* efficiency.
- *
*/
public class ConstraintSecurityHandler extends SecurityHandler implements ConstraintAware
{
@@ -78,9 +76,6 @@ public class ConstraintSecurityHandler extends SecurityHandler implements Constr
}
/* ------------------------------------------------------------ */
- /**
- * @param constraint
- */
public static Constraint createConstraint(Constraint constraint)
{
try
@@ -97,10 +92,11 @@ public class ConstraintSecurityHandler extends SecurityHandler implements Constr
/**
* Create a security constraint
*
- * @param name
- * @param authenticate
- * @param roles
- * @param dataConstraint
+ * @param name the name of the constraint
+ * @param authenticate true to authenticate
+ * @param roles list of roles
+ * @param dataConstraint the data constraint
+ * @return the constraint
*/
public static Constraint createConstraint (String name, boolean authenticate, String[] roles, int dataConstraint)
{
@@ -116,8 +112,11 @@ public class ConstraintSecurityHandler extends SecurityHandler implements Constr
/* ------------------------------------------------------------ */
/**
- * @param name
- * @param element
+ * Create a Constraint
+ *
+ * @param name the name
+ * @param element the http constraint element
+ * @return the created constraint
*/
public static Constraint createConstraint (String name, HttpConstraintElement element)
{
@@ -127,10 +126,13 @@ public class ConstraintSecurityHandler extends SecurityHandler implements Constr
/* ------------------------------------------------------------ */
/**
- * @param name
- * @param rolesAllowed
- * @param permitOrDeny
- * @param transport
+ * Create Constraint
+ *
+ * @param name the name
+ * @param rolesAllowed the list of allowed roles
+ * @param permitOrDeny the permission semantic
+ * @param transport the transport guarantee
+ * @return the created constraint
*/
public static Constraint createConstraint (String name, String[] rolesAllowed, EmptyRoleSemantic permitOrDeny, TransportGuarantee transport)
{
@@ -167,10 +169,6 @@ public class ConstraintSecurityHandler extends SecurityHandler implements Constr
/* ------------------------------------------------------------ */
- /**
- * @param pathSpec
- * @param constraintMappings
- */
public static List<ConstraintMapping> getConstraintMappingsForPath(String pathSpec, List<ConstraintMapping> constraintMappings)
{
if (pathSpec == null || "".equals(pathSpec.trim()) || constraintMappings == null || constraintMappings.size() == 0)
@@ -192,8 +190,9 @@ public class ConstraintSecurityHandler extends SecurityHandler implements Constr
/** Take out of the constraint mappings those that match the
* given path.
*
- * @param pathSpec
+ * @param pathSpec the path spec
* @param constraintMappings a new list minus the matching constraints
+ * @return the list of constraint mappings
*/
public static List<ConstraintMapping> removeConstraintMappingsForPath(String pathSpec, List<ConstraintMapping> constraintMappings)
{
@@ -215,12 +214,13 @@ public class ConstraintSecurityHandler extends SecurityHandler implements Constr
/* ------------------------------------------------------------ */
- /** Generate Constraints and ContraintMappings for the given url pattern and ServletSecurityElement
+ /**
+ * Generate Constraints and ContraintMappings for the given url pattern and ServletSecurityElement
*
- * @param name
- * @param pathSpec
- * @param securityElement
- * @return
+ * @param name the name
+ * @param pathSpec the path spec
+ * @param securityElement the servlet security element
+ * @return the list of constraint mappings
*/
public static List<ConstraintMapping> createConstraintsWithMappingsForPath (String name, String pathSpec, ServletSecurityElement securityElement)
{
@@ -463,7 +463,7 @@ public class ConstraintSecurityHandler extends SecurityHandler implements Constr
* Create and combine the constraint with the existing processed
* constraints.
*
- * @param mapping
+ * @param mapping the constraint mapping
*/
protected void processConstraintMapping(ConstraintMapping mapping)
{
@@ -521,8 +521,8 @@ public class ConstraintSecurityHandler extends SecurityHandler implements Constr
* the mappings: an entry that names the method of the Request specifically, an
* entry that names constraints that apply to all methods, entries of the form
* &lt;method&gt;.omission, where the method of the Request is not named in the omission.
- * @param mapping
- * @param mappings
+ * @param mapping the constraint mapping
+ * @param mappings the mappings of roles
*/
protected void processConstraintMappingWithMethodOmissions (ConstraintMapping mapping, Map<String, RoleInfo> mappings)
{
@@ -544,8 +544,8 @@ public class ConstraintSecurityHandler extends SecurityHandler implements Constr
/* ------------------------------------------------------------ */
/**
* Initialize or update the RoleInfo from the constraint
- * @param ri
- * @param mapping
+ * @param ri the role info
+ * @param mapping the constraint mapping
*/
protected void configureRoleInfo (RoleInfo ri, ConstraintMapping mapping)
{
@@ -870,9 +870,9 @@ public class ConstraintSecurityHandler extends SecurityHandler implements Constr
* Check if any http method omissions exist in the list of method
* to auth info mappings.
*
- * @param path
- * @param methodMappings
- * @return
+ * @param path the path
+ * @param methodMappings the method mappings
+ * @return true if ommision exist
*/
protected boolean omissionsExist (String path, Map<String, RoleInfo> methodMappings)
{
@@ -890,11 +890,11 @@ public class ConstraintSecurityHandler extends SecurityHandler implements Constr
/* ------------------------------------------------------------ */
/**
- * Given a string of the form &lt;method&gt;.&lt;method&gt;.omission
+ * Given a string of the form <code>&lt;method&gt;.&lt;method&gt;.omission</code>
* split out the individual method names.
*
- * @param omission
- * @return
+ * @param omission the method
+ * @return the list of strings
*/
protected Set<String> getOmittedMethods (String omission)
{
diff --git a/jetty-security/src/main/java/org/eclipse/jetty/security/IdentityService.java b/jetty-security/src/main/java/org/eclipse/jetty/security/IdentityService.java
index f93f09523a..b32da00297 100644
--- a/jetty-security/src/main/java/org/eclipse/jetty/security/IdentityService.java
+++ b/jetty-security/src/main/java/org/eclipse/jetty/security/IdentityService.java
@@ -24,10 +24,8 @@ import javax.security.auth.Subject;
import org.eclipse.jetty.server.UserIdentity;
-/* ------------------------------------------------------------ */
/**
* Associates UserIdentities from with threads and UserIdentity.Contexts.
- *
*/
public interface IdentityService
{
@@ -37,7 +35,7 @@ public interface IdentityService
/**
* Associate a user identity with the current thread.
* This is called with as a thread enters the
- * {@link SecurityHandler#handle(String, Request, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)}
+ * {@link SecurityHandler#handle(String, org.eclipse.jetty.server.Request, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)}
* method and then again with a null argument as that call exits.
* @param user The current user or null for no user to associated.
* @return an object representing the previous associated state
diff --git a/jetty-security/src/main/java/org/eclipse/jetty/security/PropertyUserStore.java b/jetty-security/src/main/java/org/eclipse/jetty/security/PropertyUserStore.java
index b4937d3a66..d5c8244141 100644
--- a/jetty-security/src/main/java/org/eclipse/jetty/security/PropertyUserStore.java
+++ b/jetty-security/src/main/java/org/eclipse/jetty/security/PropertyUserStore.java
@@ -46,12 +46,12 @@ import org.eclipse.jetty.util.security.Credential;
/**
* PropertyUserStore
- *
+ * <p>
* This class monitors a property file of the format mentioned below and notifies registered listeners of the changes to the the given file.
*
- * <PRE>
+ * <pre>
* username: password [,rolename ...]
- * </PRE>
+ * </pre>
*
* Passwords may be clear text, obfuscated or checksummed. The class com.eclipse.Util.Password should be used to generate obfuscated passwords or password
* checksums.
@@ -93,7 +93,8 @@ public class PropertyUserStore extends AbstractLifeCycle
/* ------------------------------------------------------------ */
/**
- * returns the resource associated with the configured properties file, creating it if necessary
+ * @return the resource associated with the configured properties file, creating it if necessary
+ * @throws IOException if unable to get the resource
*/
public Resource getConfigResource() throws IOException
{
@@ -108,15 +109,16 @@ public class PropertyUserStore extends AbstractLifeCycle
/* ------------------------------------------------------------ */
/**
* sets the refresh interval (in seconds)
+ * @param sec the refresh interval
*/
- public void setRefreshInterval(int msec)
+ public void setRefreshInterval(int sec)
{
- _refreshInterval = msec;
+ _refreshInterval = sec;
}
/* ------------------------------------------------------------ */
/**
- * refresh interval in seconds for how often the properties file should be checked for changes
+ * @return refresh interval in seconds for how often the properties file should be checked for changes
*/
public int getRefreshInterval()
{
@@ -334,6 +336,7 @@ public class PropertyUserStore extends AbstractLifeCycle
/**
* registers a listener to be notified of the contents of the property file
+ * @param listener the user listener
*/
public void registerUserListener(UserListener listener)
{
diff --git a/jetty-security/src/main/java/org/eclipse/jetty/security/SecurityHandler.java b/jetty-security/src/main/java/org/eclipse/jetty/security/SecurityHandler.java
index 1a8abdf6c7..532f4b863a 100644
--- a/jetty-security/src/main/java/org/eclipse/jetty/security/SecurityHandler.java
+++ b/jetty-security/src/main/java/org/eclipse/jetty/security/SecurityHandler.java
@@ -44,6 +44,7 @@ import org.eclipse.jetty.util.log.Logger;
/**
* Abstract SecurityHandler.
+ * <p>
* Select and apply an {@link Authenticator} to a request.
* <p>
* The Authenticator may either be directly set on the handler
@@ -54,7 +55,6 @@ import org.eclipse.jetty.util.log.Logger;
* Authentication.Configuration. At startup, any context init parameters
* that start with "org.eclipse.jetty.security." that do not have
* values in the SecurityHandler init parameters, are copied.
- *
*/
public abstract class SecurityHandler extends HandlerWrapper implements Authenticator.AuthConfiguration
{
@@ -129,8 +129,9 @@ public abstract class SecurityHandler extends HandlerWrapper implements Authenti
}
/* ------------------------------------------------------------ */
- /** Set the authenticator.
- * @param authenticator
+ /**
+ * Set the authenticator.
+ * @param authenticator the authenticator
* @throws IllegalStateException if the SecurityHandler is running
*/
public void setAuthenticator(Authenticator authenticator)
@@ -247,8 +248,8 @@ public abstract class SecurityHandler extends HandlerWrapper implements Authenti
/* ------------------------------------------------------------ */
/** Set an initialization parameter.
- * @param key
- * @param value
+ * @param key the init key
+ * @param value the init value
* @return previous value
* @throws IllegalStateException if the SecurityHandler is running
*/
@@ -414,6 +415,7 @@ public abstract class SecurityHandler extends HandlerWrapper implements Authenti
/** Set renew the session on Authentication.
* <p>
* If set to true, then on authentication, the session associated with a reqeuest is invalidated and replaced with a new session.
+ * @param renew true to renew the authentication on session
* @see org.eclipse.jetty.security.Authenticator.AuthConfiguration#isSessionRenewedOnAuthentication()
*/
public void setSessionRenewedOnAuthentication(boolean renew)
diff --git a/jetty-security/src/main/java/org/eclipse/jetty/security/authentication/ClientCertAuthenticator.java b/jetty-security/src/main/java/org/eclipse/jetty/security/authentication/ClientCertAuthenticator.java
index 0da4ca4cc3..814a284c11 100644
--- a/jetty-security/src/main/java/org/eclipse/jetty/security/authentication/ClientCertAuthenticator.java
+++ b/jetty-security/src/main/java/org/eclipse/jetty/security/authentication/ClientCertAuthenticator.java
@@ -42,9 +42,6 @@ import org.eclipse.jetty.util.security.CertificateValidator;
import org.eclipse.jetty.util.security.Constraint;
import org.eclipse.jetty.util.security.Password;
-/**
- * @version $Rev: 4793 $ $Date: 2009-03-19 00:00:01 +0100 (Thu, 19 Mar 2009) $
- */
public class ClientCertAuthenticator extends LoginAuthenticator
{
/** String name of keystore password property. */
@@ -83,12 +80,6 @@ public class ClientCertAuthenticator extends LoginAuthenticator
return Constraint.__CERT_AUTH;
}
-
-
- /**
- * @return Authentication for request
- * @throws ServerAuthException
- */
@Override
public Authentication validateRequest(ServletRequest req, ServletResponse res, boolean mandatory) throws ServerAuthException
{
@@ -166,7 +157,7 @@ public class ClientCertAuthenticator extends LoginAuthenticator
* @param storeProvider keystore provider
* @param storePassword keystore password
* @return created keystore
- * @throws Exception
+ * @throws Exception if unable to get keystore
*/
protected KeyStore getKeyStore(String storePath, String storeType, String storeProvider, String storePassword) throws Exception
{
@@ -183,7 +174,7 @@ public class ClientCertAuthenticator extends LoginAuthenticator
* @param crlPath path of certificate revocation list file
* @return a (possibly empty) collection view of java.security.cert.CRL objects initialized with the data from the
* input stream.
- * @throws Exception
+ * @throws Exception if unable to load CRL
*/
protected Collection<? extends CRL> loadCRL(String crlPath) throws Exception
{
diff --git a/jetty-security/src/main/java/org/eclipse/jetty/security/authentication/DeferredAuthentication.java b/jetty-security/src/main/java/org/eclipse/jetty/security/authentication/DeferredAuthentication.java
index 53276acdd0..ff896c82ad 100644
--- a/jetty-security/src/main/java/org/eclipse/jetty/security/authentication/DeferredAuthentication.java
+++ b/jetty-security/src/main/java/org/eclipse/jetty/security/authentication/DeferredAuthentication.java
@@ -140,7 +140,7 @@ public class DeferredAuthentication implements Authentication.Deferred
/* ------------------------------------------------------------ */
/**
- * @param response
+ * @param response the response
* @return true if this response is from a deferred call to {@link #authenticate(ServletRequest)}
*/
public static boolean isDeferred(HttpServletResponse response)
diff --git a/jetty-security/src/main/java/org/eclipse/jetty/security/authentication/FormAuthenticator.java b/jetty-security/src/main/java/org/eclipse/jetty/security/authentication/FormAuthenticator.java
index 48e4b84a50..4fc87fd0a9 100644
--- a/jetty-security/src/main/java/org/eclipse/jetty/security/authentication/FormAuthenticator.java
+++ b/jetty-security/src/main/java/org/eclipse/jetty/security/authentication/FormAuthenticator.java
@@ -64,8 +64,6 @@ import org.eclipse.jetty.util.security.Constraint;
* to the /j_security_check URI within the context. FormAuthentication uses
* {@link SessionAuthentication} to wrap Authentication results so that they
* are associated with the session.</p>
- *
- *
*/
public class FormAuthenticator extends LoginAuthenticator
{
@@ -109,7 +107,7 @@ public class FormAuthenticator extends LoginAuthenticator
* be remembered. If false, only the first uri that leads to a login
* page redirect is remembered.
* See https://bugs.eclipse.org/bugs/show_bug.cgi?id=379909
- * @param alwaysSave
+ * @param alwaysSave true to always save the uri
*/
public void setAlwaysSaveUri (boolean alwaysSave)
{
diff --git a/jetty-security/src/main/java/org/eclipse/jetty/security/authentication/LoginAuthenticator.java b/jetty-security/src/main/java/org/eclipse/jetty/security/authentication/LoginAuthenticator.java
index ea559ff6c7..e85b680fbe 100644
--- a/jetty-security/src/main/java/org/eclipse/jetty/security/authentication/LoginAuthenticator.java
+++ b/jetty-security/src/main/java/org/eclipse/jetty/security/authentication/LoginAuthenticator.java
@@ -92,11 +92,11 @@ public abstract class LoginAuthenticator implements Authenticator
/** Change the session id.
* The session is changed to a new instance with a new ID if and only if:<ul>
* <li>A session exists.
- * <li>The {@link AuthConfiguration#isSessionRenewedOnAuthentication()} returns true.
+ * <li>The {@link org.eclipse.jetty.security.Authenticator.AuthConfiguration#isSessionRenewedOnAuthentication()} returns true.
* <li>The session ID has been given to unauthenticated responses
* </ul>
- * @param request
- * @param response
+ * @param request the request
+ * @param response the response
* @return The new session.
*/
protected HttpSession renewSession(HttpServletRequest request, HttpServletResponse response)
diff --git a/jetty-security/src/main/java/org/eclipse/jetty/security/authentication/SpnegoAuthenticator.java b/jetty-security/src/main/java/org/eclipse/jetty/security/authentication/SpnegoAuthenticator.java
index 3f0fbe6f68..8692635bb1 100644
--- a/jetty-security/src/main/java/org/eclipse/jetty/security/authentication/SpnegoAuthenticator.java
+++ b/jetty-security/src/main/java/org/eclipse/jetty/security/authentication/SpnegoAuthenticator.java
@@ -46,7 +46,7 @@ public class SpnegoAuthenticator extends LoginAuthenticator
/**
* Allow for a custom authMethod value to be set for instances where SPENGO may not be appropriate
- * @param authMethod
+ * @param authMethod the auth method
*/
public SpnegoAuthenticator( String authMethod )
{
diff --git a/jetty-security/src/test/java/org/eclipse/jetty/security/ConstraintTest.java b/jetty-security/src/test/java/org/eclipse/jetty/security/ConstraintTest.java
index c3a83168fc..4a37e6c82c 100644
--- a/jetty-security/src/test/java/org/eclipse/jetty/security/ConstraintTest.java
+++ b/jetty-security/src/test/java/org/eclipse/jetty/security/ConstraintTest.java
@@ -220,8 +220,8 @@ public class ConstraintTest
/**
* Equivalent of Servlet Spec 3.1 pg 132, sec 13.4.1.1, Example 13-1
- * @ServletSecurity
- * @throws Exception
+ * &#064;ServletSecurity
+ * @throws Exception if test fails
*/
@Test
public void testSecurityElementExample13_1() throws Exception
@@ -234,9 +234,9 @@ public class ConstraintTest
/**
* Equivalent of Servlet Spec 3.1 pg 132, sec 13.4.1.1, Example 13-2
- * @ServletSecurity(@HttpConstraint(transportGuarantee = TransportGuarantee.CONFIDENTIAL))
+ * &#064;ServletSecurity(@HttpConstraint(transportGuarantee = TransportGuarantee.CONFIDENTIAL))
*
- * @throws Exception
+ * @throws Exception if test fails
*/
@Test
public void testSecurityElementExample13_2() throws Exception
@@ -253,7 +253,7 @@ public class ConstraintTest
/**
* Equivalent of Servlet Spec 3.1 pg 132, sec 13.4.1.1, Example 13-3
* @ServletSecurity(@HttpConstraint(EmptyRoleSemantic.DENY))
- * @throws Exception
+ * @throws Exception if test fails
*/
@Test
public void testSecurityElementExample13_3() throws Exception
@@ -270,7 +270,7 @@ public class ConstraintTest
/**
* Equivalent of Servlet Spec 3.1 pg 132, sec 13.4.1.1, Example 13-4
* @ServletSecurity(@HttpConstraint(rolesAllowed = "R1"))
- * @throws Exception
+ * @throws Exception if test fails
*/
@Test
public void testSecurityElementExample13_4() throws Exception
@@ -294,7 +294,7 @@ public class ConstraintTest
* @HttpMethodConstraint(value = "GET", rolesAllowed = "R1"),
* @HttpMethodConstraint(value = "POST", rolesAllowed = "R1",
* transportGuarantee = TransportGuarantee.CONFIDENTIAL)})
- * @throws Exception
+ * @throws Exception if test fails
*/
@Test
public void testSecurityElementExample13_5() throws Exception
@@ -319,7 +319,7 @@ public class ConstraintTest
/**
* Equivalent of Servlet Spec 3.1 pg 132, sec 13.4.1.1, Example 13-6
* @ServletSecurity(value = @HttpConstraint(rolesAllowed = "R1"), httpMethodConstraints = @HttpMethodConstraint("GET"))
- * @throws Exception
+ * @throws Exception if test fails
*/
@Test
public void testSecurityElementExample13_6 () throws Exception
@@ -345,7 +345,7 @@ public class ConstraintTest
* @ServletSecurity(value = @HttpConstraint(rolesAllowed = "R1"),
* httpMethodConstraints = @HttpMethodConstraint(value="TRACE",
* emptyRoleSemantic = EmptyRoleSemantic.DENY))
- * @throws Exception
+ * @throws Exception if test fails
*/
@Test
public void testSecurityElementExample13_7() throws Exception
diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/ClientContainer.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/ClientContainer.java
index 51569e256e..d693d1d250 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/ClientContainer.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/ClientContainer.java
@@ -330,6 +330,7 @@ public class ClientContainer extends ContainerLifeCycle implements WebSocketCont
/**
* Used in {@link Session#getOpenSessions()}
+ * @return the set of open sessions
*/
public Set<Session> getOpenSessions()
{
diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/JsrExtension.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/JsrExtension.java
index 49814ab808..f07d70fa5e 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/JsrExtension.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/JsrExtension.java
@@ -58,6 +58,7 @@ public class JsrExtension implements Extension
/**
* A configured extension
+ * @param cfg the configuration for the extension
*/
public JsrExtension(ExtensionConfig cfg)
{
@@ -73,6 +74,7 @@ public class JsrExtension implements Extension
/**
* A potential (unconfigured) extension
+ * @param name the name of the extension
*/
public JsrExtension(String name)
{
diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/MessageHandlerWrapper.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/MessageHandlerWrapper.java
index 42699f53c4..aef7ea276f 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/MessageHandlerWrapper.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/MessageHandlerWrapper.java
@@ -73,7 +73,7 @@ public class MessageHandlerWrapper
}
/**
- * Flag for a onMessage() method that wants MessageHandler.{@link Whole} with a Decoder that is based on {@link TextStream} or {@link BinaryStream}
+ * Flag for a onMessage() method that wants MessageHandler.{@link Whole} with a Decoder that is based on {@link javax.websocket.Decoder.TextStream} or {@link javax.websocket.Decoder.BinaryStream}
*
* @return true for Streaming based Decoder, false for normal decoder for whole messages.
*/
diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/AnnotatedEndpointMetadata.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/AnnotatedEndpointMetadata.java
index b05adb3834..f3304ecf3f 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/AnnotatedEndpointMetadata.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/AnnotatedEndpointMetadata.java
@@ -37,6 +37,8 @@ import org.eclipse.jetty.websocket.jsr356.metadata.EndpointMetadata;
*
* @param <T>
* the annotation this metadata is based off of
+ * @param <C>
+ * the endpoint configuration this is based off of
*/
public abstract class AnnotatedEndpointMetadata<T extends Annotation, C extends EndpointConfig> implements EndpointMetadata
{
diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/JsrCallable.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/JsrCallable.java
index c22af6d671..e78620e8f8 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/JsrCallable.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/JsrCallable.java
@@ -57,6 +57,7 @@ public abstract class JsrCallable extends CallableMethod
/**
* Copy Constructor
+ * @param copy the JsrCallable to copy from
*/
public JsrCallable(JsrCallable copy)
{
diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/JsrEvents.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/JsrEvents.java
index 9b04249ad4..76670a8524 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/JsrEvents.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/JsrEvents.java
@@ -40,6 +40,8 @@ import org.eclipse.jetty.websocket.jsr356.JsrSession;
/**
* The live event methods found for a specific Annotated Endpoint
+ * @param <T> the annotation type
+ * @param <C> the endpoint config type
*/
public class JsrEvents<T extends Annotation, C extends EndpointConfig>
{
diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/JsrParamIdDecoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/JsrParamIdDecoder.java
index 82c2109ae6..a56343b55e 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/JsrParamIdDecoder.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/JsrParamIdDecoder.java
@@ -25,7 +25,7 @@ import org.eclipse.jetty.websocket.jsr356.annotations.Param.Role;
import org.eclipse.jetty.websocket.jsr356.metadata.DecoderMetadata;
/**
- * Param handling for Text or Binary &#064;{@link OnMessage} parameters declared as {@link Decoder}s
+ * Param handling for Text or Binary &#064;{@link OnMessage} parameters declared as {@link javax.websocket.Decoder}s
*/
public class JsrParamIdDecoder extends JsrParamIdOnMessage implements IJsrParamId
{
diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageBinaryCallable.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageBinaryCallable.java
index de3e5f7e8d..d7a281c4c0 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageBinaryCallable.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageBinaryCallable.java
@@ -31,9 +31,9 @@ import org.eclipse.jetty.websocket.jsr356.annotations.Param.Role;
/**
* Callable for {@link OnMessage} annotated methods with a whole or partial binary messages.
* <p>
- * Not for use with {@link InputStream} based {@link OnMessage} method objects.
+ * Not for use with {@link java.io.InputStream} based {@link OnMessage} method objects.
*
- * @see Binary
+ * @see javax.websocket.Decoder.Binary
*/
public class OnMessageBinaryCallable extends OnMessageCallable
{
@@ -46,6 +46,7 @@ public class OnMessageBinaryCallable extends OnMessageCallable
/**
* Copy Constructor
+ * @param copy the callable to copy
*/
public OnMessageBinaryCallable(OnMessageCallable copy)
{
diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageBinaryStreamCallable.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageBinaryStreamCallable.java
index 3da4372a1e..41f8c1be51 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageBinaryStreamCallable.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageBinaryStreamCallable.java
@@ -33,7 +33,7 @@ import org.eclipse.jetty.websocket.jsr356.annotations.Param.Role;
/**
* Callable for {@link OnMessage} annotated methods for {@link InputStream} based binary message objects
*
- * @see BinaryStream
+ * @see javax.websocket.Decoder.BinaryStream
*/
public class OnMessageBinaryStreamCallable extends OnMessageCallable
{
@@ -46,6 +46,7 @@ public class OnMessageBinaryStreamCallable extends OnMessageCallable
/**
* Copy Constructor
+ * @param copy the callable to copy from
*/
public OnMessageBinaryStreamCallable(OnMessageCallable copy)
{
diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessagePongCallable.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessagePongCallable.java
index 87b66253c1..4b9cb63a0f 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessagePongCallable.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessagePongCallable.java
@@ -40,6 +40,7 @@ public class OnMessagePongCallable extends OnMessageCallable
/**
* Copy Constructor
+ * @param copy the callable to copy from
*/
public OnMessagePongCallable(OnMessageCallable copy)
{
diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageTextCallable.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageTextCallable.java
index 1f6a97d033..4944f825d7 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageTextCallable.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageTextCallable.java
@@ -33,7 +33,7 @@ import org.eclipse.jetty.websocket.jsr356.annotations.Param.Role;
* <p>
* Not for use with {@link Reader} based {@link OnMessage} method objects.
*
- * @see Text
+ * @see javax.websocket.Decoder.Text
*/
public class OnMessageTextCallable extends OnMessageCallable
{
@@ -46,6 +46,7 @@ public class OnMessageTextCallable extends OnMessageCallable
/**
* Copy Constructor
+ * @param copy the callable to copy from
*/
public OnMessageTextCallable(OnMessageCallable copy)
{
diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageTextStreamCallable.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageTextStreamCallable.java
index fb32124af2..fb9ef17dfe 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageTextStreamCallable.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageTextStreamCallable.java
@@ -32,7 +32,7 @@ import org.eclipse.jetty.websocket.jsr356.annotations.Param.Role;
/**
* Callable for {@link OnMessage} annotated methods for {@link Reader} based text message objects
*
- * @see TextStream
+ * @see javax.websocket.Decoder.TextStream
*/
public class OnMessageTextStreamCallable extends OnMessageCallable
{
@@ -45,6 +45,7 @@ public class OnMessageTextStreamCallable extends OnMessageCallable
/**
* Copy Constructor
+ * @param copy the callable to copy from
*/
public OnMessageTextStreamCallable(OnMessageCallable copy)
{
diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/BooleanDecoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/BooleanDecoder.java
index c18c5666c7..4ee6f3f2a9 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/BooleanDecoder.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/BooleanDecoder.java
@@ -23,7 +23,7 @@ import javax.websocket.Decoder;
/**
- * Default implementation of the {@link Text} Message to {@link Boolean} decoder.
+ * Default implementation of the {@link javax.websocket.Decoder.Text} Message to {@link Boolean} decoder.
* <p>
* Note: delegates to {@link Boolean#parseBoolean(String)} and will only support "true" and "false" as boolean values.
*/
diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/ByteDecoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/ByteDecoder.java
index 5bdd8d6905..74f931c589 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/ByteDecoder.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/ByteDecoder.java
@@ -23,7 +23,7 @@ import javax.websocket.Decoder;
/**
- * Default implementation of the {@link Text} Message to {@link Byte} decoder
+ * Default implementation of the {@link javax.websocket.Decoder.Text} Message to {@link Byte} decoder
*/
public class ByteDecoder extends AbstractDecoder implements Decoder.Text<Byte>
{
diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/CharacterDecoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/CharacterDecoder.java
index b092fcb520..53b3a93445 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/CharacterDecoder.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/CharacterDecoder.java
@@ -23,7 +23,7 @@ import javax.websocket.Decoder;
/**
- * Default implementation of the {@link Text} Message to {@link Character} decoder
+ * Default implementation of the {@link javax.websocket.Decoder.Text} Message to {@link Character} decoder
*/
public class CharacterDecoder extends AbstractDecoder implements Decoder.Text<Character>
{
diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/DoubleDecoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/DoubleDecoder.java
index 1bb9c6fcd5..ee2662f44e 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/DoubleDecoder.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/DoubleDecoder.java
@@ -23,7 +23,7 @@ import javax.websocket.Decoder;
/**
- * Default implementation of the {@link Text} Message to {@link Double} to decoder
+ * Default implementation of the {@link javax.websocket.Decoder.Text} Message to {@link Double} to decoder
*/
public class DoubleDecoder extends AbstractDecoder implements Decoder.Text<Double>
{
diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/IntegerDecoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/IntegerDecoder.java
index 0cee891225..6cc4026a1f 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/IntegerDecoder.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/IntegerDecoder.java
@@ -23,7 +23,7 @@ import javax.websocket.Decoder;
/**
- * Default implementation of the {@link Text} Message to {@link Integer} decoder
+ * Default implementation of the {@link javax.websocket.Decoder.Text} Message to {@link Integer} decoder
*/
public class IntegerDecoder extends AbstractDecoder implements Decoder.Text<Integer>
{
diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/ShortDecoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/ShortDecoder.java
index 95133a372d..66e4e45a78 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/ShortDecoder.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/ShortDecoder.java
@@ -23,7 +23,7 @@ import javax.websocket.Decoder;
/**
- * Default implementation of the {@link Text} Message to {@link Short} decoder
+ * Default implementation of the {@link javax.websocket.Decoder.Text} Message to {@link Short} decoder
*/
public class ShortDecoder extends AbstractDecoder implements Decoder.Text<Short>
{
diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/StringDecoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/StringDecoder.java
index 94bf773a22..e99780c54d 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/StringDecoder.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/StringDecoder.java
@@ -23,7 +23,7 @@ import javax.websocket.Decoder;
/**
- * Default implementation of the {@link Text} Message to {@link String} decoder
+ * Default implementation of the {@link javax.websocket.Decoder.Text} Message to {@link String} decoder
*/
public class StringDecoder extends AbstractDecoder implements Decoder.Text<String>
{
diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/BooleanEncoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/BooleanEncoder.java
index c4f22d292c..9b9f68bfd6 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/BooleanEncoder.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/BooleanEncoder.java
@@ -22,7 +22,7 @@ import javax.websocket.EncodeException;
import javax.websocket.Encoder;
/**
- * Default encoder for {@link Boolean} to {@link Text} Message encoder
+ * Default encoder for {@link Boolean} to {@link javax.websocket.Encoder.Text} Message encoder
*/
public class BooleanEncoder extends AbstractEncoder implements Encoder.Text<Boolean>
{
diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/ByteEncoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/ByteEncoder.java
index 3963d05b03..4fa090aab5 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/ByteEncoder.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/ByteEncoder.java
@@ -22,7 +22,7 @@ import javax.websocket.EncodeException;
import javax.websocket.Encoder;
/**
- * Default encoder for {@link Byte} to {@link Text} Message encoder
+ * Default encoder for {@link Byte} to {@link javax.websocket.Encoder.Text} Message encoder
*/
public class ByteEncoder extends AbstractEncoder implements Encoder.Text<Byte>
{
diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/CharacterEncoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/CharacterEncoder.java
index 87d1fa34ec..ba828fa7af 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/CharacterEncoder.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/CharacterEncoder.java
@@ -22,7 +22,7 @@ import javax.websocket.EncodeException;
import javax.websocket.Encoder;
/**
- * Default encoder for {@link Character} to {@link Text} Message encoder
+ * Default encoder for {@link Character} to {@link javax.websocket.Encoder.Text} Message encoder
*/
public class CharacterEncoder extends AbstractEncoder implements Encoder.Text<Character>
{
diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/DoubleEncoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/DoubleEncoder.java
index bc97d2232b..0831b8b8ee 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/DoubleEncoder.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/DoubleEncoder.java
@@ -22,7 +22,7 @@ import javax.websocket.EncodeException;
import javax.websocket.Encoder;
/**
- * Default encoder for {@link Double} to {@link Text} Message encoder
+ * Default encoder for {@link Double} to {@link javax.websocket.Encoder.Text} Message encoder
*/
public class DoubleEncoder extends AbstractEncoder implements Encoder.Text<Double>
{
diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/FloatEncoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/FloatEncoder.java
index a9df32abed..b5dda8dbd8 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/FloatEncoder.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/FloatEncoder.java
@@ -21,7 +21,7 @@ package org.eclipse.jetty.websocket.jsr356.encoders;
import javax.websocket.EncodeException;
import javax.websocket.Encoder;
/**
- * Default encoder for {@link Float} to {@link Text} Message encoder
+ * Default encoder for {@link Float} to {@link javax.websocket.Encoder.Text} Message encoder
*/
public class FloatEncoder extends AbstractEncoder implements Encoder.Text<Float>
{
diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/IntegerEncoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/IntegerEncoder.java
index 124c8401b1..067227c387 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/IntegerEncoder.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/IntegerEncoder.java
@@ -22,7 +22,7 @@ import javax.websocket.EncodeException;
import javax.websocket.Encoder;
/**
- * Default encoder for {@link Integer} to {@link Text} Message encoder
+ * Default encoder for {@link Integer} to {@link javax.websocket.Encoder.Text} Message encoder
*/
public class IntegerEncoder extends AbstractEncoder implements Encoder.Text<Integer>
{
diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/LongEncoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/LongEncoder.java
index f41a5700a4..1b387742d5 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/LongEncoder.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/LongEncoder.java
@@ -22,7 +22,7 @@ import javax.websocket.EncodeException;
import javax.websocket.Encoder;
/**
- * Default encoder for {@link Long} to {@link Text} Message encoder
+ * Default encoder for {@link Long} to {@link javax.websocket.Encoder.Text} Message encoder
*/
public class LongEncoder extends AbstractEncoder implements Encoder.Text<Long>
{
diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/ShortEncoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/ShortEncoder.java
index c2b55af59a..e82eb6dc3a 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/ShortEncoder.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/ShortEncoder.java
@@ -22,7 +22,7 @@ import javax.websocket.EncodeException;
import javax.websocket.Encoder;
/**
- * Default encoder for {@link Short} to {@link Text} Message encoder
+ * Default encoder for {@link Short} to {@link javax.websocket.Encoder.Text} Message encoder
*/
public class ShortEncoder extends AbstractEncoder implements Encoder.Text<Short>
{
diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/StringEncoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/StringEncoder.java
index 701d53b6f6..66f7071258 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/StringEncoder.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/StringEncoder.java
@@ -22,7 +22,7 @@ import javax.websocket.EncodeException;
import javax.websocket.Encoder;
/**
- * Default encoder for {@link String} to {@link Text} Message encoder
+ * Default encoder for {@link String} to {@link javax.websocket.Encoder.Text} Message encoder
*/
public class StringEncoder extends AbstractEncoder implements Encoder.Text<String>
{
diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/metadata/CoderMetadata.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/metadata/CoderMetadata.java
index 6333315766..38ac535f43 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/metadata/CoderMetadata.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/metadata/CoderMetadata.java
@@ -21,10 +21,10 @@ package org.eclipse.jetty.websocket.jsr356.metadata;
import org.eclipse.jetty.websocket.jsr356.MessageType;
/**
- * The immutable base metadata for a coder ({@link Decoder} or {@link Encoder}
+ * The immutable base metadata for a coder ({@link javax.websocket.Decoder} or {@link javax.websocket.Encoder}
*
* @param <T>
- * the specific type of coder ({@link Decoder} or {@link Encoder}
+ * the specific type of coder ({@link javax.websocket.Decoder} or {@link javax.websocket.Encoder}
*/
public abstract class CoderMetadata<T>
{
diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/metadata/CoderMetadataSet.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/metadata/CoderMetadataSet.java
index 35dcd65b0e..ded82019de 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/metadata/CoderMetadataSet.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/metadata/CoderMetadataSet.java
@@ -32,7 +32,7 @@ import org.eclipse.jetty.websocket.api.InvalidWebSocketException;
* This is a write-only collection, and cannot be modified once initialized.
*
* @param <T>
- * The type of coder ({@link Decoder} or {@link Encoder}
+ * The type of coder ({@link javax.websocket.Decoder} or {@link javax.websocket.Encoder}
* @param <M>
* The metadata for the coder
*/
diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/metadata/DuplicateCoderException.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/metadata/DuplicateCoderException.java
index 331cc31af6..c7cbe137d3 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/metadata/DuplicateCoderException.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/metadata/DuplicateCoderException.java
@@ -21,7 +21,7 @@ package org.eclipse.jetty.websocket.jsr356.metadata;
import org.eclipse.jetty.websocket.api.InvalidWebSocketException;
/**
- * Thrown when a duplicate coder is encountered when attempting to identify a Endpoint's metadata ( {@link Decoder} or {@link Encoder})
+ * Thrown when a duplicate coder is encountered when attempting to identify a Endpoint's metadata ({@link javax.websocket.Decoder} or {@link javax.websocket.Encoder})
*/
public class DuplicateCoderException extends InvalidWebSocketException
{
diff --git a/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/ConfiguratorTest.java b/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/ConfiguratorTest.java
index e37eaecdb7..29805808fb 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/ConfiguratorTest.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/ConfiguratorTest.java
@@ -40,7 +40,7 @@ import org.junit.BeforeClass;
import org.junit.Test;
/**
- * Tests of {@link Configurator}
+ * Tests of {@link javax.websocket.ClientEndpointConfig.Configurator}
*/
public class ConfiguratorTest
{
diff --git a/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidCloseIntSocket.java b/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidCloseIntSocket.java
index 63faaec339..52c5dc14a3 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidCloseIntSocket.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidCloseIntSocket.java
@@ -28,6 +28,7 @@ public class InvalidCloseIntSocket extends TrackingSocket
{
/**
* Invalid Close Method Declaration (parameter type int)
+ * @param statusCode the status code
*/
@OnClose
public void onClose(int statusCode)
diff --git a/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidErrorErrorSocket.java b/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidErrorErrorSocket.java
index 65550ea07f..2b30078c61 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidErrorErrorSocket.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidErrorErrorSocket.java
@@ -28,6 +28,7 @@ public class InvalidErrorErrorSocket extends TrackingSocket
{
/**
* Invalid Error Method Declaration (parameter type Error)
+ * @param error the error
*/
@OnError
public void onError(Error error)
diff --git a/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidErrorExceptionSocket.java b/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidErrorExceptionSocket.java
index 8899e5b192..bd191bdc7e 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidErrorExceptionSocket.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidErrorExceptionSocket.java
@@ -28,6 +28,7 @@ public class InvalidErrorExceptionSocket extends TrackingSocket
{
/**
* Invalid Error Method Declaration (parameter type Exception)
+ * @param e the extension
*/
@OnError
public void onError(Exception e)
diff --git a/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidErrorIntSocket.java b/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidErrorIntSocket.java
index ab29ef4354..6e23ee6457 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidErrorIntSocket.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidErrorIntSocket.java
@@ -28,6 +28,7 @@ public class InvalidErrorIntSocket extends TrackingSocket
{
/**
* Invalid Error Method Declaration (parameter type int)
+ * @param errorCount the error count
*/
@OnError
public void onError(int errorCount)
diff --git a/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidOpenCloseReasonSocket.java b/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidOpenCloseReasonSocket.java
index 702a221374..8fd202ae1f 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidOpenCloseReasonSocket.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidOpenCloseReasonSocket.java
@@ -29,6 +29,7 @@ public class InvalidOpenCloseReasonSocket extends TrackingSocket
{
/**
* Invalid Open Method Declaration (parameter type CloseReason)
+ * @param reason the close reason
*/
@OnOpen
public void onOpen(CloseReason reason)
diff --git a/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidOpenIntSocket.java b/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidOpenIntSocket.java
index c52807416f..6abef152cf 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidOpenIntSocket.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidOpenIntSocket.java
@@ -28,6 +28,7 @@ public class InvalidOpenIntSocket extends TrackingSocket
{
/**
* Invalid Open Method Declaration (parameter type int)
+ * @param value the open value
*/
@OnOpen
public void onOpen(int value)
diff --git a/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidOpenSessionIntSocket.java b/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidOpenSessionIntSocket.java
index bb73ed427b..737fb0507b 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidOpenSessionIntSocket.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/samples/InvalidOpenSessionIntSocket.java
@@ -29,6 +29,8 @@ public class InvalidOpenSessionIntSocket extends TrackingSocket
{
/**
* Invalid Open Method Declaration (parameter of type int)
+ * @param session the session for the open
+ * @param count the open count
*/
@OnOpen
public void onOpen(Session session, int count)
diff --git a/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/samples/ExtDecoder.java b/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/samples/ExtDecoder.java
index 65b9426e03..ad7f4523cf 100644
--- a/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/samples/ExtDecoder.java
+++ b/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/samples/ExtDecoder.java
@@ -22,6 +22,7 @@ import javax.websocket.Decoder;
/**
* Testing scenario of an extended Decoder interface
+ * @param <T> the decoder type
*/
public interface ExtDecoder<T> extends Decoder.Text<T>
{
diff --git a/jetty-websocket/javax-websocket-server-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/server/ContainerDefaultConfigurator.java b/jetty-websocket/javax-websocket-server-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/server/ContainerDefaultConfigurator.java
index 18902a0d17..dd20bf15b5 100644
--- a/jetty-websocket/javax-websocket-server-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/server/ContainerDefaultConfigurator.java
+++ b/jetty-websocket/javax-websocket-server-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/server/ContainerDefaultConfigurator.java
@@ -34,7 +34,7 @@ import org.eclipse.jetty.websocket.api.util.QuoteUtil;
/**
* The "Container Default Configurator" per the JSR-356 spec.
*
- * @see ServiceLoader behavior of {@link ServerEndpointConfig.Configurator}
+ * @see ServiceLoader behavior of {@link javax.websocket.server.ServerEndpointConfig.Configurator}
*/
public final class ContainerDefaultConfigurator extends Configurator
{
diff --git a/jetty-websocket/javax-websocket-server-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/server/deploy/WebSocketServerContainerInitializer.java b/jetty-websocket/javax-websocket-server-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/server/deploy/WebSocketServerContainerInitializer.java
index 76bd63d1bb..7592c46022 100644
--- a/jetty-websocket/javax-websocket-server-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/server/deploy/WebSocketServerContainerInitializer.java
+++ b/jetty-websocket/javax-websocket-server-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/server/deploy/WebSocketServerContainerInitializer.java
@@ -51,6 +51,10 @@ public class WebSocketServerContainerInitializer implements ServletContainerInit
* Jetty Native approach.
* <p>
* Note: this will add the Upgrade filter to the existing list, with no regard for order. It will just be tacked onto the end of the list.
+ *
+ * @param context the servlet context handler
+ * @return the created websocket server container
+ * @throws ServletException if unable to create the websocket server container
*/
public static ServerContainer configureContext(ServletContextHandler context) throws ServletException
{
@@ -71,6 +75,11 @@ public class WebSocketServerContainerInitializer implements ServletContainerInit
* Servlet 3.1 approach.
* <p>
* This will use Servlet 3.1 techniques on the {@link ServletContext} to add a filter at the start of the filter chain.
+ *
+ * @param context the servlet context
+ * @param jettyContext the jetty servlet context handler
+ * @return the created websocket server container
+ * @throws ServletException if unable to create the websocket server container
*/
public static ServerContainer configureContext(ServletContext context, ServletContextHandler jettyContext) throws ServletException
{
diff --git a/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/BasicEndpointTest.java b/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/BasicEndpointTest.java
index 05f7284fb1..001448fac9 100644
--- a/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/BasicEndpointTest.java
+++ b/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/BasicEndpointTest.java
@@ -35,7 +35,7 @@ import org.junit.Rule;
import org.junit.Test;
/**
- * Example of an {@link Endpoint} extended echo server added programmatically via the
+ * Example of an {@link javax.websocket.Endpoint} extended echo server added programmatically via the
* {@link ServerContainer#addEndpoint(javax.websocket.server.ServerEndpointConfig)}
*/
public class BasicEndpointTest
diff --git a/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/ConfiguratorTest.java b/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/ConfiguratorTest.java
index 26ba94a60a..44c2ddad6c 100644
--- a/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/ConfiguratorTest.java
+++ b/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/ConfiguratorTest.java
@@ -417,6 +417,7 @@ public class ConfiguratorTest
/**
* Test of Sec-WebSocket-Protocol, as seen in RFC-6455, 1 protocol
+ * @throws Exception on test failure
*/
@Test
public void testProtocol_Single() throws Exception
@@ -440,6 +441,7 @@ public class ConfiguratorTest
/**
* Test of Sec-WebSocket-Protocol, as seen in RFC-6455, 3 protocols
+ * @throws Exception on test failure
*/
@Test
public void testProtocol_Triple() throws Exception
@@ -463,6 +465,7 @@ public class ConfiguratorTest
/**
* Test of Sec-WebSocket-Protocol, using all lowercase header
+ * @throws Exception on test failure
*/
@Test
public void testProtocol_LowercaseHeader() throws Exception
@@ -486,6 +489,7 @@ public class ConfiguratorTest
/**
* Test of Sec-WebSocket-Protocol, using non-spec case header
+ * @throws Exception on test failure
*/
@Test
public void testProtocol_AltHeaderCase() throws Exception
diff --git a/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidCloseIntSocket.java b/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidCloseIntSocket.java
index 956d3f4367..af20c584ad 100644
--- a/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidCloseIntSocket.java
+++ b/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidCloseIntSocket.java
@@ -28,6 +28,7 @@ public class InvalidCloseIntSocket extends TrackingSocket
{
/**
* Invalid Close Method Declaration (parameter type int)
+ * @param statusCode the status code
*/
@OnClose
public void onClose(int statusCode)
diff --git a/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidErrorErrorSocket.java b/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidErrorErrorSocket.java
index 1f38f40bb9..a3fe92cd43 100644
--- a/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidErrorErrorSocket.java
+++ b/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidErrorErrorSocket.java
@@ -28,6 +28,7 @@ public class InvalidErrorErrorSocket extends TrackingSocket
{
/**
* Invalid Error Method Declaration (parameter type Error)
+ * @param error the error
*/
@OnError
public void onError(Error error)
diff --git a/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidErrorExceptionSocket.java b/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidErrorExceptionSocket.java
index c2ec17ac2e..dce13d4e06 100644
--- a/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidErrorExceptionSocket.java
+++ b/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidErrorExceptionSocket.java
@@ -28,6 +28,7 @@ public class InvalidErrorExceptionSocket extends TrackingSocket
{
/**
* Invalid Error Method Declaration (parameter type Exception)
+ * @param e the exception
*/
@OnError
public void onError(Exception e)
diff --git a/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidErrorIntSocket.java b/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidErrorIntSocket.java
index f6c2a340d1..48f45a3086 100644
--- a/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidErrorIntSocket.java
+++ b/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidErrorIntSocket.java
@@ -28,6 +28,7 @@ public class InvalidErrorIntSocket extends TrackingSocket
{
/**
* Invalid Error Method Declaration (parameter type int)
+ * @param errorCount the error count
*/
@OnError
public void onError(int errorCount)
diff --git a/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidOpenCloseReasonSocket.java b/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidOpenCloseReasonSocket.java
index 41813598da..0e97246d4b 100644
--- a/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidOpenCloseReasonSocket.java
+++ b/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidOpenCloseReasonSocket.java
@@ -29,6 +29,7 @@ public class InvalidOpenCloseReasonSocket extends TrackingSocket
{
/**
* Invalid Open Method Declaration (parameter type CloseReason)
+ * @param reason the close reason
*/
@OnOpen
public void onOpen(CloseReason reason)
diff --git a/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidOpenIntSocket.java b/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidOpenIntSocket.java
index fa87b658ad..91fabeaa53 100644
--- a/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidOpenIntSocket.java
+++ b/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidOpenIntSocket.java
@@ -28,6 +28,7 @@ public class InvalidOpenIntSocket extends TrackingSocket
{
/**
* Invalid Open Method Declaration (parameter type int)
+ * @param value the value
*/
@OnOpen
public void onOpen(int value)
diff --git a/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidOpenSessionIntSocket.java b/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidOpenSessionIntSocket.java
index 9739b978c8..bed3f8f75f 100644
--- a/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidOpenSessionIntSocket.java
+++ b/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/InvalidOpenSessionIntSocket.java
@@ -29,6 +29,8 @@ public class InvalidOpenSessionIntSocket extends TrackingSocket
{
/**
* Invalid Open Method Declaration (parameter of type int)
+ * @param session the sesion
+ * @param count the count
*/
@OnOpen
public void onOpen(Session session, int count)
diff --git a/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/echo/BasicEchoEndpointConfigContextListener.java b/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/echo/BasicEchoEndpointConfigContextListener.java
index fac2bffecb..94f58be02c 100644
--- a/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/echo/BasicEchoEndpointConfigContextListener.java
+++ b/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/echo/BasicEchoEndpointConfigContextListener.java
@@ -25,7 +25,7 @@ import javax.websocket.server.ServerContainer;
import javax.websocket.server.ServerEndpointConfig;
/**
- * Example of adding a server WebSocket (extending {@link Endpoint}) programmatically via config
+ * Example of adding a server WebSocket (extending {@link javax.websocket.Endpoint}) programmatically via config
*/
public class BasicEchoEndpointConfigContextListener implements ServletContextListener
{
diff --git a/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/echo/BasicEchoEndpointContextListener.java b/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/echo/BasicEchoEndpointContextListener.java
index 89281e9561..3ac5f5c7e2 100644
--- a/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/echo/BasicEchoEndpointContextListener.java
+++ b/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/echo/BasicEchoEndpointContextListener.java
@@ -27,7 +27,7 @@ import javax.websocket.server.ServerEndpointConfig;
import org.eclipse.jetty.websocket.jsr356.server.samples.pong.PongMessageEndpoint;
/**
- * Example of adding a server WebSocket (extending {@link Endpoint}) programmatically directly.
+ * Example of adding a server WebSocket (extending {@link javax.websocket.Endpoint}) programmatically directly.
* <p>
* NOTE: this shouldn't work as the endpoint has no path associated with it.
*/
diff --git a/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/echo/BasicEchoSocketConfigContextListener.java b/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/echo/BasicEchoSocketConfigContextListener.java
index 13185bc952..a6c9fb5229 100644
--- a/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/echo/BasicEchoSocketConfigContextListener.java
+++ b/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/echo/BasicEchoSocketConfigContextListener.java
@@ -25,7 +25,7 @@ import javax.websocket.server.ServerContainer;
import javax.websocket.server.ServerEndpointConfig;
/**
- * Example of adding a server socket (which extends {@link Endpoint}) programmatically via the {@link ServerContainer#addEndpoint(ServerEndpointConfig)}
+ * Example of adding a server socket (which extends {@link javax.websocket.Endpoint}) programmatically via the {@link ServerContainer#addEndpoint(ServerEndpointConfig)}
*/
public class BasicEchoSocketConfigContextListener implements ServletContextListener
{
diff --git a/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/idletimeout/IdleTimeoutContextListener.java b/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/idletimeout/IdleTimeoutContextListener.java
index dd2194ab16..5dbc69c5af 100644
--- a/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/idletimeout/IdleTimeoutContextListener.java
+++ b/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/samples/idletimeout/IdleTimeoutContextListener.java
@@ -25,7 +25,7 @@ import javax.websocket.server.ServerContainer;
import javax.websocket.server.ServerEndpointConfig;
/**
- * Example of adding a server WebSocket (extending {@link Endpoint}) programmatically via config
+ * Example of adding a server WebSocket (extending {@link javax.websocket.Endpoint}) programmatically via config
*/
public class IdleTimeoutContextListener implements ServletContextListener
{
diff --git a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/BatchMode.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/BatchMode.java
index 10106da433..530cb0b61d 100644
--- a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/BatchMode.java
+++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/BatchMode.java
@@ -21,7 +21,7 @@ package org.eclipse.jetty.websocket.api;
import org.eclipse.jetty.websocket.api.extensions.OutgoingFrames;
/**
- * The possible batch modes when invoking {@link OutgoingFrames#outgoingFrame(Frame, WriteCallback, BatchMode)}.
+ * The possible batch modes when invoking {@link OutgoingFrames#outgoingFrame(org.eclipse.jetty.websocket.api.extensions.Frame, WriteCallback, BatchMode)}.
*/
public enum BatchMode
{
diff --git a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/RemoteEndpoint.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/RemoteEndpoint.java
index c2a81bd27d..39e3c97b48 100644
--- a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/RemoteEndpoint.java
+++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/RemoteEndpoint.java
@@ -31,11 +31,14 @@ public interface RemoteEndpoint
*
* @param data
* the message to be sent
+ * @throws IOException
+ * if unable to send the bytes
*/
void sendBytes(ByteBuffer data) throws IOException;
/**
- * Initiates the asynchronous transmission of a binary message. This method returns before the message is transmitted. Developers may use the returned
+ * Initiates the asynchronous transmission of a binary message. This method returns before the message is
+ * transmitted. Developers may use the returned
* Future object to track progress of the transmission.
*
* @param data
@@ -45,7 +48,8 @@ public interface RemoteEndpoint
Future<Void> sendBytesByFuture(ByteBuffer data);
/**
- * Initiates the asynchronous transmission of a binary message. This method returns before the message is transmitted. Developers may provide a callback to
+ * Initiates the asynchronous transmission of a binary message. This method returns before the message is
+ * transmitted. Developers may provide a callback to
* be notified when the message has been transmitted or resulted in an error.
*
* @param data
@@ -56,38 +60,54 @@ public interface RemoteEndpoint
void sendBytes(ByteBuffer data, WriteCallback callback);
/**
- * Send a binary message in pieces, blocking until all of the message has been transmitted. The runtime reads the message in order. Non-final pieces are
+ * Send a binary message in pieces, blocking until all of the message has been transmitted. The runtime reads the
+ * message in order. Non-final pieces are
* sent with isLast set to false. The final piece must be sent with isLast set to true.
*
* @param fragment
* the piece of the message being sent
+ * @param isLast
+ * true if this is the last piece of the partial bytes
+ * @throws IOException
+ * if unable to send the partial bytes
*/
void sendPartialBytes(ByteBuffer fragment, boolean isLast) throws IOException;
/**
- * Send a text message in pieces, blocking until all of the message has been transmitted. The runtime reads the message in order. Non-final pieces are sent
+ * Send a text message in pieces, blocking until all of the message has been transmitted. The runtime reads the
+ * message in order. Non-final pieces are sent
* with isLast set to false. The final piece must be sent with isLast set to true.
*
* @param fragment
* the piece of the message being sent
+ * @param isLast
+ * true if this is the last piece of the partial bytes
+ * @throws IOException
+ * if unable to send the partial bytes
*/
void sendPartialString(String fragment, boolean isLast) throws IOException;
/**
- * Send a Ping message containing the given application data to the remote endpoint. The corresponding Pong message may be picked up using the
+ * Send a Ping message containing the given application data to the remote endpoint. The corresponding Pong message
+ * may be picked up using the
* MessageHandler.Pong handler.
*
* @param applicationData
* the data to be carried in the ping request
+ * @throws IOException
+ * if unable to send the ping
*/
void sendPing(ByteBuffer applicationData) throws IOException;
/**
- * Allows the developer to send an unsolicited Pong message containing the given application data in order to serve as a unidirectional heartbeat for the
+ * Allows the developer to send an unsolicited Pong message containing the given application data in order to serve
+ * as a unidirectional heartbeat for the
* session.
*
* @param applicationData
* the application data to be carried in the pong response.
+ * @throws IOException
+ * if unable to send the pong
*/
void sendPong(ByteBuffer applicationData) throws IOException;
@@ -98,11 +118,14 @@ public interface RemoteEndpoint
*
* @param text
* the message to be sent
+ * @throws IOException
+ * if unable to send the text message
*/
void sendString(String text) throws IOException;
/**
- * Initiates the asynchronous transmission of a text message. This method may return before the message is transmitted. Developers may use the returned
+ * Initiates the asynchronous transmission of a text message. This method may return before the message is
+ * transmitted. Developers may use the returned
* Future object to track progress of the transmission.
*
* @param text
@@ -112,7 +135,8 @@ public interface RemoteEndpoint
Future<Void> sendStringByFuture(String text);
/**
- * Initiates the asynchronous transmission of a text message. This method may return before the message is transmitted. Developers may provide a callback to
+ * Initiates the asynchronous transmission of a text message. This method may return before the message is
+ * transmitted. Developers may provide a callback to
* be notified when the message has been transmitted or resulted in an error.
*
* @param text
@@ -130,7 +154,9 @@ public interface RemoteEndpoint
/**
* Flushes messages that may have been batched by the implementation.
- * @throws IOException if the flush fails
+ *
+ * @throws IOException
+ * if the flush fails
* @see #getBatchMode()
*/
void flush() throws IOException;
diff --git a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/Session.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/Session.java
index 9a06435b07..3d28ecb290 100644
--- a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/Session.java
+++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/Session.java
@@ -26,7 +26,6 @@ import org.eclipse.jetty.websocket.api.annotations.OnWebSocketClose;
/**
* Session represents an active link of communications with a Remote WebSocket Endpoint.
- * <p>
*/
public interface Session extends Closeable
{
@@ -82,7 +81,11 @@ public interface Session extends Closeable
* Once called, any read/write activity on the websocket from this point will be indeterminate.
* <p>
* Once the underlying connection has been determined to be closed, the various onClose() events (either
- * {@link WebSocketListener#onWebSocketClose(int, String)} or {@link OnWebSocketClose}) will be called on your websocket.
+ * {@link WebSocketListener#onWebSocketClose(int, String)} or {@link OnWebSocketClose}) will be called on your
+ * websocket.
+ *
+ * @throws IOException
+ * if unable to disconnect
*
* @see #close()
* @see #close(CloseStatus)
diff --git a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/UpgradeResponse.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/UpgradeResponse.java
index a98a6f39d7..91df0d723b 100644
--- a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/UpgradeResponse.java
+++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/UpgradeResponse.java
@@ -136,13 +136,15 @@ public class UpgradeResponse
/**
* Issue a forbidden upgrade response.
* <p>
- * This means that the websocket endpoint was valid, but the conditions to use a WebSocket resulted in a forbidden access.
+ * This means that the websocket endpoint was valid, but the conditions to use a WebSocket resulted in a forbidden
+ * access.
* <p>
* Use this when the origin or authentication is invalid.
*
* @param message
* the short 1 line detail message about the forbidden response
* @throws IOException
+ * if unable to send the forbidden
*/
public void sendForbidden(String message) throws IOException
{
diff --git a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/WebSocketListener.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/WebSocketListener.java
index b86095154b..0037b32547 100644
--- a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/WebSocketListener.java
+++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/WebSocketListener.java
@@ -66,7 +66,7 @@ public interface WebSocketListener
* <p>
* This will result in the {@link Session} being closed by the implementing side.
*
- * @param error
+ * @param cause
* the error that occurred.
*/
void onWebSocketError(Throwable cause);
@@ -74,7 +74,7 @@ public interface WebSocketListener
/**
* A WebSocket Text frame was received.
*
- * @param message
+ * @param message the message
*/
void onWebSocketText(String message);
}
diff --git a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/OnWebSocketError.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/OnWebSocketError.java
index e15e1e2e4f..5ef8caa33c 100644
--- a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/OnWebSocketError.java
+++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/OnWebSocketError.java
@@ -31,7 +31,6 @@ import org.eclipse.jetty.websocket.api.Session;
* <p>
* Acceptable method patterns.<br>
* Note: <code>methodName</code> can be any name you want to use.
- * <p>
* <ol>
* <li><code>public void methodName({@link Throwable} error)</code></li>
* <li><code>public void methodName({@link Session} session, {@link Throwable} error)</code></li>
diff --git a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/OnWebSocketFrame.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/OnWebSocketFrame.java
index 4ecbf7716c..7dcae2343b 100644
--- a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/OnWebSocketFrame.java
+++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/OnWebSocketFrame.java
@@ -32,8 +32,8 @@ import org.eclipse.jetty.websocket.api.Session;
* Acceptable method patterns.<br>
* Note: <code>methodName</code> can be any name you want to use.
* <ol>
- * <li><code>public void methodName({@link Frame} frame)</code></li>
- * <li><code>public void methodName({@link Session} session, {@link Frame} frame)</code></li>
+ * <li><code>public void methodName({@link org.eclipse.jetty.websocket.api.extensions.Frame} frame)</code></li>
+ * <li><code>public void methodName({@link Session} session, {@link org.eclipse.jetty.websocket.api.extensions.Frame} frame)</code></li>
* </ol>
*/
@Documented
diff --git a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/extensions/Extension.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/extensions/Extension.java
index c19a3e0df6..4cee100f03 100644
--- a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/extensions/Extension.java
+++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/extensions/Extension.java
@@ -36,6 +36,7 @@ public interface Extension extends IncomingFrames, OutgoingFrames
* The <code>Sec-WebSocket-Extensions</code> name for this extension.
* <p>
* Also known as the <a href="https://tools.ietf.org/html/rfc6455#section-9.1"><code>extension-token</code> per Section 9.1. Negotiating Extensions</a>.
+ * @return the name of the extension
*/
public String getName();
diff --git a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/extensions/ExtensionConfig.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/extensions/ExtensionConfig.java
index 1041bc5d74..5036eb7a5b 100644
--- a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/extensions/ExtensionConfig.java
+++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/extensions/ExtensionConfig.java
@@ -128,6 +128,7 @@ public class ExtensionConfig
/**
* Copy constructor
+ * @param copy the extension config to copy
*/
public ExtensionConfig(ExtensionConfig copy)
{
diff --git a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/util/QuoteUtil.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/util/QuoteUtil.java
index faf9674a10..c4931c0a84 100644
--- a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/util/QuoteUtil.java
+++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/util/QuoteUtil.java
@@ -27,7 +27,6 @@ import java.util.NoSuchElementException;
* Provide some consistent Http header value and Extension configuration parameter quoting support.
* <p>
* While QuotedStringTokenizer exists in jetty-util, and works great with http header values, using it in websocket-api is undesired.
- * <p>
* <ul>
* <li>Using QuotedStringTokenizer would introduce a dependency to jetty-util that would need to be exposed via the WebAppContext classloader</li>
* <li>ABNF defined extension parameter parsing requirements of RFC-6455 (WebSocket) ABNF, is slightly different than the ABNF parsing defined in RFC-2616
diff --git a/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/WebSocketClient.java b/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/WebSocketClient.java
index 399257d23e..de4ed1ebe9 100644
--- a/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/WebSocketClient.java
+++ b/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/WebSocketClient.java
@@ -512,6 +512,7 @@ public class WebSocketClient extends ContainerLifeCycle implements SessionListen
}
/**
+ * @param bindAddress the address to bind to
* @deprecated use {@link #setBindAddress(SocketAddress)} instead
*/
@Deprecated
diff --git a/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/package-info.java b/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/package-info.java
index f6c35384ad..6c0087bd55 100644
--- a/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/package-info.java
+++ b/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/package-info.java
@@ -20,14 +20,15 @@
* Jetty WebSocket Client API
* <p>
* The core class is {@link org.eclipse.jetty.websocket.client.WebSocketClient}, which acts as a central configuration object (for example
- * for {@link org.eclipse.jetty.websocket.client.WebSocketClient#setConnectTimeout(int) connect timeouts}, {@link WebSocketClient#setCookieStore(CookieStore)
- * request cookie store}, etc.) and as a factory for WebSocket {@link org.eclipse.jetty.websocket.api.Session} objects.
+ * for {@link org.eclipse.jetty.websocket.client.WebSocketClient#setConnectTimeout(long)},
+ * {@link org.eclipse.jetty.websocket.client.WebSocketClient#setCookieStore(java.net.CookieStore)},
+ * etc.) and as a factory for WebSocket {@link org.eclipse.jetty.websocket.api.Session} objects.
* <p>
* The <a href="https://tools.ietf.org/html/rfc6455">WebSocket protocol</a> is based on a framing protocol built
* around an upgraded HTTP connection. It is primarily focused on the sending of messages (text or binary), with an
* occasional control frame (close, ping, pong) that this implementation uses.
* <p>
- * {@link org.eclipse.jetty.websocket.client.WebSocketClient} holds a number of {@link org.eclipse.jetty.websocket.api.Session Sessions}, which in turn
+ * {@link org.eclipse.jetty.websocket.client.WebSocketClient} holds a number of {@link org.eclipse.jetty.websocket.api.Session}, which in turn
* is used to manage physical vs virtual connection handling (mux extension).
*/
package org.eclipse.jetty.websocket.client;
diff --git a/jetty-websocket/websocket-client/src/test/java/org/eclipse/jetty/websocket/client/TomcatServerQuirksTest.java b/jetty-websocket/websocket-client/src/test/java/org/eclipse/jetty/websocket/client/TomcatServerQuirksTest.java
index 148ae437f5..f29904604a 100644
--- a/jetty-websocket/websocket-client/src/test/java/org/eclipse/jetty/websocket/client/TomcatServerQuirksTest.java
+++ b/jetty-websocket/websocket-client/src/test/java/org/eclipse/jetty/websocket/client/TomcatServerQuirksTest.java
@@ -67,7 +67,7 @@ public class TomcatServerQuirksTest
* <li><a href="https://issues.apache.org/bugzilla/show_bug.cgi?id=54067">Apache Tomcat Bug #54067</a></li>
* </ul>
*
- * @throws IOException
+ * @throws Exception on test failure
*/
@Test
public void testTomcat7_0_32_WithTransferEncoding() throws Exception
diff --git a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/LogicalConnection.java b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/LogicalConnection.java
index 5b81017dfe..69ae0c89da 100644
--- a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/LogicalConnection.java
+++ b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/LogicalConnection.java
@@ -61,11 +61,13 @@ public interface LogicalConnection extends OutgoingFrames, SuspendToken
/**
* Get the ByteBufferPool in use by the connection
+ * @return the buffer pool
*/
ByteBufferPool getBufferPool();
/**
* Get the Executor used by this connection.
+ * @return the executor
*/
Executor getExecutor();
@@ -165,6 +167,7 @@ public interface LogicalConnection extends OutgoingFrames, SuspendToken
/**
* Suspend a the incoming read events on the connection.
+ * @return the suspend token
*/
SuspendToken suspend();
}
diff --git a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/WebSocketFrame.java b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/WebSocketFrame.java
index be64a68086..ad61202b1a 100644
--- a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/WebSocketFrame.java
+++ b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/WebSocketFrame.java
@@ -96,7 +96,6 @@ public abstract class WebSocketFrame implements Frame
/**
* Combined FIN + RSV1 + RSV2 + RSV3 + OpCode byte.
- * <p>
*
* <pre>
* 1000_0000 (0x80) = fin
@@ -119,6 +118,7 @@ public abstract class WebSocketFrame implements Frame
/**
* Construct form opcode
+ * @param opcode the opcode the frame is based on
*/
protected WebSocketFrame(byte opcode)
{
@@ -341,6 +341,7 @@ public abstract class WebSocketFrame implements Frame
*
* @param buf
* the bytebuffer to set
+ * @return the frame itself
*/
public WebSocketFrame setPayload(ByteBuffer buf)
{
diff --git a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/events/EventDriverFactory.java b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/events/EventDriverFactory.java
index f4996cdb65..352115e945 100644
--- a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/events/EventDriverFactory.java
+++ b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/events/EventDriverFactory.java
@@ -101,7 +101,7 @@ public class EventDriverFactory
* Wrap the given WebSocket object instance in a suitable EventDriver
*
* @param websocket
- * the websocket instance to wrap. Must either implement {@link WebSocketListener} or be annotated with {@link WebSocket &#064WebSocket}
+ * the websocket instance to wrap. Must either implement {@link WebSocketListener} or be annotated with {@link WebSocket &#064;WebSocket}
* @return appropriate EventDriver for this websocket instance.
*/
public EventDriver wrap(Object websocket)
diff --git a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/events/annotated/AbstractMethodAnnotationScanner.java b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/events/annotated/AbstractMethodAnnotationScanner.java
index 480e10b353..18300b362c 100644
--- a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/events/annotated/AbstractMethodAnnotationScanner.java
+++ b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/events/annotated/AbstractMethodAnnotationScanner.java
@@ -27,6 +27,7 @@ import org.eclipse.jetty.websocket.common.events.ParamList;
/**
* Basic scanner for Annotated Methods
+ * @param <T> The type of metadata
*/
public abstract class AbstractMethodAnnotationScanner<T>
{
diff --git a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/frames/DataFrame.java b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/frames/DataFrame.java
index 0f6f79c93b..5fe357c20f 100644
--- a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/frames/DataFrame.java
+++ b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/frames/DataFrame.java
@@ -36,6 +36,7 @@ public class DataFrame extends WebSocketFrame
* Construct new DataFrame based on headers of provided frame.
* <p>
* Useful for when working in extensions and a new frame needs to be created.
+ * @param basedOn the frame this one is based on
*/
public DataFrame(Frame basedOn)
{
@@ -46,6 +47,8 @@ public class DataFrame extends WebSocketFrame
* Construct new DataFrame based on headers of provided frame, overriding for continuations if needed.
* <p>
* Useful for when working in extensions and a new frame needs to be created.
+ * @param basedOn the frame this one is based on
+ * @param continuation true if this is a continuation frame
*/
public DataFrame(Frame basedOn, boolean continuation)
{
diff --git a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/io/AbstractWebSocketConnection.java b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/io/AbstractWebSocketConnection.java
index c09ba1438f..873430a524 100644
--- a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/io/AbstractWebSocketConnection.java
+++ b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/io/AbstractWebSocketConnection.java
@@ -56,7 +56,7 @@ import org.eclipse.jetty.websocket.common.WebSocketSession;
import org.eclipse.jetty.websocket.common.io.IOState.ConnectionStateListener;
/**
- * Provides the implementation of {@link LogicalConnection} within the framework of the new {@link Connection} framework of {@code jetty-io}.
+ * Provides the implementation of {@link LogicalConnection} within the framework of the new {@link org.eclipse.jetty.io.Connection} framework of {@code jetty-io}.
*/
public abstract class AbstractWebSocketConnection extends AbstractConnection implements LogicalConnection, ConnectionStateListener, Dumpable
{
@@ -518,6 +518,7 @@ public abstract class AbstractWebSocketConnection extends AbstractConnection imp
* Extra bytes from the initial HTTP upgrade that need to
* be processed by the websocket parser before starting
* to read bytes from the connection
+ * @param prefilled the bytes of prefilled content encountered during upgrade
*/
protected void setInitialBuffer(ByteBuffer prefilled)
{
diff --git a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/io/FrameFlusher.java b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/io/FrameFlusher.java
index fb9d35fc94..8c4bc39520 100644
--- a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/io/FrameFlusher.java
+++ b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/io/FrameFlusher.java
@@ -40,7 +40,7 @@ import org.eclipse.jetty.websocket.common.OpCode;
import org.eclipse.jetty.websocket.common.frames.BinaryFrame;
/**
- * Interface for working with bytes destined for {@link EndPoint#write(Callback, ByteBuffer...)}
+ * Interface for working with bytes destined for {@link EndPoint#write(org.eclipse.jetty.util.Callback, ByteBuffer...)}
*/
public class FrameFlusher
{
diff --git a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/io/IOState.java b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/io/IOState.java
index 6a8851d467..44e782ec26 100644
--- a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/io/IOState.java
+++ b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/io/IOState.java
@@ -190,6 +190,7 @@ public class IOState
* A websocket connection has been disconnected for abnormal close reasons.
* <p>
* This is the low level disconnect of the socket. It could be the result of a normal close operation, from an IO error, or even from a timeout.
+ * @param close the close information
*/
public void onAbnormalClose(CloseInfo close)
{
@@ -221,6 +222,7 @@ public class IOState
/**
* A close handshake has been issued from the local endpoint
+ * @param close the close information
*/
public void onCloseLocal(CloseInfo close)
{
@@ -302,6 +304,7 @@ public class IOState
/**
* A close handshake has been received from the remote endpoint
+ * @param close the close information
*/
public void onCloseRemote(CloseInfo close)
{
@@ -427,6 +430,7 @@ public class IOState
* The local endpoint has reached a read failure.
* <p>
* This could be a normal result after a proper close handshake, or even a premature close due to a connection disconnect.
+ * @param t the read failure
*/
public void onReadFailure(Throwable t)
{
@@ -478,6 +482,7 @@ public class IOState
* The local endpoint has reached a write failure.
* <p>
* A low level I/O failure, or even a jetty side EndPoint close (from idle timeout) are a few scenarios
+ * @param t the throwable that caused the write failure
*/
public void onWriteFailure(Throwable t)
{
diff --git a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/scopes/WebSocketSessionScope.java b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/scopes/WebSocketSessionScope.java
index e4e678c5c3..1e59094ccf 100644
--- a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/scopes/WebSocketSessionScope.java
+++ b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/scopes/WebSocketSessionScope.java
@@ -27,11 +27,13 @@ public interface WebSocketSessionScope
{
/**
* Active {@link WebSocketSession} associated with this scope.
+ * @return the websocket session
*/
WebSocketSession getWebSocketSession();
/**
* The parent {@link WebSocketContainerScope} for this session scope.
+ * @return the websocket container scope
*/
WebSocketContainerScope getContainerScope();
}
diff --git a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/util/TextUtil.java b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/util/TextUtil.java
index 414529ad3b..651c8c9329 100644
--- a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/util/TextUtil.java
+++ b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/util/TextUtil.java
@@ -43,7 +43,6 @@ public final class TextUtil
/**
* Smash a long string to fit within the max string length, by taking the middle section of the string and replacing them with an ellipsis "..."
- * <p>
*
* <pre>
* Examples:
diff --git a/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/annotations/BadBinarySignatureSocket.java b/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/annotations/BadBinarySignatureSocket.java
index bc202e3104..d0633b8ec0 100644
--- a/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/annotations/BadBinarySignatureSocket.java
+++ b/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/annotations/BadBinarySignatureSocket.java
@@ -30,6 +30,11 @@ public class BadBinarySignatureSocket
{
/**
* Declaring a non-void return type
+ * @param session the session
+ * @param buf the buffer
+ * @param offset the offset
+ * @param len the length
+ * @return the response boolean
*/
@OnWebSocketMessage
public boolean onBinary(Session session, byte buf[], int offset, int len)
diff --git a/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/annotations/BadDuplicateBinarySocket.java b/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/annotations/BadDuplicateBinarySocket.java
index 9de8780735..9441cb85a4 100644
--- a/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/annotations/BadDuplicateBinarySocket.java
+++ b/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/annotations/BadDuplicateBinarySocket.java
@@ -31,6 +31,9 @@ public class BadDuplicateBinarySocket
{
/**
* First method
+ * @param payload the payload
+ * @param offset the offset
+ * @param len the len
*/
@OnWebSocketMessage
public void binMe(byte[] payload, int offset, int len)
@@ -40,6 +43,7 @@ public class BadDuplicateBinarySocket
/**
* Second method
+ * @param stream the input stream
*/
@OnWebSocketMessage
public void streamMe(InputStream stream)
diff --git a/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/annotations/BadDuplicateFrameSocket.java b/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/annotations/BadDuplicateFrameSocket.java
index 743ed6248c..991e9c5a27 100644
--- a/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/annotations/BadDuplicateFrameSocket.java
+++ b/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/annotations/BadDuplicateFrameSocket.java
@@ -27,6 +27,7 @@ public class BadDuplicateFrameSocket
{
/**
* The get a frame
+ * @param frame the frame
*/
@OnWebSocketFrame
public void frameMe(Frame frame)
@@ -36,6 +37,7 @@ public class BadDuplicateFrameSocket
/**
* This is a duplicate frame type (should throw an exception attempting to use)
+ * @param frame the frame
*/
@OnWebSocketFrame
public void watchMe(Frame frame)
diff --git a/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/annotations/BadTextSignatureSocket.java b/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/annotations/BadTextSignatureSocket.java
index 43449cdad8..6e16f0d75a 100644
--- a/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/annotations/BadTextSignatureSocket.java
+++ b/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/annotations/BadTextSignatureSocket.java
@@ -30,6 +30,8 @@ public class BadTextSignatureSocket
{
/**
* Declaring a static method
+ * @param session the session
+ * @param text the text message
*/
@OnWebSocketMessage
public static void onText(Session session, String text)
diff --git a/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/annotations/FrameSocket.java b/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/annotations/FrameSocket.java
index f0bb100ae4..006b04d50c 100644
--- a/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/annotations/FrameSocket.java
+++ b/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/annotations/FrameSocket.java
@@ -27,6 +27,7 @@ public class FrameSocket
{
/**
* A frame
+ * @param frame the frame
*/
@OnWebSocketFrame
public void frameMe(Frame frame)
diff --git a/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/extensions/FragmentExtensionTest.java b/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/extensions/FragmentExtensionTest.java
index 96534acab5..b245c91f05 100644
--- a/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/extensions/FragmentExtensionTest.java
+++ b/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/extensions/FragmentExtensionTest.java
@@ -140,6 +140,7 @@ public class FragmentExtensionTest
/**
* Verify that outgoing text frames are fragmented by the maxLength configuration.
+ * @throws IOException on test failure
*/
@Test
public void testOutgoingFramesByMaxLength() throws IOException
@@ -212,6 +213,7 @@ public class FragmentExtensionTest
/**
* Verify that outgoing text frames are fragmented by default configuration
+ * @throws IOException on test failure
*/
@Test
public void testOutgoingFramesDefaultConfig() throws IOException
@@ -276,6 +278,7 @@ public class FragmentExtensionTest
/**
* Outgoing PING (Control Frame) should pass through extension unmodified
+ * @throws IOException on test failure
*/
@Test
public void testOutgoingPing() throws IOException
diff --git a/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/extensions/IdentityExtensionTest.java b/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/extensions/IdentityExtensionTest.java
index c3a75096b7..7cdc07006c 100644
--- a/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/extensions/IdentityExtensionTest.java
+++ b/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/extensions/IdentityExtensionTest.java
@@ -71,6 +71,7 @@ public class IdentityExtensionTest
/**
* Verify that outgoing frames are unmodified
+ * @throws IOException on test failure
*/
@Test
public void testOutgoingFrames() throws IOException
diff --git a/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/extensions/compress/DeflateFrameExtensionTest.java b/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/extensions/compress/DeflateFrameExtensionTest.java
index 94f2cc1a50..731548c33c 100644
--- a/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/extensions/compress/DeflateFrameExtensionTest.java
+++ b/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/extensions/compress/DeflateFrameExtensionTest.java
@@ -361,6 +361,7 @@ public class DeflateFrameExtensionTest extends AbstractExtensionTest
/**
* Make sure that the server generated compressed form for "Hello" is consistent with what PyWebSocket creates.
+ * @throws IOException on test failure
*/
@Test
public void testServerGeneratedHello() throws IOException
@@ -370,6 +371,7 @@ public class DeflateFrameExtensionTest extends AbstractExtensionTest
/**
* Make sure that the server generated compressed form for "There" is consistent with what PyWebSocket creates.
+ * @throws IOException on test failure
*/
@Test
public void testServerGeneratedThere() throws IOException
diff --git a/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/extensions/compress/PerMessageDeflateExtensionTest.java b/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/extensions/compress/PerMessageDeflateExtensionTest.java
index 33bfbe2b3c..8034191c01 100644
--- a/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/extensions/compress/PerMessageDeflateExtensionTest.java
+++ b/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/extensions/compress/PerMessageDeflateExtensionTest.java
@@ -298,6 +298,7 @@ public class PerMessageDeflateExtensionTest extends AbstractExtensionTest
/**
* Outgoing PING (Control Frame) should pass through extension unmodified
+ * @throws IOException on test failure
*/
@Test
public void testOutgoingPing() throws IOException
diff --git a/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/test/BlockheadServer.java b/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/test/BlockheadServer.java
index f18f8c705e..7751e8306c 100644
--- a/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/test/BlockheadServer.java
+++ b/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/test/BlockheadServer.java
@@ -116,6 +116,8 @@ public class BlockheadServer
/**
* Add an extra header for the upgrade response (from the server). No extra work is done to ensure the key and value are sane for http.
+ * @param rawkey the raw key
+ * @param rawvalue the raw value
*/
public void addResponseHeader(String rawkey, String rawvalue)
{
diff --git a/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/test/UnitGenerator.java b/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/test/UnitGenerator.java
index df9f8414c9..f92d29e45c 100644
--- a/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/test/UnitGenerator.java
+++ b/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/test/UnitGenerator.java
@@ -83,6 +83,8 @@ public class UnitGenerator extends Generator
/**
* Generate a single giant buffer of all provided frames Not appropriate for production code, but useful for testing.
+ * @param frames the list of frames to generate from
+ * @return the bytebuffer representing all of the generated frames
*/
public static ByteBuffer generate(List<WebSocketFrame> frames)
{
diff --git a/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/test/UnitParser.java b/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/test/UnitParser.java
index b93776cac3..9f924d264a 100644
--- a/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/test/UnitParser.java
+++ b/jetty-websocket/websocket-common/src/test/java/org/eclipse/jetty/websocket/common/test/UnitParser.java
@@ -50,6 +50,7 @@ public class UnitParser extends Parser
* Parse a buffer, but do so in a quiet fashion, squelching stacktraces if encountered.
* <p>
* Use if you know the parse will cause an exception and just don't wnat to make the test console all noisy.
+ * @param buf the buffer to parse
*/
public void parseQuietly(ByteBuffer buf)
{
diff --git a/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/WebSocketHandshake.java b/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/WebSocketHandshake.java
index 4628c8b2bb..b5b849fc83 100644
--- a/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/WebSocketHandshake.java
+++ b/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/WebSocketHandshake.java
@@ -28,8 +28,9 @@ public interface WebSocketHandshake
/**
* Formulate a WebSocket upgrade handshake response.
*
- * @param request
- * @param response
+ * @param request the request
+ * @param response the response
+ * @throws IOException if unable to handshake
*/
public void doHandshakeResponse(ServletUpgradeRequest request, ServletUpgradeResponse response) throws IOException;
}
diff --git a/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/pathmap/PathMappings.java b/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/pathmap/PathMappings.java
index 53ccfae46b..c8c256d517 100644
--- a/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/pathmap/PathMappings.java
+++ b/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/pathmap/PathMappings.java
@@ -37,7 +37,7 @@ import org.eclipse.jetty.websocket.server.pathmap.PathMappings.MappedResource;
* <p>
* Sorted into search order upon entry into the Set
*
- * @param <E>
+ * @param <E> the type of mapping endpoint
*/
@ManagedObject("Path Mappings")
public class PathMappings<E> implements Iterable<MappedResource<E>>, Dumpable
diff --git a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/IdleTimeoutTest.java b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/IdleTimeoutTest.java
index b6027b2889..4049cf9958 100644
--- a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/IdleTimeoutTest.java
+++ b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/IdleTimeoutTest.java
@@ -68,6 +68,7 @@ public class IdleTimeoutTest
/**
* Test IdleTimeout on server.
+ * @throws Exception on test failure
*/
@Test
public void testIdleTimeout() throws Exception
diff --git a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/PerMessageDeflateExtensionTest.java b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/PerMessageDeflateExtensionTest.java
index 21b3b64710..b61a7fb611 100644
--- a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/PerMessageDeflateExtensionTest.java
+++ b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/PerMessageDeflateExtensionTest.java
@@ -54,6 +54,7 @@ public class PerMessageDeflateExtensionTest
/**
* Default configuration for permessage-deflate
+ * @throws Exception on test failure
*/
@Test
public void testPerMessageDeflateDefault() throws Exception
diff --git a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/TooFastClientTest.java b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/TooFastClientTest.java
index 3445957c07..43747493df 100644
--- a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/TooFastClientTest.java
+++ b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/TooFastClientTest.java
@@ -124,6 +124,7 @@ public class TooFastClientTest
* to completely overfill the {@link org.eclipse.jetty.io.AbstractConnection#getInputBufferSize()}
* to test a situation where the WebSocket connection opens with prefill that exceeds
* the normal input buffer sizes.
+ * @throws Exception on test failure
*/
@Test
public void testUpgradeWithLargeFrame() throws Exception
diff --git a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/WebSocketCloseTest.java b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/WebSocketCloseTest.java
index 65e17b0213..784ef3004d 100644
--- a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/WebSocketCloseTest.java
+++ b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/WebSocketCloseTest.java
@@ -155,6 +155,7 @@ public class WebSocketCloseTest
/**
* Test fast close (bug #403817)
+ * @throws Exception on test failure
*/
@Test
public void testFastClose() throws Exception
@@ -185,6 +186,7 @@ public class WebSocketCloseTest
/**
* Test fast fail (bug #410537)
+ * @throws Exception on test failure
*/
@Test
public void testFastFail() throws Exception
diff --git a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/WebSocketInvalidVersionTest.java b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/WebSocketInvalidVersionTest.java
index a1cf30ad9c..4a1908f1ca 100644
--- a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/WebSocketInvalidVersionTest.java
+++ b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/WebSocketInvalidVersionTest.java
@@ -48,6 +48,7 @@ public class WebSocketInvalidVersionTest
/**
* Test the requirement of responding with an http 400 when using a Sec-WebSocket-Version that is unsupported.
+ * @throws Exception on test failure
*/
@Test
public void testRequestVersion29() throws Exception
diff --git a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/WebSocketOverSSLTest.java b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/WebSocketOverSSLTest.java
index c23ddd1cab..4dcd36f0c4 100644
--- a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/WebSocketOverSSLTest.java
+++ b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/WebSocketOverSSLTest.java
@@ -65,6 +65,7 @@ public class WebSocketOverSSLTest
/**
* Test the requirement of issuing socket and receiving echo response
+ * @throws Exception on test failure
*/
@Test
public void testEcho() throws Exception
@@ -106,6 +107,7 @@ public class WebSocketOverSSLTest
/**
* Test that server session reports as secure
+ * @throws Exception on test failure
*/
@Test
public void testServerSessionIsSecure() throws Exception
@@ -147,6 +149,7 @@ public class WebSocketOverSSLTest
/**
* Test that server session.upgradeRequest.requestURI reports correctly
+ * @throws Exception on test failure
*/
@Test
public void testServerSessionRequestURI() throws Exception
diff --git a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/WebSocketServerSessionTest.java b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/WebSocketServerSessionTest.java
index e0bdbeb192..9d52c8eec8 100644
--- a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/WebSocketServerSessionTest.java
+++ b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/WebSocketServerSessionTest.java
@@ -36,7 +36,7 @@ import org.junit.Test;
import org.junit.runner.RunWith;
/**
- * Testing various aspects of the server side support for WebSocket {@link Session}
+ * Testing various aspects of the server side support for WebSocket {@link org.eclipse.jetty.websocket.api.Session}
*/
@RunWith(AdvancedRunner.class)
public class WebSocketServerSessionTest
diff --git a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/WebSocketServletRFCTest.java b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/WebSocketServletRFCTest.java
index eb1b96fb35..845c03e56e 100644
--- a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/WebSocketServletRFCTest.java
+++ b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/WebSocketServletRFCTest.java
@@ -82,6 +82,7 @@ public class WebSocketServletRFCTest
/**
* Test that aggregation of binary frames into a single message occurs
+ * @throws Exception on test failure
*/
@Test
public void testBinaryAggregate() throws Exception
@@ -167,6 +168,7 @@ public class WebSocketServletRFCTest
/**
* Test the requirement of issuing socket and receiving echo response
+ * @throws Exception on test failure
*/
@Test
public void testEcho() throws Exception
@@ -196,6 +198,7 @@ public class WebSocketServletRFCTest
/**
* Test the requirement of responding with server terminated close code 1011 when there is an unhandled (internal server error) being produced by the
* WebSocket POJO.
+ * @throws Exception on test failure
*/
@Test
public void testInternalError() throws Exception
@@ -234,6 +237,7 @@ public class WebSocketServletRFCTest
* Test http://tools.ietf.org/html/rfc6455#section-4.1 where server side upgrade handling is supposed to be case insensitive.
* <p>
* This test will simulate a client requesting upgrade with all lowercase headers.
+ * @throws Exception on test failure
*/
@Test
public void testLowercaseUpgrade() throws Exception
@@ -313,6 +317,7 @@ public class WebSocketServletRFCTest
* Test http://tools.ietf.org/html/rfc6455#section-4.1 where server side upgrade handling is supposed to be case insensitive.
* <p>
* This test will simulate a client requesting upgrade with all uppercase headers.
+ * @throws Exception on test failure
*/
@Test
public void testUppercaseUpgrade() throws Exception
diff --git a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/AbstractABCase.java b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/AbstractABCase.java
index 78a4efaf5c..a7655cec3e 100644
--- a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/AbstractABCase.java
+++ b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/AbstractABCase.java
@@ -176,6 +176,8 @@ public abstract class AbstractABCase implements Fuzzed
public TestName testname = new TestName();
/**
+ * @param clazz the class to enable
+ * @param enabled true to enable the stack traces (or not)
* @deprecated use {@link StacklessLogging} in a try-with-resources block instead
*/
@Deprecated
diff --git a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase1.java b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase1.java
index 659b3fb36b..afeb2140f4 100644
--- a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase1.java
+++ b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase1.java
@@ -36,6 +36,7 @@ public class TestABCase1 extends AbstractABCase
{
/**
* Echo 0 byte TEXT message
+ * @throws Exception on test failure
*/
@Test
public void testCase1_1_1() throws Exception
@@ -59,6 +60,7 @@ public class TestABCase1 extends AbstractABCase
/**
* Echo 125 byte TEXT message (uses small 7-bit payload length)
+ * @throws Exception on test failure
*/
@Test
public void testCase1_1_2() throws Exception
@@ -86,6 +88,7 @@ public class TestABCase1 extends AbstractABCase
/**
* Echo 126 byte TEXT message (uses medium 2 byte payload length)
+ * @throws Exception on test failure
*/
@Test
public void testCase1_1_3() throws Exception
@@ -113,6 +116,7 @@ public class TestABCase1 extends AbstractABCase
/**
* Echo 127 byte TEXT message (uses medium 2 byte payload length)
+ * @throws Exception on test failure
*/
@Test
public void testCase1_1_4() throws Exception
@@ -140,6 +144,7 @@ public class TestABCase1 extends AbstractABCase
/**
* Echo 128 byte TEXT message (uses medium 2 byte payload length)
+ * @throws Exception on test failure
*/
@Test
public void testCase1_1_5() throws Exception
@@ -167,6 +172,7 @@ public class TestABCase1 extends AbstractABCase
/**
* Echo 65535 byte TEXT message (uses medium 2 byte payload length)
+ * @throws Exception on test failure
*/
@Test
public void testCase1_1_6() throws Exception
@@ -194,6 +200,7 @@ public class TestABCase1 extends AbstractABCase
/**
* Echo 65536 byte TEXT message (uses large 8 byte payload length)
+ * @throws Exception on test failure
*/
@Test
public void testCase1_1_7() throws Exception
@@ -225,6 +232,7 @@ public class TestABCase1 extends AbstractABCase
* Only send 1 TEXT frame from client, but in small segments (flushed after each).
* <p>
* This is done to test the parsing together of the frame on the server side.
+ * @throws Exception on test failure
*/
@Test
public void testCase1_1_8() throws Exception
@@ -254,6 +262,7 @@ public class TestABCase1 extends AbstractABCase
/**
* Echo 0 byte BINARY message
+ * @throws Exception on test failure
*/
@Test
public void testCase1_2_1() throws Exception
@@ -277,6 +286,7 @@ public class TestABCase1 extends AbstractABCase
/**
* Echo 125 byte BINARY message (uses small 7-bit payload length)
+ * @throws Exception on test failure
*/
@Test
public void testCase1_2_2() throws Exception
@@ -304,6 +314,7 @@ public class TestABCase1 extends AbstractABCase
/**
* Echo 126 byte BINARY message (uses medium 2 byte payload length)
+ * @throws Exception on test failure
*/
@Test
public void testCase1_2_3() throws Exception
@@ -331,6 +342,7 @@ public class TestABCase1 extends AbstractABCase
/**
* Echo 127 byte BINARY message (uses medium 2 byte payload length)
+ * @throws Exception on test failure
*/
@Test
public void testCase1_2_4() throws Exception
@@ -358,6 +370,7 @@ public class TestABCase1 extends AbstractABCase
/**
* Echo 128 byte BINARY message (uses medium 2 byte payload length)
+ * @throws Exception on test failure
*/
@Test
public void testCase1_2_5() throws Exception
@@ -385,6 +398,7 @@ public class TestABCase1 extends AbstractABCase
/**
* Echo 65535 byte BINARY message (uses medium 2 byte payload length)
+ * @throws Exception on test failure
*/
@Test
public void testCase1_2_6() throws Exception
@@ -412,6 +426,7 @@ public class TestABCase1 extends AbstractABCase
/**
* Echo 65536 byte BINARY message (uses large 8 byte payload length)
+ * @throws Exception on test failure
*/
@Test
public void testCase1_2_7() throws Exception
@@ -443,6 +458,7 @@ public class TestABCase1 extends AbstractABCase
* Only send 1 BINARY frame from client, but in small segments (flushed after each).
* <p>
* This is done to test the parsing together of the frame on the server side.
+ * @throws Exception on test failure
*/
@Test
public void testCase1_2_8() throws Exception
diff --git a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase2.java b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase2.java
index 65ba463b0b..06efd05b2f 100644
--- a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase2.java
+++ b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase2.java
@@ -42,6 +42,7 @@ public class TestABCase2 extends AbstractABCase
{
/**
* Ping without payload
+ * @throws Exception on test failure
*/
@Test
public void testCase2_1() throws Exception
@@ -61,6 +62,7 @@ public class TestABCase2 extends AbstractABCase
/**
* 10 pings
+ * @throws Exception on test failure
*/
@Test
public void testCase2_10() throws Exception
@@ -95,6 +97,7 @@ public class TestABCase2 extends AbstractABCase
/**
* 10 pings, sent slowly
+ * @throws Exception on test failure
*/
@Test
public void testCase2_11() throws Exception
@@ -130,6 +133,7 @@ public class TestABCase2 extends AbstractABCase
/**
* Ping with small text payload
+ * @throws Exception on test failure
*/
@Test
public void testCase2_2() throws Exception
@@ -155,6 +159,7 @@ public class TestABCase2 extends AbstractABCase
/**
* Ping with small binary (non-utf8) payload
+ * @throws Exception on test failure
*/
@Test
public void testCase2_3() throws Exception
@@ -180,6 +185,7 @@ public class TestABCase2 extends AbstractABCase
/**
* Ping with 125 byte binary payload
+ * @throws Exception on test failure
*/
@Test
public void testCase2_4() throws Exception
@@ -206,6 +212,7 @@ public class TestABCase2 extends AbstractABCase
/**
* Ping with 126 byte binary payload
+ * @throws Exception on test failure
*/
@Test
public void testCase2_5() throws Exception
@@ -236,6 +243,7 @@ public class TestABCase2 extends AbstractABCase
/**
* Ping with 125 byte binary payload (slow send)
+ * @throws Exception on test failure
*/
@Test
public void testCase2_6() throws Exception
@@ -263,6 +271,7 @@ public class TestABCase2 extends AbstractABCase
/**
* Unsolicited pong frame without payload
+ * @throws Exception on test failure
*/
@Test
public void testCase2_7() throws Exception
@@ -285,6 +294,7 @@ public class TestABCase2 extends AbstractABCase
/**
* Unsolicited pong frame with basic payload
+ * @throws Exception on test failure
*/
@Test
public void testCase2_8() throws Exception
@@ -307,6 +317,7 @@ public class TestABCase2 extends AbstractABCase
/**
* Unsolicited pong frame, then ping with basic payload
+ * @throws Exception on test failure
*/
@Test
public void testCase2_9() throws Exception
diff --git a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase3.java b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase3.java
index 2eaae4f28d..daaf3a0a24 100644
--- a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase3.java
+++ b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase3.java
@@ -43,6 +43,7 @@ public class TestABCase3 extends AbstractABCase
{
/**
* Send small text frame, with RSV1 == true, with no extensions defined.
+ * @throws Exception on test failure
*/
@Test
public void testCase3_1() throws Exception
@@ -62,6 +63,7 @@ public class TestABCase3 extends AbstractABCase
/**
* Send small text frame, send again with RSV2 == true, then ping, with no extensions defined.
+ * @throws Exception on test failure
*/
@Test
public void testCase3_2() throws Exception
@@ -86,6 +88,7 @@ public class TestABCase3 extends AbstractABCase
/**
* Send small text frame, send again with (RSV1 & RSV2), then ping, with no extensions defined.
+ * @throws Exception on test failure
*/
@Test
public void testCase3_3() throws Exception
@@ -110,6 +113,7 @@ public class TestABCase3 extends AbstractABCase
/**
* Send small text frame, send again with (RSV3), then ping, with no extensions defined.
+ * @throws Exception on test failure
*/
@Test
public void testCase3_4() throws Exception
@@ -135,6 +139,7 @@ public class TestABCase3 extends AbstractABCase
/**
* Send binary frame with (RSV3 & RSV1), with no extensions defined.
+ * @throws Exception on test failure
*/
@Test
public void testCase3_5() throws Exception
@@ -159,6 +164,7 @@ public class TestABCase3 extends AbstractABCase
/**
* Send ping frame with (RSV3 & RSV2), with no extensions defined.
+ * @throws Exception on test failure
*/
@Test
public void testCase3_6() throws Exception
@@ -183,6 +189,7 @@ public class TestABCase3 extends AbstractABCase
/**
* Send close frame with (RSV3 & RSV2 & RSV1), with no extensions defined.
+ * @throws Exception on test failure
*/
@Test
public void testCase3_7() throws Exception
diff --git a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase4.java b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase4.java
index 46e244fe47..9eeb34750c 100644
--- a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase4.java
+++ b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase4.java
@@ -43,6 +43,7 @@ public class TestABCase4 extends AbstractABCase
{
/**
* Send opcode 3 (reserved)
+ * @throws Exception on test failure
*/
@Test
public void testCase4_1_1() throws Exception
@@ -64,6 +65,7 @@ public class TestABCase4 extends AbstractABCase
/**
* Send opcode 4 (reserved), with payload
+ * @throws Exception on test failure
*/
@Test
public void testCase4_1_2() throws Exception
@@ -88,6 +90,7 @@ public class TestABCase4 extends AbstractABCase
/**
* Send small text, then frame with opcode 5 (reserved), then ping
+ * @throws Exception on test failure
*/
@Test
public void testCase4_1_3() throws Exception
@@ -112,6 +115,7 @@ public class TestABCase4 extends AbstractABCase
/**
* Send small text, then frame with opcode 6 (reserved) w/payload, then ping
+ * @throws Exception on test failure
*/
@Test
public void testCase4_1_4() throws Exception
@@ -138,6 +142,7 @@ public class TestABCase4 extends AbstractABCase
/**
* Send small text, then frame with opcode 7 (reserved) w/payload, then ping
+ * @throws Exception on test failure
*/
@Test
public void testCase4_1_5() throws Exception
@@ -164,6 +169,7 @@ public class TestABCase4 extends AbstractABCase
/**
* Send opcode 11 (reserved)
+ * @throws Exception on test failure
*/
@Test
public void testCase4_2_1() throws Exception
@@ -185,6 +191,7 @@ public class TestABCase4 extends AbstractABCase
/**
* Send opcode 12 (reserved)
+ * @throws Exception on test failure
*/
@Test
public void testCase4_2_2() throws Exception
@@ -208,6 +215,7 @@ public class TestABCase4 extends AbstractABCase
/**
* Send small text, then frame with opcode 13 (reserved), then ping
+ * @throws Exception on test failure
*/
@Test
public void testCase4_2_3() throws Exception
@@ -232,6 +240,7 @@ public class TestABCase4 extends AbstractABCase
/**
* Send small text, then frame with opcode 14 (reserved), then ping
+ * @throws Exception on test failure
*/
@Test
public void testCase4_2_4() throws Exception
@@ -258,6 +267,7 @@ public class TestABCase4 extends AbstractABCase
/**
* Send small text, then frame with opcode 15 (reserved), then ping
+ * @throws Exception on test failure
*/
@Test
public void testCase4_2_5() throws Exception
diff --git a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase5.java b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase5.java
index b4c058feea..73f1c68a2a 100644
--- a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase5.java
+++ b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase5.java
@@ -45,6 +45,7 @@ public class TestABCase5 extends AbstractABCase
{
/**
* Send ping fragmented in 2 packets
+ * @throws Exception on test failure
*/
@Test
public void testCase5_1() throws Exception
@@ -68,6 +69,7 @@ public class TestABCase5 extends AbstractABCase
/**
* Send continuation+fin, then text+fin (framewise)
+ * @throws Exception on test failure
*/
@Test
public void testCase5_10() throws Exception
@@ -91,6 +93,7 @@ public class TestABCase5 extends AbstractABCase
/**
* Send continuation+fin, then text+fin (slowly)
+ * @throws Exception on test failure
*/
@Test
public void testCase5_11() throws Exception
@@ -115,6 +118,7 @@ public class TestABCase5 extends AbstractABCase
/**
* Send continuation+!fin, then text+fin
+ * @throws Exception on test failure
*/
@Test
public void testCase5_12() throws Exception
@@ -138,6 +142,7 @@ public class TestABCase5 extends AbstractABCase
/**
* Send continuation+!fin, then text+fin (framewise)
+ * @throws Exception on test failure
*/
@Test
public void testCase5_13() throws Exception
@@ -161,6 +166,7 @@ public class TestABCase5 extends AbstractABCase
/**
* Send continuation+!fin, then text+fin (slowly)
+ * @throws Exception on test failure
*/
@Test
public void testCase5_14() throws Exception
@@ -185,6 +191,7 @@ public class TestABCase5 extends AbstractABCase
/**
* Send text fragmented properly in 2 frames, then continuation!fin, then text unfragmented.
+ * @throws Exception on test failure
*/
@Test
public void testCase5_15() throws Exception
@@ -211,6 +218,7 @@ public class TestABCase5 extends AbstractABCase
/**
* (continuation!fin, text!fin, continuation+fin) * 2
+ * @throws Exception on test failure
*/
@Test
public void testCase5_16() throws Exception
@@ -238,6 +246,7 @@ public class TestABCase5 extends AbstractABCase
/**
* (continuation+fin, text!fin, continuation+fin) * 2
+ * @throws Exception on test failure
*/
@Test
public void testCase5_17() throws Exception
@@ -265,6 +274,7 @@ public class TestABCase5 extends AbstractABCase
/**
* text message fragmented in 2 frames, both frames as opcode=TEXT
+ * @throws Exception on test failure
*/
@Test
public void testCase5_18() throws Exception
@@ -288,6 +298,7 @@ public class TestABCase5 extends AbstractABCase
/**
* send text message fragmented in 5 frames, with 2 pings and wait between.
+ * @throws Exception on test failure
*/
@Test
@Slow
@@ -335,6 +346,7 @@ public class TestABCase5 extends AbstractABCase
/**
* Send pong fragmented in 2 packets
+ * @throws Exception on test failure
*/
@Test
public void testCase5_2() throws Exception
@@ -358,6 +370,7 @@ public class TestABCase5 extends AbstractABCase
/**
* send text message fragmented in 5 frames, with 2 pings and wait between. (framewise)
+ * @throws Exception on test failure
*/
@Test
public void testCase5_20() throws Exception
@@ -399,6 +412,7 @@ public class TestABCase5 extends AbstractABCase
/**
* send text message fragmented in 5 frames, with 2 pings and wait between. (framewise)
+ * @throws Exception on test failure
*/
@Test
public void testCase5_20_slow() throws Exception
@@ -441,6 +455,7 @@ public class TestABCase5 extends AbstractABCase
/**
* Send text fragmented in 2 packets
+ * @throws Exception on test failure
*/
@Test
public void testCase5_3() throws Exception
@@ -465,6 +480,7 @@ public class TestABCase5 extends AbstractABCase
/**
* Send text fragmented in 2 packets (framewise)
+ * @throws Exception on test failure
*/
@Test
public void testCase5_4() throws Exception
@@ -489,6 +505,7 @@ public class TestABCase5 extends AbstractABCase
/**
* Send text fragmented in 2 packets (slowly)
+ * @throws Exception on test failure
*/
@Test
public void testCase5_5() throws Exception
@@ -514,6 +531,7 @@ public class TestABCase5 extends AbstractABCase
/**
* Send text fragmented in 2 packets, with ping between them
+ * @throws Exception on test failure
*/
@Test
public void testCase5_6() throws Exception
@@ -540,6 +558,7 @@ public class TestABCase5 extends AbstractABCase
/**
* Send text fragmented in 2 packets, with ping between them (framewise)
+ * @throws Exception on test failure
*/
@Test
public void testCase5_7() throws Exception
@@ -566,6 +585,7 @@ public class TestABCase5 extends AbstractABCase
/**
* Send text fragmented in 2 packets, with ping between them (slowly)
+ * @throws Exception on test failure
*/
@Test
public void testCase5_8() throws Exception
@@ -593,6 +613,7 @@ public class TestABCase5 extends AbstractABCase
/**
* Send continuation+fin, then text+fin
+ * @throws Exception on test failure
*/
@Test
public void testCase5_9() throws Exception
diff --git a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase6.java b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase6.java
index 5fb6aa0256..d39bfa744f 100644
--- a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase6.java
+++ b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase6.java
@@ -49,6 +49,8 @@ public class TestABCase6 extends AbstractABCase
{
/**
* Split a message byte array into a series of fragments (frames + continuations) of 1 byte message contents each.
+ * @param frames the frames
+ * @param msg the message
*/
protected void fragmentText(List<WebSocketFrame> frames, byte msg[])
{
@@ -78,6 +80,7 @@ public class TestABCase6 extends AbstractABCase
/**
* text message, 1 frame, 0 length
+ * @throws Exception on test failure
*/
@Test
public void testCase6_1_1() throws Exception
@@ -101,6 +104,7 @@ public class TestABCase6 extends AbstractABCase
/**
* text message, 0 length, 3 fragments
+ * @throws Exception on test failure
*/
@Test
public void testCase6_1_2() throws Exception
@@ -126,6 +130,7 @@ public class TestABCase6 extends AbstractABCase
/**
* text message, small length, 3 fragments (only middle frame has payload)
+ * @throws Exception on test failure
*/
@Test
public void testCase6_1_3() throws Exception
@@ -151,6 +156,7 @@ public class TestABCase6 extends AbstractABCase
/**
* valid utf8 text message, 2 fragments (on UTF8 code point boundary)
+ * @throws Exception on test failure
*/
@Test
public void testCase6_2_2() throws Exception
@@ -185,6 +191,7 @@ public class TestABCase6 extends AbstractABCase
/**
* valid utf8 text message, many fragments (1 byte each)
+ * @throws Exception on test failure
*/
@Test
public void testCase6_2_3() throws Exception
@@ -211,6 +218,7 @@ public class TestABCase6 extends AbstractABCase
/**
* valid utf8 text message, many fragments (1 byte each)
+ * @throws Exception on test failure
*/
@Test
public void testCase6_2_4() throws Exception
@@ -236,6 +244,7 @@ public class TestABCase6 extends AbstractABCase
/**
* invalid utf8 text message, many fragments (1 byte each)
+ * @throws Exception on test failure
*/
@Test
public void testCase6_3_2() throws Exception
@@ -264,6 +273,7 @@ public class TestABCase6 extends AbstractABCase
* fragment #1 and fragment #3 are both valid in themselves.
* <p>
* fragment #2 contains the invalid utf8 code point.
+ * @throws Exception on test failure
*/
@Test
@Slow
@@ -299,6 +309,7 @@ public class TestABCase6 extends AbstractABCase
* fragment #2 finishes the UTF8 code point but it is invalid
* <p>
* fragment #3 contains the remainder of the message.
+ * @throws Exception on test failure
*/
@Test
@Slow
@@ -326,6 +337,7 @@ public class TestABCase6 extends AbstractABCase
/**
* invalid text message, 1 frame/fragment (slowly, and split within code points)
+ * @throws Exception on test failure
*/
@Test
@Slow
@@ -378,6 +390,7 @@ public class TestABCase6 extends AbstractABCase
/**
* invalid text message, 1 frame/fragment (slowly, and split within code points)
+ * @throws Exception on test failure
*/
@Test
@Slow
diff --git a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase7.java b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase7.java
index b485e02b85..7ba020e18a 100644
--- a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase7.java
+++ b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase7.java
@@ -52,6 +52,7 @@ public class TestABCase7 extends AbstractABCase
/**
* Basic message then close frame, normal behavior
+ * @throws Exception on test failure
*/
@Test
public void testCase7_1_1() throws Exception
@@ -75,6 +76,7 @@ public class TestABCase7 extends AbstractABCase
/**
* Close frame, then another close frame (send frame ignored)
+ * @throws Exception on test failure
*/
@Test
public void testCase7_1_2() throws Exception
@@ -98,6 +100,7 @@ public class TestABCase7 extends AbstractABCase
/**
* Close frame, then ping frame (no pong received)
+ * @throws Exception on test failure
*/
@Test
public void testCase7_1_3() throws Exception
@@ -121,6 +124,7 @@ public class TestABCase7 extends AbstractABCase
/**
* Close frame, then ping frame (no pong received)
+ * @throws Exception on test failure
*/
@Test
public void testCase7_1_4() throws Exception
@@ -144,6 +148,7 @@ public class TestABCase7 extends AbstractABCase
/**
* Text fin=false, close, then continuation fin=true
+ * @throws Exception on test failure
*/
@Test
public void testCase7_1_5() throws Exception
@@ -168,6 +173,7 @@ public class TestABCase7 extends AbstractABCase
/**
* 256k msg, then close, then ping
+ * @throws Exception on test failure
*/
@Test
public void testCase7_1_6() throws Exception
@@ -197,6 +203,7 @@ public class TestABCase7 extends AbstractABCase
/**
* close with no payload (payload length 0)
+ * @throws Exception on test failure
*/
@Test
public void testCase7_3_1() throws Exception
@@ -219,6 +226,7 @@ public class TestABCase7 extends AbstractABCase
/**
* close with invalid payload (payload length 1)
+ * @throws Exception on test failure
*/
@Test
public void testCase7_3_2() throws Exception
@@ -244,6 +252,7 @@ public class TestABCase7 extends AbstractABCase
/**
* close with valid payload (payload length 2)
+ * @throws Exception on test failure
*/
@Test
public void testCase7_3_3() throws Exception
@@ -266,6 +275,7 @@ public class TestABCase7 extends AbstractABCase
/**
* close with valid payload (with reason)
+ * @throws Exception on test failure
*/
@Test
public void testCase7_3_4() throws Exception
@@ -288,6 +298,7 @@ public class TestABCase7 extends AbstractABCase
/**
* close with valid payload (with 123 byte reason)
+ * @throws Exception on test failure
*/
@Test
public void testCase7_3_5() throws Exception
@@ -314,6 +325,7 @@ public class TestABCase7 extends AbstractABCase
/**
* close with invalid UTF8 in payload
+ * @throws Exception on test failure
*/
@Test
public void testCase7_5_1() throws Exception
diff --git a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase7_BadStatusCodes.java b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase7_BadStatusCodes.java
index b3b6b2090e..2a9a84c68f 100644
--- a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase7_BadStatusCodes.java
+++ b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase7_BadStatusCodes.java
@@ -83,6 +83,7 @@ public class TestABCase7_BadStatusCodes extends AbstractABCase
/**
* just the close code, no reason
+ * @throws Exception on test failure
*/
@Test
public void testBadStatusCode() throws Exception
@@ -110,6 +111,7 @@ public class TestABCase7_BadStatusCodes extends AbstractABCase
/**
* the bad close code, with reason
+ * @throws Exception on test failure
*/
@Test
public void testBadStatusCodeWithReason() throws Exception
diff --git a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase7_GoodStatusCodes.java b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase7_GoodStatusCodes.java
index d8939c0dfa..e53548363d 100644
--- a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase7_GoodStatusCodes.java
+++ b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase7_GoodStatusCodes.java
@@ -78,6 +78,7 @@ public class TestABCase7_GoodStatusCodes extends AbstractABCase
/**
* just the close code, no reason
+ * @throws Exception on test failure
*/
@Test
public void testStatusCode() throws Exception
@@ -105,6 +106,7 @@ public class TestABCase7_GoodStatusCodes extends AbstractABCase
/**
* the good close code, with reason
+ * @throws Exception on test failure
*/
@Test
public void testStatusCodeWithReason() throws Exception
diff --git a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase9.java b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase9.java
index ebe6a8c6e9..ee83897554 100644
--- a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase9.java
+++ b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/ab/TestABCase9.java
@@ -131,6 +131,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Echo 64KB text message (1 frame)
+ * @throws Exception on test failure
*/
@Test
public void testCase9_1_1() throws Exception
@@ -158,6 +159,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Echo 256KB text message (1 frame)
+ * @throws Exception on test failure
*/
@Test
public void testCase9_1_2() throws Exception
@@ -185,6 +187,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Echo 1MB text message (1 frame)
+ * @throws Exception on test failure
*/
@Test
public void testCase9_1_3() throws Exception
@@ -212,6 +215,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Echo 4MB text message (1 frame)
+ * @throws Exception on test failure
*/
@Test
public void testCase9_1_4() throws Exception
@@ -239,6 +243,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Echo 8MB text message (1 frame)
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -267,6 +272,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Echo 16MB text message (1 frame)
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -295,6 +301,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Echo 64KB binary message (1 frame)
+ * @throws Exception on test failure
*/
@Test
public void testCase9_2_1() throws Exception
@@ -321,6 +328,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Echo 256KB binary message (1 frame)
+ * @throws Exception on test failure
*/
@Test
public void testCase9_2_2() throws Exception
@@ -348,6 +356,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Echo 1MB binary message (1 frame)
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -376,6 +385,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Echo 4MB binary message (1 frame)
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -404,6 +414,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Echo 8MB binary message (1 frame)
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -432,6 +443,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Echo 16MB binary message (1 frame)
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -460,6 +472,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Send 4MB text message in multiple frames.
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -470,6 +483,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Send 4MB text message in multiple frames.
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -480,6 +494,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Send 4MB text message in multiple frames.
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -490,6 +505,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Send 4MB text message in multiple frames.
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -500,6 +516,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Send 4MB text message in multiple frames.
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -510,6 +527,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Send 4MB text message in multiple frames.
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -520,6 +538,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Send 4MB text message in multiple frames.
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -530,6 +549,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Send 4MB text message in multiple frames.
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -540,6 +560,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Send 4MB text message in multiple frames.
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -550,6 +571,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Send 4MB binary message in multiple frames.
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -560,6 +582,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Send 4MB binary message in multiple frames.
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -570,6 +593,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Send 4MB binary message in multiple frames.
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -580,6 +604,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Send 4MB binary message in multiple frames.
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -590,6 +615,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Send 4MB binary message in multiple frames.
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -600,6 +626,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Send 4MB binary message in multiple frames.
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -610,6 +637,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Send 4MB binary message in multiple frames.
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -620,6 +648,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Send 4MB binary message in multiple frames.
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -630,6 +659,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Send 4MB binary message in multiple frames.
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -640,6 +670,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Send 1MB text message in 1 frame, but slowly
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -650,6 +681,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Send 1MB text message in 1 frame, but slowly
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -660,6 +692,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Send 1MB text message in 1 frame, but slowly
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -670,6 +703,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Send 1MB text message in 1 frame, but slowly
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -680,6 +714,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Send 1MB text message in 1 frame, but slowly
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -690,6 +725,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Send 1MB text message in 1 frame, but slowly
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -700,6 +736,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Send 1MB binary message in 1 frame, but slowly
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -710,6 +747,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Send 1MB binary message in 1 frame, but slowly
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -720,6 +758,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Send 1MB binary message in 1 frame, but slowly
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -730,6 +769,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Send 1MB binary message in 1 frame, but slowly
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -740,6 +780,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Send 1MB binary message in 1 frame, but slowly
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
@@ -750,6 +791,7 @@ public class TestABCase9 extends AbstractABCase
/**
* Send 1MB binary message in 1 frame, but slowly
+ * @throws Exception on test failure
*/
@Test
@Stress("High I/O use")
diff --git a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/helper/SafariD00.java b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/helper/SafariD00.java
index 6c3f4c0528..8000849caa 100644
--- a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/helper/SafariD00.java
+++ b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/helper/SafariD00.java
@@ -56,7 +56,7 @@ public class SafariD00
* Open the Socket to the destination endpoint and
*
* @return the open java Socket.
- * @throws IOException
+ * @throws IOException on test failure
*/
public Socket connect() throws IOException
{
@@ -77,7 +77,7 @@ public class SafariD00
/**
* Issue an Http websocket (Draft-0) upgrade request using the Safari particulars.
*
- * @throws UnsupportedEncodingException
+ * @throws IOException on test failure
*/
public void issueHandshake() throws IOException
{
diff --git a/jetty-websocket/websocket-servlet/src/main/java/org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.java b/jetty-websocket/websocket-servlet/src/main/java/org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.java
index f289ee5b5c..01c82c20e7 100644
--- a/jetty-websocket/websocket-servlet/src/main/java/org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.java
+++ b/jetty-websocket/websocket-servlet/src/main/java/org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.java
@@ -182,6 +182,7 @@ public class ServletUpgradeRequest extends UpgradeRequest
}
/**
+ * @return the principal
* @deprecated use {@link #getUserPrincipal()} instead
*/
@Deprecated
diff --git a/jetty-websocket/websocket-servlet/src/main/java/org/eclipse/jetty/websocket/servlet/WebSocketCreator.java b/jetty-websocket/websocket-servlet/src/main/java/org/eclipse/jetty/websocket/servlet/WebSocketCreator.java
index 3a94c985b6..73e5d4d0d3 100644
--- a/jetty-websocket/websocket-servlet/src/main/java/org/eclipse/jetty/websocket/servlet/WebSocketCreator.java
+++ b/jetty-websocket/websocket-servlet/src/main/java/org/eclipse/jetty/websocket/servlet/WebSocketCreator.java
@@ -24,7 +24,7 @@ package org.eclipse.jetty.websocket.servlet;
* Should you desire filtering of the WebSocket object creation due to criteria such as origin or sub-protocol, then you will be required to implement a custom
* WebSocketCreator implementation.
* <p>
- * This has been moved from the WebSocketServlet to a standalone class managed by the WebSocketServerFactory due to need of WebSocket {@link Extension}s that
+ * This has been moved from the WebSocketServlet to a standalone class managed by the WebSocketServerFactory due to need of WebSocket {@link org.eclipse.jetty.websocket.api.extensions.Extension}s that
* require the ability to create new websockets (such as the mux extension)
*/
public interface WebSocketCreator
diff --git a/jetty-xml/src/main/java/org/eclipse/jetty/xml/XmlParser.java b/jetty-xml/src/main/java/org/eclipse/jetty/xml/XmlParser.java
index 9d9c00757e..9aa42756c5 100644
--- a/jetty-xml/src/main/java/org/eclipse/jetty/xml/XmlParser.java
+++ b/jetty-xml/src/main/java/org/eclipse/jetty/xml/XmlParser.java
@@ -50,11 +50,9 @@ import org.xml.sax.helpers.DefaultHandler;
/**
* XML Parser wrapper. This class wraps any standard JAXP1.1 parser with convieniant error and
* entity handlers and a mini dom-like document tree.
- * <P>
+ * <p>
* By default, the parser is created as a validating parser only if xerces is present. This can be
* configured by setting the "org.eclipse.jetty.xml.XmlParser.Validating" system property.
- *
- *
*/
public class XmlParser
{
@@ -82,9 +80,6 @@ public class XmlParser
}
/* ------------------------------------------------------------ */
- /**
- * Constructor.
- */
public XmlParser(boolean validating)
{
setValidating(validating);
@@ -139,10 +134,6 @@ public class XmlParser
}
/* ------------------------------------------------------------ */
- /**
- * @param name
- * @param entity
- */
public synchronized void redirectEntity(String name, URL entity)
{
if (entity != null)
@@ -218,6 +209,10 @@ public class XmlParser
/* ------------------------------------------------------------ */
/**
* Parse String URL.
+ * @param url the url to the xml to parse
+ * @return the root node of the xml
+ * @throws IOException if unable to load the xml
+ * @throws SAXException if unable to parse the xml
*/
public synchronized Node parse(String url) throws IOException, SAXException
{
@@ -229,6 +224,10 @@ public class XmlParser
/* ------------------------------------------------------------ */
/**
* Parse File.
+ * @param file the file to the xml to parse
+ * @return the root node of the xml
+ * @throws IOException if unable to load the xml
+ * @throws SAXException if unable to parse the xml
*/
public synchronized Node parse(File file) throws IOException, SAXException
{
@@ -240,6 +239,10 @@ public class XmlParser
/* ------------------------------------------------------------ */
/**
* Parse InputStream.
+ * @param in the input stream of the xml to parse
+ * @return the root node of the xml
+ * @throws IOException if unable to load the xml
+ * @throws SAXException if unable to parse the xml
*/
public synchronized Node parse(InputStream in) throws IOException, SAXException
{
@@ -557,6 +560,7 @@ public class XmlParser
/* ------------------------------------------------------------ */
/**
* Get an array of element attributes.
+ * @return the attributes
*/
public Attribute[] getAttributes()
{
@@ -566,7 +570,8 @@ public class XmlParser
/* ------------------------------------------------------------ */
/**
* Get an element attribute.
- *
+ *
+ * @param name the name of the attribute
* @return attribute or null.
*/
public String getAttribute(String name)
@@ -577,7 +582,9 @@ public class XmlParser
/* ------------------------------------------------------------ */
/**
* Get an element attribute.
- *
+ *
+ * @param name the name of the element
+ * @param dft the default value
* @return attribute or null.
*/
public String getAttribute(String name, String dft)
@@ -618,7 +625,7 @@ public class XmlParser
/**
* Get the first child node with the tag.
*
- * @param tag
+ * @param tag the name of the tag
* @return Node or null.
*/
public Node get(String tag)
@@ -702,6 +709,7 @@ public class XmlParser
* Convert to a string.
*
* @param tag If false, only _content is shown.
+ * @return the string value
*/
public synchronized String toString(boolean tag)
{
@@ -715,6 +723,8 @@ public class XmlParser
* Convert to a string.
*
* @param tag If false, only _content is shown.
+ * @param trim true to trim the content
+ * @return the trimmed content
*/
public synchronized String toString(boolean tag, boolean trim)
{

Back to the top