Package org.eclipse.jetty.websocket.jsr356.server.deploy

Class WebSocketServerContainerInitializer

java.lang.Object

org.eclipse.jetty.websocket.jsr356.server.deploy.WebSocketServerContainerInitializer

All Implemented Interfaces:

javax.servlet.ServletContainerInitializer

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WebSocketServerContainerInitializer.ContextDestroyListener	DestroyListener

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ADD_DYNAMIC_FILTER_KEY
static java.lang.String	ENABLE_KEY
static java.lang.String	HTTPCLIENT_ATTRIBUTE

Constructor Summary

Constructors

Constructor	Description
WebSocketServerContainerInitializer()

Method Summary

Modifier and Type	Method	Description
static ServerContainer	configureContext(javax.servlet.ServletContext context, ServletContextHandler jettyContext)	Deprecated. use configureContext(ServletContextHandler) instead
static ServerContainer	configureContext(ServletContextHandler context)	Embedded Jetty approach for non-bytecode scanning.
static boolean	isEnabledViaContext(javax.servlet.ServletContext context, java.lang.String keyName, boolean defValue)	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).
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

ENABLE_KEY

public static final java.lang.String ENABLE_KEY

See Also:

Constant Field Values

ADD_DYNAMIC_FILTER_KEY

public static final java.lang.String ADD_DYNAMIC_FILTER_KEY

See Also:

Constant Field Values

HTTPCLIENT_ATTRIBUTE

public static final java.lang.String HTTPCLIENT_ATTRIBUTE

See Also:

Constant Field Values

Constructor Detail

WebSocketServerContainerInitializer

public WebSocketServerContainerInitializer()

Method Detail

isEnabledViaContext

public static boolean isEnabledViaContext(javax.servlet.ServletContext context,
                                          java.lang.String keyName,
                                          boolean defValue)

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 - the context to search

keyName - the key name

defValue - the default value, if the value is not specified in the context

Returns:

the value for the feature key

configureContext

public static ServerContainer configureContext(ServletContextHandler context)
                                        throws javax.servlet.ServletException

Embedded Jetty approach for non-bytecode scanning.

Parameters:

context - the ServletContextHandler to use

Returns:

a configured ServerContainer instance

Throws:

javax.servlet.ServletException - if the WebSocketUpgradeFilter cannot be configured

configureContext

@Deprecated
public static ServerContainer configureContext(javax.servlet.ServletContext context,
                                               ServletContextHandler jettyContext)
                                        throws javax.servlet.ServletException

Deprecated.

use configureContext(ServletContextHandler) instead

Parameters:

context - not used

jettyContext - the ServletContextHandler to use

Returns:

a configured ServerContainer instance

Throws:

javax.servlet.ServletException - if the WebSocketUpgradeFilter cannot be configured

onStartup

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

Specified by:

onStartup in interface javax.servlet.ServletContainerInitializer

Throws:

javax.servlet.ServletException