1 /*
2 * Copyright 2002-2013 the original author or authors.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package org.springframework.web.socket.client;
18
19 import java.net.URI;
20
21 import org.springframework.util.concurrent.ListenableFuture;
22 import org.springframework.web.socket.WebSocketHandler;
23 import org.springframework.web.socket.WebSocketHttpHeaders;
24 import org.springframework.web.socket.WebSocketSession;
25
26 /**
27 * Contract for initiating a WebSocket request. As an alternative considering using the
28 * declarative style {@link WebSocketConnectionManager} that starts a WebSocket connection
29 * to a pre-configured URI when the application starts.
30 *
31 * @author Rossen Stoyanchev
32 * @since 4.0
33 * @see WebSocketConnectionManager
34 */
35 public interface WebSocketClient {
36
37 ListenableFuture<WebSocketSession> doHandshake(WebSocketHandler webSocketHandler,
38 String uriTemplate, Object... uriVariables);
39
40 ListenableFuture<WebSocketSession> doHandshake(WebSocketHandler webSocketHandler,
41 WebSocketHttpHeaders headers, URI uri);
42
43 }