パッケージ org.springframework.http.codec

クラス ServerSentEventHttpMessageWriter

java.lang.ObjectSE
org.springframework.http.codec.ServerSentEventHttpMessageWriter
実装されたすべてのインターフェース:
HttpMessageWriter<ObjectSE>
public class ServerSentEventHttpMessageWriter extends ObjectSE implements HttpMessageWriter<ObjectSE>
 "text/event-stream" レスポンスの場合は HttpMessageWriter。
導入:
5.0
作成者:
Sebastien Deleuze, Arjen Poutsma, Rossen Stoyanchev

  • コンストラクターの詳細

    • ServerSentEventHttpMessageWriter

      public ServerSentEventHttpMessageWriter()
      Encoder なしのコンストラクター。このモードでは、エンコードされるイベントデータに対して String のみがサポートされます。

    • ServerSentEventHttpMessageWriter

      public ServerSentEventHttpMessageWriter(@Nullable Encoder<?> encoder)
      オブジェクトをエンコードするための JSON Encoder を持つコンストラクター。String イベントデータのサポートが組み込まれています。
      パラメーター:
      encoder - 使用するエンコーダ (null の場合があります)

  • メソッドの詳細

    • getEncoder

      @Nullable public Encoder<?> getEncoder()
      設定された Encoder を返します（ある場合）。

    • getWritableMediaTypes

      public ListSE<MediaType> getWritableMediaTypes()
      インターフェースからコピーされた説明: HttpMessageWriter
      このライターでサポートされているメディア型のリストを返します。このリストは、考えられるすべてのターゲット要素型に適用されるとは限らないため、このメソッドの呼び出しは通常、canWrite(elementType, null) を介して保護する必要があります。このリストでは、特定の要素型でのみサポートされているメディア型を除外することもできます。または、HttpMessageWriter.getWritableMediaTypes(ResolvableType) を使用してより正確なリストを作成します。
      次で指定:
      インターフェース HttpMessageWriter<ObjectSE> の getWritableMediaTypes 
      戻り値:
      サポートされているメディア型の一般的なリスト

    • canWrite

      public boolean canWrite(ResolvableType elementType, @Nullable MediaType mediaType)
      インターフェースからコピーされた説明: HttpMessageWriter
      指定されたオブジェクト型がこのライターでサポートされているかどうか。
      次で指定:
      インターフェース HttpMessageWriter<ObjectSE> の canWrite 
      パラメーター:
      elementType - チェックするオブジェクトの型
      mediaType - 書き込みのメディア型 (おそらく null)
      戻り値:
      書き込み可能な場合は true、それ以外の場合は false 

    • write

      public reactor.core.publisher.Mono<VoidSE> write(Publisher<?> input, ResolvableType elementType, @Nullable MediaType mediaType, ReactiveHttpOutputMessage message, MapSE<StringSE,ObjectSE> hints)
      インターフェースからコピーされた説明: HttpMessageWriter
      オブジェクトの特定のストリームを出力メッセージに書き込みます。
      次で指定:
      インターフェース HttpMessageWriter<ObjectSE> の write 
      パラメーター:
      input - 書き込むオブジェクト
      elementType - HttpMessageWriter.canWrite(ResolvableType, MediaType) を介して事前にチェックされている必要があるストリーム内のオブジェクトの型
      mediaType - 書き込みのコンテンツ型 (ライターのデフォルトのコンテンツ型を使用する必要があることを示す null )
      message - 書き込むメッセージ
      hints - エンコードおよび書き込み方法に関する追加情報
      戻り値:
      完了またはエラーを示します

    • write

      public reactor.core.publisher.Mono<VoidSE> write(Publisher<?> input, ResolvableType actualType, ResolvableType elementType, @Nullable MediaType mediaType, ServerHttpRequest request, ServerHttpResponse response, MapSE<StringSE,ObjectSE> hints)
      インターフェースからコピーされた説明: HttpMessageWriter
      追加のコンテキストが利用可能な、HttpMessageWriter.write(Publisher, ResolvableType, MediaType, ReactiveHttpOutputMessage, Map) のサーバー側のみの代替。
      次で指定:
      インターフェース HttpMessageWriter<ObjectSE> の write 
      actualType - 値を返したメソッドの実際の戻り値の型。アノテーション付きコントローラーの場合、MethodParameter は ResolvableType.getSource() を介してアクセスできます。
      elementType - 入力ストリーム内のオブジェクトの型
      mediaType - 使用するコンテンツ型 (ライターのデフォルトのコンテンツ型を使用する必要があることを示す null )
      request - 現在のリクエスト
      response - 現在のレスポンス
      戻り値:
      書き込みの完了またはエラーを示す Mono