Package org.eclipse.jetty.websocket.server

Class NativeWebSocketServletContainerInitializer

java.lang.Object

org.eclipse.jetty.websocket.server.NativeWebSocketServletContainerInitializer

All Implemented Interfaces:

javax.servlet.ServletContainerInitializer

public class NativeWebSocketServletContainerInitializer
extends java.lang.Object
implements javax.servlet.ServletContainerInitializer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	NativeWebSocketServletContainerInitializer.Configurator

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ATTR_KEY

Constructor Summary

Constructors

Constructor	Description
NativeWebSocketServletContainerInitializer()

Method Summary

Modifier and Type	Method	Description
static void	configure(ServletContextHandler context, NativeWebSocketServletContainerInitializer.Configurator configurator)	Configure the ServletContextHandler to call the NativeWebSocketServletContainerInitializer during the ServletContext initialization phase.
static NativeWebSocketConfiguration	getDefaultFrom(javax.servlet.ServletContext context)	Deprecated. use configure(ServletContextHandler, Configurator) instead
static NativeWebSocketConfiguration	initialize(ServletContextHandler context)	Immediately initialize the ServletContextHandler with the default NativeWebSocketConfiguration.
void	onStartup(java.util.Set<java.lang.Class<?>> c, javax.servlet.ServletContext context)

Methods inherited from class java.lang.Object

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

Field Detail

ATTR_KEY

public static final java.lang.String ATTR_KEY

Constructor Detail

NativeWebSocketServletContainerInitializer

public NativeWebSocketServletContainerInitializer()

Method Detail

initialize

public static NativeWebSocketConfiguration initialize(ServletContextHandler context)

Immediately initialize the ServletContextHandler with the default NativeWebSocketConfiguration.

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

This method SHOULD NOT BE CALLED by users of Jetty. Use the configure(ServletContextHandler, Configurator) method instead.

This will return the default NativeWebSocketConfiguration if already initialized, and not create a new NativeWebSocketConfiguration each time it is called.

Parameters:

context - the context to work with

Returns:

the default NativeWebSocketConfiguration

configure

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

Configure the ServletContextHandler to call the NativeWebSocketServletContainerInitializer during the ServletContext initialization phase.

Parameters:

context - the context to add listener to.

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

getDefaultFrom

@Deprecated
public static NativeWebSocketConfiguration getDefaultFrom(javax.servlet.ServletContext context)

Deprecated.

use configure(ServletContextHandler, Configurator) instead

Obtain the default NativeWebSocketConfiguration from the ServletContext

Parameters:

context - the context to work with

Returns:

the default NativeWebSocketConfiguration

See Also:

configure(ServletContextHandler, Configurator)

onStartup

public void onStartup(java.util.Set<java.lang.Class<?>> c,
                      javax.servlet.ServletContext context)

Specified by:

onStartup in interface javax.servlet.ServletContainerInitializer