クラス JettyWebSocketClient
java.lang.ObjectSE
org.springframework.web.socket.client.AbstractWebSocketClient
org.springframework.web.socket.client.jetty.JettyWebSocketClient
- 実装されたすべてのインターフェース:
Lifecycle
,WebSocketClient
@DeprecatedSE(since="6.0.3",
forRemoval=true)
public class JettyWebSocketClient
extends AbstractWebSocketClient
implements Lifecycle
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
Jetty WebSocket API を使用して、WebSocket サーバーへの WebSocket リクエストをプログラムで開始します。Jetty 11 でのみサポートされ、
StandardWebSocketClient
に置き換えられました。4.1 現在、このクラスは SmartLifecycle
ではなく Lifecycle
を実装しています。WebSocket 接続を自動開始するには、代わりに WebSocketConnectionManager
を使用してください。
- 導入:
- 4.0
- 作成者:
- Rossen Stoyanchev, Juergen Hoeller
フィールドサマリー
クラス org.springframework.web.socket.client.AbstractWebSocketClient から継承されたフィールド
logger
コンストラクターのサマリー
コンストラクター説明非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。WebSocketClient
のインスタンスを作成するデフォルトのコンストラクター。JettyWebSocketClient
(org.eclipse.jetty.websocket.client.WebSocketClient client) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。既存のWebSocketClient
インスタンスを受け入れるコンストラクター。メソッドのサマリー
修飾子と型メソッド説明executeInternal
(WebSocketHandler wsHandler, HttpHeaders headers, URISE uri, ListSE<StringSE> protocols, ListSE<WebSocketExtension> extensions, MapSE<StringSE, ObjectSE> attributes) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。実際のハンドシェイクを実行して、サーバーへの接続を確立します。非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。設定されたAsyncTaskExecutor
を返します。protected PrincipalSE
getUser()
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。WebSocketSession.getPrincipal()
を介して使用できるようにユーザーを返します。boolean
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。このコンポーネントが現在実行されているかどうかを確認します。void
setTaskExecutor
(AsyncTaskExecutor taskExecutor) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。接続を開くときに使用するAsyncTaskExecutor
を設定します。void
start()
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。このコンポーネントを起動します。void
stop()
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。このメソッドを返すとコンポーネントが完全に停止するように、通常は同期的にこのコンポーネントを停止します。クラス org.springframework.web.socket.client.AbstractWebSocketClient から継承されたメソッド
assertUri, doHandshakeInternal, execute, execute
クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
インターフェース org.springframework.web.socket.client.WebSocketClient から継承されたメソッド
doHandshake, doHandshake
コンストラクターの詳細
JettyWebSocketClient
public JettyWebSocketClient()非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。WebSocketClient
のインスタンスを作成するデフォルトのコンストラクター。JettyWebSocketClient
public JettyWebSocketClient(org.eclipse.jetty.websocket.client.WebSocketClient client) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。既存のWebSocketClient
インスタンスを受け入れるコンストラクター。
メソッドの詳細
setTaskExecutor
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。接続を開くときに使用するAsyncTaskExecutor
を設定します。このプロパティが
null
に設定されている場合、doHandshake
メソッドの呼び出しは、接続が確立されるまでブロックされます。デフォルトでは、
SimpleAsyncTaskExecutor
のインスタンスが使用されます。getTaskExecutor
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。設定されたAsyncTaskExecutor
を返します。start
public void start()非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。インターフェースからコピーされた説明:Lifecycle
このコンポーネントを起動します。コンポーネントがすでに実行されている場合は、例外をスローしないでください。
コンテナーの場合、これは適用されるすべてのコンポーネントに開始シグナルを伝播します。
stop
public void stop()非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。インターフェースからコピーされた説明:Lifecycle
このメソッドを返すとコンポーネントが完全に停止するように、通常は同期的にこのコンポーネントを停止します。非同期停止動作が必要な場合は、SmartLifecycle
とそのstop(Runnable)
バリアントの実装を検討してください。この停止通知は破棄前に送信されるとは限らないことに注意してください。通常のシャットダウンでは、一般的な破棄コールバックが伝播される前に、
Lifecycle
Bean は最初に停止通知を受信します。ただし、コンテキストの存続期間中のホットリフレッシュまたは中断されたリフレッシュ試行では、特定の Bean の destroy メソッドが、停止シグナルを事前に考慮することなく呼び出されます。コンポーネントが実行されていない(まだ開始されていない)場合は、例外をスローしないでください。
コンテナーの場合、これは停止シグナルを適用するすべてのコンポーネントに伝播します。
isRunning
public boolean isRunning()非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。インターフェースからコピーされた説明:Lifecycle
このコンポーネントが現在実行されているかどうかを確認します。コンテナーの場合、これは、適用されるすべてのコンポーネントが現在実行されている場合にのみ、
true
を返します。executeInternal
public CompletableFutureSE<WebSocketSession> executeInternal(WebSocketHandler wsHandler, HttpHeaders headers, URISE uri, ListSE<StringSE> protocols, ListSE<WebSocketExtension> extensions, MapSE<StringSE, ObjectSE> attributes) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。クラスからコピーされた説明:AbstractWebSocketClient
実際のハンドシェイクを実行して、サーバーへの接続を確立します。- 次で指定:
- クラス
AbstractWebSocketClient
のexecuteInternal
- パラメーター:
wsHandler
- WebSocket メッセージのクライアント側ハンドラーheaders
- ハンドシェイクに使用する HTTP ヘッダー。不要な(禁止されている)ヘッダーはフィルターで除外されます (非null
)uri
- ハンドシェイクのターゲット URI (非null
)protocols
- リクエストされたサブプロトコル、または空のリストextensions
- リクエストされた WebSocket 拡張、または空のリストattributes
- WebSocketSession に関連付ける属性 (つまり、WebSocketSession.getAttributes()
経由)。現在、常に空のマップ- 戻り値:
CompletableFuture
でラップされた、確立された WebSocket セッション。
getUser
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。WebSocketSession.getPrincipal()
を介して利用可能にするユーザーを返します。デフォルトでは、このメソッドはnull
を返します
StandardWebSocketClient
を推奨