001/*
002 * Copyright 2002-2017 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.adapter;
018
019import org.springframework.lang.Nullable;
020import org.springframework.web.socket.WebSocketSession;
021
022/**
023 * A {@link WebSocketSession} that exposes the underlying, native WebSocketSession
024 * through a getter.
025 *
026 * @author Rossen Stoyanchev
027 * @since 4.0
028 */
029public interface NativeWebSocketSession extends WebSocketSession {
030
031        /**
032         * Return the underlying native WebSocketSession.
033         */
034        Object getNativeSession();
035
036        /**
037         * Return the underlying native WebSocketSession, if available.
038         * @param requiredType the required type of the session
039         * @return the native session of the required type,
040         * or {@code null} if not available
041         */
042        @Nullable
043        <T> T getNativeSession(@Nullable Class<T> requiredType);
044
045}