パッケージ org.springframework.web.socket.client

クラス AbstractWebSocketClient

java.lang.ObjectSE
org.springframework.web.socket.client.AbstractWebSocketClient
実装されているすべてのインターフェース:
WebSocketClient
既知の直属サブクラス
StandardWebSocketClient
public abstract class AbstractWebSocketClient extends ObjectSE implements WebSocketClient
WebSocketClient 実装の抽象基本クラス。
導入:
4.0
作成者:
Rossen Stoyanchev

  • フィールドの詳細

    • logger

      protected final Log logger

  • コンストラクターの詳細

    • AbstractWebSocketClient

      public AbstractWebSocketClient()

  • メソッドの詳細

    • execute

      public CompletableFutureSE<WebSocketSession> execute(WebSocketHandler webSocketHandler, StringSE uriTemplate, ObjectSE... uriVars)
      インターフェースからコピーされた説明: WebSocketClient
      指定された URL に対してハンドシェイクリクエストを実行し、指定されたハンドラーで結果の WebSocket セッションを処理します。
      次で指定:
      インターフェース WebSocketClient の execute 
      パラメーター:
      webSocketHandler - セッションハンドラー
      uriTemplate - URL テンプレート
      uriVars - テンプレートを展開する変数
      戻り値:
      セッションが利用可能になったときに完了するフューチャ

    • execute

      public final CompletableFutureSE<WebSocketSession> execute(WebSocketHandler webSocketHandler, @Nullable WebSocketHttpHeaders headers, URISE uri)
      インターフェースからコピーされた説明: WebSocketClient
      指定された URL に対してハンドシェイクリクエストを実行し、指定されたハンドラーで結果の WebSocket セッションを処理します。
      次で指定:
      インターフェース WebSocketClient の execute 
      パラメーター:
      webSocketHandler - セッションハンドラー
      uri - URL
      戻り値:
      セッションが利用可能になったときに完了するフューチャ

    • assertUri

      protected void assertUri(URISE uri)

    • doHandshakeInternal

      @DeprecatedSE(since="6.0", forRemoval=true) protected ListenableFuture<WebSocketSession> doHandshakeInternal(WebSocketHandler webSocketHandler, HttpHeaders headers, URISE uri, ListSE<StringSE> subProtocols, ListSE<WebSocketExtension> extensions, MapSE<StringSE,ObjectSE> attributes)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      6.0 現在、executeInternal(WebSocketHandler, HttpHeaders, URI, List, List, Map) を推奨
      実際のハンドシェイクを実行して、サーバーへの接続を確立します。
      パラメーター:
      webSocketHandler - WebSocket メッセージのクライアント側ハンドラー
      headers - ハンドシェイクに使用する HTTP ヘッダー。不要な（禁止されている）ヘッダーはフィルターで除外されます (非 null)
      uri - ハンドシェイクのターゲット URI (非 null)
      subProtocols - リクエストされたサブプロトコル、または空のリスト
      extensions - リクエストされた WebSocket 拡張、または空のリスト
      attributes - WebSocketSession に関連付ける属性、つまり WebSocketSession.getAttributes() を経由します。現在は常に空のマップです。
      戻り値:
      ListenableFuture でラップされた、確立された WebSocket セッション。

    • executeInternal

      protected abstract CompletableFutureSE<WebSocketSession> executeInternal(WebSocketHandler webSocketHandler, HttpHeaders headers, URISE uri, ListSE<StringSE> subProtocols, ListSE<WebSocketExtension> extensions, MapSE<StringSE,ObjectSE> attributes)
      実際のハンドシェイクを実行して、サーバーへの接続を確立します。
      パラメーター:
      webSocketHandler - WebSocket メッセージのクライアント側ハンドラー
      headers - ハンドシェイクに使用する HTTP ヘッダー。不要な（禁止されている）ヘッダーはフィルターで除外されます (非 null)
      uri - ハンドシェイクのターゲット URI (非 null)
      subProtocols - リクエストされたサブプロトコル、または空のリスト
      extensions - リクエストされた WebSocket 拡張、または空のリスト
      attributes - WebSocketSession に関連付ける属性 (つまり、WebSocketSession.getAttributes() 経由)。現在、常に空のマップ
      戻り値:
      CompletableFuture でラップされた、確立された WebSocket セッション。