Class JakartaWebSocketServletContainerInitializer

java.lang.Object

org.eclipse.jetty.ee10.websocket.jakarta.server.config.JakartaWebSocketServletContainerInitializer

All Implemented Interfaces:

jakarta.servlet.ServletContainerInitializer

public class JakartaWebSocketServletContainerInitializer
extends Object
implements jakarta.servlet.ServletContainerInitializer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	JakartaWebSocketServletContainerInitializer.Configurator

Field Summary

Fields

Modifier and Type	Field	Description
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
static final String	ENABLE_KEY
static final String	HTTPCLIENT_ATTRIBUTE

Constructor Summary

Constructors

Constructor	Description
JakartaWebSocketServletContainerInitializer()
JakartaWebSocketServletContainerInitializer(JakartaWebSocketServletContainerInitializer.Configurator configurator)

Method Summary

Modifier and Type	Method	Description
static void	configure(ServletContextHandler context, JakartaWebSocketServletContainerInitializer.Configurator configurator)	Configure the ServletContextHandler to call onStartup(Set, ServletContext) during the ServletContext initialization phase.
static jakarta.websocket.server.ServerContainer	initialize(ServletContextHandler context)	Immediately initialize the ServletContext with the default (and empty) ServerContainer.
void	onStartup(Set<Class<?>> c, jakarta.servlet.ServletContext context)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ATTR_JAKARTA_SERVER_CONTAINER

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

ENABLE_KEY

public static final String ENABLE_KEY

See Also:

• Constant Field Values

HTTPCLIENT_ATTRIBUTE

public static final String HTTPCLIENT_ATTRIBUTE

See Also:

• Constant Field Values

Constructor Details

JakartaWebSocketServletContainerInitializer

public JakartaWebSocketServletContainerInitializer()

JakartaWebSocketServletContainerInitializer

public JakartaWebSocketServletContainerInitializer(JakartaWebSocketServletContainerInitializer.Configurator configurator)

Method Details

configure

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

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

Parameters:

context - the context to add listener to

configurator - the lambda that is called to allow the ServerContainer to be configured during the ServletContext initialization phase

initialize

public static jakarta.websocket.server.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 - the context to work with

Returns:

the default ServerContainer for this context

onStartup

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

Specified by:

onStartup in interface jakarta.servlet.ServletContainerInitializer

Throws:

jakarta.servlet.ServletException