Nested and Inner Type Summary

Modifier and Type	Class and Description
public static interface	JakartaWebSocketServletContainerInitializer.Configurator

Field Summary

Modifier and Type	Field and Description
public static final String	ATTR_JAKARTA_SERVER_CONTAINER The ServletContext attribute key name for the ServerContainer per jakarta.websocket spec 1.0 final section 6.4 Programmatic Server Deployment
private final JakartaWebSocketServletContainerInitializer.Configurator	configurator
public static final String	ENABLE_KEY
public static final String	HTTPCLIENT_ATTRIBUTE
private static final Logger	LOG

Access	Constructor and Description
public	JakartaWebSocketServletContainerInitializer()
public	JakartaWebSocketServletContainerInitializer(JakartaWebSocketServletContainerInitializer.Configurator configurator)

Method Summary

Modifier and Type	Method and Description
public static void	configure(ServletContextHandler the context to add listener to context, JakartaWebSocketServletContainerInitializer.Configurator the lambda that is called to allow the `ServerContainer` to be configured during the `ServletContext` initialization phase configurator) Configure the `ServletContextHandler` to call `JakartaWebSocketServletContainerInitializer#onStartup(Set, ServletContext)` during the `ServletContext` initialization phase.
private void	filterClasses(Set<Class<?>> c, Set<Class<? extends Endpoint>> discoveredExtendedEndpoints, Set<Class<?>> discoveredAnnotatedEndpoints, Set<Class<? extends ServerApplicationConfig>> serverAppConfigs)
public static ServerContainer	Returns: the default `ServerContainer` for this context initialize(ServletContextHandler the context to work with context) Immediately initialize the `ServletContext` with the default (and empty) `ServerContainer`.
private static Boolean	Returns: the value for the feature key, otherwise null if key is not set in context isEnabledViaContext(ServletContext the context to search context, String the key name keyName) Test a ServletContext for `init-param` or `attribute` at `keyName` for true or false setting that determines if the specified feature is enabled (or not).
public void	onStartup(Set<Class<?>> the Set of application classes that extend, implement, or have been annotated with the class types specified by the `HandlesTypes` annotation, or `null` if there are no matches, or this `ServletContainerInitializer` has not been annotated with `HandlesTypes` c, ServletContext the `ServletContext` of the web application that is being started and in which the classes contained in `c` were found context) Implements jakarta.servlet.ServletContainerInitializer.onStartup. Notifies this `ServletContainerInitializer` of the startup of the application represented by the given `ServletContext`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ATTR_JAKARTA_SERVER_CONTAINER	back to summary
public static final String ATTR_JAKARTA_SERVER_CONTAINER The ServletContext attribute key name for the ServerContainer per jakarta.websocket spec 1.0 final section 6.4 Programmatic Server Deployment

configurator	back to summary
private final JakartaWebSocketServletContainerInitializer.Configurator configurator

ENABLE_KEY	back to summary
public static final String ENABLE_KEY

HTTPCLIENT_ATTRIBUTE	back to summary
public static final String HTTPCLIENT_ATTRIBUTE

LOG	back to summary
private static final Logger LOG

Constructor Detail

JakartaWebSocketServletContainerInitializer	back to summary
public JakartaWebSocketServletContainerInitializer()

JakartaWebSocketServletContainerInitializer	back to summary
public JakartaWebSocketServletContainerInitializer(JakartaWebSocketServletContainerInitializer.Configurator configurator)

Method Detail

configure back to summary

configure	back to summary
public static void configure(ServletContextHandler context, JakartaWebSocketServletContainerInitializer.Configurator configurator) Configure the `ServletContextHandler` to call `JakartaWebSocketServletContainerInitializer#onStartup(Set, ServletContext)` during the `ServletContext` initialization phase. Parameters context:ServletContextHandler the context to add listener to configurator:JakartaWebSocketServletContainerInitializer.Configurator the lambda that is called to allow the `ServerContainer` to be configured during the `ServletContext` initialization phase

public static void configure(ServletContextHandler context, JakartaWebSocketServletContainerInitializer.Configurator configurator)

Configure the ServletContextHandler to call JakartaWebSocketServletContainerInitializer#onStartup(Set, ServletContext) during the ServletContext initialization phase.

Parameters

context:ServletContextHandler: the context to add listener to
configurator:JakartaWebSocketServletContainerInitializer.Configurator: the lambda that is called to allow the ServerContainer to be configured during the ServletContext initialization phase

filterClasses	back to summary
private void filterClasses(Set<Class<?>> c, Set<Class<? extends Endpoint>> discoveredExtendedEndpoints, Set<Class<?>> discoveredAnnotatedEndpoints, Set<Class<? extends ServerApplicationConfig>> serverAppConfigs) Annotations @SuppressWarnings:unchecked

