Package org.eclipse.jetty.websocket.server

Class WebSocketUpgradeHandlerWrapper

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

All Implemented Interfaces:

Handler, HandlerContainer, Container, Destroyable, Dumpable, Dumpable.DumpableContainer, LifeCycle, MappedWebSocketCreator

@Deprecated(since="2021-05-27")
public class WebSocketUpgradeHandlerWrapper
extends HandlerWrapper
implements MappedWebSocketCreator

Deprecated.

Nested Class Summary

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
WebSocketUpgradeHandlerWrapper(ServletContextHandler context)	Deprecated.
WebSocketUpgradeHandlerWrapper(ServletContextHandler context, ByteBufferPool bufferPool)	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	addMapping(String spec, WebSocketCreator creator)	Deprecated. Add a mapping, of a pathspec to a WebSocketCreator.
void	addMapping(PathSpec spec, WebSocketCreator creator)	Deprecated. Add a mapping.
void	addMapping(PathSpec spec, WebSocketCreator creator)	Deprecated. use addMapping(PathSpec, WebSocketCreator) instead.
WebSocketCreator	getMapping(String target)	Deprecated. /** Returns the creator for the given path spec.
void	handle(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response)	Deprecated. Handle a request.
boolean	removeMapping(String spec)	Deprecated. Removes the mapping based on the given path spec.

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

WebSocketUpgradeHandlerWrapper

public WebSocketUpgradeHandlerWrapper(ServletContextHandler context)

Deprecated.

WebSocketUpgradeHandlerWrapper

public WebSocketUpgradeHandlerWrapper(ServletContextHandler context,
                                      ByteBufferPool bufferPool)

Deprecated.

Method Detail

addMapping

public void addMapping(PathSpec spec,
                       WebSocketCreator creator)

Deprecated.

Description copied from interface: MappedWebSocketCreator

Add a mapping.

Specified by:

addMapping in interface MappedWebSocketCreator

Parameters:

spec - the path spec to use

creator - the creator for the mapping

addMapping

@Deprecated
public void addMapping(PathSpec spec,
                       WebSocketCreator creator)

Deprecated.

use addMapping(PathSpec, WebSocketCreator) instead.

Add a mapping.

Specified by:

addMapping in interface MappedWebSocketCreator

Parameters:

spec - the path spec to use

creator - the creator for the mapping

addMapping

public void addMapping(String spec,
                       WebSocketCreator creator)

Deprecated.

Description copied from interface: MappedWebSocketCreator

Add a mapping, of a pathspec to a WebSocketCreator.

Recognized Path Spec syntaxes

/path/to or / or *.ext or servlet|{spec}

Servlet Syntax

^{spec} or regex|{spec}

Regex Syntax

uri-template|{spec}

URI Template (see JSR356 and RFC6570 level 1)

Specified by:

addMapping in interface MappedWebSocketCreator

Parameters:

spec - the path spec to use.

creator - the websocket creator for this specific mapping

removeMapping

public boolean removeMapping(String spec)

Deprecated.

Description copied from interface: MappedWebSocketCreator

Removes the mapping based on the given path spec.

Specified by:

removeMapping in interface MappedWebSocketCreator

Parameters:

spec - the path spec to remove (using the same spec syntax as seen in MappedWebSocketCreator.addMapping(String, WebSocketCreator))

Returns:

true if underlying mapping were altered, false otherwise

getMapping

public WebSocketCreator getMapping(String target)

Deprecated.

Description copied from interface: MappedWebSocketCreator

/** Returns the creator for the given path spec.

Specified by:

getMapping in interface MappedWebSocketCreator

Parameters:

target - the spec to test for (using the same spec syntax as seen in MappedWebSocketCreator.addMapping(String, WebSocketCreator))

Returns:

the websocket creator if path spec exists, or null

handle

public void handle(String target,
                   Request baseRequest,
                   HttpServletRequest request,
                   HttpServletResponse response)
            throws 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:

IOException - if unable to handle the request or response processing

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