Class WebSocketHandlerMapping

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.handler.AbstractHandlerMapping

org.springframework.web.servlet.handler.AbstractUrlHandlerMapping

org.springframework.web.servlet.handler.SimpleUrlHandlerMapping

org.springframework.web.socket.server.support.WebSocketHandlerMapping

All Implemented Interfaces:

Aware, BeanNameAware, ApplicationContextAware, Lifecycle, Phased, SmartLifecycle, Ordered, ServletContextAware, MatchableHandlerMapping, HandlerMapping

public class WebSocketHandlerMapping
extends SimpleUrlHandlerMapping
implements SmartLifecycle

Extension of SimpleUrlHandlerMapping with support for more precise mapping of WebSocket handshake requests to handlers of type WebSocketHttpRequestHandler. Also delegates Lifecycle methods to handlers in the SimpleUrlHandlerMapping.getUrlMap() that implement it.

Since:

4.2

Author:

Rossen Stoyanchev

Field Summary

Fields inherited from class AbstractHandlerMapping

mappingsLogger

Fields inherited from class ApplicationObjectSupport

logger

Fields inherited from interface HandlerMapping

API_VERSION_ATTRIBUTE, BEST_MATCHING_HANDLER_ATTRIBUTE, BEST_MATCHING_PATTERN_ATTRIBUTE, INTROSPECT_TYPE_LEVEL_MAPPING, LOOKUP_PATH, MATRIX_VARIABLES_ATTRIBUTE, PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE, PRODUCIBLE_MEDIA_TYPES_ATTRIBUTE, URI_TEMPLATE_VARIABLES_ATTRIBUTE

Fields inherited from interface Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Fields inherited from interface SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
WebSocketHandlerMapping()

Method Summary

Modifier and Type	Method	Description
protected @Nullable Object	getHandlerInternal(HttpServletRequest request)	Look up a handler for the URL path of the given request.
int	getPhase()	Return the phase that this lifecycle object is supposed to run in.
protected void	initServletContext(ServletContext servletContext)	Subclasses may override this for custom initialization based on the ServletContext that this application object runs in.
boolean	isRunning()	Check whether this component is currently running.
void	setPhase(int phase)	Set the phase that this handler should run in.
void	setWebSocketUpgradeMatch(boolean match)	When this is set, if the matched handler is WebSocketHttpRequestHandler, ensure the request is a WebSocket handshake, i.e.
void	start()	Start this component.
void	stop()	Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method.

Methods inherited from class SimpleUrlHandlerMapping

getUrlMap, initApplicationContext, registerHandlers, setMappings, setUrlMap

Methods inherited from class AbstractUrlHandlerMapping

buildPathExposingHandler, exposePathWithinMapping, exposeUriTemplateVariables, getHandlerMap, getPathPatternHandlerMap, getRootHandler, lookupHandler, lookupHandler, match, registerHandler, registerHandler, setLazyInitHandlers, setPatternParser, setRootHandler, supportsTypeLevelMappings, unregisterHandler, validateHandler

Methods inherited from class AbstractHandlerMapping

adaptInterceptor, detectMappedInterceptors, extendInterceptors, formatMappingName, getAdaptedInterceptors, getApiVersionStrategy, getCorsConfiguration, getCorsConfigurationSource, getCorsHandlerExecutionChain, getCorsProcessor, getDefaultHandler, getHandler, getHandlerExecutionChain, getMappedInterceptors, getOrder, getPathMatcher, getPatternParser, getUrlPathHelper, hasCorsConfigurationSource, initInterceptors, initLookupPath, setAlwaysUseFullPath, setApiVersionStrategy, setBeanName, setCorsConfigurations, setCorsConfigurationSource, setCorsProcessor, setDefaultHandler, setInterceptors, setOrder, setPathMatcher, setRemoveSemicolonContent, setUrlDecode, setUrlPathHelper, usesPathPatterns

