001/* 002 * Copyright 2002-2019 the original author or authors. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * https://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 */ 016 017package org.springframework.web.socket.config.annotation; 018 019import java.lang.annotation.Documented; 020import java.lang.annotation.ElementType; 021import java.lang.annotation.Retention; 022import java.lang.annotation.RetentionPolicy; 023import java.lang.annotation.Target; 024 025import org.springframework.context.annotation.Import; 026 027/** 028 * Add this annotation to an {@code @Configuration} class to enable broker-backed 029 * messaging over WebSocket using a higher-level messaging sub-protocol. 030 * 031 * <pre class="code"> 032 * @Configuration 033 * @EnableWebSocketMessageBroker 034 * public class MyWebSocketConfig { 035 * 036 * } 037 * </pre> 038 * 039 * <p>Customize the imported configuration by implementing the 040 * {@link WebSocketMessageBrokerConfigurer} interface or more likely extend the 041 * convenient base class {@link AbstractWebSocketMessageBrokerConfigurer}: 042 * 043 * <pre class="code"> 044 * @Configuration 045 * @EnableWebSocketMessageBroker 046 * public class MyConfiguration extends AbstractWebSocketMessageBrokerConfigurer { 047 * 048 * @Override 049 * public void registerStompEndpoints(StompEndpointRegistry registry) { 050 * registry.addEndpoint("/portfolio").withSockJS(); 051 * } 052 * 053 * @Override 054 * public void configureMessageBroker(MessageBrokerRegistry registry) { 055 * registry.enableStompBrokerRelay("/queue/", "/topic/"); 056 * registry.setApplicationDestinationPrefixes("/app/"); 057 * } 058 * } 059 * </pre> 060 * 061 * @author Rossen Stoyanchev 062 * @since 4.0 063 */ 064@Retention(RetentionPolicy.RUNTIME) 065@Target(ElementType.TYPE) 066@Documented 067@Import(DelegatingWebSocketMessageBrokerConfiguration.class) 068public @interface EnableWebSocketMessageBroker { 069 070}