コンストラクターの詳細

• StandardWebSocketClient

  public StandardWebSocketClient()

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

• StandardWebSocketClient

  public StandardWebSocketClient(javax.websocket.WebSocketContainer webSocketContainer)

  既存の WebSocketContainer インスタンスを受け入れるコンストラクター。

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

メソッドの詳細

• setUserProperties

  public void setUserProperties(@Nullable
                                java.util.Map<java.lang.String,java.lang.Object> userProperties)

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

• getUserProperties

  public java.util.Map<java.lang.String,java.lang.Object> 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,
                                                                   java.net.URI uri,
                                                                   java.util.List<java.lang.String> protocols,
                                                                   java.util.List<WebSocketExtension> extensions,
                                                                   java.util.Map<java.lang.String,java.lang.Object> attributes)

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

  次で指定:

  クラス AbstractWebSocketClient の doHandshakeInternal 

  パラメーター:

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

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

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

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

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

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

  戻り値:

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