init
This commit is contained in:
789
test/org/apache/tomcat/websocket/pojo/TestEncodingDecoding.java
Normal file
789
test/org/apache/tomcat/websocket/pojo/TestEncodingDecoding.java
Normal file
@@ -0,0 +1,789 @@
|
||||
/*
|
||||
* 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.pojo;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.net.URI;
|
||||
import java.nio.ByteBuffer;
|
||||
import java.util.ArrayList;
|
||||
import java.util.Collections;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.Queue;
|
||||
import java.util.concurrent.ConcurrentHashMap;
|
||||
import java.util.concurrent.ConcurrentLinkedQueue;
|
||||
|
||||
import javax.servlet.ServletContextEvent;
|
||||
import javax.websocket.ClientEndpoint;
|
||||
import javax.websocket.ContainerProvider;
|
||||
import javax.websocket.DecodeException;
|
||||
import javax.websocket.Decoder;
|
||||
import javax.websocket.DeploymentException;
|
||||
import javax.websocket.EncodeException;
|
||||
import javax.websocket.Encoder;
|
||||
import javax.websocket.Endpoint;
|
||||
import javax.websocket.EndpointConfig;
|
||||
import javax.websocket.Extension;
|
||||
import javax.websocket.MessageHandler;
|
||||
import javax.websocket.OnError;
|
||||
import javax.websocket.OnMessage;
|
||||
import javax.websocket.Session;
|
||||
import javax.websocket.WebSocketContainer;
|
||||
import javax.websocket.server.ServerContainer;
|
||||
import javax.websocket.server.ServerEndpoint;
|
||||
import javax.websocket.server.ServerEndpointConfig;
|
||||
|
||||
import org.junit.Assert;
|
||||
import org.junit.Ignore;
|
||||
import org.junit.Test;
|
||||
|
||||
import org.apache.catalina.Context;
|
||||
import org.apache.catalina.servlets.DefaultServlet;
|
||||
import org.apache.catalina.startup.Tomcat;
|
||||
import org.apache.catalina.startup.TomcatBaseTest;
|
||||
import org.apache.tomcat.websocket.pojo.TesterUtil.ServerConfigListener;
|
||||
import org.apache.tomcat.websocket.pojo.TesterUtil.SingletonConfigurator;
|
||||
import org.apache.tomcat.websocket.server.WsContextListener;
|
||||
|
||||
public class TestEncodingDecoding extends TomcatBaseTest {
|
||||
|
||||
private static final String MESSAGE_ONE = "message-one";
|
||||
private static final String MESSAGE_TWO = "message-two";
|
||||
private static final String PATH_PROGRAMMATIC_EP = "/echoProgrammaticEP";
|
||||
private static final String PATH_ANNOTATED_EP = "/echoAnnotatedEP";
|
||||
private static final String PATH_GENERICS_EP = "/echoGenericsEP";
|
||||
private static final String PATH_MESSAGES_EP = "/echoMessagesEP";
|
||||
private static final String PATH_BATCHED_EP = "/echoBatchedEP";
|
||||
|
||||
|
||||
@Test
|
||||
public void testProgrammaticEndPoints() throws Exception{
|
||||
Tomcat tomcat = getTomcatInstance();
|
||||
// No file system docBase required
|
||||
Context ctx = tomcat.addContext("", null);
|
||||
ctx.addApplicationListener(ProgramaticServerEndpointConfig.class.getName());
|
||||
Tomcat.addServlet(ctx, "default", new DefaultServlet());
|
||||
ctx.addServletMappingDecoded("/", "default");
|
||||
|
||||
WebSocketContainer wsContainer = ContainerProvider.getWebSocketContainer();
|
||||
|
||||
tomcat.start();
|
||||
|
||||
Client client = new Client();
|
||||
URI uri = new URI("ws://localhost:" + getPort() + PATH_PROGRAMMATIC_EP);
|
||||
Session session = wsContainer.connectToServer(client, uri);
|
||||
|
||||
MsgString msg1 = new MsgString();
|
||||
msg1.setData(MESSAGE_ONE);
|
||||
session.getBasicRemote().sendObject(msg1);
|
||||
// Should not take very long
|
||||
int i = 0;
|
||||
while (i < 20) {
|
||||
if (MsgStringMessageHandler.received.size() > 0 &&
|
||||
client.received.size() > 0) {
|
||||
break;
|
||||
}
|
||||
i++;
|
||||
Thread.sleep(100);
|
||||
}
|
||||
|
||||
// Check messages were received
|
||||
Assert.assertEquals(1, MsgStringMessageHandler.received.size());
|
||||
Assert.assertEquals(1, client.received.size());
|
||||
|
||||
// Check correct messages were received
|
||||
Assert.assertEquals(MESSAGE_ONE,
|
||||
((MsgString) MsgStringMessageHandler.received.peek()).getData());
|
||||
Assert.assertEquals(MESSAGE_ONE,
|
||||
new String(((MsgByte) client.received.peek()).getData()));
|
||||
session.close();
|
||||
}
|
||||
|
||||
|
||||
@Test
|
||||
public void testAnnotatedEndPoints() throws Exception {
|
||||
// Set up utility classes
|
||||
Server server = new Server();
|
||||
SingletonConfigurator.setInstance(server);
|
||||
ServerConfigListener.setPojoClazz(Server.class);
|
||||
|
||||
Tomcat tomcat = getTomcatInstance();
|
||||
// No file system docBase required
|
||||
Context ctx = tomcat.addContext("", null);
|
||||
ctx.addApplicationListener(ServerConfigListener.class.getName());
|
||||
Tomcat.addServlet(ctx, "default", new DefaultServlet());
|
||||
ctx.addServletMappingDecoded("/", "default");
|
||||
|
||||
WebSocketContainer wsContainer =
|
||||
ContainerProvider.getWebSocketContainer();
|
||||
|
||||
tomcat.start();
|
||||
|
||||
Client client = new Client();
|
||||
URI uri = new URI("ws://localhost:" + getPort() + PATH_ANNOTATED_EP);
|
||||
Session session = wsContainer.connectToServer(client, uri);
|
||||
|
||||
MsgString msg1 = new MsgString();
|
||||
msg1.setData(MESSAGE_ONE);
|
||||
session.getBasicRemote().sendObject(msg1);
|
||||
|
||||
// Should not take very long
|
||||
int i = 0;
|
||||
while (i < 20) {
|
||||
if (server.received.size() > 0 && client.received.size() > 0) {
|
||||
break;
|
||||
}
|
||||
i++;
|
||||
Thread.sleep(100);
|
||||
}
|
||||
|
||||
// Check messages were received
|
||||
Assert.assertEquals(1, server.received.size());
|
||||
Assert.assertEquals(1, client.received.size());
|
||||
|
||||
// Check correct messages were received
|
||||
Assert.assertEquals(MESSAGE_ONE,
|
||||
((MsgString) server.received.peek()).getData());
|
||||
Assert.assertEquals(MESSAGE_ONE,
|
||||
((MsgString) client.received.peek()).getData());
|
||||
session.close();
|
||||
|
||||
// Should not take very long but some failures have been seen
|
||||
i = testEvent(MsgStringEncoder.class.getName()+":init", 0);
|
||||
i = testEvent(MsgStringDecoder.class.getName()+":init", i);
|
||||
i = testEvent(MsgByteEncoder.class.getName()+":init", i);
|
||||
i = testEvent(MsgByteDecoder.class.getName()+":init", i);
|
||||
i = testEvent(MsgStringEncoder.class.getName()+":destroy", i);
|
||||
i = testEvent(MsgStringDecoder.class.getName()+":destroy", i);
|
||||
i = testEvent(MsgByteEncoder.class.getName()+":destroy", i);
|
||||
i = testEvent(MsgByteDecoder.class.getName()+":destroy", i);
|
||||
}
|
||||
|
||||
|
||||
@Test
|
||||
public void testGenericsCoders() throws Exception {
|
||||
// Set up utility classes
|
||||
GenericsServer server = new GenericsServer();
|
||||
SingletonConfigurator.setInstance(server);
|
||||
ServerConfigListener.setPojoClazz(GenericsServer.class);
|
||||
|
||||
Tomcat tomcat = getTomcatInstance();
|
||||
// No file system docBase required
|
||||
Context ctx = tomcat.addContext("", null);
|
||||
ctx.addApplicationListener(ServerConfigListener.class.getName());
|
||||
Tomcat.addServlet(ctx, "default", new DefaultServlet());
|
||||
ctx.addServletMappingDecoded("/", "default");
|
||||
|
||||
WebSocketContainer wsContainer =
|
||||
ContainerProvider.getWebSocketContainer();
|
||||
|
||||
tomcat.start();
|
||||
|
||||
GenericsClient client = new GenericsClient();
|
||||
URI uri = new URI("ws://localhost:" + getPort() + PATH_GENERICS_EP);
|
||||
Session session = wsContainer.connectToServer(client, uri);
|
||||
|
||||
ArrayList<String> list = new ArrayList<>(2);
|
||||
list.add("str1");
|
||||
list.add("str2");
|
||||
session.getBasicRemote().sendObject(list);
|
||||
|
||||
// Should not take very long
|
||||
int i = 0;
|
||||
while (i < 20) {
|
||||
if (server.received.size() > 0 && client.received.size() > 0) {
|
||||
break;
|
||||
}
|
||||
i++;
|
||||
Thread.sleep(100);
|
||||
}
|
||||
|
||||
// Check messages were received
|
||||
Assert.assertEquals(1, server.received.size());
|
||||
Assert.assertEquals(server.received.peek().toString(), "[str1, str2]");
|
||||
|
||||
Assert.assertEquals(1, client.received.size());
|
||||
Assert.assertEquals(client.received.peek().toString(), "[str1, str2]");
|
||||
|
||||
session.close();
|
||||
}
|
||||
|
||||
@Test
|
||||
@Ignore // TODO Investigate why this test fails
|
||||
public void testMessagesEndPoints() throws Exception {
|
||||
// Set up utility classes
|
||||
MessagesServer server = new MessagesServer();
|
||||
SingletonConfigurator.setInstance(server);
|
||||
ServerConfigListener.setPojoClazz(MessagesServer.class);
|
||||
|
||||
Tomcat tomcat = getTomcatInstance();
|
||||
// No file system docBase required
|
||||
Context ctx = tomcat.addContext("", null);
|
||||
ctx.addApplicationListener(ServerConfigListener.class.getName());
|
||||
Tomcat.addServlet(ctx, "default", new DefaultServlet());
|
||||
ctx.addServletMappingDecoded("/", "default");
|
||||
|
||||
WebSocketContainer wsContainer =
|
||||
ContainerProvider.getWebSocketContainer();
|
||||
|
||||
tomcat.start();
|
||||
|
||||
StringClient client = new StringClient();
|
||||
URI uri = new URI("ws://localhost:" + getPort() + PATH_MESSAGES_EP);
|
||||
Session session = wsContainer.connectToServer(client, uri);
|
||||
|
||||
session.getBasicRemote().sendText(MESSAGE_ONE);
|
||||
|
||||
// Should not take very long
|
||||
int i = 0;
|
||||
while (i < 20) {
|
||||
if (server.received.size() > 0 && client.received.size() > 0) {
|
||||
break;
|
||||
}
|
||||
i++;
|
||||
Thread.sleep(100);
|
||||
}
|
||||
|
||||
// Check messages were received
|
||||
Assert.assertEquals(1, server.received.size());
|
||||
Assert.assertEquals(1, client.received.size());
|
||||
|
||||
// Check correct messages were received
|
||||
Assert.assertEquals(MESSAGE_ONE, server.received.peek());
|
||||
session.close();
|
||||
|
||||
Assert.assertNull(server.t);
|
||||
}
|
||||
|
||||
|
||||
@Test
|
||||
@Ignore // TODO Investigate why this test fails
|
||||
public void testBatchedEndPoints() throws Exception {
|
||||
// Set up utility classes
|
||||
BatchedServer server = new BatchedServer();
|
||||
SingletonConfigurator.setInstance(server);
|
||||
ServerConfigListener.setPojoClazz(BatchedServer.class);
|
||||
|
||||
Tomcat tomcat = getTomcatInstance();
|
||||
// No file system docBase required
|
||||
Context ctx = tomcat.addContext("", null);
|
||||
ctx.addApplicationListener(ServerConfigListener.class.getName());
|
||||
Tomcat.addServlet(ctx, "default", new DefaultServlet());
|
||||
ctx.addServletMappingDecoded("/", "default");
|
||||
|
||||
WebSocketContainer wsContainer =
|
||||
ContainerProvider.getWebSocketContainer();
|
||||
|
||||
tomcat.start();
|
||||
|
||||
StringClient client = new StringClient();
|
||||
URI uri = new URI("ws://localhost:" + getPort() + PATH_BATCHED_EP);
|
||||
Session session = wsContainer.connectToServer(client, uri);
|
||||
|
||||
session.getBasicRemote().sendText(MESSAGE_ONE);
|
||||
|
||||
// Should not take very long
|
||||
int i = 0;
|
||||
while (i++ < 20) {
|
||||
if (server.received.size() > 0 && client.received.size() > 0) {
|
||||
break;
|
||||
}
|
||||
i++;
|
||||
Thread.sleep(100);
|
||||
}
|
||||
|
||||
// Check messages were received
|
||||
Assert.assertEquals(1, server.received.size());
|
||||
Assert.assertEquals(2, client.received.size());
|
||||
|
||||
// Check correct messages were received
|
||||
Assert.assertEquals(MESSAGE_ONE, server.received.peek());
|
||||
session.close();
|
||||
|
||||
Assert.assertNull(server.t);
|
||||
}
|
||||
|
||||
|
||||
private int testEvent(String name, int count) throws InterruptedException {
|
||||
int i = count;
|
||||
while (i < 50) {
|
||||
if (Server.isLifeCycleEventCalled(name)) {
|
||||
break;
|
||||
}
|
||||
i++;
|
||||
Thread.sleep(100);
|
||||
}
|
||||
Assert.assertTrue(Server.isLifeCycleEventCalled(name));
|
||||
return i;
|
||||
}
|
||||
|
||||
|
||||
@ClientEndpoint(decoders=ListStringDecoder.class, encoders=ListStringEncoder.class)
|
||||
public static class GenericsClient {
|
||||
private Queue<Object> received = new ConcurrentLinkedQueue<>();
|
||||
|
||||
@OnMessage
|
||||
public void rx(List<String> in) {
|
||||
received.add(in);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@ClientEndpoint(decoders={MsgStringDecoder.class, MsgByteDecoder.class},
|
||||
encoders={MsgStringEncoder.class, MsgByteEncoder.class})
|
||||
public static class Client {
|
||||
|
||||
private Queue<Object> received = new ConcurrentLinkedQueue<>();
|
||||
|
||||
@OnMessage
|
||||
public void rx(MsgString in) {
|
||||
received.add(in);
|
||||
}
|
||||
|
||||
@OnMessage
|
||||
public void rx(MsgByte in) {
|
||||
received.add(in);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@ClientEndpoint
|
||||
public static class StringClient {
|
||||
|
||||
private Queue<Object> received = new ConcurrentLinkedQueue<>();
|
||||
|
||||
@OnMessage
|
||||
public void rx(String in) {
|
||||
received.add(in);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
|
||||
@ServerEndpoint(value=PATH_GENERICS_EP,
|
||||
decoders=ListStringDecoder.class,
|
||||
encoders=ListStringEncoder.class,
|
||||
configurator=SingletonConfigurator.class)
|
||||
public static class GenericsServer {
|
||||
|
||||
private Queue<Object> received = new ConcurrentLinkedQueue<>();
|
||||
|
||||
|
||||
@OnMessage
|
||||
public List<String> rx(List<String> in) {
|
||||
received.add(in);
|
||||
// Echo the message back
|
||||
return in;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@ServerEndpoint(value=PATH_MESSAGES_EP,
|
||||
configurator=SingletonConfigurator.class)
|
||||
public static class MessagesServer {
|
||||
|
||||
private final Queue<String> received = new ConcurrentLinkedQueue<>();
|
||||
private volatile Throwable t = null;
|
||||
|
||||
@OnMessage
|
||||
public String onMessage(String message, Session session) {
|
||||
received.add(message);
|
||||
session.getAsyncRemote().sendText(MESSAGE_ONE);
|
||||
return message;
|
||||
}
|
||||
|
||||
@OnError
|
||||
public void onError(@SuppressWarnings("unused") Session session, Throwable t) {
|
||||
t.printStackTrace();
|
||||
this.t = t;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@ServerEndpoint(value=PATH_BATCHED_EP,
|
||||
configurator=SingletonConfigurator.class)
|
||||
public static class BatchedServer {
|
||||
|
||||
private final Queue<String> received = new ConcurrentLinkedQueue<>();
|
||||
private volatile Throwable t = null;
|
||||
|
||||
@OnMessage
|
||||
public String onMessage(String message, Session session) throws IOException {
|
||||
received.add(message);
|
||||
session.getAsyncRemote().setBatchingAllowed(true);
|
||||
session.getAsyncRemote().sendText(MESSAGE_ONE);
|
||||
return MESSAGE_TWO;
|
||||
}
|
||||
|
||||
@OnError
|
||||
public void onError(@SuppressWarnings("unused") Session session, Throwable t) {
|
||||
t.printStackTrace();
|
||||
this.t = t;
|
||||
}
|
||||
}
|
||||
|
||||
@ServerEndpoint(value=PATH_ANNOTATED_EP,
|
||||
decoders={MsgStringDecoder.class, MsgByteDecoder.class},
|
||||
encoders={MsgStringEncoder.class, MsgByteEncoder.class},
|
||||
configurator=SingletonConfigurator.class)
|
||||
public static class Server {
|
||||
|
||||
private Queue<Object> received = new ConcurrentLinkedQueue<>();
|
||||
static Map<String, Boolean> lifeCyclesCalled = new ConcurrentHashMap<>(8);
|
||||
|
||||
@OnMessage
|
||||
public MsgString rx(MsgString in) {
|
||||
received.add(in);
|
||||
// Echo the message back
|
||||
return in;
|
||||
}
|
||||
|
||||
@OnMessage
|
||||
public MsgByte rx(MsgByte in) {
|
||||
received.add(in);
|
||||
// Echo the message back
|
||||
return in;
|
||||
}
|
||||
|
||||
public static void addLifeCycleEvent(String event){
|
||||
lifeCyclesCalled.put(event, Boolean.TRUE);
|
||||
}
|
||||
|
||||
public static boolean isLifeCycleEventCalled(String event){
|
||||
Boolean called = lifeCyclesCalled.get(event);
|
||||
return called == null ? false : called.booleanValue();
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
public static class MsgByteMessageHandler implements
|
||||
MessageHandler.Whole<MsgByte> {
|
||||
|
||||
public static final Queue<Object> received = new ConcurrentLinkedQueue<>();
|
||||
private final Session session;
|
||||
|
||||
public MsgByteMessageHandler(Session session) {
|
||||
this.session = session;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void onMessage(MsgByte in) {
|
||||
System.out.println(getClass() + " received");
|
||||
received.add(in);
|
||||
try {
|
||||
MsgByte msg = new MsgByte();
|
||||
msg.setData("got it".getBytes());
|
||||
session.getBasicRemote().sendObject(msg);
|
||||
} catch (IOException | EncodeException e) {
|
||||
throw new IllegalStateException(e);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
public static class MsgStringMessageHandler implements MessageHandler.Whole<MsgString> {
|
||||
|
||||
public static final Queue<Object> received = new ConcurrentLinkedQueue<>();
|
||||
private final Session session;
|
||||
|
||||
public MsgStringMessageHandler(Session session) {
|
||||
this.session = session;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void onMessage(MsgString in) {
|
||||
received.add(in);
|
||||
try {
|
||||
MsgByte msg = new MsgByte();
|
||||
msg.setData(MESSAGE_ONE.getBytes());
|
||||
session.getBasicRemote().sendObject(msg);
|
||||
} catch (IOException | EncodeException e) {
|
||||
e.printStackTrace();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
public static class ProgrammaticEndpoint extends Endpoint {
|
||||
@Override
|
||||
public void onOpen(Session session, EndpointConfig config) {
|
||||
session.addMessageHandler(new MsgStringMessageHandler(session));
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
public static class MsgString {
|
||||
private String data;
|
||||
public String getData() { return data; }
|
||||
public void setData(String data) { this.data = data; }
|
||||
}
|
||||
|
||||
|
||||
public static class MsgStringEncoder implements Encoder.Text<MsgString> {
|
||||
|
||||
@Override
|
||||
public void init(EndpointConfig endpointConfig) {
|
||||
Server.addLifeCycleEvent(getClass().getName() + ":init");
|
||||
}
|
||||
|
||||
@Override
|
||||
public void destroy() {
|
||||
Server.addLifeCycleEvent(getClass().getName() + ":destroy");
|
||||
}
|
||||
|
||||
@Override
|
||||
public String encode(MsgString msg) throws EncodeException {
|
||||
return "MsgString:" + msg.getData();
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
public static class MsgStringDecoder implements Decoder.Text<MsgString> {
|
||||
|
||||
@Override
|
||||
public void init(EndpointConfig endpointConfig) {
|
||||
Server.addLifeCycleEvent(getClass().getName() + ":init");
|
||||
}
|
||||
|
||||
@Override
|
||||
public void destroy() {
|
||||
Server.addLifeCycleEvent(getClass().getName() + ":destroy");
|
||||
}
|
||||
|
||||
@Override
|
||||
public MsgString decode(String s) throws DecodeException {
|
||||
MsgString result = new MsgString();
|
||||
result.setData(s.substring(10));
|
||||
return result;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean willDecode(String s) {
|
||||
return s.startsWith("MsgString:");
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
public static class MsgByte {
|
||||
private byte[] data;
|
||||
public byte[] getData() { return data; }
|
||||
public void setData(byte[] data) { this.data = data; }
|
||||
}
|
||||
|
||||
|
||||
public static class MsgByteEncoder implements Encoder.Binary<MsgByte> {
|
||||
|
||||
@Override
|
||||
public void init(EndpointConfig endpointConfig) {
|
||||
Server.addLifeCycleEvent(getClass().getName() + ":init");
|
||||
}
|
||||
|
||||
@Override
|
||||
public void destroy() {
|
||||
Server.addLifeCycleEvent(getClass().getName() + ":destroy");
|
||||
}
|
||||
|
||||
@Override
|
||||
public ByteBuffer encode(MsgByte msg) throws EncodeException {
|
||||
byte[] data = msg.getData();
|
||||
ByteBuffer reply = ByteBuffer.allocate(2 + data.length);
|
||||
reply.put((byte) 0x12);
|
||||
reply.put((byte) 0x34);
|
||||
reply.put(data);
|
||||
reply.flip();
|
||||
return reply;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
public static class MsgByteDecoder implements Decoder.Binary<MsgByte> {
|
||||
|
||||
@Override
|
||||
public void init(EndpointConfig endpointConfig) {
|
||||
Server.addLifeCycleEvent(getClass().getName() + ":init");
|
||||
}
|
||||
|
||||
@Override
|
||||
public void destroy() {
|
||||
Server.addLifeCycleEvent(getClass().getName() + ":destroy");
|
||||
}
|
||||
|
||||
@Override
|
||||
public MsgByte decode(ByteBuffer bb) throws DecodeException {
|
||||
MsgByte result = new MsgByte();
|
||||
byte[] data = new byte[bb.limit() - bb.position()];
|
||||
bb.get(data);
|
||||
result.setData(data);
|
||||
return result;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean willDecode(ByteBuffer bb) {
|
||||
bb.mark();
|
||||
if (bb.get() == 0x12 && bb.get() == 0x34) {
|
||||
return true;
|
||||
}
|
||||
bb.reset();
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
public static class ListStringEncoder implements Encoder.Text<List<String>> {
|
||||
|
||||
@Override
|
||||
public void init(EndpointConfig endpointConfig) {
|
||||
Server.addLifeCycleEvent(getClass().getName() + ":init");
|
||||
}
|
||||
|
||||
@Override
|
||||
public void destroy() {
|
||||
Server.addLifeCycleEvent(getClass().getName() + ":destroy");
|
||||
}
|
||||
|
||||
@Override
|
||||
public String encode(List<String> str) throws EncodeException {
|
||||
StringBuffer sbuf = new StringBuffer();
|
||||
sbuf.append("[");
|
||||
for (String s: str){
|
||||
sbuf.append(s).append(",");
|
||||
}
|
||||
sbuf.deleteCharAt(sbuf.lastIndexOf(",")).append("]");
|
||||
return sbuf.toString();
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
public static class ListStringDecoder implements Decoder.Text<List<String>> {
|
||||
|
||||
@Override
|
||||
public void init(EndpointConfig endpointConfig) {
|
||||
Server.addLifeCycleEvent(getClass().getName() + ":init");
|
||||
}
|
||||
|
||||
@Override
|
||||
public void destroy() {
|
||||
Server.addLifeCycleEvent(getClass().getName() + ":destroy");
|
||||
}
|
||||
|
||||
@Override
|
||||
public List<String> decode(String str) throws DecodeException {
|
||||
List<String> lst = new ArrayList<>(1);
|
||||
str = str.substring(1,str.length()-1);
|
||||
String[] strings = str.split(",");
|
||||
for (String t : strings){
|
||||
lst.add(t);
|
||||
}
|
||||
return lst;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean willDecode(String str) {
|
||||
return str.startsWith("[") && str.endsWith("]");
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
public static class ProgramaticServerEndpointConfig extends WsContextListener {
|
||||
|
||||
@Override
|
||||
public void contextInitialized(ServletContextEvent sce) {
|
||||
super.contextInitialized(sce);
|
||||
ServerContainer sc =
|
||||
(ServerContainer) sce.getServletContext().getAttribute(
|
||||
org.apache.tomcat.websocket.server.Constants.
|
||||
SERVER_CONTAINER_SERVLET_CONTEXT_ATTRIBUTE);
|
||||
try {
|
||||
sc.addEndpoint(new ServerEndpointConfig() {
|
||||
@Override
|
||||
public Map<String, Object> getUserProperties() {
|
||||
return Collections.emptyMap();
|
||||
}
|
||||
@Override
|
||||
public List<Class<? extends Encoder>> getEncoders() {
|
||||
List<Class<? extends Encoder>> encoders = new ArrayList<>(2);
|
||||
encoders.add(MsgStringEncoder.class);
|
||||
encoders.add(MsgByteEncoder.class);
|
||||
return encoders;
|
||||
}
|
||||
@Override
|
||||
public List<Class<? extends Decoder>> getDecoders() {
|
||||
List<Class<? extends Decoder>> decoders = new ArrayList<>(2);
|
||||
decoders.add(MsgStringDecoder.class);
|
||||
decoders.add(MsgByteDecoder.class);
|
||||
return decoders;
|
||||
}
|
||||
@Override
|
||||
public List<String> getSubprotocols() {
|
||||
return Collections.emptyList();
|
||||
}
|
||||
@Override
|
||||
public String getPath() {
|
||||
return PATH_PROGRAMMATIC_EP;
|
||||
}
|
||||
@Override
|
||||
public List<Extension> getExtensions() {
|
||||
return Collections.emptyList();
|
||||
}
|
||||
@Override
|
||||
public Class<?> getEndpointClass() {
|
||||
return ProgrammaticEndpoint.class;
|
||||
}
|
||||
@Override
|
||||
public Configurator getConfigurator() {
|
||||
return new ServerEndpointConfig.Configurator() {
|
||||
};
|
||||
}
|
||||
});
|
||||
} catch (DeploymentException e) {
|
||||
throw new IllegalStateException(e);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@Test
|
||||
public void testUnsupportedObject() throws Exception{
|
||||
Tomcat tomcat = getTomcatInstance();
|
||||
// No file system docBase required
|
||||
Context ctx = tomcat.addContext("", null);
|
||||
ctx.addApplicationListener(ProgramaticServerEndpointConfig.class.getName());
|
||||
Tomcat.addServlet(ctx, "default", new DefaultServlet());
|
||||
ctx.addServletMappingDecoded("/", "default");
|
||||
|
||||
WebSocketContainer wsContainer = ContainerProvider.getWebSocketContainer();
|
||||
|
||||
tomcat.start();
|
||||
|
||||
Client client = new Client();
|
||||
URI uri = new URI("ws://localhost:" + getPort() + PATH_PROGRAMMATIC_EP);
|
||||
Session session = wsContainer.connectToServer(client, uri);
|
||||
|
||||
// This should fail
|
||||
Object msg1 = new Object();
|
||||
try {
|
||||
session.getBasicRemote().sendObject(msg1);
|
||||
Assert.fail("No exception thrown ");
|
||||
} catch (EncodeException e) {
|
||||
// Expected
|
||||
} catch (Throwable t) {
|
||||
Assert.fail("Wrong exception type");
|
||||
} finally {
|
||||
session.close();
|
||||
}
|
||||
}
|
||||
}
|
||||
150
test/org/apache/tomcat/websocket/pojo/TestPojoEndpointBase.java
Normal file
150
test/org/apache/tomcat/websocket/pojo/TestPojoEndpointBase.java
Normal file
@@ -0,0 +1,150 @@
|
||||
/*
|
||||
* 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.pojo;
|
||||
|
||||
import java.net.URI;
|
||||
import java.util.concurrent.CountDownLatch;
|
||||
import java.util.concurrent.TimeUnit;
|
||||
|
||||
import javax.websocket.ClientEndpoint;
|
||||
import javax.websocket.ContainerProvider;
|
||||
import javax.websocket.EndpointConfig;
|
||||
import javax.websocket.OnClose;
|
||||
import javax.websocket.OnError;
|
||||
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.servlets.DefaultServlet;
|
||||
import org.apache.catalina.startup.Tomcat;
|
||||
import org.apache.catalina.startup.TomcatBaseTest;
|
||||
import org.apache.tomcat.websocket.TestUtil;
|
||||
import org.apache.tomcat.websocket.pojo.TesterUtil.ServerConfigListener;
|
||||
import org.apache.tomcat.websocket.pojo.TesterUtil.SingletonConfigurator;
|
||||
|
||||
public class TestPojoEndpointBase extends TomcatBaseTest {
|
||||
|
||||
@Test
|
||||
public void testBug54716() throws Exception {
|
||||
TestUtil.generateMask();
|
||||
// Set up utility classes
|
||||
Bug54716 server = new Bug54716();
|
||||
SingletonConfigurator.setInstance(server);
|
||||
ServerConfigListener.setPojoClazz(Bug54716.class);
|
||||
|
||||
Tomcat tomcat = getTomcatInstance();
|
||||
// No file system docBase required
|
||||
Context ctx = tomcat.addContext("", null);
|
||||
ctx.addApplicationListener(ServerConfigListener.class.getName());
|
||||
Tomcat.addServlet(ctx, "default", new DefaultServlet());
|
||||
ctx.addServletMappingDecoded("/", "default");
|
||||
|
||||
WebSocketContainer wsContainer =
|
||||
ContainerProvider.getWebSocketContainer();
|
||||
|
||||
|
||||
tomcat.start();
|
||||
|
||||
Client client = new Client();
|
||||
URI uri = new URI("ws://localhost:" + getPort() + "/");
|
||||
|
||||
wsContainer.connectToServer(client, uri);
|
||||
|
||||
// Server should close the connection after the exception on open.
|
||||
boolean closed = client.waitForClose(5);
|
||||
Assert.assertTrue("Server failed to close connection", closed);
|
||||
}
|
||||
|
||||
|
||||
@Test
|
||||
public void testOnOpenPojoMethod() throws Exception {
|
||||
// Set up utility classes
|
||||
OnOpenServerEndpoint server = new OnOpenServerEndpoint();
|
||||
SingletonConfigurator.setInstance(server);
|
||||
ServerConfigListener.setPojoClazz(OnOpenServerEndpoint.class);
|
||||
|
||||
Tomcat tomcat = getTomcatInstance();
|
||||
// No file system docBase required
|
||||
Context ctx = tomcat.addContext("", null);
|
||||
ctx.addApplicationListener(ServerConfigListener.class.getName());
|
||||
Tomcat.addServlet(ctx, "default", new DefaultServlet());
|
||||
ctx.addServletMappingDecoded("/", "default");
|
||||
|
||||
WebSocketContainer wsContainer =
|
||||
ContainerProvider.getWebSocketContainer();
|
||||
|
||||
|
||||
tomcat.start();
|
||||
|
||||
Client client = new Client();
|
||||
URI uri = new URI("ws://localhost:" + getPort() + "/");
|
||||
|
||||
Session session = wsContainer.connectToServer(client, uri);
|
||||
|
||||
client.waitForClose(5);
|
||||
Assert.assertTrue(session.isOpen());
|
||||
}
|
||||
|
||||
|
||||
@ServerEndpoint("/")
|
||||
public static class OnOpenServerEndpoint {
|
||||
|
||||
@OnOpen
|
||||
public void onOpen(@SuppressWarnings("unused") Session session,
|
||||
EndpointConfig config) {
|
||||
if (config == null) {
|
||||
throw new RuntimeException();
|
||||
}
|
||||
}
|
||||
|
||||
@OnError
|
||||
public void onError(@SuppressWarnings("unused") Throwable t){
|
||||
throw new RuntimeException();
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@ServerEndpoint("/")
|
||||
public static class Bug54716 {
|
||||
|
||||
@OnOpen
|
||||
public void onOpen() {
|
||||
throw new RuntimeException();
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@ClientEndpoint
|
||||
public static final class Client {
|
||||
|
||||
private final CountDownLatch closeLatch = new CountDownLatch(1);
|
||||
|
||||
@OnClose
|
||||
public void onClose() {
|
||||
closeLatch.countDown();
|
||||
}
|
||||
|
||||
public boolean waitForClose(int seconds) throws InterruptedException {
|
||||
return closeLatch.await(seconds, TimeUnit.SECONDS);
|
||||
}
|
||||
}
|
||||
}
|
||||
149
test/org/apache/tomcat/websocket/pojo/TestPojoMethodMapping.java
Normal file
149
test/org/apache/tomcat/websocket/pojo/TestPojoMethodMapping.java
Normal file
@@ -0,0 +1,149 @@
|
||||
/*
|
||||
* 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.pojo;
|
||||
|
||||
import java.net.URI;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
import javax.websocket.ContainerProvider;
|
||||
import javax.websocket.OnClose;
|
||||
import javax.websocket.OnMessage;
|
||||
import javax.websocket.OnOpen;
|
||||
import javax.websocket.Session;
|
||||
import javax.websocket.WebSocketContainer;
|
||||
import javax.websocket.server.PathParam;
|
||||
import javax.websocket.server.ServerEndpoint;
|
||||
|
||||
import org.junit.Assert;
|
||||
import org.junit.Test;
|
||||
|
||||
import org.apache.catalina.Context;
|
||||
import org.apache.catalina.servlets.DefaultServlet;
|
||||
import org.apache.catalina.startup.Tomcat;
|
||||
import org.apache.catalina.startup.TomcatBaseTest;
|
||||
import org.apache.tomcat.websocket.pojo.TesterUtil.ServerConfigListener;
|
||||
import org.apache.tomcat.websocket.pojo.TesterUtil.SimpleClient;
|
||||
import org.apache.tomcat.websocket.pojo.TesterUtil.SingletonConfigurator;
|
||||
|
||||
public class TestPojoMethodMapping extends TomcatBaseTest {
|
||||
|
||||
private static final String PARAM_ONE = "abcde";
|
||||
private static final String PARAM_TWO = "12345";
|
||||
private static final String PARAM_THREE = "true";
|
||||
|
||||
@Test
|
||||
public void test() throws Exception {
|
||||
|
||||
// Set up utility classes
|
||||
Server server = new Server();
|
||||
SingletonConfigurator.setInstance(server);
|
||||
ServerConfigListener.setPojoClazz(Server.class);
|
||||
|
||||
Tomcat tomcat = getTomcatInstance();
|
||||
// No file system docBase required
|
||||
Context ctx = tomcat.addContext("", null);
|
||||
ctx.addApplicationListener(ServerConfigListener.class.getName());
|
||||
Tomcat.addServlet(ctx, "default", new DefaultServlet());
|
||||
ctx.addServletMappingDecoded("/", "default");
|
||||
|
||||
WebSocketContainer wsContainer =
|
||||
ContainerProvider.getWebSocketContainer();
|
||||
|
||||
|
||||
tomcat.start();
|
||||
|
||||
SimpleClient client = new SimpleClient();
|
||||
URI uri = new URI("ws://localhost:" + getPort() + "/" + PARAM_ONE +
|
||||
"/" + PARAM_TWO + "/" + PARAM_THREE);
|
||||
|
||||
Session session = wsContainer.connectToServer(client, uri);
|
||||
session.getBasicRemote().sendText("NO-OP");
|
||||
session.close();
|
||||
|
||||
// Give server 20s to close. 5s should be plenty but the Gump VM is slow
|
||||
int count = 0;
|
||||
while (count < 200) {
|
||||
if (server.isClosed()) {
|
||||
break;
|
||||
}
|
||||
count++;
|
||||
Thread.sleep(100);
|
||||
}
|
||||
if (count == 50) {
|
||||
Assert.fail("Server did not process an onClose event within 5 " +
|
||||
"seconds of the client sending a close message");
|
||||
}
|
||||
|
||||
// Check no errors
|
||||
List<String> errors = server.getErrors();
|
||||
for (String error : errors) {
|
||||
System.err.println(error);
|
||||
}
|
||||
Assert.assertEquals("Found errors", 0, errors.size());
|
||||
}
|
||||
|
||||
|
||||
@ServerEndpoint(value="/{one}/{two}/{three}",
|
||||
configurator=SingletonConfigurator.class)
|
||||
public static final class Server {
|
||||
|
||||
private final List<String> errors = new ArrayList<>();
|
||||
private volatile boolean closed;
|
||||
|
||||
@OnOpen
|
||||
public void onOpen(@PathParam("one") String p1, @PathParam("two")int p2,
|
||||
@PathParam("three")boolean p3) {
|
||||
checkParams("onOpen", p1, p2, p3);
|
||||
}
|
||||
|
||||
@OnMessage
|
||||
public void onMessage(@SuppressWarnings("unused") String msg,
|
||||
@PathParam("one") String p1, @PathParam("two")int p2,
|
||||
@PathParam("three")boolean p3) {
|
||||
checkParams("onMessage", p1, p2, p3);
|
||||
}
|
||||
|
||||
@OnClose
|
||||
public void onClose(@PathParam("one") String p1,
|
||||
@PathParam("two")int p2, @PathParam("three")boolean p3) {
|
||||
checkParams("onClose", p1, p2, p3);
|
||||
closed = true;
|
||||
}
|
||||
|
||||
public List<String> getErrors() {
|
||||
return errors;
|
||||
}
|
||||
|
||||
public boolean isClosed() {
|
||||
return closed;
|
||||
}
|
||||
|
||||
private void checkParams(String method, String p1, int p2, boolean p3) {
|
||||
checkParam(method, PARAM_ONE, p1);
|
||||
checkParam(method, PARAM_TWO, Integer.toString(p2));
|
||||
checkParam(method, PARAM_THREE, Boolean.toString(p3));
|
||||
}
|
||||
|
||||
private void checkParam(String method, String expected, String actual) {
|
||||
if (!expected.equals(actual)) {
|
||||
errors.add("Method [" + method + "]. Expected [" + expected +
|
||||
"] was + [" + actual + "]");
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
63
test/org/apache/tomcat/websocket/pojo/TesterUtil.java
Normal file
63
test/org/apache/tomcat/websocket/pojo/TesterUtil.java
Normal file
@@ -0,0 +1,63 @@
|
||||
/*
|
||||
* 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.pojo;
|
||||
|
||||
import javax.websocket.ClientEndpoint;
|
||||
import javax.websocket.server.ServerEndpointConfig.Configurator;
|
||||
|
||||
import org.apache.tomcat.websocket.server.TesterEndpointConfig;
|
||||
|
||||
public class TesterUtil {
|
||||
|
||||
public static class ServerConfigListener extends TesterEndpointConfig {
|
||||
|
||||
private static Class<?> pojoClazz;
|
||||
|
||||
public static void setPojoClazz(Class<?> pojoClazz) {
|
||||
ServerConfigListener.pojoClazz = pojoClazz;
|
||||
}
|
||||
|
||||
|
||||
@Override
|
||||
protected Class<?> getEndpointClass() {
|
||||
return pojoClazz;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
public static class SingletonConfigurator extends Configurator {
|
||||
|
||||
private static Object instance;
|
||||
|
||||
public static void setInstance(Object instance) {
|
||||
SingletonConfigurator.instance = instance;
|
||||
}
|
||||
|
||||
@Override
|
||||
public <T> T getEndpointInstance(Class<T> clazz)
|
||||
throws InstantiationException {
|
||||
@SuppressWarnings("unchecked")
|
||||
T result = (T) instance;
|
||||
return result;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@ClientEndpoint
|
||||
public static final class SimpleClient {
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user