- * This performs a subset of the behaviors that {@link #onStartup(Set, ServletContext)} does. + * This method is typically called from {@link #onStartup(Set, ServletContext)} itself or from + * another dependent {@link ServletContainerInitializer} that requires minimal setup to + * be performed. + *
+ *+ * This method SHOULD NOT BE CALLED by users of Jetty. + * Use the {@link #configure(ServletContextHandler, Configurator)} method instead. + *
+ ** There is no enablement check here, and no automatic deployment of endpoints at this point * in time. It merely sets up the {@link ServletContext} so with the basics needed to start * configuring for `javax.websocket.server` based endpoints. @@ -208,7 +216,7 @@ public class WebSocketServerContainerInitializer implements ServletContainerInit // Create Filter if (isEnabledViaContext(context.getServletContext(), ADD_DYNAMIC_FILTER_KEY, true)) { - WebSocketUpgradeFilter.initialize(context); + WebSocketUpgradeFilter.configure(context); } } return serverContainer; diff --git a/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/NativeWebSocketServletContainerInitializer.java b/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/NativeWebSocketServletContainerInitializer.java index 51fdf9b7f3c..fd8d4f7b83e 100644 --- a/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/NativeWebSocketServletContainerInitializer.java +++ b/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/NativeWebSocketServletContainerInitializer.java @@ -38,8 +38,17 @@ public class NativeWebSocketServletContainerInitializer implements ServletContai * Immediately initialize the {@link ServletContextHandler} with the default {@link NativeWebSocketConfiguration}. * *
- * This will return the default {@link NativeWebSocketConfiguration} if already initialized, - * and not create a new {@link NativeWebSocketConfiguration} each time it is called. + * This method is typically called from {@link #onStartup(Set, ServletContext)} itself or from + * another dependent {@link ServletContainerInitializer} that requires minimal setup to + * be performed. + *
+ *+ * This method SHOULD NOT BE CALLED by users of Jetty. + * Use the {@link #configure(ServletContextHandler, Configurator)} method instead. + *
+ *+ * This will return the default {@link NativeWebSocketConfiguration} if already initialized, + * and not create a new {@link NativeWebSocketConfiguration} each time it is called. *
* * @param context the context to work with diff --git a/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.java b/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.java index 7f5613c366f..5aca83bb42d 100644 --- a/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.java +++ b/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.java @@ -55,17 +55,22 @@ public class WebSocketUpgradeFilter implements Filter, MappedWebSocketCreator, D public static final String ATTR_KEY = WebSocketUpgradeFilter.class.getName(); /** - * Immediately initialize the default WebSocketUpgradeFilter. + * Configure the default WebSocketUpgradeFilter. * *- * Return default {@link WebSocketUpgradeFilter} if + * This will return the default {@link WebSocketUpgradeFilter} on the + * provided {@link ServletContextHandler}, creating the filter if necessary. + *
+ *+ * The default {@link WebSocketUpgradeFilter} is also available via + * the {@link ServletContext} attribute named {@code org.eclipse.jetty.websocket.server.WebSocketUpgradeFilter} *
* * @param context the {@link ServletContextHandler} to use * @return the configured default {@link WebSocketUpgradeFilter} instance * @throws ServletException if the filer cannot be configured */ - public static WebSocketUpgradeFilter initialize(ServletContextHandler context) throws ServletException + public static WebSocketUpgradeFilter configure(ServletContextHandler context) throws ServletException { // Prevent double configure WebSocketUpgradeFilter filter = (WebSocketUpgradeFilter) context.getAttribute(ATTR_KEY); @@ -100,12 +105,12 @@ public class WebSocketUpgradeFilter implements Filter, MappedWebSocketCreator, D * @param context the {@link ServletContextHandler} to use * @return a configured {@link WebSocketUpgradeFilter} instance * @throws ServletException if the filer cannot be configured - * @deprecated use {@link #initialize(ServletContextHandler)} instead + * @deprecated use {@link #configure(ServletContextHandler)} instead */ @Deprecated public static WebSocketUpgradeFilter configureContext(ServletContextHandler context) throws ServletException { - return initialize(context); + return configure(context); } /** @@ -122,7 +127,7 @@ public class WebSocketUpgradeFilter implements Filter, MappedWebSocketCreator, D { throw new ServletException("Not running on Jetty, WebSocket support unavailable"); } - return initialize(handler); + return configure(handler); } private NativeWebSocketConfiguration configuration;