クラス ResourceHttpMessageWriter
java.lang.ObjectSE
org.springframework.http.codec.ResourceHttpMessageWriter
- 実装されたすべてのインターフェース:
HttpMessageWriter<Resource>
Resource
を書き込むことができる HttpMessageWriter
。 また、リクエストで指定された HTTP 範囲に基づいて 1 つ以上の ResourceRegion
を書き込むことをサポートする HttpMessageWriter
の実装。
リソースを読み取るには、DecoderHttpMessageReader
でラップされた ResourceDecoder
を使用します。
- 導入:
- 5.0
- 作成者:
- Arjen Poutsma, Brian Clozel, Rossen Stoyanchev
- 関連事項:
コンストラクターのサマリー
コンストラクター方法の概要
修飾子と型メソッド説明reactor.core.publisher.Mono<VoidSE>
addDefaultHeaders
(ReactiveHttpOutputMessage message, Resource resource, MediaType contentType, MapSE<StringSE, ObjectSE> hints) 指定されたリソースのデフォルトヘッダーを指定されたメッセージに追加します。boolean
canWrite
(ResolvableType elementType, MediaType mediaType) 指定されたオブジェクト型がこのライターでサポートされているかどうか。このライターでサポートされているメディア型のリストを返します。reactor.core.publisher.Mono<VoidSE>
write
(Publisher<? extends Resource> inputStream, ResolvableType actualType, ResolvableType elementType, MediaType mediaType, ServerHttpRequest request, ServerHttpResponse response, MapSE<StringSE, ObjectSE> hints) 追加のコンテキストが利用可能な、HttpMessageWriter.write(Publisher, ResolvableType, MediaType, ReactiveHttpOutputMessage, Map)
のサーバー側のみの代替。reactor.core.publisher.Mono<VoidSE>
write
(Publisher<? extends Resource> inputStream, ResolvableType elementType, MediaType mediaType, ReactiveHttpOutputMessage message, MapSE<StringSE, ObjectSE> hints) オブジェクトの特定のストリームを出力メッセージに書き込みます。クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
インターフェース org.springframework.http.codec.HttpMessageWriter から継承されたメソッド
getWritableMediaTypes
コンストラクターの詳細
ResourceHttpMessageWriter
public ResourceHttpMessageWriter()ResourceHttpMessageWriter
public ResourceHttpMessageWriter(int bufferSize)
メソッドの詳細
canWrite
インターフェースからコピーされた説明:HttpMessageWriter
指定されたオブジェクト型がこのライターでサポートされているかどうか。- 次で指定:
- インターフェース
HttpMessageWriter<Resource>
のcanWrite
- パラメーター:
elementType
- チェックするオブジェクトの型mediaType
- 書き込みのメディア型 (おそらくnull
)- 戻り値:
- 書き込み可能な場合は
true
、それ以外の場合はfalse
getWritableMediaTypes
インターフェースからコピーされた説明:HttpMessageWriter
このライターでサポートされているメディア型のリストを返します。このリストは、考えられるすべてのターゲット要素型に適用されるとは限らないため、このメソッドの呼び出しは通常、canWrite(elementType, null)
を介して保護する必要があります。このリストでは、特定の要素型でのみサポートされているメディア型を除外することもできます。または、HttpMessageWriter.getWritableMediaTypes(ResolvableType)
を使用してより正確なリストを作成します。- 次で指定:
- インターフェース
HttpMessageWriter<Resource>
のgetWritableMediaTypes
- 戻り値:
- サポートされているメディア型の一般的なリスト
write
public reactor.core.publisher.Mono<VoidSE> write(Publisher<? extends Resource> inputStream, ResolvableType elementType, @Nullable MediaType mediaType, ReactiveHttpOutputMessage message, MapSE<StringSE, ObjectSE> hints) インターフェースからコピーされた説明:HttpMessageWriter
オブジェクトの特定のストリームを出力メッセージに書き込みます。- 次で指定:
- インターフェース
HttpMessageWriter<Resource>
のwrite
- パラメーター:
inputStream
- 書き込むオブジェクトelementType
-HttpMessageWriter.canWrite(ResolvableType, MediaType)
を介して事前にチェックされている必要があるストリーム内のオブジェクトの型mediaType
- 書き込みのコンテンツ型 (ライターのデフォルトのコンテンツ型を使用する必要があることを示すnull
)message
- 書き込むメッセージhints
- エンコードおよび書き込み方法に関する追加情報- 戻り値:
- 完了またはエラーを示します
addDefaultHeaders
public reactor.core.publisher.Mono<VoidSE> addDefaultHeaders(ReactiveHttpOutputMessage message, Resource resource, @Nullable MediaType contentType, MapSE<StringSE, ObjectSE> hints) 指定されたリソースのデフォルトヘッダーを指定されたメッセージに追加します。- 導入:
- 6.1
write
public reactor.core.publisher.Mono<VoidSE> write(Publisher<? extends Resource> inputStream, @Nullable ResolvableType actualType, ResolvableType elementType, @Nullable MediaType mediaType, ServerHttpRequest request, ServerHttpResponse response, MapSE<StringSE, ObjectSE> hints) インターフェースからコピーされた説明:HttpMessageWriter
追加のコンテキストが利用可能な、HttpMessageWriter.write(Publisher, ResolvableType, MediaType, ReactiveHttpOutputMessage, Map)
のサーバー側のみの代替。- 次で指定:
- インターフェース
HttpMessageWriter<Resource>
のwrite
actualType
- 値を返したメソッドの実際の戻り値の型。アノテーション付きコントローラーの場合、MethodParameter
はResolvableType.getSource()
を介してアクセスできます。elementType
- 入力ストリーム内のオブジェクトの型mediaType
- 使用するコンテンツ型 (ライターのデフォルトのコンテンツ型を使用する必要があることを示すnull
)request
- 現在のリクエストresponse
- 現在のレスポンス- 戻り値:
- 書き込みの完了またはエラーを示す
Mono