JSR-356 fixing ServerContainer.setDefault*() method behavior

This commit is contained in:
Joakim Erdfelt 2013-07-31 14:25:54 -07:00
parent eb9fce2fa5
commit e2f02a7a8a
13 changed files with 257 additions and 26 deletions

View File

@ -306,10 +306,10 @@ public class ClientContainer extends ContainerLifeCycle implements WebSocketCont
}
@Override
public void setAsyncSendTimeout(long timeoutmillis)
public void setAsyncSendTimeout(long ms)
{
client.setMaxIdleTimeout(timeoutmillis);
client.setAsyncWriteTimeout(timeoutmillis);
client.setMaxIdleTimeout(ms);
client.setAsyncWriteTimeout(ms);
}
@Override
@ -320,9 +320,9 @@ public class ClientContainer extends ContainerLifeCycle implements WebSocketCont
}
@Override
public void setDefaultMaxSessionIdleTimeout(long timeout)
public void setDefaultMaxSessionIdleTimeout(long ms)
{
client.setMaxIdleTimeout(timeout);
client.setMaxIdleTimeout(ms);
}
@Override

View File

@ -138,4 +138,54 @@ public class ServerContainer extends ClientContainer implements javax.websocket.
return metadata;
}
}
@Override
public long getDefaultAsyncSendTimeout()
{
return webSocketServerFactory.getPolicy().getAsyncWriteTimeout();
}
@Override
public int getDefaultMaxBinaryMessageBufferSize()
{
return webSocketServerFactory.getPolicy().getMaxBinaryMessageBufferSize();
}
@Override
public long getDefaultMaxSessionIdleTimeout()
{
return webSocketServerFactory.getPolicy().getIdleTimeout();
}
@Override
public int getDefaultMaxTextMessageBufferSize()
{
return webSocketServerFactory.getPolicy().getMaxTextMessageBufferSize();
}
@Override
public void setAsyncSendTimeout(long ms)
{
webSocketServerFactory.getPolicy().setAsyncWriteTimeout(ms);
}
@Override
public void setDefaultMaxBinaryMessageBufferSize(int max)
{
webSocketServerFactory.getPolicy().setMaxBinaryMessageSize(max);
webSocketServerFactory.getPolicy().setMaxBinaryMessageBufferSize(max);
}
@Override
public void setDefaultMaxSessionIdleTimeout(long ms)
{
webSocketServerFactory.getPolicy().setIdleTimeout(ms);
}
@Override
public void setDefaultMaxTextMessageBufferSize(int max)
{
webSocketServerFactory.getPolicy().setMaxTextMessageSize(max);
webSocketServerFactory.getPolicy().setMaxTextMessageBufferSize(max);
}
}

View File

