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