public class WebSocketUpgradeHandlerWrapper extends HandlerWrapper implements MappedWebSocketCreator
AbstractHandler.ErrorDispatchHandler
AbstractLifeCycle.AbstractLifeCycleListener
LifeCycle.Listener
Container.InheritedListener, Container.Listener
Constructor and Description |
---|
WebSocketUpgradeHandlerWrapper(ServletContextHandler context) |
WebSocketUpgradeHandlerWrapper(ServletContextHandler context,
ByteBufferPool bufferPool) |
Modifier and Type | Method and Description |
---|---|
void |
addMapping(PathSpec spec,
WebSocketCreator creator)
Add a mapping.
|
void |
addMapping(PathSpec spec,
WebSocketCreator creator)
Deprecated.
use
addMapping(PathSpec, WebSocketCreator) instead. |
void |
addMapping(String spec,
WebSocketCreator creator)
Add a mapping, of a pathspec to a WebSocketCreator.
|
WebSocketCreator |
getMapping(String target)
/**
Returns the creator for the given path spec.
|
void |
handle(String target,
Request baseRequest,
HttpServletRequest request,
HttpServletResponse response)
Handle a request.
|
boolean |
removeMapping(String spec)
Removes the mapping based on the given path spec.
|
destroy, getHandler, getHandlers, insertHandler, setHandler
findContainerOf, getChildHandlerByClass, getChildHandlers, getChildHandlersByClass, setServer
getServer
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
addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop, toString
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, start, stop, stop
dumpContainer, dumpIterable, dumpMapEntries, dumpObjects, dumpSelf, named
public WebSocketUpgradeHandlerWrapper(ServletContextHandler context)
public WebSocketUpgradeHandlerWrapper(ServletContextHandler context, ByteBufferPool bufferPool)
public void addMapping(PathSpec spec, WebSocketCreator creator)
MappedWebSocketCreator
addMapping
in interface MappedWebSocketCreator
spec
- the path spec to usecreator
- the creator for the mapping@Deprecated public void addMapping(PathSpec spec, WebSocketCreator creator)
addMapping(PathSpec, WebSocketCreator)
instead.addMapping
in interface MappedWebSocketCreator
spec
- the path spec to usecreator
- the creator for the mappingpublic void addMapping(String spec, WebSocketCreator creator)
MappedWebSocketCreator
Recognized Path Spec syntaxes
/path/to
or /
or *.ext
or servlet|{spec}
^{spec}
or regex|{spec}
uri-template|{spec}
addMapping
in interface MappedWebSocketCreator
spec
- the path spec to use.creator
- the websocket creator for this specific mappingpublic boolean removeMapping(String spec)
MappedWebSocketCreator
removeMapping
in interface MappedWebSocketCreator
spec
- the path spec to remove (using the same spec syntax as seen in MappedWebSocketCreator.addMapping(String, WebSocketCreator)
)public WebSocketCreator getMapping(String target)
MappedWebSocketCreator
getMapping
in interface MappedWebSocketCreator
target
- the spec to test for (using the same spec syntax as seen in MappedWebSocketCreator.addMapping(String, WebSocketCreator)
)public void handle(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException
Handler
handle
in interface Handler
handle
in class HandlerWrapper
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.IOException
- if unable to handle the request or response processingServletException
- if unable to handle the request or response due to underlying servlet issueCopyright © 2010 - 2020 Adobe. All Rights Reserved