Package org.eclipse.jetty.websocket.core.server

Class WebSocketMappings

java.lang.Object

org.eclipse.jetty.websocket.core.server.WebSocketMappings

All Implemented Interfaces:

EventListener, Dumpable, LifeCycle.Listener

public class WebSocketMappings
extends 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.

Nested Class Summary

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

Dumpable.DumpableContainer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	WEBSOCKET_MAPPING_ATTRIBUTE

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

KEY

Constructor Summary

Constructors

Constructor	Description
WebSocketMappings()
WebSocketMappings(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.
void	addMapping(PathSpec pathSpec, WebSocketNegotiator negotiator)	Manually add a WebSocket mapping.
void	dump(Appendable out, String indent)	Dump this object (and children) into an Appendable using the provided indent after any new lines.
static WebSocketMappings	ensureMappings(jakarta.servlet.ServletContext servletContext)
Handshaker	getHandshaker()
static WebSocketMappings	getMappings(jakarta.servlet.ServletContext servletContext)
WebSocketNegotiator	getMatchedNegotiator(String target, Consumer<PathSpec> pathSpecConsumer)	Get the matching MappedResource for the provided target.
WebSocketCreator	getWebSocketCreator(PathSpec pathSpec)
WebSocketNegotiator	getWebSocketNegotiator(PathSpec pathSpec)
void	lifeCycleStopping(LifeCycle context)
static PathSpec	parsePathSpec(String rawSpec)	Parse a PathSpec string into a PathSpec instance.
boolean	removeMapping(PathSpec pathSpec)
boolean	upgrade(jakarta.servlet.http.HttpServletRequest request, jakarta.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

dump, dumpSelf

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

lifeCycleFailure, lifeCycleStarted, lifeCycleStarting, lifeCycleStopped

Field Details

WEBSOCKET_MAPPING_ATTRIBUTE

public static final String WEBSOCKET_MAPPING_ATTRIBUTE

Constructor Details

WebSocketMappings

public WebSocketMappings()

WebSocketMappings

public WebSocketMappings(WebSocketComponents components)

Method Details

getMappings

public static WebSocketMappings getMappings(jakarta.servlet.ServletContext servletContext)

ensureMappings

public static WebSocketMappings ensureMappings(jakarta.servlet.ServletContext servletContext)

parsePathSpec

public static PathSpec parsePathSpec(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

getHandshaker

public Handshaker getHandshaker()

lifeCycleStopping

public void lifeCycleStopping(LifeCycle context)

Specified by:

lifeCycleStopping in interface LifeCycle.Listener

dump

public void dump(Appendable out,
 String indent)
          throws 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:

IOException - if unable to write to Appendable

getWebSocketNegotiator

public WebSocketNegotiator getWebSocketNegotiator(PathSpec pathSpec)

getWebSocketCreator

public WebSocketCreator getWebSocketCreator(PathSpec pathSpec)

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

addMapping

public void addMapping(PathSpec pathSpec,
 WebSocketNegotiator negotiator)
                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

negotiator - the WebSocketNegotiator to use to create a FrameHandler for the websocket.

Throws:

WebSocketException

removeMapping

public boolean removeMapping(PathSpec pathSpec)

getMatchedNegotiator

public WebSocketNegotiator getMatchedNegotiator(String target,
 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(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 Configuration.Customizer defaultCustomizer)
                throws IOException

Throws:

IOException