Module org.eclipse.jetty.websocket.servlet

Package org.eclipse.jetty.websocket.servlet

Class WebSocketMapping

java.lang.Object

org.eclipse.jetty.websocket.servlet.WebSocketMapping

All Implemented Interfaces:

java.util.EventListener, Dumpable, LifeCycle.Listener

public class WebSocketMapping
extends java.lang.Object
implements Dumpable, LifeCycle.Listener

Mapping of pathSpec to a tupple of WebSocketCreator, FrameHandlerFactory and Configuration.Customizer.

When the upgrade(HttpServletRequest, HttpServletResponse, Configuration.Customizer) method is called, a match for the pathSpec is looked for. If one is found then the creator is used to create a POJO for the WebSocket endpoint, the factory is used to wrap that POJO with a FrameHandler and the customizer is used to configure the resulting CoreSession.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_KEY

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

KEY

Constructor Summary

Constructors

Constructor	Description
WebSocketMapping()
WebSocketMapping(WebSocketComponents components)

Method Summary

Modifier and Type	Method	Description
void	addMapping(PathSpec pathSpec, WebSocketCreator creator, FrameHandlerFactory factory, Configuration.Customizer customizer)	Manually add a WebSocket mapping.
java.lang.String	dump()
void	dump(java.lang.Appendable out, java.lang.String indent)	Dump this object (and children) into an Appendable using the provided indent after any new lines.
static WebSocketMapping	ensureMapping(javax.servlet.ServletContext servletContext, java.lang.String mappingKey)
static WebSocketMapping	getMapping(javax.servlet.ServletContext servletContext, java.lang.String mappingKey)
WebSocketCreator	getMapping(PathSpec pathSpec)
WebSocketNegotiator	getMatchedNegotiator(java.lang.String target, java.util.function.Consumer<PathSpec> pathSpecConsumer)	Get the matching MappedResource for the provided target.
void	lifeCycleStopping(LifeCycle context)
static PathSpec	parsePathSpec(java.lang.String rawSpec)	Parse a PathSpec string into a PathSpec instance.
boolean	removeMapping(PathSpec pathSpec)
boolean	upgrade(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Configuration.Customizer defaultCustomizer)

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

dumpSelf

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle.Listener

lifeCycleFailure, lifeCycleStarted, lifeCycleStarting, lifeCycleStopped

Field Detail

DEFAULT_KEY

public static final java.lang.String DEFAULT_KEY

See Also:

Constant Field Values

Constructor Detail

WebSocketMapping

public WebSocketMapping()

WebSocketMapping

public WebSocketMapping(WebSocketComponents components)

Method Detail

getMapping

public static WebSocketMapping getMapping(javax.servlet.ServletContext servletContext,
                                          java.lang.String mappingKey)

getMapping

public WebSocketCreator getMapping(PathSpec pathSpec)

ensureMapping

public static WebSocketMapping ensureMapping(javax.servlet.ServletContext servletContext,
                                             java.lang.String mappingKey)

parsePathSpec

public static PathSpec parsePathSpec(java.lang.String rawSpec)

Parse a PathSpec string into a PathSpec instance.

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)

Parameters:

rawSpec - the raw path spec as String to parse.

Returns:

the PathSpec implementation for the rawSpec

lifeCycleStopping

public void lifeCycleStopping(LifeCycle context)

Specified by:

lifeCycleStopping in interface LifeCycle.Listener

dump

public java.lang.String dump()

Specified by:

dump in interface Dumpable

dump

public void dump(java.lang.Appendable out,
                 java.lang.String indent)
          throws java.io.IOException

Description copied from interface: Dumpable

Dump this object (and children) into an Appendable using the provided indent after any new lines. The indent should not be applied to the first object dumped.

Specified by:

dump in interface Dumpable

Parameters:

out - The appendable to dump to

indent - The indent to apply after any new lines.

Throws:

java.io.IOException - if unable to write to Appendable

addMapping

public void addMapping(PathSpec pathSpec,
                       WebSocketCreator creator,
                       FrameHandlerFactory factory,
                       Configuration.Customizer customizer)
                throws WebSocketException

Manually add a WebSocket mapping.

If mapping is added before this configuration is started, then it is persisted through stop/start of this configuration's lifecycle. Otherwise it will be removed when this configuration is stopped.

Parameters:

pathSpec - the pathspec to respond on

creator - the websocket creator to activate on the provided mapping.

factory - the factory to use to create a FrameHandler for the websocket

customizer - the customizer to use to customize the WebSocket session.

Throws:

WebSocketException

removeMapping

public boolean removeMapping(PathSpec pathSpec)

getMatchedNegotiator

public WebSocketNegotiator getMatchedNegotiator(java.lang.String target,
                                                java.util.function.Consumer<PathSpec> pathSpecConsumer)

Get the matching MappedResource for the provided target.

Parameters:

target - the target path

pathSpecConsumer - the path

Returns:

the matching resource, or null if no match.

upgrade

public boolean upgrade(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response,
                       Configuration.Customizer defaultCustomizer)
                throws java.io.IOException

Throws:

java.io.IOException