001/* 002 * Copyright 2002-2015 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 org.springframework.web.socket.messaging.StompSubProtocolErrorHandler; 020import org.springframework.web.util.UrlPathHelper; 021 022/** 023 * A contract for registering STOMP over WebSocket endpoints. 024 * 025 * @author Rossen Stoyanchev 026 * @since 4.0 027 */ 028public interface StompEndpointRegistry { 029 030 /** 031 * Register a STOMP over WebSocket endpoint at the given mapping path. 032 */ 033 StompWebSocketEndpointRegistration addEndpoint(String... paths); 034 035 /** 036 * Set the order of the {@link org.springframework.web.servlet.HandlerMapping} 037 * used for STOMP endpoints relative to other Spring MVC handler mappings. 038 * <p>By default this is set to 1. 039 */ 040 void setOrder(int order); 041 042 /** 043 * Configure a customized {@link UrlPathHelper} for the STOMP endpoint 044 * {@link org.springframework.web.servlet.HandlerMapping HandlerMapping}. 045 */ 046 void setUrlPathHelper(UrlPathHelper urlPathHelper); 047 048 /** 049 * Configure a handler for customizing or handling STOMP ERROR frames to clients. 050 * @param errorHandler the error handler 051 * @since 4.2 052 */ 053 WebMvcStompEndpointRegistry setErrorHandler(StompSubProtocolErrorHandler errorHandler); 054 055}