/* * Copyright 2002-2014 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 * * http://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.config.annotation; import java.util.Collections; import org.springframework.beans.factory.config.CustomScopeConfigurer; import org.springframework.context.annotation.Bean; import org.springframework.messaging.simp.SimpSessionScope; import org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration; import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler; import org.springframework.web.servlet.HandlerMapping; import org.springframework.web.socket.WebSocketHandler; import org.springframework.web.socket.messaging.SubProtocolWebSocketHandler; import org.springframework.web.socket.sockjs.transport.SockJsThreadPoolTaskScheduler; /** * Extends {@link AbstractMessageBrokerConfiguration} and adds configuration for * receiving and responding to STOMP messages from WebSocket clients. *
* Typically used in conjunction with * {@link EnableWebSocketMessageBroker @EnableWebSocketMessageBroker} but can * also be extended directly. * * @author Rossen Stoyanchev * @author Artem Bilan * @since 4.0 */ public abstract class WebSocketMessageBrokerConfigurationSupport extends AbstractMessageBrokerConfiguration { private WebSocketTransportRegistration transportRegistration; protected WebSocketMessageBrokerConfigurationSupport() { } @Bean public HandlerMapping stompWebSocketHandlerMapping() { WebMvcStompEndpointRegistry registry = new WebMvcStompEndpointRegistry(subProtocolWebSocketHandler(), getTransportRegistration(), userSessionRegistry(), messageBrokerSockJsTaskScheduler()); registry.setApplicationContext(getApplicationContext()); registerStompEndpoints(registry); return registry.getHandlerMapping(); } @Bean public WebSocketHandler subProtocolWebSocketHandler() { return new SubProtocolWebSocketHandler(clientInboundChannel(), clientOutboundChannel()); } protected final WebSocketTransportRegistration getTransportRegistration() { if (this.transportRegistration == null) { this.transportRegistration = new WebSocketTransportRegistration(); configureWebSocketTransport(this.transportRegistration); } return this.transportRegistration; } protected void configureWebSocketTransport(WebSocketTransportRegistration registry) { } protected abstract void registerStompEndpoints(StompEndpointRegistry registry); /** * The default TaskScheduler to use if none is configured via * {@link SockJsServiceRegistration#setTaskScheduler(org.springframework.scheduling.TaskScheduler)}, i.e. *
* @Configuration * @EnableWebSocketMessageBroker * public class WebSocketConfig implements WebSocketMessageBrokerConfigurer { * * public void registerStompEndpoints(StompEndpointRegistry registry) { * registry.addEndpoint("/stomp").withSockJS().setTaskScheduler(myScheduler()); * } * * // ... * * } **/ @Bean public ThreadPoolTaskScheduler messageBrokerSockJsTaskScheduler() { ThreadPoolTaskScheduler scheduler = new SockJsThreadPoolTaskScheduler(); scheduler.setThreadNamePrefix("MessageBrokerSockJS-"); return scheduler; } @Bean public static CustomScopeConfigurer webSocketScopeConfigurer() { CustomScopeConfigurer configurer = new CustomScopeConfigurer(); configurer.setScopes(Collections.