org.springframework.web.socket.server.support.WebSocketHandlerMapping Maven / Gradle / Ivy
/*
* Copyright 2002-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.web.socket.server.support;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
import org.springframework.context.Lifecycle;
import org.springframework.context.SmartLifecycle;
import org.springframework.http.HttpHeaders;
import org.springframework.lang.Nullable;
import org.springframework.web.context.ServletContextAware;
import org.springframework.web.servlet.HandlerExecutionChain;
import org.springframework.web.servlet.handler.SimpleUrlHandlerMapping;
/**
* Extension of {@link SimpleUrlHandlerMapping} with support for more
* precise mapping of WebSocket handshake requests to handlers of type
* {@link WebSocketHttpRequestHandler}. Also delegates {@link Lifecycle}
* methods to handlers in the {@link #getUrlMap()} that implement it.
*
* @author Rossen Stoyanchev
* @since 4.2
*/
public class WebSocketHandlerMapping extends SimpleUrlHandlerMapping implements SmartLifecycle {
private boolean webSocketUpgradeMatch;
private volatile boolean running;
/**
* When this is set, if the matched handler is
* {@link WebSocketHttpRequestHandler}, ensure the request is a WebSocket
* handshake, i.e. HTTP GET with the header {@code "Upgrade:websocket"},
* or otherwise suppress the match and return {@code null} allowing another
* {@link org.springframework.web.servlet.HandlerMapping} to match for the
* same URL path.
* @param match whether to enable matching on {@code "Upgrade: websocket"}
* @since 5.3.5
*/
public void setWebSocketUpgradeMatch(boolean match) {
this.webSocketUpgradeMatch = match;
}
@Override
protected void initServletContext(ServletContext servletContext) {
for (Object handler : getUrlMap().values()) {
if (handler instanceof ServletContextAware) {
((ServletContextAware) handler).setServletContext(servletContext);
}
}
}
@Override
public void start() {
if (!isRunning()) {
this.running = true;
for (Object handler : getUrlMap().values()) {
if (handler instanceof Lifecycle) {
((Lifecycle) handler).start();
}
}
}
}
@Override
public void stop() {
if (isRunning()) {
this.running = false;
for (Object handler : getUrlMap().values()) {
if (handler instanceof Lifecycle) {
((Lifecycle) handler).stop();
}
}
}
}
@Override
public boolean isRunning() {
return this.running;
}
@Nullable
@Override
protected Object getHandlerInternal(HttpServletRequest request) throws Exception {
Object handler = super.getHandlerInternal(request);
return matchWebSocketUpgrade(handler, request) ? handler : null;
}
private boolean matchWebSocketUpgrade(@Nullable Object handler, HttpServletRequest request) {
handler = (handler instanceof HandlerExecutionChain ?
((HandlerExecutionChain) handler).getHandler() : handler);
if (this.webSocketUpgradeMatch && handler instanceof WebSocketHttpRequestHandler) {
String header = request.getHeader(HttpHeaders.UPGRADE);
return (request.getMethod().equals("GET") &&
header != null && header.equalsIgnoreCase("websocket"));
}
return true;
}
}