org.eclipse.jetty.websocket

Class WebSocketHandler

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.AggregateLifeCycle

org.eclipse.jetty.server.handler.AbstractHandler

org.eclipse.jetty.server.handler.AbstractHandlerContainer

org.eclipse.jetty.server.handler.HandlerWrapper

org.eclipse.jetty.websocket.WebSocketHandler

All Implemented Interfaces:

Handler, HandlerContainer, Destroyable, Dumpable, LifeCycle, WebSocketFactory.Acceptor

public abstract class WebSocketHandler
extends HandlerWrapper
implements WebSocketFactory.Acceptor

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

LifeCycle.Listener

Field Summary

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

_handler

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

_listeners, FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor and Description
WebSocketHandler()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkOrigin(javax.servlet.http.HttpServletRequest request, String origin) Checks the origin of an incoming WebSocket handshake request.
WebSocketFactory	getWebSocketFactory()
void	handle(String target, Request baseRequest, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

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

destroy, doStart, doStop, expandChildren, getHandler, getHandlers, getNestedHandlerByClass, setHandler, setServer

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

dump, expandHandler, findContainerOf, getChildHandlerByClass, getChildHandlers, getChildHandlersByClass

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

dumpThis, getServer

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

addBean, addBean, contains, dump, dump, dump, dump, dumpObject, dumpStdErr, getBean, getBeans, getBeans, isManaged, manage, removeBean, removeBeans, unmanage

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

addLifeCycleListener, getState, getState, 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.websocket.WebSocketFactory.Acceptor

doWebSocketConnect

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()

Method Detail

getWebSocketFactory

public WebSocketFactory getWebSocketFactory()

handle

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

Specified by:

handle in interface Handler

Overrides:

handle in class HandlerWrapper

Throws:

IOException

javax.servlet.ServletException

checkOrigin

public boolean checkOrigin(javax.servlet.http.HttpServletRequest request,
                  String origin)

Description copied from interface: WebSocketFactory.Acceptor

Checks the origin of an incoming WebSocket handshake request.

Specified by:

checkOrigin in interface WebSocketFactory.Acceptor

Parameters:

request - the incoming HTTP upgrade request

origin - the origin URI

Returns:

boolean to indicate that the origin is acceptable.