initialize back to summary

initialize	back to summary
public static ServerContainer initialize(ServletContextHandler context) Immediately initialize the `ServletContext` with the default (and empty) `ServerContainer`. This method is typically called from `onStartup(Set, ServletContext)` itself or from another dependent `ServletContainerInitializer` that requires minimal setup to be performed. Users of Jetty should use the `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 `ServletContext` so with the basics needed to start configuring for `jakarta.websocket.server` based endpoints. Parameters context:ServletContextHandler the context to work with Returns:ServerContainer the default `ServerContainer` for this context

public static ServerContainer initialize(ServletContextHandler context)

Immediately initialize the ServletContext with the default (and empty) ServerContainer.

This method is typically called from onStartup(Set, ServletContext) itself or from another dependent ServletContainerInitializer that requires minimal setup to be performed.

Users of Jetty should use the 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 ServletContext so with the basics needed to start configuring for `jakarta.websocket.server` based endpoints.

Parameters

context:ServletContextHandler: the context to work with

Returns:ServerContainer

the default ServerContainer for this context

isEnabledViaContext back to summary

isEnabledViaContext	back to summary
private static Boolean isEnabledViaContext(ServletContext context, String keyName) Test a ServletContext for `init-param` or `attribute` at `keyName` for true or false setting that determines if the specified feature is enabled (or not). Parameters context:ServletContext the context to search keyName:String the key name Returns:Boolean the value for the feature key, otherwise null if key is not set in context

private static Boolean isEnabledViaContext(ServletContext context, String keyName)

Test a ServletContext for init-param or attribute at keyName for true or false setting that determines if the specified feature is enabled (or not).

Parameters

context:ServletContext: the context to search
keyName:String: the key name

Returns:Boolean

the value for the feature key, otherwise null if key is not set in context

onStartup back to summary

onStartup	back to summary
public void onStartup(Set<Class<?>> c, ServletContext context) throws ServletException Implements jakarta.servlet.ServletContainerInitializer.onStartup. Doc from jakarta.servlet.ServletContainerInitializer.onStartup. Notifies this `ServletContainerInitializer` of the startup of the application represented by the given `ServletContext`. If this `ServletContainerInitializer` is bundled in a JAR file inside the `WEB-INF/lib` directory of an application, its `onStartup` method will be invoked only once during the startup of the bundling application. If this `ServletContainerInitializer` is bundled inside a JAR file outside of any `WEB-INF/lib` directory, but still discoverable as described above, its `onStartup` method will be invoked every time an application is started. Parameters c:Set<Class<?>> the Set of application classes that extend, implement, or have been annotated with the class types specified by the `HandlesTypes` annotation, or `null` if there are no matches, or this `ServletContainerInitializer` has not been annotated with `HandlesTypes` context:ServletContext the `ServletContext` of the web application that is being started and in which the classes contained in `c` were found Annotations @Override Exceptions ServletException: if an error has occurred

public void onStartup(Set<Class<?>> c, ServletContext context) throws ServletException

Implements jakarta.servlet.ServletContainerInitializer.onStartup.

Doc from jakarta.servlet.ServletContainerInitializer.onStartup.

Notifies this ServletContainerInitializer of the startup of the application represented by the given ServletContext.

If this ServletContainerInitializer is bundled in a JAR file inside the WEB-INF/lib directory of an application, its onStartup method will be invoked only once during the startup of the bundling application. If this ServletContainerInitializer is bundled inside a JAR file outside of any WEB-INF/lib directory, but still discoverable as described above, its onStartup method will be invoked every time an application is started.

Parameters

c:Set<Class<?>>: the Set of application classes that extend, implement, or have been annotated with the class types specified by the HandlesTypes annotation, or null if there are no matches, or this ServletContainerInitializer has not been annotated with HandlesTypes
context:ServletContext: the ServletContext of the web application that is being started and in which the classes contained in c were found

Annotations

@Override

Exceptions

ServletException:: if an error has occurred

org.eclipse.jetty.ee10.websocket.jakarta.server.config back to summary

public Interface JakartaWebSocketServletContainerInitializer.Configurator

Method Summary

Modifier and Type	Method and Description
public void	accept(ServletContext servletContext, ServerContainer serverContainer)

Method Detail

accept	back to summary
public void accept(ServletContext servletContext, ServerContainer serverContainer) throws DeploymentException

public Class JakartaWebSocketServletContainerInitializer

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface JakartaWebSocketServletContainerInitializer.Configurator

Method Summary

Method Detail