Issue #3661 - review of exposed classes in jetty-websocket-server

[lachlan-roberts]

Issue #3661

removing any exposed classes from websocket-common and websocket-servlet in the jetty-websocket-server package

added javadoc for JettyWebSocketServletFactory

[gregw]

@lachlan-roberts I bit more description would be useful on this one, as I'd like to get feedback from @janbartel @sbordet @joakime on what we did here.

The org.eclipse.jetty.websocket.server contains 3 types of classes:

• ones that implement the jetty API and are exposed to the webapp (eg JettyWebSocketServlet)
• those that are internal implementation classes (eg UpgradeResponseAdapter) put in the internal sub package, which is hidden from the webapp.
• Those that are needed by a user to configure, but not exposed to the webapp (eg JettyWebSocketConfiguration and JettyWebSocketServletContainerInitializer), which this PR moves to a config sub package, which is hidden from the webapp.

So firstly @lachlan-roberts can you verify that you have got this right with no common or core classes in the webapp API by looking at the OSGi headers in the generated manifest for the jar. The exports clause for org.eclipse.jetty.websocket.server should have no uses clauses on it for config or internal. @janbartel, I'm guessing it will still export internal and config, so how do we stop that? @sbordet ditto for JPMS? OR should it export config ??

Should the SCI and Configuration just be in internal? They are both mainly discovered with SystemLoader?

[lachlan-roberts]

@gregw
This is what the MANIFEST file looks like at the moment:

Export-Package: 
org.eclipse.jetty.websocket.server.config;
uses:="
javax.servlet,
org.eclipse.jetty.servlet,
org.eclipse.jetty.webapp,
org.eclipse.jetty.websocket.server";
version="10.0.0",

org.eclipse.jetty.websocket.server;
uses:="
javax.servlet,
javax.servlet.http,
org.eclipse.jetty.util.component,
org.eclipse.jetty.websocket.api,
org.eclipse.jetty.websocket.api.extensions,
org.eclipse.jetty.websocket.common,
org.eclipse.jetty.websocket.servlet";
version="10.0.0"

there is a few packages that we still don't want, I think these are here because we are exposing classes which extend classes from these packages.

org.eclipse.jetty.util.component,
org.eclipse.jetty.websocket.common
org.eclipse.jetty.websocket.servlet

these classes are JettyWebSocketServerContainer which extends ContainerLifeCycle and implements org.eclipse.jetty.websocket.common.WebSocketContainer
and JettyWebSocketServlet extends org.eclipse.jetty.websocket.servlet.WebSocketServlet

[gregw]

LGTM