javax.xml.soap

クラス SOAPPart

java.lang.Object

javax.xml.soap.SOAPPart

すべての実装されたインタフェース:

Document, Node

public abstract class SOAPPart
extends Object
implements Document, Node

SOAPMessage オブジェクトの SOAP 固有の部分のコンテナ。すべてのメッセージは SOAP 部を持つよう要求されているため、SOAPMessage オブジェクトが作成されると自動的に SOAPPart オブジェクトを持ちます。

SOAPPart オブジェクトは MIME 部であり、Content-Id、Content-Location、および Content-Type の MIME ヘッダーを持ちます。Content-Type の値は "text/xml" である必要があるため、SOAPPart オブジェクトは自動的に Content-Type の値が "text/xml" に設定された MIME ヘッダーを持ちます。メッセージの SOAP 部のコンテンツは XML 形式である必要があるため、値は "text/xml" である必要があります。タイプ "text/xml" でないコンテンツは、SOAPPart オブジェクトの中ではなく AttachmentPart オブジェクトの中に入れる必要があります。

メッセージが送信される際、メッセージの SOAP 部には MIME ヘッダーの Content-Type を "text/xml" に設定する必要があります。または、別の視点では、受信する任意のメッセージの SOAP 部は、MIME ヘッダーの Content-Type を "text/xml" の値で持つ必要があります。

クライアントは、SOAPMessage.getSOAPPart メソッドを呼び出して SOAPMessage オブジェクトの SOAPPart オブジェクトにアクセスできます。次のコードでは、message が SOAPMessage オブジェクトで、メッセージの SOAP 部を取得します。

   SOAPPart soapPart = message.getSOAPPart();
 

SOAPPart オブジェクトは SOAPEnvelope オブジェクトを含み、順に SOAPBody オブジェクトおよび SOAPHeader オブジェクトを含みます。SOAPPart メソッド getEnvelope を使用すると、SOAPEnvelope オブジェクトを取得できます。

フィールドのサマリー

インタフェース org.w3c.dom.Node から継承されたフィールド

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
SOAPPart()

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
abstract void	addMimeHeader(String name, String value) 指定された名前および値を含む MimeHeader オブジェクトを作成し、それをこの SOAPPart オブジェクトに追加します。
abstract Iterator	getAllMimeHeaders() この SOAPPart オブジェクトのすべてのヘッダーを MimeHeader オブジェクトのイテレータとして取得します。
abstract Source	getContent() SOAPEnvelope のコンテンツを JAXP Source オブジェクトとして返します。
String	getContentId() 名前が "Content-Id" である MIME ヘッダーの値を取得します。
String	getContentLocation() 名前が "Content-Location" である MIME ヘッダーの値を取得します。
abstract SOAPEnvelope	getEnvelope() この SOAPPart オブジェクトに関連付けられた SOAPEnvelope オブジェクトを取得します。
abstract Iterator	getMatchingMimeHeaders(String[] names) 指定した配列内の名前に一致するすべての MimeHeader オブジェクトを取得します。
abstract String[]	getMimeHeader(String name) 指定された String で識別されるこの SOAPPart オブジェクト内の MimeHeader オブジェクトの、すべての値を取得します。
abstract Iterator	getNonMatchingMimeHeaders(String[] names) 名前が指定した配列内の名前と一致しないすべての MimeHeader オブジェクトを取得します。
abstract void	removeAllMimeHeaders() この SOAPEnvelope オブジェクトの MimeHeader オブジェクトをすべて削除します。
abstract void	removeMimeHeader(String header) 指定した名前に一致する MIME ヘッダーをすべて削除します。
abstract void	setContent(Source source) SOAPEnvelope オブジェクトのコンテンツを、指定した Source オブジェクトからのデータに設定します。
void	setContentId(String contentId) 名前が「Content-Id」である MIME ヘッダーの値を、指定された String に設定します。
void	setContentLocation(String contentLocation) MIME ヘッダー「Content-Location」の値を、指定された String に設定します。
abstract void	setMimeHeader(String name, String value) 指定したヘッダー名に一致する最初のヘッダーエントリを変更してその値が指定した値になるようにし、既存のヘッダーで一致するものがない場合は指定した名前の新しいヘッダーを追加します。

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

インタフェース org.w3c.dom.Document から継承されたメソッド

adoptNode, createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createProcessingInstruction, createTextNode, getDoctype, getDocumentElement, getDocumentURI, getDomConfig, getElementById, getElementsByTagName, getElementsByTagNameNS, getImplementation, getInputEncoding, getStrictErrorChecking, getXmlEncoding, getXmlStandalone, getXmlVersion, importNode, normalizeDocument, renameNode, setDocumentURI, setStrictErrorChecking, setXmlStandalone, setXmlVersion

インタフェース javax.xml.soap.Node から継承されたメソッド

detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue

インタフェース org.w3c.dom.Node から継承されたメソッド

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

コンストラクタの詳細

SOAPPart

public SOAPPart()

メソッドの詳細

getEnvelope

public abstract SOAPEnvelope getEnvelope()
                                  throws SOAPException

この SOAPPart オブジェクトに関連付けられた SOAPEnvelope オブジェクトを取得します。SOAP エンベロープを取得したなら、それを使用してコンテンツを取得できます。

戻り値:

この SOAPPart オブジェクトの SOAPEnvelope オブジェクト

例外:

SOAPException - SOAP エラーが存在する場合

getContentId

public String getContentId()

名前が "Content-Id" である MIME ヘッダーの値を取得します。

戻り値:

