-
- すべてのスーパー・インタフェース:
Element
,Node
,Node
,SOAPElement
public interface SOAPBody extends SOAPElement
SOAPメッセージ内のSOAP本体要素のコンテンツを表すオブジェクトです。 SOAP本体要素はXMLデータで構成されており、アプリケーション固有のコンテンツの処理方法に影響します。SOAPBody
オブジェクトには、SOAP本体のコンテンツを持つSOAPBodyElement
オブジェクトが含まれています。 ステータスやエラー情報を伝えるSOAPFault
オブジェクトは、SOAPBodyElement
オブジェクトの一例です。- 導入されたバージョン:
- 1.6
- 関連項目:
SOAPFault
-
-
フィールドのサマリー
-
インタフェース 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
-
-
メソッドのサマリー
すべてのメソッド インスタンス・メソッド 抽象メソッド 修飾子と型 メソッド 説明 SOAPBodyElement
addBodyElement(QName qname)
指定のQNameでSOAPBodyElement
オブジェクトを新しく作成し、このSOAPBody
オブジェクトに追加します。SOAPBodyElement
addBodyElement(Name name)
指定の名前でSOAPBodyElement
オブジェクトを新しく作成し、このSOAPBody
オブジェクトに追加します。SOAPBodyElement
addDocument(Document document)
DOMDocument
のルート・ノードをこのSOAPBody
オブジェクトに追加します。SOAPFault
addFault()
新しいSOAPFault
オブジェクトを作成し、そのオブジェクトをこのSOAPBody
オブジェクトに追加します。SOAPFault
addFault(QName faultCode, String faultString)
新しいSOAPFault
オブジェクトを作成し、そのオブジェクトをこのSOAPBody
オブジェクトに追加します。SOAPFault
addFault(QName faultCode, String faultString, Locale locale)
新しいSOAPFault
オブジェクトを作成し、そのオブジェクトをこのSOAPBody
オブジェクトに追加します。SOAPFault
addFault(Name faultCode, String faultString)
新しいSOAPFault
オブジェクトを作成し、そのオブジェクトをこのSOAPBody
オブジェクトに追加します。SOAPFault
addFault(Name faultCode, String faultString, Locale locale)
新しいSOAPFault
オブジェクトを作成し、そのオブジェクトをこのSOAPBody
オブジェクトに追加します。Document
extractContentAsDocument()
新しいDOMDocument
を作成し、このSOAPBody
の最初の子をドキュメント要素として設定します。SOAPFault
getFault()
このSOAPBody
オブジェクト内のSOAPFault
オブジェクトを返します。boolean
hasFault()
このSOAPBody
オブジェクト内にSOAPFault
オブジェクトが存在するかどうかを示します。-
インタフェース org.w3c.dom.Elementから継承されたメソッド
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS
-
インタフェース 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
-
インタフェース javax.xml.soap.SOAPElementから継承されたメソッド
addAttribute, addAttribute, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, addTextNode, createQName, getAllAttributes, getAllAttributesAsQNames, getAttributeValue, getAttributeValue, getChildElements, getChildElements, getChildElements, getElementName, getElementQName, getEncodingStyle, getNamespacePrefixes, getNamespaceURI, getVisibleNamespacePrefixes, removeAttribute, removeAttribute, removeContents, removeNamespaceDeclaration, setElementQName, setEncodingStyle
-
-
-
-
メソッドの詳細
-
addFault
SOAPFault addFault() throws SOAPException
新しいSOAPFault
オブジェクトを作成し、そのオブジェクトをこのSOAPBody
オブジェクトに追加します。 新しいSOAPFault
のデフォルト値には、子の要素が強制的に設定されます。SOAPFault
のタイプは、MessageFactory
インスタンスの作成中に指定されるprotocol
によってSOAP 1.1またはSOAP 1.2のSOAPFault
に分かれます。SOAPBody
は、SOAPFault
の子の要素を最大1つ保有できます。- 戻り値:
- 新しい
SOAPFault
オブジェクト - 例外:
SOAPException
- SOAPエラーが存在する場合
-
addFault
SOAPFault addFault(Name faultCode, String faultString, Locale locale) throws SOAPException
新しいSOAPFault
オブジェクトを作成し、そのオブジェクトをこのSOAPBody
オブジェクトに追加します。SOAPFault
のタイプは、MessageFactory
インスタンスの作成中に指定されるprotocol
によってSOAP 1.1またはSOAP 1.2のSOAPFault
に分かれます。SOAP 1.2の場合、
faultCode
パラメータはFault/Code/Value要素の値で、faultString
パラメータはFault/Reason/Text要素の値です。 SOAP 1.1の場合、faultCode
パラメータはfaultcode
要素の値で、faultString
パラメータはfaultstring
要素の値です。SOAPBody
は、SOAPFault
の子の要素を最大1つ保有できます。- パラメータ:
faultCode
- 設定するフォルト・コードを示すName
オブジェクト(使用中のSOAP仕様のバージョンに定義されているフォルト・コードの1つである必要がある)faultString
- エラーの説明を提供するString
locale
-faultString
のネイティブ言語を示すLocale
オブジェクト- 戻り値:
- 新しい
SOAPFault
オブジェクト - 例外:
SOAPException
- SOAPエラーが存在する場合- 導入されたバージョン:
- 1.6, SAAJ 1.2
- 関連項目:
SOAPFault.setFaultCode(javax.xml.soap.Name)
,SOAPFault.setFaultString(java.lang.String)
-
addFault
SOAPFault addFault(QName faultCode, String faultString, Locale locale) throws SOAPException
新しいSOAPFault
オブジェクトを作成し、そのオブジェクトをこのSOAPBody
オブジェクトに追加します。SOAPFault
のタイプは、MessageFactory
インスタンスの作成中に指定されるprotocol
によってSOAP 1.1またはSOAP 1.2のSOAPFault
に分かれます。SOAP 1.2の場合、
faultCode
パラメータはFault/Code/Value要素の値で、faultString
パラメータはFault/Reason/Text要素の値です。 SOAP 1.1の場合、faultCode
パラメータはfaultcode
要素の値で、faultString
パラメータはfaultstring
要素の値です。SOAPBody
は、SOAPFault
の子の要素を最大1つ保有できます。- パラメータ:
faultCode
- 設定するフォルト・コードを示すQName
オブジェクト(使用中のSOAP仕様のバージョンに定義されているフォルト・コードの1つである必要がある)。faultString
- エラーの説明を提供するString
locale
-faultString
のネイティブ言語を示すLocale
オブジェクト- 戻り値:
- 新しい
SOAPFault
オブジェクト - 例外:
SOAPException
- SOAPエラーが存在する場合- 導入されたバージョン:
- 1.6, SAAJ 1.3
- 関連項目:
SOAPFault.setFaultCode(javax.xml.soap.Name)
,SOAPFault.setFaultString(java.lang.String)
,addFault(Name faultCode, String faultString, Locale locale)
-
addFault
SOAPFault addFault(Name faultCode, String faultString) throws SOAPException
新しいSOAPFault
オブジェクトを作成し、そのオブジェクトをこのSOAPBody
オブジェクトに追加します。SOAPFault
のタイプは、MessageFactory
インスタンスの作成中に指定されるprotocol
によってSOAP 1.1またはSOAP 1.2のSOAPFault
に分かれます。SOAP 1.2の場合、
faultCode
パラメータはFault/Code/Value要素の値で、faultString
パラメータはFault/Reason/Text要素の値です。 SOAP 1.1の場合、faultCode
パラメータはfaultcode要素の値で、faultString
パラメータはfaultstring要素の値です。SOAP 1.2が失敗した場合、Fault/Reason/Text要素で必須の
xml:lang
属性のデフォルト値がjava.util.Locale.getDefault()
に設定されますSOAPBody
は、SOAPFault
の子の要素を最大1つ保有できます。- パラメータ:
faultCode
- 設定するフォルト・コードを示すName
オブジェクト(使用中のSOAP仕様のバージョンに定義されているフォルト・コードの1つである必要がある)faultString
- エラーの説明を提供するString
- 戻り値:
- 新しい
SOAPFault
オブジェクト - 例外:
SOAPException
- SOAPエラーが存在する場合- 導入されたバージョン:
- 1.6, SAAJ 1.2
- 関連項目:
SOAPFault.setFaultCode(javax.xml.soap.Name)
,SOAPFault.setFaultString(java.lang.String)
-
addFault
SOAPFault addFault(QName faultCode, String faultString) throws SOAPException
新しいSOAPFault
オブジェクトを作成し、そのオブジェクトをこのSOAPBody
オブジェクトに追加します。SOAPFault
のタイプは、MessageFactory
インスタンスの作成中に指定されるprotocol
によってSOAP 1.1またはSOAP 1.2のSOAPFault
に分かれます。SOAP 1.2の場合、
faultCode
パラメータはFault/Code/Value要素の値で、faultString
パラメータはFault/Reason/Text要素の値です。 SOAP 1.1の場合、faultCode
パラメータはfaultcode要素の値で、faultString
パラメータはfaultstring要素の値です。SOAP 1.2が失敗した場合、Fault/Reason/Text要素で必須の
xml:lang
属性のデフォルト値がjava.util.Locale.getDefault()
に設定されますSOAPBody
は、SOAPFault
の子の要素を最大1つ保有できます- パラメータ:
faultCode
- 設定するフォルト・コードを示すQName
オブジェクト(使用中のSOAP仕様のバージョンに定義されているフォルト・コードの1つである必要がある)faultString
- エラーの説明を提供するString
- 戻り値:
- 新しい
SOAPFault
オブジェクト - 例外:
SOAPException
- SOAPエラーが存在する場合- 導入されたバージョン:
- 1.6, SAAJ 1.3
- 関連項目:
SOAPFault.setFaultCode(javax.xml.soap.Name)
,SOAPFault.setFaultString(java.lang.String)
,addFault(Name faultCode, String faultString)
-
hasFault
boolean hasFault()
このSOAPBody
オブジェクト内にSOAPFault
オブジェクトが存在するかどうかを示します。- 戻り値:
- この
SOAPBody
オブジェクト内にSOAPFault
オブジェクトが存在する場合はtrue
、それ以外の場合はfalse
-
getFault
SOAPFault getFault()
このSOAPBody
オブジェクト内のSOAPFault
オブジェクトを返します。- 戻り値:
- 存在する場合はこの
SOAPBody
オブジェクトのSOAPFault
オブジェクト、それ以外の場合はnull。
-
addBodyElement
SOAPBodyElement addBodyElement(Name name) throws SOAPException
指定の名前でSOAPBodyElement
オブジェクトを新しく作成し、このSOAPBody
オブジェクトに追加します。- パラメータ:
name
- 新規SOAPBodyElement
オブジェクトの名前を持つName
オブジェクト- 戻り値:
- 新しい
SOAPBodyElement
オブジェクト - 例外:
SOAPException
- SOAPエラーが発生した場合- 関連項目:
addBodyElement(javax.xml.namespace.QName)
-
addBodyElement
SOAPBodyElement addBodyElement(QName qname) throws SOAPException
指定のQNameでSOAPBodyElement
オブジェクトを新しく作成し、このSOAPBody
オブジェクトに追加します。- パラメータ:
qname
- 新規SOAPBodyElement
オブジェクトのqnameを持つQName
オブジェクト- 戻り値:
- 新しい
SOAPBodyElement
オブジェクト - 例外:
SOAPException
- SOAPエラーが発生した場合- 導入されたバージョン:
- 1.6, SAAJ 1.3
- 関連項目:
addBodyElement(Name)
-
addDocument
SOAPBodyElement addDocument(Document document) throws SOAPException
DOMDocument
のルート・ノードをこのSOAPBody
オブジェクトに追加します。このメソッドを呼び出すと、
document
パラメータが無効になります。 クライアント・アプリケーションは、addDocument
の呼出し時に、このDocument
とそのコンテンツに対するすべての参照を破棄するはずです。 継続してこのような参照を使用するアプリケーションの動作は、定義されていません。- パラメータ:
document
- このSOAPBody
に追加されるルート・ノードを持つDocument
オブジェクト。- 戻り値:
- 追加されたルート・ノードを表す
SOAPBodyElement
。 - 例外:
SOAPException
-Document
を追加できない場合- 導入されたバージョン:
- 1.6, SAAJ 1.2
-
extractContentAsDocument
Document extractContentAsDocument() throws SOAPException
新しいDOMDocument
を作成し、このSOAPBody
の最初の子をドキュメント要素として設定します。 子のSOAPElement
は、処理の過程で削除されます。- 戻り値:
SOAPBody
コンテンツのDocument
表現。- 例外:
SOAPException
-SOAPBody
の子SOAPElement
が1つも正確にない場合。- 導入されたバージョン:
- 1.6, SAAJ 1.3
-
-