パッケージ jakarta.ws.rs.ext
インターフェース WriterInterceptorContext
- すべてのスーパーインターフェース:
InterceptorContext
public interface WriterInterceptorContext extends InterceptorContext
MessageBodyWriter.writeTo(T, java.lang.Class<?>, java.lang.reflect.Type, java.lang.annotation.Annotation[], jakarta.ws.rs.core.MediaType, jakarta.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.Object>, java.io.OutputStream)
への呼び出しをインターセプトするためにWriterInterceptor
によって使用されるコンテキストクラス。このコンテキストクラスの getter および setter は、インターセプトされたメソッドのパラメーターに対応します。- 導入:
- 2.0
- 作成者:
- Santiago Pericas-Geertsen, Bill Burke
- 関連事項:
WriterInterceptor
,MessageBodyWriter
メソッドのサマリー
すべてのメソッド インスタンスメソッド 抽象メソッド 修飾子と型 メソッド 説明 ObjectSE
getEntity()
HTTP エンティティとして書き込まれるオブジェクトを取得します。MultivaluedMap<StringSE,ObjectSE>
getHeaders()
HTTP ヘッダーの可変マップを取得します。OutputStreamSE
getOutputStream()
書き込むオブジェクトの出力ストリームを取得します。void
proceed()
チェーンの次のインターセプターに進みます。void
setEntity(ObjectSE entity)
HTTP エンティティとして書き込まれるオブジェクトを更新します。void
setOutputStream(OutputStreamSE os)
書き込むオブジェクトの新しい出力ストリームを設定します。インターフェース jakarta.ws.rs.ext.InterceptorContext から継承されたメソッド
getAnnotations, getGenericType, getMediaType, getProperty, getPropertyNames, getType, hasProperty, removeProperty, setAnnotations, setGenericType, setMediaType, setProperty, setType
メソッドの詳細
proceed
void proceed() throws IOExceptionSE, WebApplicationException
チェーンの次の迎撃機に進みます。インターセプターは、実行チェーンを続行するためにこのメソッドを明示的に呼び出さなければなりません。チェーンの最後のインターセプターでこのメソッドを呼び出すと、ラップされたMessageBodyWriter.writeTo(T, java.lang.Class<?>, java.lang.reflect.Type, java.lang.annotation.Annotation[], jakarta.ws.rs.core.MediaType, jakarta.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.Object>, java.io.OutputStream)
メソッドが呼び出されます。- 例外:
IOExceptionSE
- IO エラーが発生した場合、またはラップされたMessageBodyWriter.writeTo
メソッドによってスローされた場合。WebApplicationException
- ラップされたMessageBodyWriter.writeTo
メソッドによってスローされます。
getEntity
ObjectSE getEntity()
HTTP エンティティとして書き込まれるオブジェクトを取得します。- 戻り値:
- HTTP エンティティとして書き込まれるオブジェクト。
setEntity
void setEntity(ObjectSE entity)
HTTP エンティティとして書き込まれるオブジェクトを更新します。- パラメーター:
entity
- 書き込まれる新しいオブジェクト。
getOutputStream
OutputStreamSE getOutputStream()
書き込むオブジェクトの出力ストリームを取得します。JAX-RS ランタイムは、出力ストリームを閉じるロールを果たします。- 戻り値:
- 書き込まれるオブジェクトの出力ストリーム。
setOutputStream
void setOutputStream(OutputStreamSE os)
書き込むオブジェクトの新しい出力ストリームを設定します。例: 別の出力ストリームでラップします。JAX-RS ランタイムは、設定された出力ストリームを閉じるロールを果たします。- パラメーター:
os
- 書き込まれるオブジェクトの新しい出力ストリーム。
getHeaders
MultivaluedMap<StringSE,ObjectSE> getHeaders()
HTTP ヘッダーの可変マップを取得します。- 戻り値:
- HTTP ヘッダーのマップ。