org.eclipse.jetty.websocket.server

Class WebSocketUpgradeFilter

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.websocket.server.WebSocketUpgradeFilter

All Implemented Interfaces:

Filter, Container, Destroyable, Dumpable, LifeCycle, MappedWebSocketCreator

@ManagedObject(value="WebSocket Upgrade Filter")
public class WebSocketUpgradeFilter
extends ContainerLifeCycle
implements Filter, MappedWebSocketCreator, Dumpable

Inline Servlet Filter to capture WebSocket upgrade requests and perform path mappings to WebSocketCreator objects.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

Container.InheritedListener, Container.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

LifeCycle.Listener

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTEXT_ATTRIBUTE_KEY

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor and Description
WebSocketUpgradeFilter()
WebSocketUpgradeFilter(WebSocketPolicy policy, ByteBufferPool bufferPool)

Method Summary

Methods

Modifier and Type	Method and Description
void	addMapping(PathSpec spec, WebSocketCreator creator)
static WebSocketUpgradeFilter	configureContext(ServletContext context)
static WebSocketUpgradeFilter	configureContext(ServletContextHandler context)
void	destroy()
void	doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
String	dump()
void	dump(Appendable out, String indent)
WebSocketServerFactory	getFactory()
PathMappings<WebSocketCreator>	getMappings()
void	init(FilterConfig config)
void	setToAttribute(ServletContext context, String key)
String	toString()

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

addBean, addBean, addBean, addEventListener, addManaged, contains, doStart, doStop, dump, dump, dump, dumpBeans, dumpObject, dumpStdErr, dumpThis, getBean, getBeans, getBeans, isManaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBeans

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

Methods inherited from class java.lang.Object

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

Field Detail

CONTEXT_ATTRIBUTE_KEY

public static final String CONTEXT_ATTRIBUTE_KEY

See Also:

Constant Field Values

Constructor Detail

WebSocketUpgradeFilter

public WebSocketUpgradeFilter()

WebSocketUpgradeFilter

public WebSocketUpgradeFilter(WebSocketPolicy policy,
                      ByteBufferPool bufferPool)

Method Detail

configureContext

public static WebSocketUpgradeFilter configureContext(ServletContextHandler context)
                                               throws ServletException

Throws:

ServletException

configureContext

public static WebSocketUpgradeFilter configureContext(ServletContext context)
                                               throws ServletException

Throws:

ServletException

addMapping

public void addMapping(PathSpec spec,
              WebSocketCreator creator)

Specified by:

addMapping in interface MappedWebSocketCreator

destroy

public void destroy()

Specified by:

destroy in interface Filter

Specified by:

destroy in interface Destroyable

Overrides:

destroy in class ContainerLifeCycle

doFilter

public void doFilter(ServletRequest request,
            ServletResponse response,
            FilterChain chain)
              throws IOException,
                     ServletException

Specified by:

doFilter in interface Filter

Throws:

IOException

ServletException

dump

public String dump()

Specified by:

dump in interface Dumpable

Overrides:

dump in class ContainerLifeCycle

dump

public void dump(Appendable out,
        String indent)
          throws IOException

Specified by:

dump in interface Dumpable

Overrides:

dump in class ContainerLifeCycle

Throws:

IOException

getFactory

public WebSocketServerFactory getFactory()

getMappings

@ManagedAttribute(value="mappings",
                  readonly=true)
public PathMappings<WebSocketCreator> getMappings()

Specified by:

getMappings in interface MappedWebSocketCreator

init

public void init(FilterConfig config)
          throws ServletException

Specified by:

init in interface Filter

Throws:

ServletException

setToAttribute

public void setToAttribute(ServletContext context,
                  String key)
                    throws ServletException

Throws:

ServletException

toString

public String toString()

Overrides:

toString in class Object