パッケージ jakarta.ws.rs.sse
インターフェース Sse
public interface Sse
OutboundSseEvent および SseBroadcaster を作成するためのサーバー側エントリポイント。このインターフェースのインスタンスは、フィールドに挿入するか、メソッドまたはコンストラクターのパラメーターとして挿入できます。また、インスタンスはスレッドセーフです。つまり、インスタンスを共有し、そのメソッドを別のスレッドから呼び出すことができます。内部状態に矛盾が生じることはありません。
- 導入:
- 2.1
- 作成者:
- Marek Potociar (marek.potociar at oracle.com)
方法の概要
修飾子と型メソッド説明新しいサーバー送信イベントブロードキャストを取得します。default OutboundSseEvent提供されたデータから新しいOutboundSseEventを作成します。default OutboundSseEvent提供されたデータと名前から新しいOutboundSseEventを作成します。新しい送信イベントビルダーを取得します。
方法の詳細
newEventBuilder
OutboundSseEvent.Builder newEventBuilder()新しい送信イベントビルダーを取得します。- 戻り値:
- SSE 送信イベントビルダー。
newEvent
提供されたデータから新しいOutboundSseEventを作成します。データは文字列のみであり、null であってはなりません。
- パラメーター:
data- イベントデータ。- 戻り値:
OutboundSseEventを作成しました。- 例外:
IllegalArgumentExceptionSE- データがnullの場合。
newEvent
提供されたデータと名前から新しいOutboundSseEventを作成します。- パラメーター:
name- イベント名。(SseEvent.getName()を参照)。data- イベントデータ。- 戻り値:
OutboundSseEventを作成しました。- 例外:
IllegalArgumentExceptionSE- 名前またはデータがnullの場合。
newBroadcaster
SseBroadcaster newBroadcaster()新しいサーバー送信イベントブロードキャストを取得します。- 戻り値:
- 新しいサーバー送信イベントブロードキャスタインスタンス。