クラス AxiomSoapMessage
java.lang.ObjectSE
org.springframework.ws.mime.AbstractMimeMessage
org.springframework.ws.soap.AbstractSoapMessage
org.springframework.ws.soap.axiom.AxiomSoapMessage
- 実装済みのインターフェース一覧:
FaultAwareWebServiceMessage, MimeMessage, SoapMessage, StreamingWebServiceMessage, WebServiceMessage
- 導入:
- 1.0.0
- 関連事項:
コンストラクター概要
コンストラクターコンストラクター説明AxiomSoapMessage(org.apache.axiom.soap.SOAPFactory soapFactory) 新しい空のAxiomSoapMessageを作成します。AxiomSoapMessage(org.apache.axiom.soap.SOAPFactory soapFactory, boolean payloadCaching, boolean langAttributeOnSoap11FaultString) 新しい空のAxiomSoapMessageを作成します。AxiomSoapMessage(org.apache.axiom.soap.SOAPMessage soapMessage, StringSE soapAction, boolean payloadCaching, boolean langAttributeOnSoap11FaultString) 指定された AXIOMSOAPMessageに基づいて新しいAxiomSoapMessageを作成します。AxiomSoapMessage(org.apache.axiom.soap.SOAPMessage soapMessage, org.apache.axiom.attachments.Attachments attachments, StringSE soapAction, boolean payloadCaching, boolean langAttributeOnSoap11FaultString) 指定された AXIOMSOAPMessageと添付ファイルに基づいて新しいAxiomSoapMessageを作成します。方法の概要
修飾子と型メソッド説明addAttachment(StringSE contentId, jakarta.activation.DataHandler dataHandler) DataHandlerからコンテンツを取得して、メッセージに添付ファイルを追加します。booleanこのメッセージを XOP パッケージに変換します。protected StringSEdetermineContentType(org.apache.axiom.om.OMOutputFormat outputFormat, SoapVersion soapVersion) 使用する「コンテンツ型」ヘッダーを決定します。@Nullable AttachmentgetAttachment(StringSE contentId) 指定されたコンテンツ ID を持つAttachmentを返します。このメッセージの一部であるすべてのAttachmentオブジェクトに対してIteratorを返します。final org.apache.axiom.soap.SOAPMessageこのAxiomSoapMessageが基づいている AXIOMSOAPMessageを返します。このメッセージをDocumentSE として返します。このメッセージに関連付けられたSoapEnvelopeを返します。このメッセージの SOAP アクションを取得するか、存在しない場合はnullを取得します。booleanこのメッセージが XOP パッケージであるかどうかを示します。final voidsetAxiomMessage(org.apache.axiom.soap.SOAPMessage axiomMessage) このAxiomSoapMessageのベースとなる AXIOMSOAPMessageを設定します。voidsetDocument(DocumentSE document) メッセージの内容を指定されたDocumentSE に設定します。voidsetOutputFormat(org.apache.axiom.om.OMOutputFormat outputFormat) メッセージの書き込み時に使用するOMOutputFormatを設定します。voidsetSoapAction(StringSE soapAction) このメッセージの SOAP アクションを設定します。voidsetStreamingPayload(StreamingPayload payload) このメッセージのストリーミングペイロードを設定します。toString()voidwriteTo(OutputStreamSE outputStream) メッセージ全体を指定された出力ストリームに書き込みます。protected voidwriteTo(OutputStreamSE outputStream, org.apache.axiom.om.OMOutputFormat outputFormat) 指定されたOMOutputFormatを使用して、メッセージ全体を指定された出力ストリームに書き込みます。クラス AbstractSoapMessage から継承されたメソッド
getFaultCode, getFaultReason, getPayloadResult, getPayloadSource, getSoapBody, getSoapHeader, getVersion, hasFaultクラス AbstractMimeMessage から継承されたメソッド
addAttachment, addAttachmentクラス ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, wait, waitSE, waitSEインターフェース MimeMessage から継承されたメソッド
addAttachment, addAttachmentインターフェース WebServiceMessage から継承されたメソッド
getPayloadResult, getPayloadSource
コンストラクターの詳細
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) 指定された AXIOMSOAPMessageに基づいて新しいAxiomSoapMessageを作成します。- パラメーター:
soapMessage- AXIOM SOAPMessagesoapAction- SOAP アクションヘッダーの値payloadCaching- SOAP 本体の内容をキャッシュする必要があるかどうか
AxiomSoapMessage
public AxiomSoapMessage(org.apache.axiom.soap.SOAPMessage soapMessage, org.apache.axiom.attachments.Attachments attachments, StringSE soapAction, boolean payloadCaching, boolean langAttributeOnSoap11FaultString) 指定された AXIOMSOAPMessageと添付ファイルに基づいて新しいAxiomSoapMessageを作成します。- パラメーター:
soapMessage- AXIOM SOAPMessageattachments- 添付ファイルsoapAction- SOAP アクションヘッダーの値payloadCaching- SOAP 本体の内容をキャッシュする必要があるかどうか
方法の詳細
getAxiomMessage
public final org.apache.axiom.soap.SOAPMessage getAxiomMessage()このAxiomSoapMessageが基づいている AXIOMSOAPMessageを返します。setAxiomMessage
public final void setAxiomMessage(org.apache.axiom.soap.SOAPMessage axiomMessage) このAxiomSoapMessageのベースとなる AXIOMSOAPMessageを設定します。このメソッドを呼び出すと、SOAP アクションプロパティもクリアされます。
setOutputFormat
public void setOutputFormat(org.apache.axiom.om.OMOutputFormat outputFormat) メッセージの書き込み時に使用するOMOutputFormatを設定します。- 関連事項:
setStreamingPayload
インターフェースからコピーされた説明:StreamingWebServiceMessageこのメッセージのストリーミングペイロードを設定します。- 次で指定:
- インターフェース
StreamingWebServiceMessage内のsetStreamingPayload - パラメーター:
payload- ストリーミングペイロード
getEnvelope
インターフェースからコピーされた説明:SoapMessageこのメッセージに関連付けられたSoapEnvelopeを返します。- 次で指定:
- インターフェース
SoapMessage内のgetEnvelope
getSoapAction
インターフェースからコピーされた説明:SoapMessageこのメッセージの SOAP アクションを取得するか、存在しない場合はnullを取得します。- 次で指定:
- インターフェース
SoapMessage内のgetSoapAction - 戻り値:
- SOAP アクション。
setSoapAction
インターフェースからコピーされた説明:SoapMessageこのメッセージの SOAP アクションを設定します。- 次で指定:
- インターフェース
SoapMessage内のsetSoapAction - パラメーター:
soapAction- SOAP アクション。
getDocument
インターフェースからコピーされた説明:SoapMessageこのメッセージをDocumentSE として返します。基盤となる実装に応じて、このドキュメントは「ライブ」である場合とそうでない場合があります。- 次で指定:
- インターフェース
SoapMessage内のgetDocument - 戻り値:
- DOM ドキュメントとしてのこの SOAP メッセージ
setDocument
インターフェースからコピーされた説明: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
インターフェースからコピーされた説明:MimeMessage指定されたコンテンツ ID を持つAttachmentを返します。- 次で指定:
- インターフェース
MimeMessage内のgetAttachment - 戻り値:
- 指定されたコンテンツ ID の添付ファイル。または、見つからない場合は
null
getAttachments
インターフェースからコピーされた説明:MimeMessageこのメッセージの一部であるすべてのAttachmentオブジェクトに対してIteratorを返します。- 次で指定:
- インターフェース
MimeMessage内のgetAttachments - 戻り値:
- すべての添付ファイルに対するイテレータ
- 関連事項:
addAttachment
インターフェースからコピーされた説明:MimeMessageDataHandlerからコンテンツを取得して、メッセージに添付ファイルを追加します。- 次で指定:
- インターフェース
MimeMessage内のaddAttachment - パラメーター:
dataHandler- コンテンツを取得するデータハンドラー- 戻り値:
- 追加された添付ファイル
writeTo
インターフェースからコピーされた説明: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- 例外:
IOExceptionSEXMLStreamExceptionSE- 導入:
- 4.1.0
determineContentType
protected StringSE determineContentType(org.apache.axiom.om.OMOutputFormat outputFormat, SoapVersion soapVersion) 使用する「コンテンツ型」ヘッダーを決定します。- パラメーター:
outputFormat-OMOutputFormatsoapVersion-SoapVersion- 戻り値:
- 使用するコンテンツ型
- 導入:
- 4.1.0
toString