クラス SOAPPart
- java.lang.ObjectSE
-
- jakarta.xml.soap.SOAPPart
- 実装されているすべてのインターフェース:
Node、DocumentSE、NodeSE
public abstract class SOAPPart extends ObjectSE implements DocumentSE, Node
SOAPMessageオブジェクトの SOAP 固有の部分のコンテナー。すべてのメッセージには SOAP 部分が必要であるため、SOAPMessageオブジェクトが作成されると、自動的にSOAPPartオブジェクトが含まれます。SOAPPartオブジェクトは MIME パーツであり、MIME ヘッダー Content-Id、Content-Location、Content-Type を持っています。Content-Type の値は "text/xml" でなければならないため、SOAPPartオブジェクトには、値が "text/xml" に設定された Content-Type の MIME ヘッダーが自動的に含まれます。メッセージの SOAP 部分のコンテンツは XML 形式である必要があるため、値は "text/xml" である必要があります。"text/xml" 型ではないコンテンツは、SOAPPartオブジェクトではなくAttachmentPartオブジェクトに存在する必要があります。メッセージが送信されるとき、その SOAP 部分には、MIME ヘッダーの Content-Type が "text/xml" に設定されている必要があります。または、別の観点から見ると、受信するメッセージの SOAP 部分には、"text/xml" の値を持つ MIME ヘッダー Content-Type が必要です。
クライアントは、メソッド
SOAPMessage.getSOAPPartを呼び出すことにより、SOAPMessageオブジェクトのSOAPPartオブジェクトにアクセスできます。messageがSOAPMessageオブジェクトである次のコード行は、メッセージの SOAP 部分を取得します。SOAPPart soapPart = message.getSOAPPart();SOAPPartオブジェクトにはSOAPEnvelopeオブジェクトが含まれ、SOAPEnvelopeオブジェクトにはSOAPBodyオブジェクトとSOAPHeaderオブジェクトが含まれます。SOAPPartメソッドgetEnvelopeを使用して、SOAPEnvelopeオブジェクトを取得できます。- 導入:
- 1.6
フィールドのサマリー
インターフェース org.w3c.dom.NodeSE から継承されたフィールド
ATTRIBUTE_NODESE, CDATA_SECTION_NODESE, COMMENT_NODESE, DOCUMENT_FRAGMENT_NODESE, DOCUMENT_NODESE, DOCUMENT_POSITION_CONTAINED_BYSE, DOCUMENT_POSITION_CONTAINSSE, DOCUMENT_POSITION_DISCONNECTEDSE, DOCUMENT_POSITION_FOLLOWINGSE, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFICSE, DOCUMENT_POSITION_PRECEDINGSE, DOCUMENT_TYPE_NODESE, ELEMENT_NODESE, ENTITY_NODESE, ENTITY_REFERENCE_NODESE, NOTATION_NODESE, PROCESSING_INSTRUCTION_NODESE, TEXT_NODESE
コンストラクターの概要
コンストラクター 修飾子 コンストラクター 説明 protectedSOAPPart()デフォルトコンストラクター。
メソッドのサマリー
すべてのメソッド インスタンスメソッド 抽象メソッド 具象メソッド 修飾子と型 メソッド 説明 abstract voidaddMimeHeader(StringSE name, StringSE value)指定された名前と値でMimeHeaderオブジェクトを作成し、それをこのSOAPPartオブジェクトに追加します。abstract IteratorSE<MimeHeader>getAllMimeHeaders()このSOAPPartオブジェクトのすべてのヘッダーを、MimeHeaderオブジェクトのイテレーターとして取得します。abstract SourceSEgetContent()SOAPEnvelope のコンテンツを JAXPSourceオブジェクトとして返します。StringSEgetContentId()名前が "Content-Id" である MIME ヘッダーの値を取得します。StringSEgetContentLocation()名前が "Content-Location" である MIME ヘッダーの値を取得します。abstract SOAPEnvelopegetEnvelope()このSOAPPartオブジェクトに関連付けられているSOAPEnvelopeオブジェクトを取得します。abstract IteratorSE<MimeHeader>getMatchingMimeHeaders(StringSE[] names)指定された配列の名前に一致するすべてのMimeHeaderオブジェクトを取得します。abstract StringSE[]getMimeHeader(StringSE name)指定されたStringによって識別されるこのSOAPPartオブジェクト内のMimeHeaderオブジェクトのすべての値を取得します。abstract IteratorSE<MimeHeader>getNonMatchingMimeHeaders(StringSE[] names)指定された配列の名前と名前が一致しないすべてのMimeHeaderオブジェクトを取得します。abstract voidremoveAllMimeHeaders()このSOAPEnvelopeオブジェクトのすべてのMimeHeaderオブジェクトを削除します。abstract voidremoveMimeHeader(StringSE header)指定された名前に一致するすべての MIME ヘッダーを削除します。abstract voidsetContent(SourceSE source)指定されたSourceオブジェクトからのデータを使用してSOAPEnvelopeオブジェクトのコンテンツを設定します。voidsetContentId(StringSE contentId)"Content-Id" という名前の MIME ヘッダーの値を指定されたStringに設定します。voidsetContentLocation(StringSE contentLocation)MIME ヘッダー "Content-Location" の値を指定されたStringに設定します。abstract voidsetMimeHeader(StringSE name, StringSE value)指定されたヘッダー名に一致する最初のヘッダーエントリを変更して、その値が指定された値になるようにします。既存のヘッダーが一致しない場合は、指定された名前と値で新しいヘッダーを追加します。クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
インターフェース org.w3c.dom.DocumentSE から継承されたメソッド
adoptNodeSE, createAttributeSE, createAttributeNSSE, createCDATASectionSE, createCommentSE, createDocumentFragment, createElementSE, createElementNSSE, createEntityReferenceSE, createProcessingInstructionSE, createTextNodeSE, getDoctype, getDocumentElement, getDocumentURI, getDomConfig, getElementByIdSE, getElementsByTagNameSE, getElementsByTagNameNSSE, getImplementation, getInputEncoding, getStrictErrorChecking, getXmlEncoding, getXmlStandalone, getXmlVersion, importNodeSE, normalizeDocument, renameNodeSE, setDocumentURISE, setStrictErrorCheckingSE, setXmlStandaloneSE, setXmlVersionSE
インターフェース jakarta.xml.soap.Node から継承されたメソッド
detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue
インターフェース org.w3c.dom.NodeSE から継承されたメソッド
appendChildSE, cloneNodeSE, compareDocumentPositionSE, getAttributes, getBaseURI, getChildNodes, getFeatureSE, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserDataSE, hasAttributes, hasChildNodes, insertBeforeSE, isDefaultNamespaceSE, isEqualNodeSE, isSameNodeSE, isSupportedSE, lookupNamespaceURISE, lookupPrefixSE, normalize, removeChildSE, replaceChildSE, setNodeValueSE, setPrefixSE, setTextContentSE, setUserDataSE
メソッドの詳細
getEnvelope
public abstract SOAPEnvelope getEnvelope() throws SOAPException
このSOAPPartオブジェクトに関連付けられているSOAPEnvelopeオブジェクトを取得します。SOAP エンベロープが取得されると、その内容を取得するために使用できます。- 戻り値:
- この
SOAPPartオブジェクトのSOAPEnvelopeオブジェクト - 例外:
SOAPException- SOAP エラーがある場合
getContentId
public StringSE getContentId()
名前が "Content-Id" である MIME ヘッダーの値を取得します。- 戻り値:
- "Content-Id" という名前の MIME ヘッダーの値を提供する
String - 関連事項:
setContentId(java.lang.String)
getContentLocation
public StringSE getContentLocation()
名前が "Content-Location" である MIME ヘッダーの値を取得します。- 戻り値:
- 名前が "Content-Location" である MIME ヘッダーの値を与える
String - 関連事項:
setContentLocation(java.lang.String)
setContentId
public void setContentId(StringSE contentId)
"Content-Id" という名前の MIME ヘッダーの値を指定されたStringに設定します。- パラメーター:
contentId- MIME ヘッダー "Content-Id" の値を提供するString- 例外:
IllegalArgumentExceptionSE- コンテンツ ID の設定に問題がある場合- 関連事項:
getContentId()
setContentLocation
public void setContentLocation(StringSE contentLocation)
MIME ヘッダー "Content-Location" の値を指定されたStringに設定します。- パラメーター:
contentLocation- MIME ヘッダー "Content-Location" の値を指定するString- 例外:
IllegalArgumentExceptionSE- コンテンツの場所の設定に問題がある場合。- 関連事項:
getContentLocation()
removeMimeHeader
public abstract void removeMimeHeader(StringSE header)
指定された名前に一致するすべての MIME ヘッダーを削除します。- パラメーター:
header- 削除する MIME ヘッダーの名前を指定するString
removeAllMimeHeaders
public abstract void removeAllMimeHeaders()
このSOAPEnvelopeオブジェクトのすべてのMimeHeaderオブジェクトを削除します。
getMimeHeader
public abstract StringSE[] getMimeHeader(StringSE name)
指定されたStringによって識別されるこのSOAPPartオブジェクト内のMimeHeaderオブジェクトのすべての値を取得します。- パラメーター:
name- ヘッダーの名前。例: 「コンテンツ型」- 戻り値:
- 指定されたヘッダーのすべての値を示す
String配列 - 関連事項:
setMimeHeader(java.lang.String, java.lang.String)
setMimeHeader
public abstract void setMimeHeader(StringSE name, StringSE value)
指定されたヘッダー名に一致する最初のヘッダーエントリを変更して、その値が指定された値になるようにします。既存のヘッダーが一致しない場合は、指定された名前と値で新しいヘッダーを追加します。一致する場合、このメソッドは一致する最初のヘッダーの既存の値をすべてクリアし、代わりに指定された値を設定します。複数のヘッダーに指定された名前がある場合、このメソッドは最初のヘッダーの後に一致するすべてのヘッダーを削除します。RFC822 ヘッダーには、US-ASCII 文字のみを含めることができることに注意してください。
- パラメーター:
name- 検索するヘッダー名を指定するStringvalue- 設定する値を指定するString。この値は、一致する最初のヘッダーの現在の値 (存在する場合) に置き換えられます。一致するものがない場合、この値は新しいMimeHeaderオブジェクトの値になります。- 例外:
IllegalArgumentExceptionSE- 指定された mime ヘッダーの名前または値に問題があった場合- 関連事項:
getMimeHeader(java.lang.String)
addMimeHeader
public abstract void addMimeHeader(StringSE name, StringSE value)
指定された名前と値でMimeHeaderオブジェクトを作成し、このSOAPPartオブジェクトに追加します。指定された名前のMimeHeaderがすでに存在する場合、このメソッドは指定された値を既存の値に追加します。RFC822 ヘッダーには、US-ASCII 文字のみを含めることができることに注意してください。
- パラメーター:
name- ヘッダー名を指定するStringvalue- 設定または追加する値を指定するString- 例外:
IllegalArgumentExceptionSE- 指定された mime ヘッダーの名前または値に問題があった場合
getAllMimeHeaders
public abstract IteratorSE<MimeHeader> getAllMimeHeaders()
このSOAPPartオブジェクトのすべてのヘッダーを、MimeHeaderオブジェクトのイテレーターとして取得します。- 戻り値:
- この
SOAPPartオブジェクトのすべての Mime ヘッダーを含むIteratorオブジェクト
getMatchingMimeHeaders
public abstract IteratorSE<MimeHeader> getMatchingMimeHeaders(StringSE[] names)
指定された配列の名前に一致するすべてのMimeHeaderオブジェクトを取得します。- パラメーター:
names- 返される MIME ヘッダーの名前を持つString配列- 戻り値:
- 指定された配列内の名前のいずれかに一致するすべての MIME ヘッダー。
Iteratorオブジェクトとして返されます
getNonMatchingMimeHeaders
public abstract IteratorSE<MimeHeader> getNonMatchingMimeHeaders(StringSE[] names)
指定された配列の名前と名前が一致しないすべてのMimeHeaderオブジェクトを取得します。- パラメーター:
names- 返されない MIME ヘッダーの名前を持つString配列- 戻り値:
- 指定された配列内の名前のいずれかに一致するものを除く、この
SOAPPartオブジェクト内のすべての MIME ヘッダー。一致しない MIME ヘッダーは、Iteratorオブジェクトとして返されます。
setContent
public abstract void setContent(SourceSE source) throws SOAPException
指定されたSourceオブジェクトからのデータでSOAPEnvelopeオブジェクトのコンテンツを設定します。このSourceには、有効な SOAP ドキュメントが含まれている必要があります。- パラメーター:
source- データを設定するjavax.xml.transform.Sourceオブジェクト- 例外:
SOAPException- ソースの設定に問題がある場合- 関連事項:
getContent()
getContent
public abstract SourceSE getContent() throws SOAPException
SOAPEnvelope のコンテンツを JAXPSourceオブジェクトとして返します。- 戻り値:
javax.xml.transform.Sourceオブジェクトとしてのコンテンツ- 例外:
SOAPException- 実装が指定されたSourceオブジェクトを変換できない場合- 関連事項:
setContent(javax.xml.transform.Source)