Bug 56025

Summary: Order of invocation of method of ServerEndpointConfig.Configurator
Product: Tomcat 8 Reporter: Simone Bordet <simone.bordet>
Component: WebSocketAssignee: Tomcat Developers Mailing List <dev>
Severity: normal CC: ckellner
Priority: P2    
Version: 8.0.x-trunk   
Target Milestone: ----   
Hardware: PC   
OS: Linux   

Description Simone Bordet 2014-01-17 08:23:30 UTC
The current order of invocation (from http://svn.apache.org/repos/asf/tomcat/trunk/java/org/apache/tomcat/websocket/server/UpgradeUtil.java) is:


JSR 356 is guilty for not specifying this order, but I believe a different order is more useful. 
Below I refer to "the application" as a subclass of the ServerEndpointConfig.Configurator implemented by end users.
I'd like to propose this new order:

modifyHandshake() as first: this allows applications to query/store information about the upgrade request (for example, the URI);

checkOrigin() as second: this allows applications to check the origin with more information available, because the request/response are available from the previous call and therefore checks of the origin against the request URI and/or other HTTP headers will be possible;

getNegotiatedSubprotocol() as third: this should be always invoked, while right now it is not invoked if the client does not specify the Sec-WebSocket-Protocol header; this is not ideal since the server may have been configured with a sub-protocol, but the application is never called to check what the client has sent;

getEndPointInstance() as last: there is no point in creating the endpoint if the other methods returned a failure, nor there is point to invoke any other method if this one returned null.

The current order also does not invoke method getNegotiatedExtensions(), but as far as I understand extensions are not yet supported.
I believe this method should be eventually invoked as fourth, before getEndPointInstance().

Thanks !
Comment 1 Mark Thomas 2014-01-17 11:41:41 UTC
JSR356 specifies at least some of the order. Unfortunately, JSRs have a nasty habit (one I have tried and failed to stop) of splitting information between the spec doc and the Javadoc. You have to read both.
The Javadoc for ServerEndpointConfig.Configurator.modifyHandshake() has some information on ordering. It requires that modifyHandshake() is called after checkOrigin(), getNegotiatedExtensions() and getNegotiatedSubprotocol()

The discussion on this topic on the EG mailing list did mention getEndpointInstance() happening after modifyHandshake() and I agree that makes sense.

I also agree that getNegotiatedSubprotocol() should always be called.

You are correct that Tomcat doesn't support any extensions at the moment. That said, I hope to be adding compression support so I'll add the call to getNegotiatedExtensions() while I am making changes here.
Comment 2 Mark Thomas 2014-01-17 12:00:21 UTC
Fixed in trunk for 8.0.0. I opted not to add the extension header handling as that requires a little more work to parse the headers.

I also back-ported the changes to 7.0.x for 7.0.51 onwards.