Package 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, Dumpable.DumpableContainer, LifeCycle

Direct Known Subclasses:

WebSocketHandler.Simple

@Deprecated(since="2021-05-27")
public abstract class WebSocketHandler
extends HandlerWrapper

Deprecated.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WebSocketHandler.Simple	Deprecated. The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.

Nested classes/interfaces inherited from class org.eclipse.jetty.server.handler.AbstractHandler

AbstractHandler.ErrorDispatchHandler

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

Dumpable.DumpableContainer

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

LifeCycle.Listener

Field Summary

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

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Constructor Summary

Constructors

Constructor	Description
WebSocketHandler()	Deprecated.
WebSocketHandler(ByteBufferPool bufferPool)	Deprecated.

Method Summary

Modifier and Type	Method	Description
abstract void	configure(WebSocketServletFactory factory)	Deprecated.
void	configurePolicy(WebSocketPolicy policy)	Deprecated.
WebSocketServletFactory	getWebSocketFactory()	Deprecated.
void	handle(java.lang.String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response)	Deprecated. Handle a request.

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

destroy, getHandler, getHandlers, insertHandler, setHandler

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

findContainerOf, getChildHandlerByClass, getChildHandlers, getChildHandlersByClass, setServer

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

getServer

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

addBean, addBean, addEventListener, addManaged, contains, dump, dump, dump, dump, dump, dumpObject, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, unmanage, updateBean, 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, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

dumpSelf

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer

isDumpable

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

Deprecated.

WebSocketHandler

public WebSocketHandler(ByteBufferPool bufferPool)

Deprecated.

Method Detail

configure

public abstract void configure(WebSocketServletFactory factory)

Deprecated.

configurePolicy

public void configurePolicy(WebSocketPolicy policy)

Deprecated.

getWebSocketFactory

public WebSocketServletFactory getWebSocketFactory()

Deprecated.

handle

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

Deprecated.

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 HttpConnection.getCurrentConnection().getHttpChannel().getRequest() method can be used access the Request object if required.

response - The response as the Response object or a wrapper of that request. The HttpConnection.getCurrentConnection().getHttpChannel().getResponse() method can be used access the Response object if required.

Throws:

java.io.IOException - if unable to handle the request or response processing

ServletException - if unable to handle the request or response due to underlying servlet issue