From b938245b140282ab3c8c7fb797f6ba3ac7cfe0d3 Mon Sep 17 00:00:00 2001 From: Joakim Erdfelt Date: Thu, 17 Jan 2013 15:41:33 -0700 Subject: [PATCH] Adding some javadoc, cleaning up package namespaces where appropriate --- .../api/annotations/package-info.java} | 16 +++------ .../api/extensions/package-info.java} | 18 +++------- .../jetty/websocket/api/io/package-info.java | 23 +++++++++++++ .../jetty/websocket/api/package-info.java | 23 +++++++++++++ .../websocket/api/util/package-info.java | 23 +++++++++++++ .../websocket/client/WebSocketClient.java | 4 +-- .../{internal => io}/ConnectPromise.java | 2 +- .../{internal => io}/ConnectionManager.java | 3 +- .../io/HttpResponseHeaderParser.java | 2 +- .../{internal => }/io/UpgradeConnection.java | 3 +- .../io/WebSocketClientConnection.java | 4 +-- .../io/WebSocketClientSelectorManager.java | 3 +- .../websocket/client/io/package-info.java | 23 +++++++++++++ .../jetty/websocket/client/masks/Masker.java | 11 ++++++ .../websocket/client/masks/package-info.java | 23 +++++++++++++ .../websocket/client/mux/package-info.java | 23 +++++++++++++ .../jetty/websocket/client/package-info.java | 34 +++++++++++++++++++ .../internal/ConnectionManagerTest.java | 1 + .../io/HttpResponseHeaderParserTest.java | 1 + .../websocket/common/events/package-info.java | 23 +++++++++++++ .../extensions/compress/package-info.java | 23 +++++++++++++ .../extensions/fragment/package-info.java | 23 +++++++++++++ .../extensions/identity/package-info.java | 23 +++++++++++++ .../extensions/mux/add/package-info.java | 23 +++++++++++++ .../extensions/mux/op/package-info.java | 23 +++++++++++++ .../common/extensions/mux/package-info.java | 23 +++++++++++++ .../common/extensions/package-info.java | 23 +++++++++++++ .../websocket/common/io/package-info.java | 23 +++++++++++++ .../common/io/payload/package-info.java | 23 +++++++++++++ .../common/message/package-info.java | 23 +++++++++++++ .../jetty/websocket/common/package-info.java | 29 ++++++++++++++++ .../{handshake => }/HandshakeRFC6455.java | 5 +-- .../server/WebSocketServerFactory.java | 1 - .../websocket/server/mux/package-info.java | 23 +++++++++++++ .../jetty/websocket/server/package-info.java | 23 +++++++++++++ .../jetty/websocket/servlet/package-info.java | 31 +++++++++++++++++ 36 files changed, 561 insertions(+), 44 deletions(-) rename jetty-websocket/{websocket-client/src/main/java/org/eclipse/jetty/websocket/client/internal/mux/MuxClientExtension.java => websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/package-info.java} (67%) rename jetty-websocket/{websocket-client/src/main/java/org/eclipse/jetty/websocket/client/internal/mux/MuxClientAddHandler.java => websocket-api/src/main/java/org/eclipse/jetty/websocket/api/extensions/package-info.java} (61%) create mode 100644 jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/io/package-info.java create mode 100644 jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/package-info.java create mode 100644 jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/util/package-info.java rename jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/{internal => io}/ConnectPromise.java (97%) rename jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/{internal => io}/ConnectionManager.java (97%) rename jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/{internal => }/io/HttpResponseHeaderParser.java (98%) rename jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/{internal => }/io/UpgradeConnection.java (98%) rename jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/{internal => }/io/WebSocketClientConnection.java (95%) rename jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/{internal => }/io/WebSocketClientSelectorManager.java (97%) create mode 100644 jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/io/package-info.java create mode 100644 jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/masks/package-info.java create mode 100644 jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/mux/package-info.java create mode 100644 jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/package-info.java create mode 100644 jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/events/package-info.java create mode 100644 jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/extensions/compress/package-info.java create mode 100644 jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/extensions/fragment/package-info.java create mode 100644 jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/extensions/identity/package-info.java create mode 100644 jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/extensions/mux/add/package-info.java create mode 100644 jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/extensions/mux/op/package-info.java create mode 100644 jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/extensions/mux/package-info.java create mode 100644 jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/extensions/package-info.java create mode 100644 jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/io/package-info.java create mode 100644 jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/io/payload/package-info.java create mode 100644 jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/message/package-info.java create mode 100644 jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/package-info.java rename jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/{handshake => }/HandshakeRFC6455.java (90%) create mode 100644 jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/mux/package-info.java create mode 100644 jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/package-info.java create mode 100644 jetty-websocket/websocket-servlet/src/main/java/org/eclipse/jetty/websocket/servlet/package-info.java diff --git a/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/internal/mux/MuxClientExtension.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/package-info.java similarity index 67% rename from jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/internal/mux/MuxClientExtension.java rename to jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/package-info.java index 56a69a19151..e23e5c687ba 100644 --- a/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/internal/mux/MuxClientExtension.java +++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/package-info.java @@ -16,16 +16,8 @@ // ======================================================================== // -package org.eclipse.jetty.websocket.client.internal.mux; +/** + * Jetty WebSocket API : WebSocket POJO Annotations + */ +package org.eclipse.jetty.websocket.api.annotations; -import org.eclipse.jetty.websocket.common.extensions.mux.AbstractMuxExtension; -import org.eclipse.jetty.websocket.common.extensions.mux.Muxer; - -public class MuxClientExtension extends AbstractMuxExtension -{ - @Override - public void configureMuxer(Muxer muxer) - { - muxer.setAddClient(new MuxClientAddHandler()); - } -} diff --git a/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/internal/mux/MuxClientAddHandler.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/extensions/package-info.java similarity index 61% rename from jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/internal/mux/MuxClientAddHandler.java rename to jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/extensions/package-info.java index 0c599f2e022..a48e04ab968 100644 --- a/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/internal/mux/MuxClientAddHandler.java +++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/extensions/package-info.java @@ -16,18 +16,8 @@ // ======================================================================== // -package org.eclipse.jetty.websocket.client.internal.mux; +/** + * Jetty WebSocket API : WebSocket Extension API + */ +package org.eclipse.jetty.websocket.api.extensions; -import org.eclipse.jetty.websocket.common.WebSocketSession; -import org.eclipse.jetty.websocket.common.extensions.mux.add.MuxAddClient; -import org.eclipse.jetty.websocket.common.extensions.mux.op.MuxAddChannelResponse; - -public class MuxClientAddHandler implements MuxAddClient -{ - @Override - public WebSocketSession createSession(MuxAddChannelResponse response) - { - // TODO Auto-generated method stub - return null; - } -} diff --git a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/io/package-info.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/io/package-info.java new file mode 100644 index 00000000000..6c2ae1c2974 --- /dev/null +++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/io/package-info.java @@ -0,0 +1,23 @@ +// +// ======================================================================== +// Copyright (c) 1995-2013 Mort Bay Consulting Pty. Ltd. +// ------------------------------------------------------------------------ +// All rights reserved. This program and the accompanying materials +// are made available under the terms of the Eclipse Public License v1.0 +// and Apache License v2.0 which accompanies this distribution. +// +// The Eclipse Public License is available at +// http://www.eclipse.org/legal/epl-v10.html +// +// The Apache License v2.0 is available at +// http://www.opensource.org/licenses/apache2.0.php +// +// You may elect to redistribute this code under either of these licenses. +// ======================================================================== +// + +/** + * Jetty WebSocket API : I/O Classes + */ +package org.eclipse.jetty.websocket.api.io; + diff --git a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/package-info.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/package-info.java new file mode 100644 index 00000000000..d96d91cd792 --- /dev/null +++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/package-info.java @@ -0,0 +1,23 @@ +// +// ======================================================================== +// Copyright (c) 1995-2013 Mort Bay Consulting Pty. Ltd. +// ------------------------------------------------------------------------ +// All rights reserved. This program and the accompanying materials +// are made available under the terms of the Eclipse Public License v1.0 +// and Apache License v2.0 which accompanies this distribution. +// +// The Eclipse Public License is available at +// http://www.eclipse.org/legal/epl-v10.html +// +// The Apache License v2.0 is available at +// http://www.opensource.org/licenses/apache2.0.php +// +// You may elect to redistribute this code under either of these licenses. +// ======================================================================== +// + +/** + * Jetty WebSocket API + */ +package org.eclipse.jetty.websocket.api; + diff --git a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/util/package-info.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/util/package-info.java new file mode 100644 index 00000000000..e8a8bc2be5a --- /dev/null +++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/util/package-info.java @@ -0,0 +1,23 @@ +// +// ======================================================================== +// Copyright (c) 1995-2013 Mort Bay Consulting Pty. Ltd. +// ------------------------------------------------------------------------ +// All rights reserved. This program and the accompanying materials +// are made available under the terms of the Eclipse Public License v1.0 +// and Apache License v2.0 which accompanies this distribution. +// +// The Eclipse Public License is available at +// http://www.eclipse.org/legal/epl-v10.html +// +// The Apache License v2.0 is available at +// http://www.opensource.org/licenses/apache2.0.php +// +// You may elect to redistribute this code under either of these licenses. +// ======================================================================== +// + +/** + * Jetty WebSocket API : Utility Classes + */ +package org.eclipse.jetty.websocket.api.util; + 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 e5e5bcc3229..b8ea3b458bf 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 @@ -43,8 +43,8 @@ import org.eclipse.jetty.websocket.api.WebSocketPolicy; import org.eclipse.jetty.websocket.api.extensions.Extension; import org.eclipse.jetty.websocket.api.extensions.ExtensionConfig; import org.eclipse.jetty.websocket.api.extensions.ExtensionFactory; -import org.eclipse.jetty.websocket.client.internal.ConnectPromise; -import org.eclipse.jetty.websocket.client.internal.ConnectionManager; +import org.eclipse.jetty.websocket.client.io.ConnectPromise; +import org.eclipse.jetty.websocket.client.io.ConnectionManager; import org.eclipse.jetty.websocket.client.masks.Masker; import org.eclipse.jetty.websocket.client.masks.RandomMasker; import org.eclipse.jetty.websocket.common.events.EventDriver; diff --git a/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/internal/ConnectPromise.java b/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/io/ConnectPromise.java similarity index 97% rename from jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/internal/ConnectPromise.java rename to jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/io/ConnectPromise.java index 90ae360968f..6e680075e39 100644 --- a/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/internal/ConnectPromise.java +++ b/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/io/ConnectPromise.java @@ -16,7 +16,7 @@ // ======================================================================== // -package org.eclipse.jetty.websocket.client.internal; +package org.eclipse.jetty.websocket.client.io; import org.eclipse.jetty.util.FuturePromise; import org.eclipse.jetty.websocket.api.Session; diff --git a/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/internal/ConnectionManager.java b/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/io/ConnectionManager.java similarity index 97% rename from jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/internal/ConnectionManager.java rename to jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/io/ConnectionManager.java index 6174333756f..e8b53bfec30 100644 --- a/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/internal/ConnectionManager.java +++ b/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/io/ConnectionManager.java @@ -16,7 +16,7 @@ // ======================================================================== // -package org.eclipse.jetty.websocket.client.internal; +package org.eclipse.jetty.websocket.client.io; import java.net.InetSocketAddress; import java.net.SocketAddress; @@ -34,7 +34,6 @@ import org.eclipse.jetty.util.log.Logger; import org.eclipse.jetty.websocket.api.UpgradeException; import org.eclipse.jetty.websocket.client.ClientUpgradeRequest; import org.eclipse.jetty.websocket.client.WebSocketClient; -import org.eclipse.jetty.websocket.client.internal.io.WebSocketClientSelectorManager; import org.eclipse.jetty.websocket.common.WebSocketSession; import org.eclipse.jetty.websocket.common.events.EventDriver; diff --git a/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/internal/io/HttpResponseHeaderParser.java b/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/io/HttpResponseHeaderParser.java similarity index 98% rename from jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/internal/io/HttpResponseHeaderParser.java rename to jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/io/HttpResponseHeaderParser.java index 8b917175afd..6639ff71756 100644 --- a/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/internal/io/HttpResponseHeaderParser.java +++ b/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/io/HttpResponseHeaderParser.java @@ -16,7 +16,7 @@ // ======================================================================== // -package org.eclipse.jetty.websocket.client.internal.io; +package org.eclipse.jetty.websocket.client.io; import java.nio.ByteBuffer; import java.util.regex.Matcher; diff --git a/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/internal/io/UpgradeConnection.java b/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/io/UpgradeConnection.java similarity index 98% rename from jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/internal/io/UpgradeConnection.java rename to jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/io/UpgradeConnection.java index 43259c809a8..cb362fe547f 100644 --- a/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/internal/io/UpgradeConnection.java +++ b/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/io/UpgradeConnection.java @@ -16,7 +16,7 @@ // ======================================================================== // -package org.eclipse.jetty.websocket.client.internal.io; +package org.eclipse.jetty.websocket.client.io; import java.io.IOException; import java.net.URI; @@ -39,7 +39,6 @@ import org.eclipse.jetty.websocket.api.WebSocketPolicy; import org.eclipse.jetty.websocket.api.extensions.ExtensionConfig; import org.eclipse.jetty.websocket.client.ClientUpgradeRequest; import org.eclipse.jetty.websocket.client.ClientUpgradeResponse; -import org.eclipse.jetty.websocket.client.internal.ConnectPromise; import org.eclipse.jetty.websocket.common.AcceptHash; import org.eclipse.jetty.websocket.common.WebSocketSession; import org.eclipse.jetty.websocket.common.events.EventDriver; diff --git a/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/internal/io/WebSocketClientConnection.java b/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/io/WebSocketClientConnection.java similarity index 95% rename from jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/internal/io/WebSocketClientConnection.java rename to jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/io/WebSocketClientConnection.java index a8db86c0b10..575bf27fe4a 100644 --- a/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/internal/io/WebSocketClientConnection.java +++ b/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/io/WebSocketClientConnection.java @@ -16,7 +16,7 @@ // ======================================================================== // -package org.eclipse.jetty.websocket.client.internal.io; +package org.eclipse.jetty.websocket.client.io; import java.net.InetSocketAddress; import java.util.concurrent.Executor; @@ -28,8 +28,6 @@ import org.eclipse.jetty.websocket.api.ProtocolException; import org.eclipse.jetty.websocket.api.WriteCallback; import org.eclipse.jetty.websocket.api.extensions.Frame; import org.eclipse.jetty.websocket.api.extensions.IncomingFrames; -import org.eclipse.jetty.websocket.client.internal.ConnectPromise; -import org.eclipse.jetty.websocket.client.internal.ConnectionManager; import org.eclipse.jetty.websocket.client.masks.Masker; import org.eclipse.jetty.websocket.common.WebSocketFrame; import org.eclipse.jetty.websocket.common.WebSocketSession; diff --git a/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/internal/io/WebSocketClientSelectorManager.java b/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/io/WebSocketClientSelectorManager.java similarity index 97% rename from jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/internal/io/WebSocketClientSelectorManager.java rename to jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/io/WebSocketClientSelectorManager.java index a285e9a2844..08bcc6db903 100644 --- a/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/internal/io/WebSocketClientSelectorManager.java +++ b/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/io/WebSocketClientSelectorManager.java @@ -16,7 +16,7 @@ // ======================================================================== // -package org.eclipse.jetty.websocket.client.internal.io; +package org.eclipse.jetty.websocket.client.io; import java.io.IOException; import java.nio.channels.SelectionKey; @@ -37,7 +37,6 @@ import org.eclipse.jetty.util.ssl.SslContextFactory; import org.eclipse.jetty.util.thread.Scheduler; import org.eclipse.jetty.websocket.api.WebSocketPolicy; import org.eclipse.jetty.websocket.client.WebSocketClient; -import org.eclipse.jetty.websocket.client.internal.ConnectPromise; public class WebSocketClientSelectorManager extends SelectorManager { diff --git a/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/io/package-info.java b/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/io/package-info.java new file mode 100644 index 00000000000..319c3b6703a --- /dev/null +++ b/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/io/package-info.java @@ -0,0 +1,23 @@ +// +// ======================================================================== +// Copyright (c) 1995-2013 Mort Bay Consulting Pty. Ltd. +// ------------------------------------------------------------------------ +// All rights reserved. This program and the accompanying materials +// are made available under the terms of the Eclipse Public License v1.0 +// and Apache License v2.0 which accompanies this distribution. +// +// The Eclipse Public License is available at +// http://www.eclipse.org/legal/epl-v10.html +// +// The Apache License v2.0 is available at +// http://www.opensource.org/licenses/apache2.0.php +// +// You may elect to redistribute this code under either of these licenses. +// ======================================================================== +// + +/** + * Jetty WebSocket Client : I/O Implementation [Internal Use Only] + */ +package org.eclipse.jetty.websocket.client.io; + diff --git a/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/masks/Masker.java b/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/masks/Masker.java index a1590e492ed..56f489d575d 100644 --- a/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/masks/Masker.java +++ b/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/masks/Masker.java @@ -20,7 +20,18 @@ package org.eclipse.jetty.websocket.client.masks; import org.eclipse.jetty.websocket.common.WebSocketFrame; +/** + * Interface for various Masker implementations. + */ public interface Masker { + /** + * Set the mask on the provided {@link WebSocketFrame}. + *

