クラス AxiomSoapMessage

実装済みのインターフェース一覧:
FaultAwareWebServiceMessage, MimeMessage, SoapMessage, StreamingWebServiceMessage, WebServiceMessage

public class AxiomSoapMessage extends AbstractSoapMessage implements StreamingWebServiceMessage
SoapMessage インターフェースの AXIOM 固有の実装。AxiomSoapMessageFactory を介して作成され、SOAPMessage をラップします。
導入:
1.0.0
関連事項:
  • SOAPMessage
  • コンストラクターの詳細

    • AxiomSoapMessage

      public AxiomSoapMessage(org.apache.axiom.soap.SOAPFactory soapFactory)
      新しい空の AxiomSoapMessage を作成します。
      パラメーター:
      soapFactory - AXIOMSOAPFactory
    • AxiomSoapMessage

      public AxiomSoapMessage(org.apache.axiom.soap.SOAPFactory soapFactory, boolean payloadCaching, boolean langAttributeOnSoap11FaultString)
      新しい空の AxiomSoapMessage を作成します。
      パラメーター:
      soapFactory - AXIOMSOAPFactory
    • AxiomSoapMessage

      public AxiomSoapMessage(org.apache.axiom.soap.SOAPMessage soapMessage, StringSE soapAction, boolean payloadCaching, boolean langAttributeOnSoap11FaultString)
      指定された AXIOM SOAPMessage に基づいて新しい AxiomSoapMessage を作成します。
      パラメーター:
      soapMessage - AXIOM SOAPMessage
      soapAction - SOAP アクションヘッダーの値
      payloadCaching - SOAP 本体の内容をキャッシュする必要があるかどうか
    • AxiomSoapMessage

      public AxiomSoapMessage(org.apache.axiom.soap.SOAPMessage soapMessage, org.apache.axiom.attachments.Attachments attachments, StringSE soapAction, boolean payloadCaching, boolean langAttributeOnSoap11FaultString)
      指定された AXIOM SOAPMessage と添付ファイルに基づいて新しい AxiomSoapMessage を作成します。
      パラメーター:
      soapMessage - AXIOM SOAPMessage
      attachments - 添付ファイル
      soapAction - SOAP アクションヘッダーの値
      payloadCaching - SOAP 本体の内容をキャッシュする必要があるかどうか
  • 方法の詳細

    • getAxiomMessage

      public final org.apache.axiom.soap.SOAPMessage getAxiomMessage()
      この AxiomSoapMessage が基づいている AXIOM SOAPMessage を返します。
    • setAxiomMessage

      public final void setAxiomMessage(org.apache.axiom.soap.SOAPMessage axiomMessage)
      この AxiomSoapMessage のベースとなる AXIOM SOAPMessage を設定します。

      このメソッドを呼び出すと、SOAP アクションプロパティもクリアされます。

    • setOutputFormat

      public void setOutputFormat(org.apache.axiom.om.OMOutputFormat outputFormat)
      メッセージの書き込み時に使用する OMOutputFormat を設定します。
      関連事項:
    • setStreamingPayload

      public void setStreamingPayload(StreamingPayload payload)
      インターフェースからコピーされた説明: StreamingWebServiceMessage
      このメッセージのストリーミングペイロードを設定します。
      次で指定:
      インターフェース StreamingWebServiceMessage 内の setStreamingPayload 
      パラメーター:
      payload - ストリーミングペイロード
    • getEnvelope

      public SoapEnvelope getEnvelope()
      インターフェースからコピーされた説明: SoapMessage
      このメッセージに関連付けられた SoapEnvelope を返します。
      次で指定:
      インターフェース SoapMessage 内の getEnvelope 
    • getSoapAction

      public StringSE getSoapAction()
      インターフェースからコピーされた説明: SoapMessage
      このメッセージの SOAP アクションを取得するか、存在しない場合は null を取得します。
      次で指定:
      インターフェース SoapMessage 内の getSoapAction 
      戻り値:
      SOAP アクション。
    • setSoapAction

      public void setSoapAction(StringSE soapAction)
      インターフェースからコピーされた説明: SoapMessage
      このメッセージの SOAP アクションを設定します。
      次で指定:
      インターフェース SoapMessage 内の setSoapAction 
      パラメーター:
      soapAction - SOAP アクション。
    • getDocument

      public DocumentSE getDocument()
      インターフェースからコピーされた説明: SoapMessage
      このメッセージを DocumentSE として返します。基盤となる実装に応じて、このドキュメントは「ライブ」である場合とそうでない場合があります。
      次で指定:
      インターフェース SoapMessage 内の getDocument 
      戻り値:
      DOM ドキュメントとしてのこの SOAP メッセージ
    • setDocument

      public void setDocument(DocumentSE document)
      インターフェースからコピーされた説明: SoapMessage
      メッセージの内容を指定された DocumentSE に設定します。
      次で指定:
      インターフェース SoapMessage 内の setDocument 
      パラメーター:
      document - DOM ドキュメントとしての SOAP メッセージ
    • isXopPackage

      public boolean isXopPackage()
      インターフェースからコピーされた説明: MimeMessage
      このメッセージが XOP パッケージであるかどうかを示します。
      次で指定:
      インターフェース MimeMessage 内の isXopPackage 
      戻り値:
      XOP ドキュメントの識別で指定された制約が満たされた場合の true
      関連事項:
    • convertToXopPackage

      public boolean convertToXopPackage()
      インターフェースからコピーされた説明: MimeMessage
      このメッセージを XOP パッケージに変換します。
      次で指定:
      インターフェース MimeMessage 内の convertToXopPackage 
      戻り値:
      メッセージが XOP パッケージの場合の true 
      関連事項:
    • getAttachment

      public @Nullable Attachment getAttachment(StringSE contentId)
      インターフェースからコピーされた説明: MimeMessage
      指定されたコンテンツ ID を持つ Attachment を返します。
      次で指定:
      インターフェース MimeMessage 内の getAttachment 
      戻り値:
      指定されたコンテンツ ID の添付ファイル。または、見つからない場合は null 
    • getAttachments

      public IteratorSE<Attachment> getAttachments()
      インターフェースからコピーされた説明: MimeMessage
      このメッセージの一部であるすべての Attachment オブジェクトに対して Iterator を返します。
      次で指定:
      インターフェース MimeMessage 内の getAttachments 
      戻り値:
      すべての添付ファイルに対するイテレータ
      関連事項:
    • addAttachment

      public Attachment addAttachment(StringSE contentId, jakarta.activation.DataHandler dataHandler)
      インターフェースからコピーされた説明: MimeMessage
      DataHandler からコンテンツを取得して、メッセージに添付ファイルを追加します。
      次で指定:
      インターフェース MimeMessage 内の addAttachment 
      パラメーター:
      dataHandler - コンテンツを取得するデータハンドラー
      戻り値:
      追加された添付ファイル
    • writeTo

      public void writeTo(OutputStreamSE outputStream) throws IOExceptionSE
      インターフェースからコピーされた説明: WebServiceMessage
      メッセージ全体を指定された出力ストリームに書き込みます。

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

      次で指定:
      インターフェース WebServiceMessage 内の writeTo 
      パラメーター:
      outputStream - 書き込むストリーム
      例外:
      IOExceptionSE - I/O 例外が発生した場合
    • writeTo

      protected void writeTo(OutputStreamSE outputStream, org.apache.axiom.om.OMOutputFormat outputFormat) throws IOExceptionSE, XMLStreamExceptionSE
      指定された OMOutputFormat を使用して、メッセージ全体を指定された出力ストリームに書き込みます。
      パラメーター:
      outputStream - 書き込むストリーム
      outputFormat - OMOutputFormat
      例外:
      IOExceptionSE
      XMLStreamExceptionSE
      導入:
      4.1.0
    • determineContentType

      protected StringSE determineContentType(org.apache.axiom.om.OMOutputFormat outputFormat, SoapVersion soapVersion)
      使用する「コンテンツ型」ヘッダーを決定します。
      パラメーター:
      outputFormat - OMOutputFormat
      soapVersion - SoapVersion
      戻り値:
      使用するコンテンツ型
      導入:
      4.1.0
    • toString

      public StringSE toString()
      オーバーライド:
      クラス ObjectSEtoString