インターフェース WebServiceMessage

既知のすべてのサブインターフェース:
FaultAwareWebServiceMessage, MimeMessage, PoxMessage, SoapMessage, StreamingWebServiceMessage
すべての既知の実装クラス:
AbstractMimeMessage, AbstractSoapMessage, AxiomSoapMessage, DomPoxMessage, SaajSoapMessage
public interface WebServiceMessage
プロトコルに依存しない XML メッセージを表します。

メッセージのペイロードへのアクセスを提供するメソッドが含まれています。

導入:
1.0.0
関連事項:

  • 方法の概要

    修飾子と型
    メソッド
    説明
    ResultSE
    getPayloadResult()
    メッセージの内容を ResultSE として返します。
    @Nullable SourceSE
    getPayloadSource()
    メッセージの内容を SourceSE として返します。
    void
    writeTo(OutputStreamSE outputStream)
    メッセージ全体を指定された出力ストリームに書き込みます。

  • 方法の詳細

    • getPayloadSource

      @Nullable SourceSE getPayloadSource()
      メッセージの内容を SourceSE として返します。

      実装に応じて、これは複数回取得することも、1 回だけ取得することもできます。

      戻り値:
      メッセージの内容

    • getPayloadResult

      ResultSE getPayloadResult()
      メッセージの内容を ResultSE として返します。

      このメソッドを呼び出すと、現在のペイロードが削除されます。

      読み取り専用の実装は UnsupportedOperationExceptionSE をスローします。

      戻り値:
      メッセージの内容
      例外:
      UnsupportedOperationExceptionSE - メッセージが読み取り専用の場合

    • writeTo

      void writeTo(OutputStreamSE outputStream) throws IOExceptionSE
      メッセージ全体を指定された出力ストリームに書き込みます。

      指定されたストリームが TransportOutputStream のインスタンスである場合、対応するヘッダーも書き込まれます。

      パラメーター:
      outputStream - 書き込むストリーム
      例外:
      IOExceptionSE - I/O 例外が発生した場合