+ * Implementations MUST set the mask on the frame. + * + * @param frame + * the frame to set the mask on. + */ void setMask(WebSocketFrame frame); } \ No newline at end of file diff --git a/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/masks/package-info.java b/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/masks/package-info.java new file mode 100644 index 00000000000..39499290e8a --- /dev/null +++ b/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/masks/package-info.java @@ -0,0 +1,23 @@ +// +// ======================================================================== +// Copyright (c) 1995-2013 Mort Bay Consulting Pty. Ltd. +// ------------------------------------------------------------------------ +// All rights reserved. This program and the accompanying materials +// are made available under the terms of the Eclipse Public License v1.0 +// and Apache License v2.0 which accompanies this distribution. +// +// The Eclipse Public License is available at +// http://www.eclipse.org/legal/epl-v10.html +// +// The Apache License v2.0 is available at +// http://www.opensource.org/licenses/apache2.0.php +// +// You may elect to redistribute this code under either of these licenses. +// ======================================================================== +// + +/** + * Jetty WebSocket Client : Frame Masking Implementations + */ +package org.eclipse.jetty.websocket.client.masks; + diff --git a/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/mux/package-info.java b/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/mux/package-info.java new file mode 100644 index 00000000000..6df80bb5202 --- /dev/null +++ b/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/mux/package-info.java @@ -0,0 +1,23 @@ +// +// ======================================================================== +// Copyright (c) 1995-2013 Mort Bay Consulting Pty. Ltd. +// ------------------------------------------------------------------------ +// All rights reserved. This program and the accompanying materials +// are made available under the terms of the Eclipse Public License v1.0 +// and Apache License v2.0 which accompanies this distribution. +// +// The Eclipse Public License is available at +// http://www.eclipse.org/legal/epl-v10.html +// +// The Apache License v2.0 is available at +// http://www.opensource.org/licenses/apache2.0.php +// +// You may elect to redistribute this code under either of these licenses. +// ======================================================================== +// + +/** + * Jetty WebSocket Client : MUX Extension [Unstable Early Draft] + */ +package org.eclipse.jetty.websocket.client.mux; + 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 new file mode 100644 index 00000000000..1f5df7d3403 --- /dev/null +++ b/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/package-info.java @@ -0,0 +1,34 @@ +// +// ======================================================================== +// Copyright (c) 1995-2013 Mort Bay Consulting Pty. Ltd. +// ------------------------------------------------------------------------ +// All rights reserved. This program and the accompanying materials +// are made available under the terms of the Eclipse Public License v1.0 +// and Apache License v2.0 which accompanies this distribution. +// +// The Eclipse Public License is available at +// http://www.eclipse.org/legal/epl-v10.html +// +// The Apache License v2.0 is available at +// http://www.opensource.org/licenses/apache2.0.php +// +// You may elect to redistribute this code under either of these licenses. +// ======================================================================== +// + +/** + * Jetty WebSocket Client API + *

