コンストラクターの詳細

• 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)

  標準の Java WebSocket API では、userPropertiesEE を介して「ユーザープロパティ」をサーバーに渡すことができます。このプロパティを使用して、1 つ以上のプロパティをハンドシェイクごとに渡すように構成します。

• getUserProperties

  public MapSE<StringSE,ObjectSE> getUserProperties()

  設定されたユーザープロパティ。

• setTaskExecutor

  public void setTaskExecutor(@Nullable
                              AsyncListenableTaskExecutor taskExecutor)

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

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

• getTaskExecutor

  @Nullable
  public AsyncListenableTaskExecutor getTaskExecutor()

  設定された TaskExecutor を返します。

• doHandshakeInternal

  protected ListenableFuture<WebSocketSession> doHandshakeInternal(WebSocketHandler webSocketHandler,
                                                                   HttpHeaders headers,
                                                                   URISE uri,
                                                                   ListSE<StringSE> protocols,
                                                                   ListSE<WebSocketExtension> extensions,
                                                                   MapSE<StringSE,ObjectSE> attributes)

  クラスからコピーされた説明: AbstractWebSocketClient
  実際のハンドシェイクを実行して、サーバーへの接続を確立します。

  次で指定:

  クラス AbstractWebSocketClient の doHandshakeInternal 

  パラメーター:

  webSocketHandler - WebSocket メッセージのクライアント側ハンドラー

  headers - ハンドシェイクに使用する HTTP ヘッダー。不要な（禁止されている）ヘッダーはフィルターで除外されます (非 null)

  uri - ハンドシェイクのターゲット URI (非 null)

  protocols - リクエストされたサブプロトコル、または空のリスト

  extensions - リクエストされた WebSocket 拡張、または空のリスト

  attributes - WebSocketSession に関連付ける属性、つまり WebSocketSession.getAttributes() を経由します。現在は常に空のマップです。

  戻り値:

  ListenableFuture にラップされた確立された WebSocket セッション。