Methods inherited from class WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, isContextRequired, setServletContext

Methods inherited from class ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, obtainApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface HandlerMapping

getHandler, usesPathPatterns

Methods inherited from interface MatchableHandlerMapping

getPatternParser

Methods inherited from interface SmartLifecycle

isAutoStartup, isPauseable, stop

Constructor Details

WebSocketHandlerMapping

public WebSocketHandlerMapping()

Method Details

setWebSocketUpgradeMatch

public void setWebSocketUpgradeMatch(boolean match)

When this is set, if the matched handler is WebSocketHttpRequestHandler, ensure the request is a WebSocket handshake, i.e. HTTP GET with the header "Upgrade:websocket", or otherwise suppress the match and return null allowing another HandlerMapping to match for the same URL path.

Parameters:

match - whether to enable matching on "Upgrade: websocket"

Since:

5.3.5

setPhase

public void setPhase(int phase)

Set the phase that this handler should run in.

By default, this is SmartLifecycle.DEFAULT_PHASE, but with @EnableWebSocketMessageBroker configuration it is set to 0.

Since:

6.1.4

getPhase

public int getPhase()

Description copied from interface: SmartLifecycle

Return the phase that this lifecycle object is supposed to run in.

The default implementation returns SmartLifecycle.DEFAULT_PHASE in order to let stop() callbacks execute before regular Lifecycle implementations.

Specified by:

getPhase in interface Phased

Specified by:

getPhase in interface SmartLifecycle

See Also:

• SmartLifecycle.isAutoStartup()
• Lifecycle.start()
• SmartLifecycle.stop(Runnable)
• DefaultLifecycleProcessor.getPhase(Lifecycle)

initServletContext

protected void initServletContext(ServletContext servletContext)

Description copied from class: WebApplicationObjectSupport

Subclasses may override this for custom initialization based on the ServletContext that this application object runs in.

The default implementation is empty. Called by WebApplicationObjectSupport.initApplicationContext(org.springframework.context.ApplicationContext) as well as WebApplicationObjectSupport.setServletContext(jakarta.servlet.ServletContext).

Overrides:

initServletContext in class WebApplicationObjectSupport

Parameters:

servletContext - the ServletContext that this application object runs in (never null)

start

public void start()

Description copied from interface: Lifecycle

Start this component.

Should not throw an exception if the component is already running.

In the case of a container, this will propagate a hard start signal to all components that apply, even to non-auto-startup components.

Specified by:

start in interface Lifecycle

See Also:

• SmartLifecycle.isAutoStartup()

stop

public void stop()

Description copied from interface: Lifecycle

Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method. Consider implementing SmartLifecycle and its stop(Runnable) variant when asynchronous stop behavior is necessary.

Note that this stop notification is not guaranteed to come before destruction: On regular shutdown, Lifecycle beans will first receive a stop notification before the general destruction callbacks are being propagated; however, on hot refresh during a context's lifetime or on aborted refresh attempts, a given bean's destroy method will be called without any consideration of stop signals upfront.

Should not throw an exception if the component is not running (not started yet).

In the case of a container, this will propagate the stop signal to all components that apply.

Specified by:

stop in interface Lifecycle

See Also:

• SmartLifecycle.stop(Runnable)
• DisposableBean.destroy()

isRunning

public boolean isRunning()

Description copied from interface: Lifecycle

Check whether this component is currently running.

In the case of a container, this will return true only if all components that apply are currently running.

Specified by:

isRunning in interface Lifecycle

Returns:

whether the component is currently running

getHandlerInternal

protected @Nullable Object getHandlerInternal(HttpServletRequest request)
                                       throws Exception

Description copied from class: AbstractUrlHandlerMapping

Look up a handler for the URL path of the given request.

Overrides:

getHandlerInternal in class AbstractUrlHandlerMapping

Parameters:

request - current HTTP request

Returns:

the handler instance, or null if none found

Throws:

Exception - if there is an internal error