+ * The core class is {@link WebSocketClient}, which acts as a central configuration object (for example + * for {@link 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. + *

+ * The WebSocket protocol 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. + *

+ * {@link WebSocketClient} holds a number of {@link org.eclipse.jetty.websocket.api.Session Sessions}, 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/internal/ConnectionManagerTest.java b/jetty-websocket/websocket-client/src/test/java/org/eclipse/jetty/websocket/client/internal/ConnectionManagerTest.java index 5086edcca50..481bf9d07eb 100644 --- a/jetty-websocket/websocket-client/src/test/java/org/eclipse/jetty/websocket/client/internal/ConnectionManagerTest.java +++ b/jetty-websocket/websocket-client/src/test/java/org/eclipse/jetty/websocket/client/internal/ConnectionManagerTest.java @@ -25,6 +25,7 @@ import java.net.URI; import java.net.URISyntaxException; import org.eclipse.jetty.toolchain.test.TestTracker; +import org.eclipse.jetty.websocket.client.io.ConnectionManager; import org.junit.Assert; import org.junit.Rule; import org.junit.Test; diff --git a/jetty-websocket/websocket-client/src/test/java/org/eclipse/jetty/websocket/client/internal/io/HttpResponseHeaderParserTest.java b/jetty-websocket/websocket-client/src/test/java/org/eclipse/jetty/websocket/client/internal/io/HttpResponseHeaderParserTest.java index a8f82363aa9..d2f882216f3 100644 --- a/jetty-websocket/websocket-client/src/test/java/org/eclipse/jetty/websocket/client/internal/io/HttpResponseHeaderParserTest.java +++ b/jetty-websocket/websocket-client/src/test/java/org/eclipse/jetty/websocket/client/internal/io/HttpResponseHeaderParserTest.java @@ -28,6 +28,7 @@ import org.eclipse.jetty.toolchain.test.TestTracker; import org.eclipse.jetty.util.BufferUtil; import org.eclipse.jetty.util.StringUtil; import org.eclipse.jetty.websocket.api.UpgradeResponse; +import org.eclipse.jetty.websocket.client.io.HttpResponseHeaderParser; import org.junit.Assert; import org.junit.Rule; import org.junit.Test; diff --git a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/events/package-info.java b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/events/package-info.java new file mode 100644 index 00000000000..9003474682e --- /dev/null +++ b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/events/package-info.java @@ -0,0 +1,23 @@ +// +// ======================================================================== +// Copyright (c) 1995-2013 Mort Bay Consulting Pty. Ltd. +// ------------------------------------------------------------------------ +// All rights reserved. This program and the accompanying materials +// are made available under the terms of the Eclipse Public License v1.0 +// and Apache License v2.0 which accompanies this distribution. +// +// The Eclipse Public License is available at +// http://www.eclipse.org/legal/epl-v10.html +// +// The Apache License v2.0 is available at +// http://www.opensource.org/licenses/apache2.0.php +// +// You may elect to redistribute this code under either of these licenses. +// ======================================================================== +// + +/** + * Jetty WebSocket Common : Event Driver for WebSocket Object + */ +package org.eclipse.jetty.websocket.common.events; + diff --git a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/extensions/compress/package-info.java b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/extensions/compress/package-info.java new file mode 100644 index 00000000000..e8c5af5f173 --- /dev/null +++ b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/extensions/compress/package-info.java @@ -0,0 +1,23 @@ +// +// ======================================================================== +// Copyright (c) 1995-2013 Mort Bay Consulting Pty. Ltd. +// ------------------------------------------------------------------------ +// All rights reserved. This program and the accompanying materials +// are made available under the terms of the Eclipse Public License v1.0 +// and Apache License v2.0 which accompanies this distribution. +// +// The Eclipse Public License is available at +// http://www.eclipse.org/legal/epl-v10.html +// +// The Apache License v2.0 is available at +// http://www.opensource.org/licenses/apache2.0.php +// +// You may elect to redistribute this code under either of these licenses. +// ======================================================================== +// + +/** + * Jetty WebSocket Common : Frame & Message Compression Extension Implementations + */ +package org.eclipse.jetty.websocket.common.extensions.compress; + diff --git a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/extensions/fragment/package-info.java b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/extensions/fragment/package-info.java new file mode 100644 index 00000000000..bdec158cf01 --- /dev/null +++ b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/extensions/fragment/package-info.java @@ -0,0 +1,23 @@ +// +// ======================================================================== +// Copyright (c) 1995-2013 Mort Bay Consulting Pty. Ltd. +// ------------------------------------------------------------------------ +// All rights reserved. This program and the accompanying materials +// are made available under the terms of the Eclipse Public License v1.0 +// and Apache License v2.0 which accompanies this distribution. +// +// The Eclipse Public License is available at +// http://www.eclipse.org/legal/epl-v10.html +// +// The Apache License v2.0 is available at +// http://www.opensource.org/licenses/apache2.0.php +// +// You may elect to redistribute this code under either of these licenses. +// ======================================================================== +// + +/** + * Jetty WebSocket Common : Auto Fragment Extension Implementation + */ +package org.eclipse.jetty.websocket.common.extensions.fragment; + diff --git a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/extensions/identity/package-info.java b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/extensions/identity/package-info.java new file mode 100644 index 00000000000..f0f91b9580c --- /dev/null +++ b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/extensions/identity/package-info.java @@ -0,0 +1,23 @@ +// +// ======================================================================== +// Copyright (c) 1995-2013 Mort Bay Consulting Pty. Ltd. +// ------------------------------------------------------------------------ +// All rights reserved. This program and the accompanying materials +// are made available under the terms of the Eclipse Public License v1.0 +// and Apache License v2.0 which accompanies this distribution. +// +// The Eclipse Public License is available at +// http://www.eclipse.org/legal/epl-v10.html +// +// The Apache License v2.0 is available at +// http://www.opensource.org/licenses/apache2.0.php +// +// You may elect to redistribute this code under either of these licenses. +// ======================================================================== +// + +/** + * Jetty WebSocket Common : Identity Extension Implementation + */ +package org.eclipse.jetty.websocket.common.extensions.identity; + diff --git a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/extensions/mux/add/package-info.java b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/extensions/mux/add/package-info.java new file mode 100644 index 00000000000..87985efb123 --- /dev/null +++ b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/extensions/mux/add/package-info.java @@ -0,0 +1,23 @@ +// +// ======================================================================== +// Copyright (c) 1995-2013 Mort Bay Consulting Pty. Ltd. +// ------------------------------------------------------------------------ +// All rights reserved. This program and the accompanying materials +// are made available under the terms of the Eclipse Public License v1.0 +// and Apache License v2.0 which accompanies this distribution. +// +// The Eclipse Public License is available at +// http://www.eclipse.org/legal/epl-v10.html +// +// The Apache License v2.0 is available at +// http://www.opensource.org/licenses/apache2.0.php +// +// You may elect to redistribute this code under either of these licenses. +// ======================================================================== +// + +/** + * Jetty WebSocket Common : MUX Extension Add Channel Handling [Unstable Early Draft] + */ +package org.eclipse.jetty.websocket.common.extensions.mux.add; + diff --git a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/extensions/mux/op/package-info.java b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/extensions/mux/op/package-info.java new file mode 100644 index 00000000000..cd5c7ac8057 --- /dev/null +++ b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/extensions/mux/op/package-info.java @@ -0,0 +1,23 @@ +// +// ======================================================================== +// Copyright (c) 1995-2013 Mort Bay Consulting Pty. Ltd. +// ------------------------------------------------------------------------ +// All rights reserved. This program and the accompanying materials +// are made available under the terms of the Eclipse Public License v1.0 +// and Apache License v2.0 which accompanies this distribution. +// +// The Eclipse Public License is available at +// http://www.eclipse.org/legal/epl-v10.html +// +// The Apache License v2.0 is available at +// http://www.opensource.org/licenses/apache2.0.php +// +// You may elect to redistribute this code under either of these licenses. +// ======================================================================== +// + +/** + * Jetty WebSocket Common : MUX Extension OpCode Handling [Unstable Early Draft] + */ +package org.eclipse.jetty.websocket.common.extensions.mux.op; + diff --git a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/extensions/mux/package-info.java b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/extensions/mux/package-info.java new file mode 100644 index 00000000000..7112f3b2d45 --- /dev/null +++ b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/extensions/mux/package-info.java @@ -0,0 +1,23 @@ +// +// ======================================================================== +// Copyright (c) 1995-2013 Mort Bay Consulting Pty. Ltd. +// ------------------------------------------------------------------------ +// All rights reserved. This program and the accompanying materials +// are made available under the terms of the Eclipse Public License v1.0 +// and Apache License v2.0 which accompanies this distribution. +// +// The Eclipse Public License is available at +// http://www.eclipse.org/legal/epl-v10.html +// +// The Apache License v2.0 is available at +// http://www.opensource.org/licenses/apache2.0.php +// +// You may elect to redistribute this code under either of these licenses. +// ======================================================================== +// + +/** + * Jetty WebSocket Common : MUX Extension Core [Unstable Early Draft] + */ +package org.eclipse.jetty.websocket.common.extensions.mux; + diff --git a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/extensions/package-info.java b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/extensions/package-info.java new file mode 100644 index 00000000000..127894d53f0 --- /dev/null +++ b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/extensions/package-info.java @@ -0,0 +1,23 @@ +// +// ======================================================================== +// Copyright (c) 1995-2013 Mort Bay Consulting Pty. Ltd. +// ------------------------------------------------------------------------ +// All rights reserved. This program and the accompanying materials +// are made available under the terms of the Eclipse Public License v1.0 +// and Apache License v2.0 which accompanies this distribution. +// +// The Eclipse Public License is available at +// http://www.eclipse.org/legal/epl-v10.html +// +// The Apache License v2.0 is available at +// http://www.opensource.org/licenses/apache2.0.php +// +// You may elect to redistribute this code under either of these licenses. +// ======================================================================== +// + +/** + * Jetty WebSocket Common : Extension Implementations + */ +package org.eclipse.jetty.websocket.common.extensions; + diff --git a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/io/package-info.java b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/io/package-info.java new file mode 100644 index 00000000000..097b034a177 --- /dev/null +++ b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/io/package-info.java @@ -0,0 +1,23 @@ +// +// ======================================================================== +// Copyright (c) 1995-2013 Mort Bay Consulting Pty. Ltd. +// ------------------------------------------------------------------------ +// All rights reserved. This program and the accompanying materials +// are made available under the terms of the Eclipse Public License v1.0 +// and Apache License v2.0 which accompanies this distribution. +// +// The Eclipse Public License is available at +// http://www.eclipse.org/legal/epl-v10.html +// +// The Apache License v2.0 is available at +// http://www.opensource.org/licenses/apache2.0.php +// +// You may elect to redistribute this code under either of these licenses. +// ======================================================================== +// + +/** + * Jetty WebSocket Common : I/O Implementation + */ +package org.eclipse.jetty.websocket.common.io; + diff --git a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/io/payload/package-info.java b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/io/payload/package-info.java new file mode 100644 index 00000000000..f916861751b --- /dev/null +++ b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/io/payload/package-info.java @@ -0,0 +1,23 @@ +// +// ======================================================================== +// Copyright (c) 1995-2013 Mort Bay Consulting Pty. Ltd. +// ------------------------------------------------------------------------ +// All rights reserved. This program and the accompanying materials +// are made available under the terms of the Eclipse Public License v1.0 +// and Apache License v2.0 which accompanies this distribution. +// +// The Eclipse Public License is available at +// http://www.eclipse.org/legal/epl-v10.html +// +// The Apache License v2.0 is available at +// http://www.opensource.org/licenses/apache2.0.php +// +// You may elect to redistribute this code under either of these licenses. +// ======================================================================== +// + +/** + * Jetty WebSocket Common : I/O : Frame Payload Handling + */ +package org.eclipse.jetty.websocket.common.io.payload; + diff --git a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/message/package-info.java b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/message/package-info.java new file mode 100644 index 00000000000..859d69c1405 --- /dev/null +++ b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/message/package-info.java @@ -0,0 +1,23 @@ +// +// ======================================================================== +// Copyright (c) 1995-2013 Mort Bay Consulting Pty. Ltd. +// ------------------------------------------------------------------------ +// All rights reserved. This program and the accompanying materials +// are made available under the terms of the Eclipse Public License v1.0 +// and Apache License v2.0 which accompanies this distribution. +// +// The Eclipse Public License is available at +// http://www.eclipse.org/legal/epl-v10.html +// +// The Apache License v2.0 is available at +// http://www.opensource.org/licenses/apache2.0.php +// +// You may elect to redistribute this code under either of these licenses. +// ======================================================================== +// + +/** + * Jetty WebSocket Common : Message Handling + */ +package org.eclipse.jetty.websocket.common.message; + diff --git a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/package-info.java b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/package-info.java new file mode 100644 index 00000000000..1ef501cd2dc --- /dev/null +++ b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/package-info.java @@ -0,0 +1,29 @@ +// +// ======================================================================== +// Copyright (c) 1995-2013 Mort Bay Consulting Pty. Ltd. +// ------------------------------------------------------------------------ +// All rights reserved. This program and the accompanying materials +// are made available under the terms of the Eclipse Public License v1.0 +// and Apache License v2.0 which accompanies this distribution. +// +// The Eclipse Public License is available at +// http://www.eclipse.org/legal/epl-v10.html +// +// The Apache License v2.0 is available at +// http://www.opensource.org/licenses/apache2.0.php +// +// You may elect to redistribute this code under either of these licenses. +// ======================================================================== +// + +/** + * Jetty WebSocket Common : Implementation [Internal Use Only] + *

+ * A core set of internal implementation classes for the Jetty WebSocket API. + *

+ * Note: do not reference or use classes present in this package space in your code.
+ * Restrict your usage to the Jetty WebSocket API classes, the Jetty WebSocket Client API, + * or the Jetty WebSocket Servlet API. + */ +package org.eclipse.jetty.websocket.common; + diff --git a/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/handshake/HandshakeRFC6455.java b/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/HandshakeRFC6455.java similarity index 90% rename from jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/handshake/HandshakeRFC6455.java rename to jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/HandshakeRFC6455.java index cab07c832ed..14f1559fd48 100644 --- a/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/handshake/HandshakeRFC6455.java +++ b/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/HandshakeRFC6455.java @@ -16,7 +16,7 @@ // ======================================================================== // -package org.eclipse.jetty.websocket.server.handshake; +package org.eclipse.jetty.websocket.server; import java.io.IOException; @@ -24,9 +24,6 @@ import javax.servlet.http.HttpServletResponse; import org.eclipse.jetty.websocket.api.extensions.ExtensionConfig; import org.eclipse.jetty.websocket.common.AcceptHash; -import org.eclipse.jetty.websocket.server.ServletWebSocketRequest; -import org.eclipse.jetty.websocket.server.ServletWebSocketResponse; -import org.eclipse.jetty.websocket.server.WebSocketHandshake; /** * WebSocket Handshake for RFC 6455. diff --git a/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/WebSocketServerFactory.java b/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/WebSocketServerFactory.java index fa2b16a2390..e5f75af903b 100644 --- a/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/WebSocketServerFactory.java +++ b/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/WebSocketServerFactory.java @@ -52,7 +52,6 @@ import org.eclipse.jetty.websocket.common.events.EventDriver; import org.eclipse.jetty.websocket.common.events.EventDriverFactory; import org.eclipse.jetty.websocket.common.extensions.ExtensionStack; import org.eclipse.jetty.websocket.common.extensions.WebSocketExtensionFactory; -import org.eclipse.jetty.websocket.server.handshake.HandshakeRFC6455; import org.eclipse.jetty.websocket.servlet.WebSocketCreator; import org.eclipse.jetty.websocket.servlet.WebSocketServletFactory; diff --git a/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/mux/package-info.java b/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/mux/package-info.java new file mode 100644 index 00000000000..34367885f53 --- /dev/null +++ b/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/mux/package-info.java @@ -0,0 +1,23 @@ +// +// ======================================================================== +// Copyright (c) 1995-2013 Mort Bay Consulting Pty. Ltd. +// ------------------------------------------------------------------------ +// All rights reserved. This program and the accompanying materials +// are made available under the terms of the Eclipse Public License v1.0 +// and Apache License v2.0 which accompanies this distribution. +// +// The Eclipse Public License is available at +// http://www.eclipse.org/legal/epl-v10.html +// +// The Apache License v2.0 is available at +// http://www.opensource.org/licenses/apache2.0.php +// +// You may elect to redistribute this code under either of these licenses. +// ======================================================================== +// + +/** + * Jetty WebSocket Server : MUX Extension [Unstable Early Draft] + */ +package org.eclipse.jetty.websocket.server.mux; + diff --git a/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/package-info.java b/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/package-info.java new file mode 100644 index 00000000000..6571bb06d74 --- /dev/null +++ b/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/package-info.java @@ -0,0 +1,23 @@ +// +// ======================================================================== +// Copyright (c) 1995-2013 Mort Bay Consulting Pty. Ltd. +// ------------------------------------------------------------------------ +// All rights reserved. This program and the accompanying materials +// are made available under the terms of the Eclipse Public License v1.0 +// and Apache License v2.0 which accompanies this distribution. +// +// The Eclipse Public License is available at +// http://www.eclipse.org/legal/epl-v10.html +// +// The Apache License v2.0 is available at +// http://www.opensource.org/licenses/apache2.0.php +// +// You may elect to redistribute this code under either of these licenses. +// ======================================================================== +// + +/** + * Jetty WebSocket Server : Implementation [Internal Use Only] + */ +package org.eclipse.jetty.websocket.server; + diff --git a/jetty-websocket/websocket-servlet/src/main/java/org/eclipse/jetty/websocket/servlet/package-info.java b/jetty-websocket/websocket-servlet/src/main/java/org/eclipse/jetty/websocket/servlet/package-info.java new file mode 100644 index 00000000000..b5f9ae73035 --- /dev/null +++ b/jetty-websocket/websocket-servlet/src/main/java/org/eclipse/jetty/websocket/servlet/package-info.java @@ -0,0 +1,31 @@ +// +// ======================================================================== +// Copyright (c) 1995-2013 Mort Bay Consulting Pty. Ltd. +// ------------------------------------------------------------------------ +// All rights reserved. This program and the accompanying materials +// are made available under the terms of the Eclipse Public License v1.0 +// and Apache License v2.0 which accompanies this distribution. +// +// The Eclipse Public License is available at +// http://www.eclipse.org/legal/epl-v10.html +// +// The Apache License v2.0 is available at +// http://www.opensource.org/licenses/apache2.0.php +// +// You may elect to redistribute this code under either of these licenses. +// ======================================================================== +// + +/** + * Jetty WebSocket Servlet API + *

+ * How to provide WebSocket servers via the Jetty WebSocket Servlet API: + *

    + *
  1. Create your WebSocket Object
    2. + *
  2. Create your WebSocketServlet
    3. + *
  3. Register your WebSocket Object with the WebSocketServletFactory
    4. + *
  4. Wire up your WebSocketServlet to your web.xml or via Servlet 3.x annotations
    5. + *
+ */ +package org.eclipse.jetty.websocket.servlet; +