org.springframework.web.socket.handler.WebSocketHandlerDecoratorFactory Maven / Gradle / Ivy
/*
* Copyright 2002-2022 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.handler;
import org.springframework.web.socket.WebSocketHandler;
/**
* A factory for applying decorators to a WebSocketHandler.
*
* Decoration should be done through sub-classing
* {@link org.springframework.web.socket.handler.WebSocketHandlerDecorator
* WebSocketHandlerDecorator} to allow any code to traverse decorators and/or
* unwrap the original handler when necessary.
*
* @author Rossen Stoyanchev
* @since 4.1.2
*/
public interface WebSocketHandlerDecoratorFactory {
/**
* Decorate the given WebSocketHandler.
* @param handler the handler to be decorated.
* @return the same handler or the handler wrapped with a subclass of
* {@code WebSocketHandlerDecorator}
*/
WebSocketHandler decorate(WebSocketHandler handler);
}