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

クラス StandardWebSocketClient

java.lang.ObjectSE
org.springframework.web.socket.client.AbstractWebSocketClient
org.springframework.web.socket.client.standard.StandardWebSocketClient
実装されたすべてのインターフェース:
WebSocketClient
public class StandardWebSocketClient extends AbstractWebSocketClient
定番の Jakarta WebSocket API をベースに WebSocketClient。
導入:
4.0
作成者:
Rossen Stoyanchev, Juergen Hoeller

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

    • StandardWebSocketClient

      public StandardWebSocketClient()
      ContainerProvider.getWebSocketContainer() を呼び出して（新しい）WebSocketContainerEE インスタンスを取得するデフォルトのコンストラクター。既存の WebSocketContainer インスタンスを受け入れるコンストラクターも参照してください。

    • StandardWebSocketClient

      public StandardWebSocketClient(WebSocketContainerEE webSocketContainer)
      既存の WebSocketContainerEE インスタンスを受け入れるコンストラクター。

      XML 構成については、WebSocketContainerFactoryBean を参照してください。Java 構成の場合、ContainerProvider.getWebSocketContainer() を使用して WebSocketContainer インスタンスを取得します。

  • メソッドの詳細

    • setUserProperties

      public void setUserProperties(@Nullable MapSE<StringSE,ObjectSE> userProperties)
      標準の Jakarta WebSocket API では、「ユーザープロパティ」を userPropertiesEE 経由でサーバーに渡すことができます。このプロパティを使用して、すべてのハンドシェイクで渡される 1 つ以上のプロパティを構成します。

    • getUserProperties

      public MapSE<StringSE,ObjectSE> getUserProperties()
      構成されたユーザープロパティを返します。

    • setSslContext

      public void setSslContext(@Nullable SSLContextSE sslContext)
      ClientEndpointConfig.getSSLContext()EE に使用する SSLContextSE を設定します。
      導入:
      6.1.3

    • getSslContext

      @Nullable public SSLContextSE getSslContext()
      使用する SSLContextSE を返します。
      導入:
      6.1.3

    • setTaskExecutor

      public void setTaskExecutor(@Nullable AsyncTaskExecutor taskExecutor)
      接続を開くときに使用する AsyncTaskExecutor を設定します。

      このプロパティが null に設定されている場合、doHandshake メソッドの呼び出しは、接続が確立されるまでブロックされます。

      デフォルトでは、SimpleAsyncTaskExecutor のインスタンスが使用されます。

    • getTaskExecutor

      @Nullable public AsyncTaskExecutor getTaskExecutor()
      設定された AsyncTaskExecutor を返します。

    • executeInternal

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