org.eclipse.jetty.websocket.server

Class WebSocketHandler

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.server.handler.AbstractHandler

org.eclipse.jetty.server.handler.AbstractHandlerContainer

org.eclipse.jetty.server.handler.HandlerWrapper

org.eclipse.jetty.websocket.server.WebSocketHandler

All Implemented Interfaces:

Handler, HandlerContainer, Container, Destroyable, Dumpable, LifeCycle

Direct Known Subclasses:

WebSocketHandler.Simple

public abstract class WebSocketHandler
extends HandlerWrapper

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebSocketHandler.Simple Create a simple WebSocketHandler that registers a single WebSocket POJO that is created on every upgrade request.

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.LifeCycle

LifeCycle.Listener

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

Container.InheritedListener, Container.Listener

Field Summary

Fields inherited from class org.eclipse.jetty.server.handler.HandlerWrapper

_handler

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

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor and Description
WebSocketHandler()
WebSocketHandler(ByteBufferPool bufferPool)

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	configure(WebSocketServletFactory factory)
void	configurePolicy(WebSocketPolicy policy)
protected void	doStart() Starts the managed lifecycle beans in the order they were added.
WebSocketServletFactory	getWebSocketFactory()
void	handle(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response) Handle a request.

Methods inherited from class org.eclipse.jetty.server.handler.HandlerWrapper

destroy, expandChildren, getHandler, getHandlers, setHandler, setServer

Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandlerContainer

expandHandler, findContainerOf, getChildHandlerByClass, getChildHandlers, getChildHandlersByClass

Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandler

doStop, dumpThis, getServer

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

addBean, addBean, addBean, addEventListener, addManaged, contains, dump, dump, dump, dump, dump, dumpBeans, dumpObject, dumpStdErr, 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, toString, wait, wait, wait

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

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

Constructor Detail

WebSocketHandler

public WebSocketHandler()

WebSocketHandler

public WebSocketHandler(ByteBufferPool bufferPool)

Method Detail

configure

public abstract void configure(WebSocketServletFactory factory)

configurePolicy

public void configurePolicy(WebSocketPolicy policy)

doStart

protected void doStart()
                throws Exception

Description copied from class: ContainerLifeCycle

Starts the managed lifecycle beans in the order they were added.

Overrides:

doStart in class AbstractHandler

Throws:

Exception

getWebSocketFactory

public WebSocketServletFactory getWebSocketFactory()

handle

public void handle(String target,
          Request baseRequest,
          HttpServletRequest request,
          HttpServletResponse response)
            throws IOException,
                   ServletException

Description copied from interface: Handler

Handle a request.

Specified by:

handle in interface Handler

Overrides:

handle in class HandlerWrapper

Parameters:

target - The target of the request - either a URI or a name.

baseRequest - The original unwrapped request object.

request - The request either as the Request object or a wrapper of that request. The HttpChannel.getCurrentHttpChannel() method can be used access the Request object if required.

response - The response as the Response object or a wrapper of that request. The HttpChannel.getCurrentHttpChannel() method can be used access the Response object if required.

Throws:

IOException

ServletException