@ -30,6 +30,8 @@ import org.eclipse.jetty.util.log.Logger;
import org.eclipse.jetty.webapp.AbstractConfiguration;
import org.eclipse.jetty.webapp.Configuration;
import org.eclipse.jetty.webapp.WebAppContext;
import org.eclipse.jetty.websocket.api.WebSocketBehavior;
import org.eclipse.jetty.websocket.api.WebSocketPolicy;
import org.eclipse.jetty.websocket.jsr356.server.deploy.DiscoveredEndpoints;
import org.eclipse.jetty.websocket.jsr356.server.deploy.ServerEndpointAnnotationHandler;
import org.eclipse.jetty.websocket.server.WebSocketUpgradeFilter;
@ -43,7 +45,9 @@ public class WebSocketConfiguration extends AbstractConfiguration
public static ServerContainer configureContext(ServletContextHandler context)
{
WebSocketUpgradeFilter filter = new WebSocketUpgradeFilter();
WebSocketPolicy policy = new WebSocketPolicy(WebSocketBehavior.SERVER);
WebSocketUpgradeFilter filter = new WebSocketUpgradeFilter(policy);
FilterHolder fholder = new FilterHolder(filter);
fholder.setName("Jetty_WebSocketUpgradeFilter");
fholder.setDisplayName("WebSocket Upgrade Filter");

View File

@ -29,7 +29,7 @@ import org.eclipse.jetty.util.StringUtil;
import org.eclipse.jetty.webapp.WebAppContext;
import org.eclipse.jetty.websocket.api.Session;
import org.eclipse.jetty.websocket.client.WebSocketClient;
import org.eclipse.jetty.websocket.jsr356.server.samples.echo.LargeEchoSocket;
import org.eclipse.jetty.websocket.jsr356.server.samples.echo.LargeEchoConfiguredSocket;
import org.junit.Assert;
import org.junit.Rule;
import org.junit.Test;
@ -47,7 +47,7 @@ public class LargeAnnotatedTest
{
WSServer wsb = new WSServer(testdir,"app");
wsb.createWebInf();
wsb.copyEndpoint(LargeEchoSocket.class);
wsb.copyEndpoint(LargeEchoConfiguredSocket.class);
try
{

View File

@ -0,0 +1,88 @@
//
// ========================================================================
// 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.
// ========================================================================
//
package org.eclipse.jetty.websocket.jsr356.server;
import java.net.URI;
import java.util.Arrays;
import java.util.Queue;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import org.eclipse.jetty.toolchain.test.TestingDir;
import org.eclipse.jetty.util.StringUtil;
import org.eclipse.jetty.webapp.WebAppContext;
import org.eclipse.jetty.websocket.api.Session;
import org.eclipse.jetty.websocket.client.WebSocketClient;
import org.eclipse.jetty.websocket.jsr356.server.samples.echo.LargeEchoDefaultSocket;
import org.junit.Assert;
import org.junit.Rule;
import org.junit.Test;
/**
* Test Echo of Large messages, targeting the {@link javax.websocket.WebSocketContainer#setDefaultMaxTextMessageBufferSize(int)} functionality
*/
public class LargeContainerTest
{
@Rule
public TestingDir testdir = new TestingDir();
@Test
public void testEcho() throws Exception
{
WSServer wsb = new WSServer(testdir,"app");
wsb.copyWebInf("large-echo-config-web.xml");
wsb.copyEndpoint(LargeEchoDefaultSocket.class);
try
{
wsb.start();
URI uri = wsb.getServerBaseURI();
WebAppContext webapp = wsb.createWebAppContext();
wsb.deployWebapp(webapp);
// wsb.dump();
WebSocketClient client = new WebSocketClient();
try
{
client.getPolicy().setMaxTextMessageSize(128*1024);
client.start();
JettyEchoSocket clientEcho = new JettyEchoSocket();
Future<Session> foo = client.connect(clientEcho,uri.resolve("echo/large"));
// wait for connect
foo.get(1,TimeUnit.SECONDS);
// The message size should be bigger than default, but smaller than the limit that LargeEchoSocket specifies
byte txt[] = new byte[100 * 1024];
Arrays.fill(txt,(byte)'o');
String msg = new String(txt,StringUtil.__UTF8_CHARSET);
clientEcho.sendMessage(msg);
Queue<String> msgs = clientEcho.awaitMessages(1);
Assert.assertEquals("Expected message",msg,msgs.poll());
}
finally
{
client.stop();
}
}
finally
{
wsb.stop();
}
}
}

View File

@ -27,7 +27,7 @@ import javax.websocket.server.ServerEndpoint;
* Annotated echo socket
*/
@ServerEndpoint(value = "/echo/large")
public class LargeEchoSocket
public class LargeEchoConfiguredSocket
{
private Session session;

View File

@ -0,0 +1,42 @@
//
// ========================================================================
// 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.
// ========================================================================
//
package org.eclipse.jetty.websocket.jsr356.server.samples.echo;
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.websocket.server.ServerContainer;
/**
* Configure the Large Text Message Size via the Container
*/
public class LargeEchoContextListener implements ServletContextListener
{
@Override
public void contextDestroyed(ServletContextEvent sce)
{
/* do nothing */
}
@Override
public void contextInitialized(ServletContextEvent sce)
{
ServerContainer container = (ServerContainer)sce.getServletContext().getAttribute(ServerContainer.class.getName());
container.setDefaultMaxTextMessageBufferSize(128 * 1024);
}
}

View File

@ -0,0 +1,38 @@
//
// ========================================================================
// 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.
// ========================================================================
//
package org.eclipse.jetty.websocket.jsr356.server.samples.echo;
import javax.websocket.OnMessage;
import javax.websocket.Session;
import javax.websocket.WebSocketContainer;
import javax.websocket.server.ServerEndpoint;
/**
* Annotated echo socket (default behavior as defined from {@link WebSocketContainer#setDefaultMaxTextMessageBufferSize(int)})
*/
@ServerEndpoint(value = "/echo/large")
public class LargeEchoDefaultSocket
{
@OnMessage
public void echo(Session session, String msg)
{
// reply with echo
session.getAsyncRemote().sendText(msg);
}
}

View File

@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<web-app
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://java.sun.com/xml/ns/javaee"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
metadata-complete="false"
version="3.0">
<listener>
<listener-class>org.eclipse.jetty.websocket.jsr356.server.samples.echo.LargeEchoContextListener</listener-class>
</listener>
</web-app>

View File

@ -427,16 +427,16 @@ public class WebSocketClient extends ContainerLifeCycle
/**
* Set the timeout for connecting to the remote server.
*
* @param timeoutMilliseconds
* @param ms
* the timeout in milliseconds
*/
public void setConnectTimeout(long timeoutMilliseconds)
public void setConnectTimeout(long ms)
{
if (timeoutMilliseconds < 0)
if (ms < 0)
{
throw new IllegalStateException("Connect Timeout cannot be negative");
}
this.connectTimeout = timeoutMilliseconds;
this.connectTimeout = ms;
}
public void setCookieStore(CookieStore cookieStore)
@ -469,12 +469,12 @@ public class WebSocketClient extends ContainerLifeCycle
* <p>
* Existing connections will not have their max idle timeout adjusted.
*
* @param milliseconds
* @param ms
* the timeout in milliseconds
*/
public void setMaxIdleTimeout(long milliseconds)
public void setMaxIdleTimeout(long ms)
{
this.policy.setIdleTimeout(milliseconds);
this.policy.setIdleTimeout(ms);
}
public void setMaxTextMessageBufferSize(int max)

View File

@ -227,7 +227,7 @@ public class UpgradeConnection extends AbstractConnection
// Initialize / Negotiate Extensions
EventDriver websocket = connectPromise.getDriver();
WebSocketPolicy policy = connectPromise.getClient().getPolicy();
WebSocketPolicy policy = websocket.getPolicy();
SessionFactory sessionFactory = connectPromise.getClient().getSessionFactory();
WebSocketSession session = sessionFactory.createSession(request.getRequestURI(),websocket,connection);

View File

@ -23,7 +23,6 @@ import java.net.URI;
import java.net.URISyntaxException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
@ -92,7 +91,7 @@ public class WebSocketServerFactory extends ContainerLifeCycle implements WebSoc
private final Scheduler scheduler = new ScheduledExecutorScheduler();
private final Queue<WebSocketSession> sessions = new ConcurrentLinkedQueue<>();
private final String supportedVersions;
private final WebSocketPolicy basePolicy;
private final WebSocketPolicy defaultPolicy;
private final EventDriverFactory eventDriverFactory;
private final WebSocketExtensionFactory extensionFactory;
private List<SessionFactory> sessionFactories;
@ -116,9 +115,9 @@ public class WebSocketServerFactory extends ContainerLifeCycle implements WebSoc
this.registeredSocketClasses = new ArrayList<>();
this.basePolicy = policy;
this.eventDriverFactory = new EventDriverFactory(basePolicy);
this.extensionFactory = new WebSocketExtensionFactory(basePolicy,bufferPool);
this.defaultPolicy = policy;
this.eventDriverFactory = new EventDriverFactory(defaultPolicy);
this.extensionFactory = new WebSocketExtensionFactory(defaultPolicy,bufferPool);
this.sessionFactories = new ArrayList<>();
this.sessionFactories.add(new WebSocketSessionFactory());
this.creator = this;
@ -307,7 +306,7 @@ public class WebSocketServerFactory extends ContainerLifeCycle implements WebSoc
@Override
public WebSocketPolicy getPolicy()
{
return basePolicy;
return defaultPolicy;
}
@Override

View File

@ -35,7 +35,6 @@ import org.eclipse.jetty.util.component.ContainerLifeCycle;
import org.eclipse.jetty.util.component.Dumpable;
import org.eclipse.jetty.util.log.Log;
import org.eclipse.jetty.util.log.Logger;
import org.eclipse.jetty.websocket.api.WebSocketBehavior;
import org.eclipse.jetty.websocket.api.WebSocketPolicy;
import org.eclipse.jetty.websocket.server.pathmap.PathMappings;
import org.eclipse.jetty.websocket.server.pathmap.PathMappings.MappedResource;
@ -52,9 +51,8 @@ public class WebSocketUpgradeFilter extends ContainerLifeCycle implements Filter
private final WebSocketServerFactory factory;
private PathMappings<WebSocketCreator> pathmap = new PathMappings<>();
public WebSocketUpgradeFilter()
public WebSocketUpgradeFilter(WebSocketPolicy policy)
{
WebSocketPolicy policy = new WebSocketPolicy(WebSocketBehavior.SERVER);
factory = new WebSocketServerFactory(policy);
addBean(factory,true);
}