001/*
002 * Copyright 2002-2014 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.handler;
018
019import org.springframework.web.socket.WebSocketHandler;
020
021/**
022 * A factory for applying decorators to a WebSocketHandler.
023 *
024 * <p>Decoration should be done through sub-classing
025 * {@link org.springframework.web.socket.handler.WebSocketHandlerDecorator
026 * WebSocketHandlerDecorator} to allow any code to traverse decorators and/or
027 * unwrap the original handler when necessary .
028 *
029 * @author Rossen Stoyanchev
030 * @since 4.1.2
031 */
032public interface WebSocketHandlerDecoratorFactory {
033
034        /**
035         * Decorate the given WebSocketHandler.
036         * @param handler the handler to be decorated.
037         * @return the same handler or the handler wrapped with a sub-class of
038         * {@code WebSocketHandlerDecorator}.
039         */
040        WebSocketHandler decorate(WebSocketHandler handler);
041
042}