You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by ma...@apache.org on 2016/04/06 18:45:48 UTC
svn commit: r1738005 - in /tomcat/trunk: java/org/apache/tomcat/websocket/
java/org/apache/tomcat/websocket/server/
test/org/apache/tomcat/websocket/server/
Author: markt
Date: Wed Apr 6 16:45:47 2016
New Revision: 1738005
URL: http://svn.apache.org/viewvc?rev=1738005&view=rev
Log:
Restore correct class loader during processing of WebSocket messages post the 8.5.x/9.0.x connector refactoring
Added:
tomcat/trunk/test/org/apache/tomcat/websocket/server/TestClassLoader.java (with props)
Modified:
tomcat/trunk/java/org/apache/tomcat/websocket/WsFrameBase.java
tomcat/trunk/java/org/apache/tomcat/websocket/server/WsFrameServer.java
tomcat/trunk/java/org/apache/tomcat/websocket/server/WsHttpUpgradeHandler.java
Modified: tomcat/trunk/java/org/apache/tomcat/websocket/WsFrameBase.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/websocket/WsFrameBase.java?rev=1738005&r1=1738004&r2=1738005&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/tomcat/websocket/WsFrameBase.java (original)
+++ tomcat/trunk/java/org/apache/tomcat/websocket/WsFrameBase.java Wed Apr 6 16:45:47 2016
@@ -377,7 +377,7 @@ public abstract class WsFrameBase {
@SuppressWarnings("unchecked")
- private void sendMessageText(boolean last) throws WsIOException {
+ protected void sendMessageText(boolean last) throws WsIOException {
if (textMsgHandler instanceof WrappedMessageHandler) {
long maxMessageSize =
((WrappedMessageHandler) textMsgHandler).getMaxMessageSize();
@@ -572,7 +572,7 @@ public abstract class WsFrameBase {
@SuppressWarnings("unchecked")
- private void sendMessageBinary(ByteBuffer msg, boolean last)
+ protected void sendMessageBinary(ByteBuffer msg, boolean last)
throws WsIOException {
if (binaryMsgHandler instanceof WrappedMessageHandler) {
long maxMessageSize =
Modified: tomcat/trunk/java/org/apache/tomcat/websocket/server/WsFrameServer.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/websocket/server/WsFrameServer.java?rev=1738005&r1=1738004&r2=1738005&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/tomcat/websocket/server/WsFrameServer.java (original)
+++ tomcat/trunk/java/org/apache/tomcat/websocket/server/WsFrameServer.java Wed Apr 6 16:45:47 2016
@@ -17,6 +17,7 @@
package org.apache.tomcat.websocket.server;
import java.io.IOException;
+import java.nio.ByteBuffer;
import org.apache.juli.logging.Log;
import org.apache.juli.logging.LogFactory;
@@ -24,6 +25,7 @@ import org.apache.tomcat.util.net.Socket
import org.apache.tomcat.util.res.StringManager;
import org.apache.tomcat.websocket.Transformation;
import org.apache.tomcat.websocket.WsFrameBase;
+import org.apache.tomcat.websocket.WsIOException;
import org.apache.tomcat.websocket.WsSession;
public class WsFrameServer extends WsFrameBase {
@@ -32,12 +34,14 @@ public class WsFrameServer extends WsFra
private static final StringManager sm = StringManager.getManager(WsFrameServer.class);
private final SocketWrapperBase<?> socketWrapper;
+ private final ClassLoader applicationClassLoader;
public WsFrameServer(SocketWrapperBase<?> socketWrapper, WsSession wsSession,
- Transformation transformation) {
+ Transformation transformation, ClassLoader applicationClassLoader) {
super(wsSession, transformation);
this.socketWrapper = socketWrapper;
+ this.applicationClassLoader = applicationClassLoader;
}
@@ -92,4 +96,28 @@ public class WsFrameServer extends WsFra
protected Log getLog() {
return log;
}
+
+
+ @Override
+ protected void sendMessageText(boolean last) throws WsIOException {
+ ClassLoader cl = Thread.currentThread().getContextClassLoader();
+ try {
+ Thread.currentThread().setContextClassLoader(applicationClassLoader);
+ super.sendMessageText(last);
+ } finally {
+ Thread.currentThread().setContextClassLoader(cl);
+ }
+ }
+
+
+ @Override
+ protected void sendMessageBinary(ByteBuffer msg, boolean last) throws WsIOException {
+ ClassLoader cl = Thread.currentThread().getContextClassLoader();
+ try {
+ Thread.currentThread().setContextClassLoader(applicationClassLoader);
+ super.sendMessageBinary(msg, last);
+ } finally {
+ Thread.currentThread().setContextClassLoader(cl);
+ }
+ }
}
Modified: tomcat/trunk/java/org/apache/tomcat/websocket/server/WsHttpUpgradeHandler.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/websocket/server/WsHttpUpgradeHandler.java?rev=1738005&r1=1738004&r2=1738005&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/tomcat/websocket/server/WsHttpUpgradeHandler.java (original)
+++ tomcat/trunk/java/org/apache/tomcat/websocket/server/WsHttpUpgradeHandler.java Wed Apr 6 16:45:47 2016
@@ -126,7 +126,8 @@ public class WsHttpUpgradeHandler implem
handshakeRequest.getUserPrincipal(), httpSessionId,
negotiatedExtensions, subProtocol, pathParameters, secure,
endpointConfig);
- wsFrame = new WsFrameServer(socketWrapper, wsSession, transformation);
+ wsFrame = new WsFrameServer(socketWrapper, wsSession, transformation,
+ applicationClassLoader);
// WsFrame adds the necessary final transformations. Copy the
// completed transformation chain to the remote end point.
wsRemoteEndpointServer.setTransformation(wsFrame.getTransformation());
Added: tomcat/trunk/test/org/apache/tomcat/websocket/server/TestClassLoader.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/test/org/apache/tomcat/websocket/server/TestClassLoader.java?rev=1738005&view=auto
==============================================================================
--- tomcat/trunk/test/org/apache/tomcat/websocket/server/TestClassLoader.java (added)
+++ tomcat/trunk/test/org/apache/tomcat/websocket/server/TestClassLoader.java Wed Apr 6 16:45:47 2016
@@ -0,0 +1,151 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.tomcat.websocket.server;
+
+import java.io.IOException;
+import java.net.URI;
+import java.util.concurrent.atomic.AtomicInteger;
+
+import javax.websocket.ClientEndpoint;
+import javax.websocket.ContainerProvider;
+import javax.websocket.OnMessage;
+import javax.websocket.OnOpen;
+import javax.websocket.Session;
+import javax.websocket.WebSocketContainer;
+import javax.websocket.server.ServerEndpoint;
+
+import org.junit.Assert;
+import org.junit.Test;
+
+import org.apache.catalina.Context;
+import org.apache.catalina.loader.WebappClassLoaderBase;
+import org.apache.catalina.servlets.DefaultServlet;
+import org.apache.catalina.startup.Tomcat;
+import org.apache.catalina.startup.TomcatBaseTest;
+
+/**
+ * Tests endpoint methods are called with the correct class loader.
+ */
+public class TestClassLoader extends TomcatBaseTest {
+
+ private static final String PASS = "PASS";
+ private static final String FAIL = "FAIL";
+
+
+ /*
+ * Checks class loader for the server endpoint during onOpen and onMessage
+ */
+ @Test
+ public void testSimple() throws Exception {
+ Tomcat tomcat = getTomcatInstance();
+ // No file system docBase required
+ Context ctx = tomcat.addContext("", null);
+ ctx.addApplicationListener(Config.class.getName());
+
+ Tomcat.addServlet(ctx, "default", new DefaultServlet());
+ ctx.addServletMapping("/", "default");
+
+ tomcat.start();
+
+ WebSocketContainer wsContainer = ContainerProvider.getWebSocketContainer();
+
+ Client client = new Client();
+
+ Session wsSession = wsContainer.connectToServer(client,
+ new URI("ws://localhost:" + getPort() + "/test"));
+
+ Assert.assertTrue(wsSession.isOpen());
+
+ // Wait up to 5s for a message
+ int count = 0;
+ while (count < 50 && client.getMsgCount() < 1) {
+ Thread.sleep(100);
+ }
+
+ // Check it
+ Assert.assertEquals(1, client.getMsgCount());
+ Assert.assertFalse(client.hasFailed());
+
+ wsSession.getBasicRemote().sendText("Testing");
+
+ // Wait up to 5s for a message
+ count = 0;
+ while (count < 50 && client.getMsgCount() < 2) {
+ Thread.sleep(100);
+ }
+
+ Assert.assertEquals(2, client.getMsgCount());
+ Assert.assertFalse(client.hasFailed());
+
+ wsSession.close();
+ }
+
+ @ClientEndpoint
+ public static class Client {
+
+ private final AtomicInteger msgCount = new AtomicInteger(0);
+ private boolean failed = false;
+
+ public boolean hasFailed() {
+ return failed;
+ }
+
+ public int getMsgCount() {
+ return msgCount.get();
+ }
+
+ @OnMessage
+ public void onMessage(String msg) {
+ if (!failed && !PASS.equals(msg)) {
+ failed = true;
+ }
+ msgCount.incrementAndGet();
+ }
+ }
+
+
+ @ServerEndpoint("/test")
+ public static class ClassLoaderEndpoint {
+
+ @OnOpen
+ public void onOpen(Session session) throws IOException {
+ if (Thread.currentThread().getContextClassLoader() instanceof WebappClassLoaderBase) {
+ session.getBasicRemote().sendText(PASS);
+ } else {
+ session.getBasicRemote().sendText(FAIL);
+ }
+ }
+
+ @OnMessage
+ public String onMessage(@SuppressWarnings("unused") String msg) {
+ if (Thread.currentThread().getContextClassLoader() instanceof WebappClassLoaderBase) {
+ return PASS;
+ } else {
+ return FAIL;
+ }
+ }
+ }
+
+ public static class Config extends TesterEndpointConfig {
+
+ @Override
+ protected Class<?> getEndpointClass() {
+ return ClassLoaderEndpoint.class;
+ }
+
+ }
+}
Propchange: tomcat/trunk/test/org/apache/tomcat/websocket/server/TestClassLoader.java
------------------------------------------------------------------------------
svn:eol-style = native
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org