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, org.eclipse.jetty.util.component.Container, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.LifeCycle, MappedWebSocketCreator

public class WebSocketUpgradeHandlerWrapper
extends HandlerWrapper
implements MappedWebSocketCreator

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener

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

org.eclipse.jetty.util.component.LifeCycle.Listener

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

org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.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
WebSocketUpgradeHandlerWrapper()
WebSocketUpgradeHandlerWrapper(org.eclipse.jetty.io.ByteBufferPool bufferPool)

Method Summary

Methods

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.
PathMappings<WebSocketCreator>	getMappings() Get all of the PathMappings declared.
void	handle(String target, Request baseRequest, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
boolean	removeMapping(String spec) Removes the mapping based on the given path spec.

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

doStart, 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

WebSocketUpgradeHandlerWrapper

public WebSocketUpgradeHandlerWrapper()

WebSocketUpgradeHandlerWrapper

public WebSocketUpgradeHandlerWrapper(org.eclipse.jetty.io.ByteBufferPool bufferPool)

Method Detail

addMapping

public void addMapping(PathSpec spec,
              WebSocketCreator creator)

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)

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)

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

getMappings

public PathMappings<WebSocketCreator> getMappings()

Description copied from interface: MappedWebSocketCreator

Get all of the PathMappings declared.

Specified by:

getMappings in interface MappedWebSocketCreator

Returns:

the PathMappings

getMapping

public WebSocketCreator getMapping(String target)

Description copied from interface: MappedWebSocketCreator

Returns the creator for the given path spec.

Specified by:

getMapping in interface MappedWebSocketCreator

Parameters:

target - @param spec 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,
          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