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