"Content-Id" という名前の MIME ヘッダーの値を示す String

関連項目:

setContentId(java.lang.String)

getContentLocation

public String getContentLocation()

名前が "Content-Location" である MIME ヘッダーの値を取得します。

戻り値:

"Content-Location" という名前の MIME ヘッダーの値を示す String

関連項目:

setContentLocation(java.lang.String)

setContentId

public void setContentId(String contentId)

名前が「Content-Id」である MIME ヘッダーの値を、指定された String に設定します。

パラメータ:

contentId - MIME ヘッダー "Content-Id" の値を示す String

例外:

IllegalArgumentException - コンテンツ ID の設定時に問題が発生した場合

関連項目:

getContentId()

setContentLocation

public void setContentLocation(String contentLocation)

MIME ヘッダー「Content-Location」の値を、指定された String に設定します。

パラメータ:

contentLocation - MIME ヘッダー "Content-Location" の値を示す String

例外:

IllegalArgumentException - コンテンツの場所の設定時に問題が発生した場合。

関連項目:

getContentLocation()

removeMimeHeader

public abstract void removeMimeHeader(String header)

指定した名前に一致する MIME ヘッダーをすべて削除します。

パラメータ:

header - 削除する MIME ヘッダーの名前を示す String

removeAllMimeHeaders

public abstract void removeAllMimeHeaders()

この SOAPEnvelope オブジェクトの MimeHeader オブジェクトをすべて削除します。

getMimeHeader

public abstract String[] getMimeHeader(String name)

指定された String で識別されるこの SOAPPart オブジェクト内の MimeHeader オブジェクトの、すべての値を取得します。

パラメータ:

name - ヘッダーの名前。例:"Content-Type"

戻り値:

指定したヘッダーのすべての値を示す String 配列

関連項目:

setMimeHeader(java.lang.String, java.lang.String)

setMimeHeader

public abstract void setMimeHeader(String name,
                 String value)

指定したヘッダー名に一致する最初のヘッダーエントリを変更してその値が指定した値になるようにし、既存のヘッダーで一致するものがない場合は指定した名前の新しいヘッダーを追加します。一致するヘッダーが存在する場合、このメソッドが、一致する最初のヘッダーの既存の値すべてをクリアにし、代わりに指定された値で設定します。複数のヘッダーが指定した名前を持つ場合、このメソッドは、最初に一致したヘッダーのあとに一致するヘッダーをすべて削除します。

RFC822 ヘッダーは US-ASCII 文字だけを含むことが可能である点に注意してください。

パラメータ:

name - 検索するヘッダー名を指定する String

value - 設定される値を示す String。この値は、一致するヘッダーがある場合には最初のヘッダーの現在の値と置き換えられる。一致がない場合、この値は新しい MimeHeader オブジェクトの値になる。

例外:

IllegalArgumentException - 指定した MIME ヘッダー名または値に問題があった場合

関連項目:

getMimeHeader(java.lang.String)

addMimeHeader

public abstract void addMimeHeader(String name,
                 String value)

指定された名前および値を含む MimeHeader オブジェクトを作成し、それをこの SOAPPart オブジェクトに追加します。指定された名前を持つ MimeHeader がすでに存在する場合、このメソッドは指定した値を既存の値に追加します。

RFC822 ヘッダーは US-ASCII 文字だけを含むことが可能である点に注意してください。

パラメータ:

name - ヘッダー名を指定する String

value - 設定または追加される値を示す String

例外:

IllegalArgumentException - 指定した MIME ヘッダー名または値に問題があった場合

getAllMimeHeaders

public abstract Iterator getAllMimeHeaders()

この SOAPPart オブジェクトのすべてのヘッダーを MimeHeader オブジェクトのイテレータとして取得します。

戻り値:

この SOAPPart オブジェクトの MIME ヘッダーすべてを含む Iterator オブジェクト

getMatchingMimeHeaders

public abstract Iterator getMatchingMimeHeaders(String[] names)

指定した配列内の名前に一致するすべての MimeHeader オブジェクトを取得します。

パラメータ:

names - 返される MIME ヘッダーの名前を含む String 配列

戻り値:

指定した配列内の名前の 1 つと一致する MIME ヘッダーすべてを、Iterator オブジェクトとして返す

getNonMatchingMimeHeaders

public abstract Iterator getNonMatchingMimeHeaders(String[] names)

名前が指定した配列内の名前と一致しないすべての MimeHeader オブジェクトを取得します。

パラメータ:

names - 返されない MIME ヘッダーの名前を含む String 配列

戻り値:

指定した配列内の名前の 1 つに一致するものを除く、この SOAPPart オブジェクト内のすべての MIME ヘッダー。一致しない MIME ヘッダーは、Iterator オブジェクトとして返される。

setContent

public abstract void setContent(Source source)
                         throws SOAPException

SOAPEnvelope オブジェクトのコンテンツを、指定した Source オブジェクトからのデータに設定します。この Source には、有効な SOAP ドキュメントが含まれている必要があります。

パラメータ:

source - 設定するデータを含む javax.xml.transform.Source オブジェクト

例外:

SOAPException - source の設定時に問題がある場合

関連項目:

getContent()

getContent

public abstract Source getContent()
                           throws SOAPException

SOAPEnvelope のコンテンツを JAXP Source オブジェクトとして返します。

戻り値:

javax.xml.transform.Source オブジェクトとしてのコンテンツ

例外:

SOAPException - 実装が、指定した Source オブジェクトを変換できない場合

関連項目:

setContent(javax.xml.transform.Source)