001/*
002 * Copyright 2002-2013 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.client;
018
019import java.net.URI;
020
021import org.springframework.lang.Nullable;
022import org.springframework.util.concurrent.ListenableFuture;
023import org.springframework.web.socket.WebSocketHandler;
024import org.springframework.web.socket.WebSocketHttpHeaders;
025import org.springframework.web.socket.WebSocketSession;
026
027/**
028 * Contract for initiating a WebSocket request. As an alternative considering using the
029 * declarative style {@link WebSocketConnectionManager} that starts a WebSocket connection
030 * to a pre-configured URI when the application starts.
031 *
032 * @author Rossen Stoyanchev
033 * @since 4.0
034 * @see WebSocketConnectionManager
035 */
036public interface WebSocketClient {
037
038        ListenableFuture<WebSocketSession> doHandshake(WebSocketHandler webSocketHandler,
039                        String uriTemplate, Object... uriVariables);
040
041        ListenableFuture<WebSocketSession> doHandshake(WebSocketHandler webSocketHandler,
042                        @Nullable WebSocketHttpHeaders headers, URI uri);
043
044}