Issue #1124 - WebSocketUpgradeFilter + ServletContextListener
+ Now Spring and its initialization of WebSocketUpgradeFilter can work. + Improves life for cometd 3.1.0 as well
This commit is contained in:
parent
f254dbc0b6
commit
a73e466e4d
|
@ -28,6 +28,8 @@ import javax.websocket.Extension;
|
||||||
import javax.websocket.Extension.Parameter;
|
import javax.websocket.Extension.Parameter;
|
||||||
import javax.websocket.server.ServerEndpointConfig;
|
import javax.websocket.server.ServerEndpointConfig;
|
||||||
|
|
||||||
|
import org.eclipse.jetty.http.pathmap.PathSpec;
|
||||||
|
import org.eclipse.jetty.http.pathmap.UriTemplatePathSpec;
|
||||||
import org.eclipse.jetty.util.StringUtil;
|
import org.eclipse.jetty.util.StringUtil;
|
||||||
import org.eclipse.jetty.util.log.Log;
|
import org.eclipse.jetty.util.log.Log;
|
||||||
import org.eclipse.jetty.util.log.Logger;
|
import org.eclipse.jetty.util.log.Logger;
|
||||||
|
@ -36,7 +38,6 @@ import org.eclipse.jetty.websocket.api.extensions.ExtensionFactory;
|
||||||
import org.eclipse.jetty.websocket.jsr356.JsrExtension;
|
import org.eclipse.jetty.websocket.jsr356.JsrExtension;
|
||||||
import org.eclipse.jetty.websocket.jsr356.endpoints.EndpointInstance;
|
import org.eclipse.jetty.websocket.jsr356.endpoints.EndpointInstance;
|
||||||
import org.eclipse.jetty.websocket.jsr356.server.pathmap.WebSocketPathSpec;
|
import org.eclipse.jetty.websocket.jsr356.server.pathmap.WebSocketPathSpec;
|
||||||
import org.eclipse.jetty.websocket.server.pathmap.PathSpec;
|
|
||||||
import org.eclipse.jetty.websocket.servlet.ServletUpgradeRequest;
|
import org.eclipse.jetty.websocket.servlet.ServletUpgradeRequest;
|
||||||
import org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse;
|
import org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse;
|
||||||
import org.eclipse.jetty.websocket.servlet.WebSocketCreator;
|
import org.eclipse.jetty.websocket.servlet.WebSocketCreator;
|
||||||
|
@ -134,10 +135,10 @@ public class JsrCreator implements WebSocketCreator
|
||||||
|
|
||||||
// [JSR] Step 4: build out new ServerEndpointConfig
|
// [JSR] Step 4: build out new ServerEndpointConfig
|
||||||
PathSpec pathSpec = jsrHandshakeRequest.getRequestPathSpec();
|
PathSpec pathSpec = jsrHandshakeRequest.getRequestPathSpec();
|
||||||
if (pathSpec instanceof WebSocketPathSpec)
|
if (pathSpec instanceof UriTemplatePathSpec)
|
||||||
{
|
{
|
||||||
// We have a PathParam path spec
|
// We have a PathParam path spec
|
||||||
WebSocketPathSpec wspathSpec = (WebSocketPathSpec)pathSpec;
|
UriTemplatePathSpec wspathSpec = (UriTemplatePathSpec)pathSpec;
|
||||||
String requestPath = req.getRequestPath();
|
String requestPath = req.getRequestPath();
|
||||||
// Wrap the config with the path spec information
|
// Wrap the config with the path spec information
|
||||||
config = new PathParamServerEndpointConfig(config,wspathSpec,requestPath);
|
config = new PathParamServerEndpointConfig(config,wspathSpec,requestPath);
|
||||||
|
|
|
@ -25,7 +25,7 @@ import java.util.Map;
|
||||||
|
|
||||||
import javax.websocket.server.HandshakeRequest;
|
import javax.websocket.server.HandshakeRequest;
|
||||||
|
|
||||||
import org.eclipse.jetty.websocket.server.pathmap.PathSpec;
|
import org.eclipse.jetty.http.pathmap.PathSpec;
|
||||||
import org.eclipse.jetty.websocket.servlet.ServletUpgradeRequest;
|
import org.eclipse.jetty.websocket.servlet.ServletUpgradeRequest;
|
||||||
|
|
||||||
public class JsrHandshakeRequest implements HandshakeRequest
|
public class JsrHandshakeRequest implements HandshakeRequest
|
||||||
|
|
|
@ -23,7 +23,7 @@ import java.util.Map;
|
||||||
|
|
||||||
import javax.websocket.server.ServerEndpointConfig;
|
import javax.websocket.server.ServerEndpointConfig;
|
||||||
|
|
||||||
import org.eclipse.jetty.websocket.jsr356.server.pathmap.WebSocketPathSpec;
|
import org.eclipse.jetty.http.pathmap.UriTemplatePathSpec;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Wrapper for a {@link ServerEndpointConfig} where there PathParm information from the incoming request.
|
* Wrapper for a {@link ServerEndpointConfig} where there PathParm information from the incoming request.
|
||||||
|
@ -32,12 +32,12 @@ public class PathParamServerEndpointConfig extends BasicServerEndpointConfig imp
|
||||||
{
|
{
|
||||||
private final Map<String, String> pathParamMap;
|
private final Map<String, String> pathParamMap;
|
||||||
|
|
||||||
public PathParamServerEndpointConfig(ServerEndpointConfig config, WebSocketPathSpec pathSpec, String requestPath)
|
public PathParamServerEndpointConfig(ServerEndpointConfig config, UriTemplatePathSpec pathSpec, String requestPath)
|
||||||
{
|
{
|
||||||
super(config);
|
super(config);
|
||||||
|
|
||||||
Map<String, String> pathMap = pathSpec.getPathParams(requestPath);
|
Map<String, String> pathMap = pathSpec.getPathParams(requestPath);
|
||||||
pathParamMap = new HashMap<String, String>();
|
pathParamMap = new HashMap<>();
|
||||||
if (pathMap != null)
|
if (pathMap != null)
|
||||||
{
|
{
|
||||||
pathParamMap.putAll(pathMap);
|
pathParamMap.putAll(pathMap);
|
||||||
|
|
|
@ -25,6 +25,7 @@ import javax.websocket.Endpoint;
|
||||||
import javax.websocket.server.ServerEndpoint;
|
import javax.websocket.server.ServerEndpoint;
|
||||||
import javax.websocket.server.ServerEndpointConfig;
|
import javax.websocket.server.ServerEndpointConfig;
|
||||||
|
|
||||||
|
import org.eclipse.jetty.http.pathmap.UriTemplatePathSpec;
|
||||||
import org.eclipse.jetty.util.log.Log;
|
import org.eclipse.jetty.util.log.Log;
|
||||||
import org.eclipse.jetty.util.log.Logger;
|
import org.eclipse.jetty.util.log.Logger;
|
||||||
import org.eclipse.jetty.websocket.common.events.EventDriverFactory;
|
import org.eclipse.jetty.websocket.common.events.EventDriverFactory;
|
||||||
|
@ -33,26 +34,22 @@ import org.eclipse.jetty.websocket.jsr356.JsrSessionFactory;
|
||||||
import org.eclipse.jetty.websocket.jsr356.annotations.AnnotatedEndpointScanner;
|
import org.eclipse.jetty.websocket.jsr356.annotations.AnnotatedEndpointScanner;
|
||||||
import org.eclipse.jetty.websocket.jsr356.endpoints.EndpointInstance;
|
import org.eclipse.jetty.websocket.jsr356.endpoints.EndpointInstance;
|
||||||
import org.eclipse.jetty.websocket.jsr356.metadata.EndpointMetadata;
|
import org.eclipse.jetty.websocket.jsr356.metadata.EndpointMetadata;
|
||||||
import org.eclipse.jetty.websocket.jsr356.server.pathmap.WebSocketPathSpec;
|
import org.eclipse.jetty.websocket.server.NativeWebSocketConfiguration;
|
||||||
import org.eclipse.jetty.websocket.server.MappedWebSocketCreator;
|
|
||||||
import org.eclipse.jetty.websocket.server.WebSocketServerFactory;
|
|
||||||
|
|
||||||
public class ServerContainer extends ClientContainer implements javax.websocket.server.ServerContainer
|
public class ServerContainer extends ClientContainer implements javax.websocket.server.ServerContainer
|
||||||
{
|
{
|
||||||
private static final Logger LOG = Log.getLogger(ServerContainer.class);
|
private static final Logger LOG = Log.getLogger(ServerContainer.class);
|
||||||
|
|
||||||
private final MappedWebSocketCreator mappedCreator;
|
private final NativeWebSocketConfiguration configuration;
|
||||||
private final WebSocketServerFactory webSocketServerFactory;
|
|
||||||
|
|
||||||
public ServerContainer(MappedWebSocketCreator creator, WebSocketServerFactory factory, Executor executor)
|
public ServerContainer(NativeWebSocketConfiguration nativeWebSocketConfiguration, Executor executor)
|
||||||
{
|
{
|
||||||
super(executor);
|
super(executor);
|
||||||
this.mappedCreator = creator;
|
this.configuration = nativeWebSocketConfiguration;
|
||||||
this.webSocketServerFactory = factory;
|
EventDriverFactory eventDriverFactory = this.configuration.getFactory().getEventDriverFactory();
|
||||||
EventDriverFactory eventDriverFactory = this.webSocketServerFactory.getEventDriverFactory();
|
|
||||||
eventDriverFactory.addImplementation(new JsrServerEndpointImpl());
|
eventDriverFactory.addImplementation(new JsrServerEndpointImpl());
|
||||||
eventDriverFactory.addImplementation(new JsrServerExtendsEndpointImpl());
|
eventDriverFactory.addImplementation(new JsrServerExtendsEndpointImpl());
|
||||||
this.webSocketServerFactory.addSessionFactory(new JsrSessionFactory(this,this));
|
this.configuration.getFactory().addSessionFactory(new JsrSessionFactory(this,this));
|
||||||
}
|
}
|
||||||
|
|
||||||
public EndpointInstance newClientEndpointInstance(Object endpoint, ServerEndpointConfig config, String path)
|
public EndpointInstance newClientEndpointInstance(Object endpoint, ServerEndpointConfig config, String path)
|
||||||
|
@ -82,8 +79,8 @@ public class ServerContainer extends ClientContainer implements javax.websocket.
|
||||||
|
|
||||||
public void addEndpoint(ServerEndpointMetadata metadata) throws DeploymentException
|
public void addEndpoint(ServerEndpointMetadata metadata) throws DeploymentException
|
||||||
{
|
{
|
||||||
JsrCreator creator = new JsrCreator(metadata,webSocketServerFactory.getExtensionFactory());
|
JsrCreator creator = new JsrCreator(metadata,this.configuration.getFactory().getExtensionFactory());
|
||||||
mappedCreator.addMapping(new WebSocketPathSpec(metadata.getPath()),creator);
|
this.configuration.addMapping(new UriTemplatePathSpec(metadata.getPath()),creator);
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
|
@ -129,36 +126,36 @@ public class ServerContainer extends ClientContainer implements javax.websocket.
|
||||||
|
|
||||||
return metadata;
|
return metadata;
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public long getDefaultAsyncSendTimeout()
|
public long getDefaultAsyncSendTimeout()
|
||||||
{
|
{
|
||||||
return webSocketServerFactory.getPolicy().getAsyncWriteTimeout();
|
return this.configuration.getPolicy().getAsyncWriteTimeout();
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public int getDefaultMaxBinaryMessageBufferSize()
|
public int getDefaultMaxBinaryMessageBufferSize()
|
||||||
{
|
{
|
||||||
return webSocketServerFactory.getPolicy().getMaxBinaryMessageSize();
|
return this.configuration.getPolicy().getMaxBinaryMessageSize();
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public long getDefaultMaxSessionIdleTimeout()
|
public long getDefaultMaxSessionIdleTimeout()
|
||||||
{
|
{
|
||||||
return webSocketServerFactory.getPolicy().getIdleTimeout();
|
return this.configuration.getPolicy().getIdleTimeout();
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public int getDefaultMaxTextMessageBufferSize()
|
public int getDefaultMaxTextMessageBufferSize()
|
||||||
{
|
{
|
||||||
return webSocketServerFactory.getPolicy().getMaxTextMessageSize();
|
return this.configuration.getPolicy().getMaxTextMessageSize();
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public void setAsyncSendTimeout(long ms)
|
public void setAsyncSendTimeout(long ms)
|
||||||
{
|
{
|
||||||
super.setAsyncSendTimeout(ms);
|
super.setAsyncSendTimeout(ms);
|
||||||
webSocketServerFactory.getPolicy().setAsyncWriteTimeout(ms);
|
this.configuration.getPolicy().setAsyncWriteTimeout(ms);
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
|
@ -166,16 +163,16 @@ public class ServerContainer extends ClientContainer implements javax.websocket.
|
||||||
{
|
{
|
||||||
super.setDefaultMaxBinaryMessageBufferSize(max);
|
super.setDefaultMaxBinaryMessageBufferSize(max);
|
||||||
// overall message limit (used in non-streaming)
|
// overall message limit (used in non-streaming)
|
||||||
webSocketServerFactory.getPolicy().setMaxBinaryMessageSize(max);
|
this.configuration.getPolicy().setMaxBinaryMessageSize(max);
|
||||||
// incoming streaming buffer size
|
// incoming streaming buffer size
|
||||||
webSocketServerFactory.getPolicy().setMaxBinaryMessageBufferSize(max);
|
this.configuration.getPolicy().setMaxBinaryMessageBufferSize(max);
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public void setDefaultMaxSessionIdleTimeout(long ms)
|
public void setDefaultMaxSessionIdleTimeout(long ms)
|
||||||
{
|
{
|
||||||
super.setDefaultMaxSessionIdleTimeout(ms);
|
super.setDefaultMaxSessionIdleTimeout(ms);
|
||||||
webSocketServerFactory.getPolicy().setIdleTimeout(ms);
|
this.configuration.getPolicy().setIdleTimeout(ms);
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
|
@ -183,8 +180,8 @@ public class ServerContainer extends ClientContainer implements javax.websocket.
|
||||||
{
|
{
|
||||||
super.setDefaultMaxTextMessageBufferSize(max);
|
super.setDefaultMaxTextMessageBufferSize(max);
|
||||||
// overall message limit (used in non-streaming)
|
// overall message limit (used in non-streaming)
|
||||||
webSocketServerFactory.getPolicy().setMaxTextMessageSize(max);
|
this.configuration.getPolicy().setMaxTextMessageSize(max);
|
||||||
// incoming streaming buffer size
|
// incoming streaming buffer size
|
||||||
webSocketServerFactory.getPolicy().setMaxTextMessageBufferSize(max);
|
this.configuration.getPolicy().setMaxTextMessageBufferSize(max);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -31,18 +31,14 @@ import javax.websocket.server.ServerApplicationConfig;
|
||||||
import javax.websocket.server.ServerEndpoint;
|
import javax.websocket.server.ServerEndpoint;
|
||||||
import javax.websocket.server.ServerEndpointConfig;
|
import javax.websocket.server.ServerEndpointConfig;
|
||||||
|
|
||||||
import org.eclipse.jetty.io.ByteBufferPool;
|
|
||||||
import org.eclipse.jetty.io.MappedByteBufferPool;
|
|
||||||
import org.eclipse.jetty.server.handler.ContextHandler;
|
import org.eclipse.jetty.server.handler.ContextHandler;
|
||||||
import org.eclipse.jetty.servlet.ServletContextHandler;
|
import org.eclipse.jetty.servlet.ServletContextHandler;
|
||||||
import org.eclipse.jetty.util.TypeUtil;
|
import org.eclipse.jetty.util.TypeUtil;
|
||||||
import org.eclipse.jetty.util.log.Log;
|
import org.eclipse.jetty.util.log.Log;
|
||||||
import org.eclipse.jetty.util.log.Logger;
|
import org.eclipse.jetty.util.log.Logger;
|
||||||
import org.eclipse.jetty.websocket.api.WebSocketPolicy;
|
|
||||||
import org.eclipse.jetty.websocket.jsr356.server.ServerContainer;
|
import org.eclipse.jetty.websocket.jsr356.server.ServerContainer;
|
||||||
import org.eclipse.jetty.websocket.server.DefaultMappedWebSocketCreator;
|
import org.eclipse.jetty.websocket.server.NativeWebSocketConfiguration;
|
||||||
import org.eclipse.jetty.websocket.server.MappedWebSocketCreator;
|
import org.eclipse.jetty.websocket.server.NativeWebSocketServletContainerInitializer;
|
||||||
import org.eclipse.jetty.websocket.server.WebSocketServerFactory;
|
|
||||||
import org.eclipse.jetty.websocket.server.WebSocketUpgradeFilter;
|
import org.eclipse.jetty.websocket.server.WebSocketUpgradeFilter;
|
||||||
|
|
||||||
@HandlesTypes(
|
@HandlesTypes(
|
||||||
|
@ -107,18 +103,12 @@ public class WebSocketServerContainerInitializer implements ServletContainerInit
|
||||||
public static ServerContainer configureContext(ServletContextHandler context) throws ServletException
|
public static ServerContainer configureContext(ServletContextHandler context) throws ServletException
|
||||||
{
|
{
|
||||||
// Create Basic components
|
// Create Basic components
|
||||||
WebSocketPolicy policy = WebSocketPolicy.newServerPolicy();
|
NativeWebSocketConfiguration nativeWebSocketConfiguration = NativeWebSocketServletContainerInitializer.getDefaultFrom(context.getServletContext());
|
||||||
ByteBufferPool bufferPool = new MappedByteBufferPool();
|
|
||||||
MappedWebSocketCreator creator = new DefaultMappedWebSocketCreator();
|
|
||||||
WebSocketServerFactory factory = new WebSocketServerFactory(policy, bufferPool);
|
|
||||||
|
|
||||||
// Create the Jetty ServerContainer implementation
|
// Create the Jetty ServerContainer implementation
|
||||||
ServerContainer jettyContainer = new ServerContainer(creator,factory,context.getServer().getThreadPool());
|
ServerContainer jettyContainer = new ServerContainer(nativeWebSocketConfiguration, context.getServer().getThreadPool());
|
||||||
context.addBean(jettyContainer);
|
context.addBean(jettyContainer);
|
||||||
|
|
||||||
context.setAttribute(WebSocketUpgradeFilter.CREATOR_KEY, creator);
|
|
||||||
context.setAttribute(WebSocketUpgradeFilter.FACTORY_KEY, factory);
|
|
||||||
|
|
||||||
// Store a reference to the ServerContainer per javax.websocket spec 1.0 final section 6.4 Programmatic Server Deployment
|
// Store a reference to the ServerContainer per javax.websocket spec 1.0 final section 6.4 Programmatic Server Deployment
|
||||||
context.setAttribute(javax.websocket.server.ServerContainer.class.getName(),jettyContainer);
|
context.setAttribute(javax.websocket.server.ServerContainer.class.getName(),jettyContainer);
|
||||||
|
|
||||||
|
@ -126,6 +116,7 @@ public class WebSocketServerContainerInitializer implements ServletContainerInit
|
||||||
if(isEnabledViaContext(context.getServletContext(), ADD_DYNAMIC_FILTER_KEY, true))
|
if(isEnabledViaContext(context.getServletContext(), ADD_DYNAMIC_FILTER_KEY, true))
|
||||||
{
|
{
|
||||||
WebSocketUpgradeFilter.configureContext(context);
|
WebSocketUpgradeFilter.configureContext(context);
|
||||||
|
NativeWebSocketServletContainerInitializer.getDefaultFrom(context.getServletContext());
|
||||||
}
|
}
|
||||||
|
|
||||||
return jettyContainer;
|
return jettyContainer;
|
||||||
|
|
|
@ -18,6 +18,7 @@
|
||||||
|
|
||||||
package org.eclipse.jetty.websocket.jsr356.server;
|
package org.eclipse.jetty.websocket.jsr356.server;
|
||||||
|
|
||||||
|
import org.eclipse.jetty.http.pathmap.MappedResource;
|
||||||
import org.eclipse.jetty.websocket.server.MappedWebSocketCreator;
|
import org.eclipse.jetty.websocket.server.MappedWebSocketCreator;
|
||||||
import org.eclipse.jetty.websocket.server.pathmap.PathMappings;
|
import org.eclipse.jetty.websocket.server.pathmap.PathMappings;
|
||||||
import org.eclipse.jetty.websocket.server.pathmap.PathSpec;
|
import org.eclipse.jetty.websocket.server.pathmap.PathSpec;
|
||||||
|
@ -30,10 +31,22 @@ public class DummyCreator implements MappedWebSocketCreator
|
||||||
{
|
{
|
||||||
/* do nothing */
|
/* do nothing */
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void addMapping(org.eclipse.jetty.http.pathmap.PathSpec spec, WebSocketCreator creator)
|
||||||
|
{
|
||||||
|
/* do nothing */
|
||||||
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public PathMappings<WebSocketCreator> getMappings()
|
public PathMappings<WebSocketCreator> getMappings()
|
||||||
{
|
{
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public MappedResource<WebSocketCreator> getMapping(String target)
|
||||||
|
{
|
||||||
|
return null;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -47,7 +47,7 @@ import org.eclipse.jetty.websocket.jsr356.JsrExtension;
|
||||||
import org.eclipse.jetty.websocket.jsr356.JsrSession;
|
import org.eclipse.jetty.websocket.jsr356.JsrSession;
|
||||||
import org.eclipse.jetty.websocket.jsr356.server.deploy.WebSocketServerContainerInitializer;
|
import org.eclipse.jetty.websocket.jsr356.server.deploy.WebSocketServerContainerInitializer;
|
||||||
import org.eclipse.jetty.websocket.jsr356.server.samples.echo.BasicEchoEndpoint;
|
import org.eclipse.jetty.websocket.jsr356.server.samples.echo.BasicEchoEndpoint;
|
||||||
import org.eclipse.jetty.websocket.server.WebSocketUpgradeFilter;
|
import org.eclipse.jetty.websocket.server.NativeWebSocketConfiguration;
|
||||||
import org.junit.After;
|
import org.junit.After;
|
||||||
import org.junit.Assert;
|
import org.junit.Assert;
|
||||||
import org.junit.Assume;
|
import org.junit.Assume;
|
||||||
|
@ -88,8 +88,9 @@ public class ExtensionStackProcessingTest
|
||||||
|
|
||||||
private void assumeDeflateFrameAvailable()
|
private void assumeDeflateFrameAvailable()
|
||||||
{
|
{
|
||||||
WebSocketUpgradeFilter filter = (WebSocketUpgradeFilter)servletContextHandler.getAttribute(WebSocketUpgradeFilter.class.getName());
|
NativeWebSocketConfiguration configuration = (NativeWebSocketConfiguration) servletContextHandler
|
||||||
ExtensionFactory serverExtensionFactory = filter.getFactory().getExtensionFactory();
|
.getServletContext().getAttribute(NativeWebSocketConfiguration.class.getName());
|
||||||
|
ExtensionFactory serverExtensionFactory = configuration.getFactory().getExtensionFactory();
|
||||||
Assume.assumeTrue("Server has permessage-deflate extension registered",serverExtensionFactory.isAvailable("permessage-deflate"));
|
Assume.assumeTrue("Server has permessage-deflate extension registered",serverExtensionFactory.isAvailable("permessage-deflate"));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -89,6 +89,18 @@
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
<scope>provided</scope>
|
<scope>provided</scope>
|
||||||
</dependency>
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.eclipse.jetty</groupId>
|
||||||
|
<artifactId>jetty-webapp</artifactId>
|
||||||
|
<version>${project.version}</version>
|
||||||
|
<scope>test</scope>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.eclipse.jetty</groupId>
|
||||||
|
<artifactId>jetty-annotations</artifactId>
|
||||||
|
<version>${project.version}</version>
|
||||||
|
<scope>test</scope>
|
||||||
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.jetty.websocket</groupId>
|
<groupId>org.eclipse.jetty.websocket</groupId>
|
||||||
<artifactId>websocket-common</artifactId>
|
<artifactId>websocket-common</artifactId>
|
||||||
|
|
|
@ -18,6 +18,7 @@
|
||||||
|
|
||||||
package org.eclipse.jetty.websocket.server;
|
package org.eclipse.jetty.websocket.server;
|
||||||
|
|
||||||
|
import org.eclipse.jetty.http.pathmap.MappedResource;
|
||||||
import org.eclipse.jetty.websocket.server.pathmap.PathMappings;
|
import org.eclipse.jetty.websocket.server.pathmap.PathMappings;
|
||||||
import org.eclipse.jetty.websocket.server.pathmap.PathSpec;
|
import org.eclipse.jetty.websocket.server.pathmap.PathSpec;
|
||||||
import org.eclipse.jetty.websocket.servlet.WebSocketCreator;
|
import org.eclipse.jetty.websocket.servlet.WebSocketCreator;
|
||||||
|
@ -27,7 +28,41 @@ import org.eclipse.jetty.websocket.servlet.WebSocketCreator;
|
||||||
*/
|
*/
|
||||||
public interface MappedWebSocketCreator
|
public interface MappedWebSocketCreator
|
||||||
{
|
{
|
||||||
public void addMapping(PathSpec spec, WebSocketCreator creator);
|
/**
|
||||||
|
* Add a mapping.
|
||||||
public PathMappings<WebSocketCreator> getMappings();
|
*
|
||||||
|
* @param spec the path spec to use
|
||||||
|
* @param creator the creator for the mapping
|
||||||
|
* @deprecated use {@link #addMapping(org.eclipse.jetty.http.pathmap.PathSpec, WebSocketCreator)} instead.
|
||||||
|
* (support classes moved to generic jetty-http project)
|
||||||
|
*/
|
||||||
|
@Deprecated
|
||||||
|
void addMapping(PathSpec spec, WebSocketCreator creator);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add a mapping.
|
||||||
|
*
|
||||||
|
* @param spec the path spec to use
|
||||||
|
* @param creator the creator for the mapping
|
||||||
|
* @since 9.2.20
|
||||||
|
*/
|
||||||
|
void addMapping(org.eclipse.jetty.http.pathmap.PathSpec spec, WebSocketCreator creator);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get all of the PathMappings declared.
|
||||||
|
*
|
||||||
|
* @return the PathMappings
|
||||||
|
* @deprecated do not use, use {@link #getMapping(String)} instead.
|
||||||
|
*/
|
||||||
|
@Deprecated
|
||||||
|
PathMappings<WebSocketCreator> getMappings();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get specific MappedResource for associated target.
|
||||||
|
*
|
||||||
|
* @param target the target to get mapping for
|
||||||
|
* @return the MappedResource for the target, or null if no match.
|
||||||
|
* @since 9.2.20
|
||||||
|
*/
|
||||||
|
MappedResource<WebSocketCreator> getMapping(String target);
|
||||||
}
|
}
|
||||||
|
|
|
@ -0,0 +1,171 @@
|
||||||
|
//
|
||||||
|
// ========================================================================
|
||||||
|
// Copyright (c) 1995-2016 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.server;
|
||||||
|
|
||||||
|
import java.io.IOException;
|
||||||
|
|
||||||
|
import org.eclipse.jetty.http.pathmap.MappedResource;
|
||||||
|
import org.eclipse.jetty.http.pathmap.PathMappings;
|
||||||
|
import org.eclipse.jetty.http.pathmap.PathSpec;
|
||||||
|
import org.eclipse.jetty.http.pathmap.RegexPathSpec;
|
||||||
|
import org.eclipse.jetty.http.pathmap.ServletPathSpec;
|
||||||
|
import org.eclipse.jetty.util.component.ContainerLifeCycle;
|
||||||
|
import org.eclipse.jetty.util.component.Dumpable;
|
||||||
|
import org.eclipse.jetty.websocket.api.WebSocketException;
|
||||||
|
import org.eclipse.jetty.websocket.api.WebSocketPolicy;
|
||||||
|
import org.eclipse.jetty.websocket.servlet.ServletUpgradeRequest;
|
||||||
|
import org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse;
|
||||||
|
import org.eclipse.jetty.websocket.servlet.WebSocketCreator;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Interface for Configuring Jetty Server Native WebSockets
|
||||||
|
* <p>
|
||||||
|
* Only applicable if using {@link WebSocketUpgradeFilter}
|
||||||
|
* </p>
|
||||||
|
*/
|
||||||
|
public class NativeWebSocketConfiguration extends ContainerLifeCycle implements Dumpable
|
||||||
|
{
|
||||||
|
private final WebSocketServerFactory factory;
|
||||||
|
private final PathMappings<WebSocketCreator> mappings = new PathMappings<>();
|
||||||
|
|
||||||
|
public NativeWebSocketConfiguration()
|
||||||
|
{
|
||||||
|
this(new WebSocketServerFactory());
|
||||||
|
}
|
||||||
|
|
||||||
|
public NativeWebSocketConfiguration(WebSocketServerFactory webSocketServerFactory)
|
||||||
|
{
|
||||||
|
this.factory = webSocketServerFactory;
|
||||||
|
addBean(this.factory);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void doStop() throws Exception
|
||||||
|
{
|
||||||
|
mappings.reset();
|
||||||
|
super.doStop();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public String dump()
|
||||||
|
{
|
||||||
|
return ContainerLifeCycle.dump(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void dump(Appendable out, String indent) throws IOException
|
||||||
|
{
|
||||||
|
// TODO: show factory/mappings ?
|
||||||
|
mappings.dump(out, indent);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get WebSocketServerFactory being used.
|
||||||
|
*
|
||||||
|
* @return the WebSocketServerFactory being used.
|
||||||
|
*/
|
||||||
|
public WebSocketServerFactory getFactory()
|
||||||
|
{
|
||||||
|
return this.factory;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the matching {@link MappedResource} for the provided target.
|
||||||
|
*
|
||||||
|
* @param target the target path
|
||||||
|
* @return the matching resource, or null if no match.
|
||||||
|
*/
|
||||||
|
public MappedResource<WebSocketCreator> getMatch(String target)
|
||||||
|
{
|
||||||
|
return this.mappings.getMatch(target);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Used to configure the Default {@link WebSocketPolicy} used by all endpoints that
|
||||||
|
* don't redeclare the values.
|
||||||
|
*
|
||||||
|
* @return the default policy for all WebSockets
|
||||||
|
*/
|
||||||
|
public WebSocketPolicy getPolicy()
|
||||||
|
{
|
||||||
|
return this.factory.getPolicy();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Manually add a WebSocket mapping.
|
||||||
|
*
|
||||||
|
* @param pathSpec the pathspec to respond on
|
||||||
|
* @param creator the websocket creator to activate on the provided mapping.
|
||||||
|
*/
|
||||||
|
public void addMapping(PathSpec pathSpec, WebSocketCreator creator)
|
||||||
|
{
|
||||||
|
mappings.put(pathSpec, creator);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Manually add a WebSocket mapping.
|
||||||
|
*
|
||||||
|
* @param spec the pathspec to respond on
|
||||||
|
* @param creator the websocket creator to activate on the provided mapping
|
||||||
|
* @deprecated use {@link #addMapping(PathSpec, Class)} instead.
|
||||||
|
*/
|
||||||
|
@Deprecated
|
||||||
|
public void addMapping(org.eclipse.jetty.websocket.server.pathmap.PathSpec spec, WebSocketCreator creator)
|
||||||
|
{
|
||||||
|
if (spec instanceof org.eclipse.jetty.websocket.server.pathmap.ServletPathSpec)
|
||||||
|
{
|
||||||
|
addMapping(new ServletPathSpec(spec.getPathSpec()), creator);
|
||||||
|
}
|
||||||
|
else if (spec instanceof org.eclipse.jetty.websocket.server.pathmap.RegexPathSpec)
|
||||||
|
{
|
||||||
|
addMapping(new RegexPathSpec(spec.getPathSpec()), creator);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
throw new RuntimeException("Unsupported (Deprecated) PathSpec implementation type: " + spec.getClass().getName());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Manually add a WebSocket mapping.
|
||||||
|
*
|
||||||
|
* @param pathSpec the pathspec to respond on
|
||||||
|
* @param endpointClass the endpoint class to use for new upgrade requests on the provided
|
||||||
|
* pathspec (can be an {@link org.eclipse.jetty.websocket.api.annotations.WebSocket} annotated
|
||||||
|
* POJO, or implementing {@link org.eclipse.jetty.websocket.api.WebSocketListener})
|
||||||
|
*/
|
||||||
|
public void addMapping(PathSpec pathSpec, final Class<?> endpointClass)
|
||||||
|
{
|
||||||
|
mappings.put(pathSpec, new WebSocketCreator()
|
||||||
|
{
|
||||||
|
@Override
|
||||||
|
public Object createWebSocket(ServletUpgradeRequest req, ServletUpgradeResponse resp)
|
||||||
|
{
|
||||||
|
try
|
||||||
|
{
|
||||||
|
return endpointClass.newInstance();
|
||||||
|
}
|
||||||
|
catch (InstantiationException | IllegalAccessException e)
|
||||||
|
{
|
||||||
|
throw new WebSocketException("Unable to create instance of " + endpointClass.getName(), e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,48 @@
|
||||||
|
//
|
||||||
|
// ========================================================================
|
||||||
|
// Copyright (c) 1995-2016 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.server;
|
||||||
|
|
||||||
|
import java.util.Set;
|
||||||
|
|
||||||
|
import javax.servlet.ServletContainerInitializer;
|
||||||
|
import javax.servlet.ServletContext;
|
||||||
|
import javax.servlet.ServletException;
|
||||||
|
|
||||||
|
public class NativeWebSocketServletContainerInitializer implements ServletContainerInitializer
|
||||||
|
{
|
||||||
|
public static NativeWebSocketConfiguration getDefaultFrom(ServletContext context)
|
||||||
|
{
|
||||||
|
final String KEY = NativeWebSocketConfiguration.class.getName();
|
||||||
|
|
||||||
|
NativeWebSocketConfiguration configuration = (NativeWebSocketConfiguration) context.getAttribute(KEY);
|
||||||
|
if (configuration == null)
|
||||||
|
{
|
||||||
|
configuration = new NativeWebSocketConfiguration();
|
||||||
|
context.setAttribute(KEY, configuration);
|
||||||
|
}
|
||||||
|
return configuration;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void onStartup(Set<Class<?>> c, ServletContext ctx) throws ServletException
|
||||||
|
{
|
||||||
|
// initialize
|
||||||
|
getDefaultFrom(ctx);
|
||||||
|
}
|
||||||
|
}
|
|
@ -32,30 +32,31 @@ import javax.servlet.ServletResponse;
|
||||||
import javax.servlet.http.HttpServletRequest;
|
import javax.servlet.http.HttpServletRequest;
|
||||||
import javax.servlet.http.HttpServletResponse;
|
import javax.servlet.http.HttpServletResponse;
|
||||||
|
|
||||||
|
import org.eclipse.jetty.http.pathmap.MappedResource;
|
||||||
|
import org.eclipse.jetty.http.pathmap.PathSpec;
|
||||||
import org.eclipse.jetty.io.ByteBufferPool;
|
import org.eclipse.jetty.io.ByteBufferPool;
|
||||||
import org.eclipse.jetty.io.MappedByteBufferPool;
|
|
||||||
import org.eclipse.jetty.server.handler.ContextHandler;
|
import org.eclipse.jetty.server.handler.ContextHandler;
|
||||||
import org.eclipse.jetty.servlet.FilterHolder;
|
import org.eclipse.jetty.servlet.FilterHolder;
|
||||||
import org.eclipse.jetty.servlet.ServletContextHandler;
|
import org.eclipse.jetty.servlet.ServletContextHandler;
|
||||||
import org.eclipse.jetty.util.annotation.ManagedAttribute;
|
import org.eclipse.jetty.util.annotation.ManagedAttribute;
|
||||||
import org.eclipse.jetty.util.annotation.ManagedObject;
|
import org.eclipse.jetty.util.annotation.ManagedObject;
|
||||||
|
import org.eclipse.jetty.util.component.AbstractLifeCycle;
|
||||||
import org.eclipse.jetty.util.component.ContainerLifeCycle;
|
import org.eclipse.jetty.util.component.ContainerLifeCycle;
|
||||||
import org.eclipse.jetty.util.component.Dumpable;
|
import org.eclipse.jetty.util.component.Dumpable;
|
||||||
import org.eclipse.jetty.util.log.Log;
|
import org.eclipse.jetty.util.log.Log;
|
||||||
import org.eclipse.jetty.util.log.Logger;
|
import org.eclipse.jetty.util.log.Logger;
|
||||||
import org.eclipse.jetty.websocket.api.WebSocketPolicy;
|
import org.eclipse.jetty.websocket.api.WebSocketPolicy;
|
||||||
import org.eclipse.jetty.websocket.server.pathmap.PathMappings;
|
|
||||||
import org.eclipse.jetty.websocket.server.pathmap.PathMappings.MappedResource;
|
|
||||||
import org.eclipse.jetty.websocket.server.pathmap.PathSpec;
|
|
||||||
import org.eclipse.jetty.websocket.servlet.WebSocketCreator;
|
import org.eclipse.jetty.websocket.servlet.WebSocketCreator;
|
||||||
|
import org.eclipse.jetty.websocket.servlet.WebSocketServletFactory;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Inline Servlet Filter to capture WebSocket upgrade requests and perform path mappings to {@link WebSocketCreator} objects.
|
* Inline Servlet Filter to capture WebSocket upgrade requests and perform path mappings to {@link WebSocketCreator} objects.
|
||||||
*/
|
*/
|
||||||
@ManagedObject("WebSocket Upgrade Filter")
|
@ManagedObject("WebSocket Upgrade Filter")
|
||||||
public class WebSocketUpgradeFilter extends ContainerLifeCycle implements Filter, MappedWebSocketCreator, Dumpable
|
public class WebSocketUpgradeFilter extends AbstractLifeCycle implements Filter, MappedWebSocketCreator, Dumpable
|
||||||
{
|
{
|
||||||
public static final String CONTEXT_ATTRIBUTE_KEY = "contextAttributeKey";
|
public static final String CONTEXT_ATTRIBUTE_KEY = "contextAttributeKey";
|
||||||
|
public static final String CONFIG_ATTRIBUTE_KEY = "configAttributeKey";
|
||||||
private static final Logger LOG = Log.getLogger(WebSocketUpgradeFilter.class);
|
private static final Logger LOG = Log.getLogger(WebSocketUpgradeFilter.class);
|
||||||
|
|
||||||
public static WebSocketUpgradeFilter configureContext(ServletContextHandler context) throws ServletException
|
public static WebSocketUpgradeFilter configureContext(ServletContextHandler context) throws ServletException
|
||||||
|
@ -68,7 +69,8 @@ public class WebSocketUpgradeFilter extends ContainerLifeCycle implements Filter
|
||||||
}
|
}
|
||||||
|
|
||||||
// Dynamically add filter
|
// Dynamically add filter
|
||||||
filter = new WebSocketUpgradeFilter();
|
NativeWebSocketConfiguration configuration = NativeWebSocketServletContainerInitializer.getDefaultFrom(context.getServletContext());
|
||||||
|
filter = new WebSocketUpgradeFilter(configuration);
|
||||||
filter.setToAttribute(context, WebSocketUpgradeFilter.class.getName());
|
filter.setToAttribute(context, WebSocketUpgradeFilter.class.getName());
|
||||||
|
|
||||||
String name = "Jetty_WebSocketUpgradeFilter";
|
String name = "Jetty_WebSocketUpgradeFilter";
|
||||||
|
@ -110,43 +112,63 @@ public class WebSocketUpgradeFilter extends ContainerLifeCycle implements Filter
|
||||||
return configureContext((ServletContextHandler) handler);
|
return configureContext((ServletContextHandler) handler);
|
||||||
}
|
}
|
||||||
|
|
||||||
public static final String CREATOR_KEY = "org.eclipse.jetty.websocket.server.creator";
|
private NativeWebSocketConfiguration configuration;
|
||||||
public static final String FACTORY_KEY = "org.eclipse.jetty.websocket.server.factory";
|
|
||||||
|
|
||||||
private final WebSocketPolicy policy;
|
|
||||||
private final ByteBufferPool bufferPool;
|
|
||||||
private WebSocketServerFactory factory;
|
|
||||||
private MappedWebSocketCreator mappedWebSocketCreator;
|
|
||||||
private String fname;
|
|
||||||
private boolean alreadySetToAttribute = false;
|
private boolean alreadySetToAttribute = false;
|
||||||
|
|
||||||
public WebSocketUpgradeFilter()
|
public WebSocketUpgradeFilter()
|
||||||
{
|
{
|
||||||
this(WebSocketPolicy.newServerPolicy(), new MappedByteBufferPool());
|
// do nothing
|
||||||
}
|
}
|
||||||
|
|
||||||
public WebSocketUpgradeFilter(WebSocketPolicy policy, ByteBufferPool bufferPool)
|
public WebSocketUpgradeFilter(WebSocketPolicy policy, ByteBufferPool bufferPool)
|
||||||
{
|
{
|
||||||
this.policy = policy;
|
this(new NativeWebSocketConfiguration(new WebSocketServerFactory(policy, bufferPool)));
|
||||||
this.bufferPool = bufferPool;
|
}
|
||||||
|
|
||||||
|
public WebSocketUpgradeFilter(NativeWebSocketConfiguration configuration)
|
||||||
|
{
|
||||||
|
this.configuration = configuration;
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public void addMapping(PathSpec spec, WebSocketCreator creator)
|
public void addMapping(PathSpec spec, WebSocketCreator creator)
|
||||||
{
|
{
|
||||||
mappedWebSocketCreator.addMapping(spec, creator);
|
configuration.addMapping(spec, creator);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Deprecated
|
||||||
|
@Override
|
||||||
|
public void addMapping(org.eclipse.jetty.websocket.server.pathmap.PathSpec spec, WebSocketCreator creator)
|
||||||
|
{
|
||||||
|
configuration.addMapping(spec, creator);
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public void destroy()
|
public void destroy()
|
||||||
{
|
{
|
||||||
factory.cleanup();
|
try
|
||||||
super.destroy();
|
{
|
||||||
|
configuration.stop();
|
||||||
|
}
|
||||||
|
catch (Exception e)
|
||||||
|
{
|
||||||
|
LOG.ignore(e);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException
|
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException
|
||||||
{
|
{
|
||||||
|
if (configuration == null)
|
||||||
|
{
|
||||||
|
// no configuration, cannot operate
|
||||||
|
LOG.debug("WebSocketUpgradeFilter is not operational - missing " + NativeWebSocketConfiguration.class.getName());
|
||||||
|
chain.doFilter(request, response);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
WebSocketServletFactory factory = configuration.getFactory();
|
||||||
|
|
||||||
if (factory == null)
|
if (factory == null)
|
||||||
{
|
{
|
||||||
// no factory, cannot operate
|
// no factory, cannot operate
|
||||||
|
@ -175,14 +197,9 @@ public class WebSocketUpgradeFilter extends ContainerLifeCycle implements Filter
|
||||||
target = target.substring(contextPath.length());
|
target = target.substring(contextPath.length());
|
||||||
}
|
}
|
||||||
|
|
||||||
MappedResource<WebSocketCreator> resource = mappedWebSocketCreator.getMappings().getMatch(target);
|
MappedResource<WebSocketCreator> resource = configuration.getMatch(target);
|
||||||
if (resource == null)
|
if (resource == null)
|
||||||
{
|
{
|
||||||
if (LOG.isDebugEnabled())
|
|
||||||
{
|
|
||||||
LOG.debug("WebSocket Upgrade on {} has no associated endpoint", target);
|
|
||||||
LOG.debug("PathMappings: {}", mappedWebSocketCreator.getMappings().dump());
|
|
||||||
}
|
|
||||||
// no match.
|
// no match.
|
||||||
chain.doFilter(request, response);
|
chain.doFilter(request, response);
|
||||||
return;
|
return;
|
||||||
|
@ -236,66 +253,93 @@ public class WebSocketUpgradeFilter extends ContainerLifeCycle implements Filter
|
||||||
@Override
|
@Override
|
||||||
public void dump(Appendable out, String indent) throws IOException
|
public void dump(Appendable out, String indent) throws IOException
|
||||||
{
|
{
|
||||||
out.append(indent).append(" +- pathmap=").append(mappedWebSocketCreator.toString()).append("\n");
|
out.append(indent).append(" +- configuration=").append(configuration.toString()).append("\n");
|
||||||
mappedWebSocketCreator.getMappings().dump(out, indent + " ");
|
configuration.dump(out, indent);
|
||||||
}
|
}
|
||||||
|
|
||||||
public WebSocketServerFactory getFactory()
|
public WebSocketServletFactory getFactory()
|
||||||
{
|
{
|
||||||
return factory;
|
return configuration.getFactory();
|
||||||
|
}
|
||||||
|
|
||||||
|
@ManagedAttribute(value = "configuration", readonly = true)
|
||||||
|
public NativeWebSocketConfiguration getConfiguration()
|
||||||
|
{
|
||||||
|
if (configuration == null)
|
||||||
|
{
|
||||||
|
throw new IllegalStateException(this.getClass().getName() + " not initialized yet");
|
||||||
|
}
|
||||||
|
return configuration;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ManagedAttribute(value = "mappings", readonly = true)
|
|
||||||
@Override
|
@Override
|
||||||
public PathMappings<WebSocketCreator> getMappings()
|
public MappedResource<WebSocketCreator> getMapping(String target)
|
||||||
{
|
{
|
||||||
return mappedWebSocketCreator.getMappings();
|
return getConfiguration().getMatch(target);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
@Deprecated
|
||||||
|
public org.eclipse.jetty.websocket.server.pathmap.PathMappings<WebSocketCreator> getMappings()
|
||||||
|
{
|
||||||
|
throw new IllegalStateException("Access to PathMappings cannot be supported. See alternative API in javadoc for "
|
||||||
|
+ MappedWebSocketCreator.class.getName());
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public void init(FilterConfig config) throws ServletException
|
public void init(FilterConfig config) throws ServletException
|
||||||
{
|
{
|
||||||
fname = config.getFilterName();
|
|
||||||
|
|
||||||
try
|
try
|
||||||
{
|
{
|
||||||
mappedWebSocketCreator = (MappedWebSocketCreator) config.getServletContext().getAttribute(CREATOR_KEY);
|
String configurationKey = config.getInitParameter(CONFIG_ATTRIBUTE_KEY);
|
||||||
if (mappedWebSocketCreator == null)
|
if (configurationKey == null)
|
||||||
{
|
{
|
||||||
mappedWebSocketCreator = new DefaultMappedWebSocketCreator();
|
configurationKey = NativeWebSocketConfiguration.class.getName();
|
||||||
}
|
}
|
||||||
|
|
||||||
factory = (WebSocketServerFactory) config.getServletContext().getAttribute(FACTORY_KEY);
|
if (configuration == null)
|
||||||
if (factory == null)
|
|
||||||
{
|
{
|
||||||
factory = new WebSocketServerFactory(policy, bufferPool);
|
this.configuration = (NativeWebSocketConfiguration) config.getServletContext().getAttribute(configurationKey);
|
||||||
|
if (this.configuration == null)
|
||||||
|
{
|
||||||
|
// The NativeWebSocketConfiguration should have arrived from the NativeWebSocketServletContainerInitializer
|
||||||
|
throw new ServletException("Unable to find required instance of " +
|
||||||
|
NativeWebSocketConfiguration.class.getName() + " at ServletContext attribute '" + configurationKey + "'");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
// We have a NativeWebSocketConfiguration already present, make sure it exists on the ServletContext
|
||||||
|
if (config.getServletContext().getAttribute(configurationKey) == null)
|
||||||
|
{
|
||||||
|
config.getServletContext().setAttribute(configurationKey, this.configuration);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
addBean(factory, true);
|
|
||||||
|
|
||||||
// TODO: Policy isn't from attributes
|
this.configuration.start();
|
||||||
|
|
||||||
String max = config.getInitParameter("maxIdleTime");
|
String max = config.getInitParameter("maxIdleTime");
|
||||||
if (max != null)
|
if (max != null)
|
||||||
{
|
{
|
||||||
factory.getPolicy().setIdleTimeout(Long.parseLong(max));
|
getFactory().getPolicy().setIdleTimeout(Long.parseLong(max));
|
||||||
}
|
}
|
||||||
|
|
||||||
max = config.getInitParameter("maxTextMessageSize");
|
max = config.getInitParameter("maxTextMessageSize");
|
||||||
if (max != null)
|
if (max != null)
|
||||||
{
|
{
|
||||||
factory.getPolicy().setMaxTextMessageSize(Integer.parseInt(max));
|
getFactory().getPolicy().setMaxTextMessageSize(Integer.parseInt(max));
|
||||||
}
|
}
|
||||||
|
|
||||||
max = config.getInitParameter("maxBinaryMessageSize");
|
max = config.getInitParameter("maxBinaryMessageSize");
|
||||||
if (max != null)
|
if (max != null)
|
||||||
{
|
{
|
||||||
factory.getPolicy().setMaxBinaryMessageSize(Integer.parseInt(max));
|
getFactory().getPolicy().setMaxBinaryMessageSize(Integer.parseInt(max));
|
||||||
}
|
}
|
||||||
|
|
||||||
max = config.getInitParameter("inputBufferSize");
|
max = config.getInitParameter("inputBufferSize");
|
||||||
if (max != null)
|
if (max != null)
|
||||||
{
|
{
|
||||||
factory.getPolicy().setInputBufferSize(Integer.parseInt(max));
|
getFactory().getPolicy().setInputBufferSize(Integer.parseInt(max));
|
||||||
}
|
}
|
||||||
|
|
||||||
String key = config.getInitParameter(CONTEXT_ATTRIBUTE_KEY);
|
String key = config.getInitParameter(CONTEXT_ATTRIBUTE_KEY);
|
||||||
|
@ -305,33 +349,22 @@ public class WebSocketUpgradeFilter extends ContainerLifeCycle implements Filter
|
||||||
key = WebSocketUpgradeFilter.class.getName();
|
key = WebSocketUpgradeFilter.class.getName();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Set instance of this filter to context attribute
|
||||||
setToAttribute(config.getServletContext(), key);
|
setToAttribute(config.getServletContext(), key);
|
||||||
|
|
||||||
factory.start();
|
|
||||||
}
|
}
|
||||||
catch (Exception x)
|
catch (ServletException e)
|
||||||
{
|
{
|
||||||
throw new ServletException(x);
|
throw e;
|
||||||
|
}
|
||||||
|
catch (Throwable t)
|
||||||
|
{
|
||||||
|
throw new ServletException(t);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
private void setToAttribute(ServletContextHandler context, String key) throws ServletException
|
private void setToAttribute(ServletContextHandler context, String key) throws ServletException
|
||||||
{
|
{
|
||||||
if (alreadySetToAttribute)
|
setToAttribute(context.getServletContext(), key);
|
||||||
{
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (context.getAttribute(key) != null)
|
|
||||||
{
|
|
||||||
throw new ServletException(WebSocketUpgradeFilter.class.getName() +
|
|
||||||
" is defined twice for the same context attribute key '" + key
|
|
||||||
+ "'. Make sure you have different init-param '" +
|
|
||||||
CONTEXT_ATTRIBUTE_KEY + "' values set");
|
|
||||||
}
|
|
||||||
context.setAttribute(key, this);
|
|
||||||
|
|
||||||
alreadySetToAttribute = true;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
public void setToAttribute(ServletContext context, String key) throws ServletException
|
public void setToAttribute(ServletContext context, String key) throws ServletException
|
||||||
|
@ -356,6 +389,6 @@ public class WebSocketUpgradeFilter extends ContainerLifeCycle implements Filter
|
||||||
@Override
|
@Override
|
||||||
public String toString()
|
public String toString()
|
||||||
{
|
{
|
||||||
return String.format("%s[factory=%s,creator=%s]", this.getClass().getSimpleName(), factory, mappedWebSocketCreator);
|
return String.format("%s[configuration=%s]", this.getClass().getSimpleName(), configuration);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -24,19 +24,17 @@ import javax.servlet.ServletException;
|
||||||
import javax.servlet.http.HttpServletRequest;
|
import javax.servlet.http.HttpServletRequest;
|
||||||
import javax.servlet.http.HttpServletResponse;
|
import javax.servlet.http.HttpServletResponse;
|
||||||
|
|
||||||
|
import org.eclipse.jetty.http.pathmap.MappedResource;
|
||||||
|
import org.eclipse.jetty.http.pathmap.PathSpec;
|
||||||
import org.eclipse.jetty.io.ByteBufferPool;
|
import org.eclipse.jetty.io.ByteBufferPool;
|
||||||
import org.eclipse.jetty.io.MappedByteBufferPool;
|
import org.eclipse.jetty.io.MappedByteBufferPool;
|
||||||
import org.eclipse.jetty.server.Request;
|
import org.eclipse.jetty.server.Request;
|
||||||
import org.eclipse.jetty.server.handler.HandlerWrapper;
|
import org.eclipse.jetty.server.handler.HandlerWrapper;
|
||||||
import org.eclipse.jetty.websocket.server.pathmap.PathMappings;
|
|
||||||
import org.eclipse.jetty.websocket.server.pathmap.PathMappings.MappedResource;
|
|
||||||
import org.eclipse.jetty.websocket.server.pathmap.PathSpec;
|
|
||||||
import org.eclipse.jetty.websocket.servlet.WebSocketCreator;
|
import org.eclipse.jetty.websocket.servlet.WebSocketCreator;
|
||||||
|
|
||||||
public class WebSocketUpgradeHandlerWrapper extends HandlerWrapper implements MappedWebSocketCreator
|
public class WebSocketUpgradeHandlerWrapper extends HandlerWrapper implements MappedWebSocketCreator
|
||||||
{
|
{
|
||||||
private PathMappings<WebSocketCreator> pathmap = new PathMappings<>();
|
private NativeWebSocketConfiguration configuration;
|
||||||
private final WebSocketServerFactory factory;
|
|
||||||
|
|
||||||
public WebSocketUpgradeHandlerWrapper()
|
public WebSocketUpgradeHandlerWrapper()
|
||||||
{
|
{
|
||||||
|
@ -45,27 +43,48 @@ public class WebSocketUpgradeHandlerWrapper extends HandlerWrapper implements Ma
|
||||||
|
|
||||||
public WebSocketUpgradeHandlerWrapper(ByteBufferPool bufferPool)
|
public WebSocketUpgradeHandlerWrapper(ByteBufferPool bufferPool)
|
||||||
{
|
{
|
||||||
factory = new WebSocketServerFactory(bufferPool);
|
this.configuration = new NativeWebSocketConfiguration(new WebSocketServerFactory(bufferPool));
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public void addMapping(PathSpec spec, WebSocketCreator creator)
|
public void addMapping(PathSpec spec, WebSocketCreator creator)
|
||||||
{
|
{
|
||||||
pathmap.put(spec,creator);
|
this.configuration.addMapping(spec, creator);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add a mapping.
|
||||||
|
*
|
||||||
|
* @param spec the path spec to use
|
||||||
|
* @param creator the creator for the mapping
|
||||||
|
* @deprecated use {@link #addMapping(PathSpec, WebSocketCreator)} instead.
|
||||||
|
*/
|
||||||
@Override
|
@Override
|
||||||
public PathMappings<WebSocketCreator> getMappings()
|
@Deprecated
|
||||||
|
public void addMapping(org.eclipse.jetty.websocket.server.pathmap.PathSpec spec, WebSocketCreator creator)
|
||||||
{
|
{
|
||||||
return pathmap;
|
configuration.addMapping(spec, creator);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public org.eclipse.jetty.websocket.server.pathmap.PathMappings<WebSocketCreator> getMappings()
|
||||||
|
{
|
||||||
|
throw new IllegalStateException("Access to PathMappings cannot be supported. See alternative API in javadoc for "
|
||||||
|
+ MappedWebSocketCreator.class.getName());
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public MappedResource<WebSocketCreator> getMapping(String target)
|
||||||
|
{
|
||||||
|
return this.configuration.getMatch(target);
|
||||||
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public void handle(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException
|
public void handle(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException
|
||||||
{
|
{
|
||||||
if (factory.isUpgradeRequest(request,response))
|
if (configuration.getFactory().isUpgradeRequest(request,response))
|
||||||
{
|
{
|
||||||
MappedResource<WebSocketCreator> resource = pathmap.getMatch(target);
|
MappedResource<WebSocketCreator> resource = configuration.getMatch(target);
|
||||||
if (resource == null)
|
if (resource == null)
|
||||||
{
|
{
|
||||||
// no match.
|
// no match.
|
||||||
|
@ -79,7 +98,7 @@ public class WebSocketUpgradeHandlerWrapper extends HandlerWrapper implements Ma
|
||||||
request.setAttribute(PathSpec.class.getName(),resource);
|
request.setAttribute(PathSpec.class.getName(),resource);
|
||||||
|
|
||||||
// We have an upgrade request
|
// We have an upgrade request
|
||||||
if (factory.acceptWebSocket(creator,request,response))
|
if (configuration.getFactory().acceptWebSocket(creator,request,response))
|
||||||
{
|
{
|
||||||
// We have a socket instance created
|
// We have a socket instance created
|
||||||
return;
|
return;
|
||||||
|
|
|
@ -38,7 +38,9 @@ import org.eclipse.jetty.websocket.server.pathmap.PathMappings.MappedResource;
|
||||||
* Sorted into search order upon entry into the Set
|
* Sorted into search order upon entry into the Set
|
||||||
*
|
*
|
||||||
* @param <E>
|
* @param <E>
|
||||||
|
* @deprecated use {@link org.eclipse.jetty.http.pathmap.PathMappings} instead
|
||||||
*/
|
*/
|
||||||
|
@Deprecated
|
||||||
@ManagedObject("Path Mappings")
|
@ManagedObject("Path Mappings")
|
||||||
public class PathMappings<E> implements Iterable<MappedResource<E>>, Dumpable
|
public class PathMappings<E> implements Iterable<MappedResource<E>>, Dumpable
|
||||||
{
|
{
|
||||||
|
|
|
@ -0,0 +1 @@
|
||||||
|
org.eclipse.jetty.websocket.server.NativeWebSocketServletContainerInitializer
|
|
@ -0,0 +1,50 @@
|
||||||
|
//
|
||||||
|
// ========================================================================
|
||||||
|
// Copyright (c) 1995-2016 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.server;
|
||||||
|
|
||||||
|
import javax.servlet.ServletContextEvent;
|
||||||
|
import javax.servlet.ServletContextListener;
|
||||||
|
|
||||||
|
import org.eclipse.jetty.http.pathmap.ServletPathSpec;
|
||||||
|
import org.eclipse.jetty.websocket.servlet.ServletUpgradeRequest;
|
||||||
|
import org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse;
|
||||||
|
import org.eclipse.jetty.websocket.servlet.WebSocketCreator;
|
||||||
|
|
||||||
|
public class InfoContextListener implements WebSocketCreator, ServletContextListener
|
||||||
|
{
|
||||||
|
@Override
|
||||||
|
public void contextInitialized(ServletContextEvent sce)
|
||||||
|
{
|
||||||
|
NativeWebSocketConfiguration configuration = new NativeWebSocketConfiguration();
|
||||||
|
configuration.getFactory().getPolicy().setMaxTextMessageSize(10 * 1024 * 1024);
|
||||||
|
configuration.addMapping(new ServletPathSpec("/info/*"), this);
|
||||||
|
sce.getServletContext().setAttribute(NativeWebSocketConfiguration.class.getName(), configuration);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void contextDestroyed(ServletContextEvent sce)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public Object createWebSocket(ServletUpgradeRequest req, ServletUpgradeResponse resp)
|
||||||
|
{
|
||||||
|
return new InfoSocket();
|
||||||
|
}
|
||||||
|
}
|
|
@ -18,23 +18,27 @@
|
||||||
|
|
||||||
package org.eclipse.jetty.websocket.server;
|
package org.eclipse.jetty.websocket.server;
|
||||||
|
|
||||||
import org.eclipse.jetty.websocket.server.pathmap.PathMappings;
|
import org.eclipse.jetty.websocket.api.RemoteEndpoint;
|
||||||
import org.eclipse.jetty.websocket.server.pathmap.PathSpec;
|
import org.eclipse.jetty.websocket.api.Session;
|
||||||
import org.eclipse.jetty.websocket.servlet.WebSocketCreator;
|
import org.eclipse.jetty.websocket.api.annotations.OnWebSocketConnect;
|
||||||
|
import org.eclipse.jetty.websocket.api.annotations.OnWebSocketMessage;
|
||||||
|
import org.eclipse.jetty.websocket.api.annotations.WebSocket;
|
||||||
|
|
||||||
public class DefaultMappedWebSocketCreator implements MappedWebSocketCreator
|
@WebSocket
|
||||||
|
public class InfoSocket
|
||||||
{
|
{
|
||||||
private final PathMappings<WebSocketCreator> mappings = new PathMappings<>();
|
private Session session;
|
||||||
|
|
||||||
@Override
|
@OnWebSocketConnect
|
||||||
public void addMapping(PathSpec spec, WebSocketCreator creator)
|
public void onConnect(Session session)
|
||||||
{
|
{
|
||||||
this.mappings.put(spec, creator);
|
this.session = session;
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@OnWebSocketMessage
|
||||||
public PathMappings<WebSocketCreator> getMappings()
|
public void onMessage(String msg)
|
||||||
{
|
{
|
||||||
return this.mappings;
|
RemoteEndpoint remote = this.session.getRemote();
|
||||||
|
remote.sendStringByFuture("session.maxTextMessageSize=" + session.getPolicy().getMaxTextMessageSize());
|
||||||
}
|
}
|
||||||
}
|
}
|
|
@ -0,0 +1,204 @@
|
||||||
|
//
|
||||||
|
// ========================================================================
|
||||||
|
// Copyright (c) 1995-2016 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.server;
|
||||||
|
|
||||||
|
import static org.hamcrest.Matchers.notNullValue;
|
||||||
|
|
||||||
|
import java.io.File;
|
||||||
|
import java.io.IOException;
|
||||||
|
import java.net.MalformedURLException;
|
||||||
|
import java.net.URI;
|
||||||
|
import java.net.URL;
|
||||||
|
|
||||||
|
import org.eclipse.jetty.annotations.AnnotationConfiguration;
|
||||||
|
import org.eclipse.jetty.plus.webapp.EnvConfiguration;
|
||||||
|
import org.eclipse.jetty.plus.webapp.PlusConfiguration;
|
||||||
|
import org.eclipse.jetty.server.Server;
|
||||||
|
import org.eclipse.jetty.server.ServerConnector;
|
||||||
|
import org.eclipse.jetty.server.handler.ContextHandlerCollection;
|
||||||
|
import org.eclipse.jetty.server.handler.HandlerCollection;
|
||||||
|
import org.eclipse.jetty.toolchain.test.FS;
|
||||||
|
import org.eclipse.jetty.toolchain.test.IO;
|
||||||
|
import org.eclipse.jetty.toolchain.test.MavenTestingUtils;
|
||||||
|
import org.eclipse.jetty.toolchain.test.OS;
|
||||||
|
import org.eclipse.jetty.toolchain.test.TestingDir;
|
||||||
|
import org.eclipse.jetty.util.log.Log;
|
||||||
|
import org.eclipse.jetty.util.log.Logger;
|
||||||
|
import org.eclipse.jetty.util.resource.Resource;
|
||||||
|
import org.eclipse.jetty.webapp.Configuration;
|
||||||
|
import org.eclipse.jetty.webapp.FragmentConfiguration;
|
||||||
|
import org.eclipse.jetty.webapp.MetaInfConfiguration;
|
||||||
|
import org.eclipse.jetty.webapp.WebAppContext;
|
||||||
|
import org.eclipse.jetty.webapp.WebInfConfiguration;
|
||||||
|
import org.eclipse.jetty.webapp.WebXmlConfiguration;
|
||||||
|
import org.junit.Assert;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Utility to build out exploded directory WebApps, in the /target/tests/ directory, for testing out servers that use javax.websocket endpoints.
|
||||||
|
* <p>
|
||||||
|
* This is particularly useful when the WebSocket endpoints are discovered via the javax.websocket annotation scanning.
|
||||||
|
*/
|
||||||
|
public class WSServer
|
||||||
|
{
|
||||||
|
private static final Logger LOG = Log.getLogger(WSServer.class);
|
||||||
|
private final File contextDir;
|
||||||
|
private final String contextPath;
|
||||||
|
private Server server;
|
||||||
|
private URI serverUri;
|
||||||
|
private ContextHandlerCollection contexts;
|
||||||
|
private File webinf;
|
||||||
|
private File classesDir;
|
||||||
|
|
||||||
|
public WSServer(TestingDir testdir, String contextName)
|
||||||
|
{
|
||||||
|
this(testdir.getDir(),contextName);
|
||||||
|
}
|
||||||
|
|
||||||
|
public WSServer(File testdir, String contextName)
|
||||||
|
{
|
||||||
|
this.contextDir = new File(testdir,contextName);
|
||||||
|
this.contextPath = "/" + contextName;
|
||||||
|
FS.ensureEmpty(contextDir);
|
||||||
|
}
|
||||||
|
|
||||||
|
public void copyClass(Class<?> clazz) throws Exception
|
||||||
|
{
|
||||||
|
ClassLoader cl = Thread.currentThread().getContextClassLoader();
|
||||||
|
String endpointPath = clazz.getName().replace('.','/') + ".class";
|
||||||
|
URL classUrl = cl.getResource(endpointPath);
|
||||||
|
Assert.assertThat("Class URL for: " + clazz,classUrl,notNullValue());
|
||||||
|
File destFile = new File(classesDir,OS.separators(endpointPath));
|
||||||
|
FS.ensureDirExists(destFile.getParentFile());
|
||||||
|
File srcFile = new File(classUrl.toURI());
|
||||||
|
IO.copy(srcFile,destFile);
|
||||||
|
}
|
||||||
|
|
||||||
|
public void copyEndpoint(Class<?> endpointClass) throws Exception
|
||||||
|
{
|
||||||
|
copyClass(endpointClass);
|
||||||
|
}
|
||||||
|
|
||||||
|
public void copyWebInf(String testResourceName) throws IOException
|
||||||
|
{
|
||||||
|
webinf = new File(contextDir,"WEB-INF");
|
||||||
|
FS.ensureDirExists(webinf);
|
||||||
|
classesDir = new File(webinf,"classes");
|
||||||
|
FS.ensureDirExists(classesDir);
|
||||||
|
File webxml = new File(webinf,"web.xml");
|
||||||
|
File testWebXml = MavenTestingUtils.getTestResourceFile(testResourceName);
|
||||||
|
IO.copy(testWebXml,webxml);
|
||||||
|
}
|
||||||
|
|
||||||
|
public WebAppContext createWebAppContext() throws MalformedURLException, IOException
|
||||||
|
{
|
||||||
|
WebAppContext context = new WebAppContext();
|
||||||
|
context.setContextPath(this.contextPath);
|
||||||
|
context.setBaseResource(Resource.newResource(this.contextDir));
|
||||||
|
context.setAttribute("org.eclipse.jetty.websocket.jsr356",Boolean.TRUE);
|
||||||
|
|
||||||
|
// @formatter:off
|
||||||
|
context.setConfigurations(new Configuration[] {
|
||||||
|
new AnnotationConfiguration(),
|
||||||
|
new WebXmlConfiguration(),
|
||||||
|
new WebInfConfiguration(),
|
||||||
|
new PlusConfiguration(),
|
||||||
|
new MetaInfConfiguration(),
|
||||||
|
new FragmentConfiguration(),
|
||||||
|
new EnvConfiguration()});
|
||||||
|
// @formatter:on
|
||||||
|
|
||||||
|
return context;
|
||||||
|
}
|
||||||
|
|
||||||
|
public void createWebInf() throws IOException
|
||||||
|
{
|
||||||
|
copyWebInf("empty-web.xml");
|
||||||
|
}
|
||||||
|
|
||||||
|
public void deployWebapp(WebAppContext webapp) throws Exception
|
||||||
|
{
|
||||||
|
contexts.addHandler(webapp);
|
||||||
|
contexts.manage(webapp);
|
||||||
|
webapp.start();
|
||||||
|
if (LOG.isDebugEnabled())
|
||||||
|
{
|
||||||
|
webapp.dump(System.err);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public void dump()
|
||||||
|
{
|
||||||
|
server.dumpStdErr();
|
||||||
|
}
|
||||||
|
|
||||||
|
public URI getServerBaseURI()
|
||||||
|
{
|
||||||
|
return serverUri;
|
||||||
|
}
|
||||||
|
|
||||||
|
public Server getServer()
|
||||||
|
{
|
||||||
|
return server;
|
||||||
|
}
|
||||||
|
|
||||||
|
public File getWebAppDir()
|
||||||
|
{
|
||||||
|
return this.contextDir;
|
||||||
|
}
|
||||||
|
|
||||||
|
public void start() throws Exception
|
||||||
|
{
|
||||||
|
server = new Server();
|
||||||
|
ServerConnector connector = new ServerConnector(server);
|
||||||
|
connector.setPort(0);
|
||||||
|
server.addConnector(connector);
|
||||||
|
|
||||||
|
HandlerCollection handlers = new HandlerCollection();
|
||||||
|
contexts = new ContextHandlerCollection();
|
||||||
|
handlers.addHandler(contexts);
|
||||||
|
server.setHandler(handlers);
|
||||||
|
|
||||||
|
server.start();
|
||||||
|
|
||||||
|
String host = connector.getHost();
|
||||||
|
if (host == null)
|
||||||
|
{
|
||||||
|
host = "localhost";
|
||||||
|
}
|
||||||
|
int port = connector.getLocalPort();
|
||||||
|
serverUri = new URI(String.format("ws://%s:%d%s/",host,port,contextPath));
|
||||||
|
if (LOG.isDebugEnabled())
|
||||||
|
LOG.debug("Server started on {}",serverUri);
|
||||||
|
}
|
||||||
|
|
||||||
|
public void stop()
|
||||||
|
{
|
||||||
|
if (server != null)
|
||||||
|
{
|
||||||
|
try
|
||||||
|
{
|
||||||
|
server.stop();
|
||||||
|
}
|
||||||
|
catch (Exception e)
|
||||||
|
{
|
||||||
|
e.printStackTrace(System.err);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,268 @@
|
||||||
|
//
|
||||||
|
// ========================================================================
|
||||||
|
// Copyright (c) 1995-2016 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.server;
|
||||||
|
|
||||||
|
import static org.hamcrest.Matchers.containsString;
|
||||||
|
import static org.hamcrest.Matchers.notNullValue;
|
||||||
|
import static org.junit.Assert.assertThat;
|
||||||
|
|
||||||
|
import java.io.File;
|
||||||
|
import java.net.URI;
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.EnumSet;
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.concurrent.TimeUnit;
|
||||||
|
|
||||||
|
import javax.servlet.DispatcherType;
|
||||||
|
|
||||||
|
import org.eclipse.jetty.http.pathmap.ServletPathSpec;
|
||||||
|
import org.eclipse.jetty.server.Server;
|
||||||
|
import org.eclipse.jetty.server.ServerConnector;
|
||||||
|
import org.eclipse.jetty.servlet.ServletContextHandler;
|
||||||
|
import org.eclipse.jetty.toolchain.test.EventQueue;
|
||||||
|
import org.eclipse.jetty.toolchain.test.MavenTestingUtils;
|
||||||
|
import org.eclipse.jetty.webapp.WebAppContext;
|
||||||
|
import org.eclipse.jetty.websocket.common.WebSocketFrame;
|
||||||
|
import org.eclipse.jetty.websocket.common.frames.TextFrame;
|
||||||
|
import org.eclipse.jetty.websocket.common.test.BlockheadClient;
|
||||||
|
import org.eclipse.jetty.websocket.servlet.ServletUpgradeRequest;
|
||||||
|
import org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse;
|
||||||
|
import org.eclipse.jetty.websocket.servlet.WebSocketCreator;
|
||||||
|
import org.junit.Test;
|
||||||
|
import org.junit.runner.RunWith;
|
||||||
|
import org.junit.runners.Parameterized;
|
||||||
|
|
||||||
|
@RunWith(Parameterized.class)
|
||||||
|
public class WebSocketUpgradeFilterTest
|
||||||
|
{
|
||||||
|
interface ServerProvider
|
||||||
|
{
|
||||||
|
Server newServer() throws Exception;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Parameterized.Parameters(name = "{0}")
|
||||||
|
public static List<Object[]> data()
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Case A:
|
||||||
|
* 1. embedded-jetty WSUF.configureContext() / app-ws configured at ...
|
||||||
|
* a. during server construction / before server.start (might not be possible with current impl, native SCI not run (yet))
|
||||||
|
* might require NativeSCI.getDefaultFrom() first
|
||||||
|
* b. during server construction / after server.start
|
||||||
|
* c. during server start / via CustomServlet.init()
|
||||||
|
* 2. embedded-jetty WSUF addFilter / app-ws configured at server construction (before server.start)
|
||||||
|
* Case B:
|
||||||
|
* 1. web.xml WSUF / app-ws configured in CustomServlet.init() load-on-start
|
||||||
|
* Case C:
|
||||||
|
* 1. embedded-jetty WSUF.configureContext() / app-ws configured via ServletContextListener.contextInitialized
|
||||||
|
* 2. embedded-jetty WSUF addFilter / app-ws configured via ServletContextListener.contextInitialized
|
||||||
|
* Case D:
|
||||||
|
* 1. web.xml WSUF / app-ws configured via ServletContextListener.contextInitialized
|
||||||
|
*
|
||||||
|
* Every "app-ws configured" means it should access/set ws policy and add ws mappings
|
||||||
|
*/
|
||||||
|
|
||||||
|
final WebSocketCreator infoCreator = new WebSocketCreator()
|
||||||
|
{
|
||||||
|
@Override
|
||||||
|
public Object createWebSocket(ServletUpgradeRequest req, ServletUpgradeResponse resp)
|
||||||
|
{
|
||||||
|
return new InfoSocket();
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
List<Object[]> cases = new ArrayList<>();
|
||||||
|
|
||||||
|
// Embedded WSUF.configureContext(), directly app-ws configuration
|
||||||
|
|
||||||
|
cases.add(new Object[]{"wsuf.configureContext/Direct configure", new ServerProvider()
|
||||||
|
{
|
||||||
|
@Override
|
||||||
|
public Server newServer() throws Exception
|
||||||
|
{
|
||||||
|
Server server = new Server();
|
||||||
|
ServerConnector connector = new ServerConnector(server);
|
||||||
|
connector.setPort(0);
|
||||||
|
server.addConnector(connector);
|
||||||
|
|
||||||
|
ServletContextHandler context = new ServletContextHandler();
|
||||||
|
context.setContextPath("/");
|
||||||
|
server.setHandler(context);
|
||||||
|
|
||||||
|
WebSocketUpgradeFilter wsuf = WebSocketUpgradeFilter.configureContext(context);
|
||||||
|
|
||||||
|
// direct configuration via WSUF
|
||||||
|
wsuf.getFactory().getPolicy().setMaxTextMessageSize(10 * 1024 * 1024);
|
||||||
|
wsuf.addMapping(new ServletPathSpec("/info/*"), infoCreator);
|
||||||
|
|
||||||
|
server.start();
|
||||||
|
return server;
|
||||||
|
}
|
||||||
|
}});
|
||||||
|
|
||||||
|
// Embedded WSUF.configureContext(), apply app-ws configuration via attribute
|
||||||
|
|
||||||
|
cases.add(new Object[]{"wsuf.configureContext/Attribute based configure", new ServerProvider()
|
||||||
|
{
|
||||||
|
@Override
|
||||||
|
public Server newServer() throws Exception
|
||||||
|
{
|
||||||
|
Server server = new Server();
|
||||||
|
ServerConnector connector = new ServerConnector(server);
|
||||||
|
connector.setPort(0);
|
||||||
|
server.addConnector(connector);
|
||||||
|
|
||||||
|
ServletContextHandler context = new ServletContextHandler();
|
||||||
|
context.setContextPath("/");
|
||||||
|
server.setHandler(context);
|
||||||
|
|
||||||
|
WebSocketUpgradeFilter.configureContext(context);
|
||||||
|
|
||||||
|
// configuration via attribute
|
||||||
|
NativeWebSocketConfiguration configuration = (NativeWebSocketConfiguration) context.getServletContext().getAttribute(NativeWebSocketConfiguration.class.getName());
|
||||||
|
assertThat("NativeWebSocketConfiguration", configuration, notNullValue());
|
||||||
|
configuration.getFactory().getPolicy().setMaxTextMessageSize(10 * 1024 * 1024);
|
||||||
|
configuration.addMapping(new ServletPathSpec("/info/*"), infoCreator);
|
||||||
|
|
||||||
|
server.start();
|
||||||
|
|
||||||
|
return server;
|
||||||
|
}
|
||||||
|
}});
|
||||||
|
|
||||||
|
// Embedded WSUF, added as filter, apply app-ws configuration via attribute
|
||||||
|
|
||||||
|
cases.add(new Object[]{"wsuf/addFilter/Attribute based configure", new ServerProvider()
|
||||||
|
{
|
||||||
|
@Override
|
||||||
|
public Server newServer() throws Exception
|
||||||
|
{
|
||||||
|
Server server = new Server();
|
||||||
|
ServerConnector connector = new ServerConnector(server);
|
||||||
|
connector.setPort(0);
|
||||||
|
server.addConnector(connector);
|
||||||
|
|
||||||
|
ServletContextHandler context = new ServletContextHandler();
|
||||||
|
context.setContextPath("/");
|
||||||
|
server.setHandler(context);
|
||||||
|
context.addFilter(WebSocketUpgradeFilter.class, "/*", EnumSet.of(DispatcherType.REQUEST));
|
||||||
|
|
||||||
|
NativeWebSocketConfiguration configuration = new NativeWebSocketConfiguration();
|
||||||
|
configuration.getFactory().getPolicy().setMaxTextMessageSize(10 * 1024 * 1024);
|
||||||
|
configuration.addMapping(new ServletPathSpec("/info/*"), infoCreator);
|
||||||
|
context.getServletContext().setAttribute(NativeWebSocketConfiguration.class.getName(), configuration);
|
||||||
|
|
||||||
|
server.start();
|
||||||
|
|
||||||
|
return server;
|
||||||
|
}
|
||||||
|
}});
|
||||||
|
|
||||||
|
// Embedded WSUF, added as filter, apply app-ws configuration via ServletContextListener
|
||||||
|
|
||||||
|
cases.add(new Object[]{"wsuf.configureContext/ServletContextListener configure", new ServerProvider()
|
||||||
|
{
|
||||||
|
@Override
|
||||||
|
public Server newServer() throws Exception
|
||||||
|
{
|
||||||
|
Server server = new Server();
|
||||||
|
ServerConnector connector = new ServerConnector(server);
|
||||||
|
connector.setPort(0);
|
||||||
|
server.addConnector(connector);
|
||||||
|
|
||||||
|
ServletContextHandler context = new ServletContextHandler();
|
||||||
|
context.setContextPath("/");
|
||||||
|
server.setHandler(context);
|
||||||
|
context.addFilter(WebSocketUpgradeFilter.class, "/*", EnumSet.of(DispatcherType.REQUEST));
|
||||||
|
context.addEventListener(new InfoContextListener());
|
||||||
|
|
||||||
|
server.start();
|
||||||
|
|
||||||
|
return server;
|
||||||
|
}
|
||||||
|
}});
|
||||||
|
|
||||||
|
// WSUF from web.xml, SCI active, apply app-ws configuration via ServletContextListener
|
||||||
|
|
||||||
|
cases.add(new Object[]{"wsuf/WebAppContext/web.xml/ServletContextListener", new ServerProvider()
|
||||||
|
{
|
||||||
|
@Override
|
||||||
|
public Server newServer() throws Exception
|
||||||
|
{
|
||||||
|
File testDir = MavenTestingUtils.getTargetTestingDir("WSUF-webxml");
|
||||||
|
|
||||||
|
WSServer server = new WSServer(testDir, "/");
|
||||||
|
|
||||||
|
server.copyClass(InfoSocket.class);
|
||||||
|
server.copyClass(InfoContextListener.class);
|
||||||
|
server.copyWebInf("wsuf-config-via-listener.xml");
|
||||||
|
server.start();
|
||||||
|
|
||||||
|
WebAppContext webapp = server.createWebAppContext();
|
||||||
|
server.deployWebapp(webapp);
|
||||||
|
|
||||||
|
return server.getServer();
|
||||||
|
}
|
||||||
|
}});
|
||||||
|
|
||||||
|
return cases;
|
||||||
|
}
|
||||||
|
|
||||||
|
private final Server server;
|
||||||
|
private final URI serverUri;
|
||||||
|
|
||||||
|
public WebSocketUpgradeFilterTest(String testId, ServerProvider serverProvider) throws Exception
|
||||||
|
{
|
||||||
|
this.server = serverProvider.newServer();
|
||||||
|
|
||||||
|
ServerConnector connector = (ServerConnector) server.getConnectors()[0];
|
||||||
|
|
||||||
|
// Establish the Server URI
|
||||||
|
String host = connector.getHost();
|
||||||
|
if (host == null)
|
||||||
|
{
|
||||||
|
host = "localhost";
|
||||||
|
}
|
||||||
|
int port = connector.getLocalPort();
|
||||||
|
|
||||||
|
serverUri = new URI(String.format("ws://%s:%d/", host, port));
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void testConfiguration() throws Exception
|
||||||
|
{
|
||||||
|
URI destUri = serverUri.resolve("/info/");
|
||||||
|
|
||||||
|
try (BlockheadClient client = new BlockheadClient(destUri))
|
||||||
|
{
|
||||||
|
client.connect();
|
||||||
|
client.sendStandardRequest();
|
||||||
|
client.expectUpgradeResponse();
|
||||||
|
|
||||||
|
client.write(new TextFrame().setPayload("hello"));
|
||||||
|
|
||||||
|
EventQueue<WebSocketFrame> frames = client.readFrames(1, 1000, TimeUnit.MILLISECONDS);
|
||||||
|
String payload = frames.poll().getPayloadAsUTF8();
|
||||||
|
|
||||||
|
// If we can connect and send a text message, we know that the endpoint was
|
||||||
|
// added properly, and the response will help us verify the policy configuration too
|
||||||
|
assertThat("payload", payload, containsString("session.maxTextMessageSize=" + (10 * 1024 * 1024)));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,22 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<web-app
|
||||||
|
xmlns="http://xmlns.jcp.org/xml/ns/javaee"
|
||||||
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||||
|
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee
|
||||||
|
http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
|
||||||
|
version="3.1">
|
||||||
|
|
||||||
|
<listener>
|
||||||
|
<listener-class>org.eclipse.jetty.websocket.server.InfoContextListener</listener-class>
|
||||||
|
</listener>
|
||||||
|
|
||||||
|
<filter>
|
||||||
|
<filter-name>wsuf</filter-name>
|
||||||
|
<filter-class>org.eclipse.jetty.websocket.server.WebSocketUpgradeFilter</filter-class>
|
||||||
|
</filter>
|
||||||
|
|
||||||
|
<filter-mapping>
|
||||||
|
<filter-name>wsuf</filter-name>
|
||||||
|
<url-pattern>/*</url-pattern>
|
||||||
|
</filter-mapping>
|
||||||
|
</web-app>
|
Loading…
Reference in New Issue