インターフェース SOAPBody
- すべてのスーパーインターフェース:
ElementSE
、Node
、NodeSE
、SOAPElement
public interface SOAPBody extends SOAPElement
SOAP メッセージの SOAP 本体要素の内容を表すオブジェクト。SOAP 本体要素は、アプリケーション固有のコンテンツの処理方法に影響を与える XML データで構成されます。SOAPBody
オブジェクトには、SOAP 本体のコンテンツを持つSOAPBodyElement
オブジェクトが含まれています。ステータスやエラー情報を保持するSOAPFault
オブジェクトは、SOAPBodyElement
オブジェクトの例です。- 導入:
- 1.6
- 関連事項:
SOAPFault
フィールドサマリー
インターフェース 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
メソッドのサマリー
すべてのメソッド インスタンスメソッド 抽象メソッド 修飾子と型 メソッド 説明 SOAPBodyElement
addBodyElement(Name name)
指定された名前で新しいSOAPBodyElement
オブジェクトを作成し、それをこのSOAPBody
オブジェクトに追加します。SOAPBodyElement
addBodyElement(QNameSE qname)
指定された QName で新しいSOAPBodyElement
オブジェクトを作成し、それをこのSOAPBody
オブジェクトに追加します。SOAPBodyElement
addDocument(DocumentSE document)
DOMDocument
SE のルートノードをこのSOAPBody
オブジェクトに追加します。SOAPFault
addFault()
新しいSOAPFault
オブジェクトを作成し、それをこのSOAPBody
オブジェクトに追加します。SOAPFault
addFault(Name faultCode, StringSE faultString)
新しいSOAPFault
オブジェクトを作成し、それをこのSOAPBody
オブジェクトに追加します。SOAPFault
addFault(Name faultCode, StringSE faultString, LocaleSE locale)
新しいSOAPFault
オブジェクトを作成し、それをこのSOAPBody
オブジェクトに追加します。SOAPFault
addFault(QNameSE faultCode, StringSE faultString)
新しいSOAPFault
オブジェクトを作成し、それをこのSOAPBody
オブジェクトに追加します。SOAPFault
addFault(QNameSE faultCode, StringSE faultString, LocaleSE locale)
新しいSOAPFault
オブジェクトを作成し、それをこのSOAPBody
オブジェクトに追加します。DocumentSE
extractContentAsDocument()
新しい DOMDocument
SE を作成し、このSOAPBody
の最初の子をドキュメント要素として設定します。SOAPFault
getFault()
このSOAPBody
オブジェクト内のSOAPFault
オブジェクトを返します。boolean
hasFault()
このSOAPBody
オブジェクトにSOAPFault
オブジェクトが存在するかどうかを示します。インターフェース org.w3c.dom.ElementSE から継承されたメソッド
getAttributeSE, getAttributeNodeSE, getAttributeNodeNSSE, getAttributeNSSE, getElementsByTagNameSE, getElementsByTagNameNSSE, getSchemaTypeInfo, getTagName, hasAttributeSE, hasAttributeNSSE, removeAttributeSE, removeAttributeNodeSE, removeAttributeNSSE, setAttributeSE, setAttributeNodeSE, setAttributeNodeNSSE, setAttributeNSSE, setIdAttributeSE, setIdAttributeNodeSE, setIdAttributeNSSE
インターフェース 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
インターフェース jakarta.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 または SOAP1.2SOAPFault
になります。SOAPBody
には、最大で 1 つのSOAPFault
子要素を含めることができます。- 戻り値:
- 新しい
SOAPFault
オブジェクト - 例外:
SOAPException
- SOAP エラーがある場合
addFault
SOAPFault addFault(Name faultCode, StringSE faultString, LocaleSE locale) throws SOAPException
新しいSOAPFault
オブジェクトを作成し、それをこのSOAPBody
オブジェクトに追加します。SOAPFault
の型は、MessageFactory
インスタンスの作成時に指定されたprotocol
に応じて、SOAP 1.1 または SOAP1.2SOAPFault
になります。SOAP 1.2 の場合、
faultCode
パラメーターは Fault/Code/Value 要素の値であり、faultString
パラメーターは Fault/Reason/Text 要素の値です。SOAP 1.1 の場合、faultCode
パラメーターはfaultcode
エレメントの値であり、faultString
パラメーターはfaultstring
エレメントの値です。SOAPBody
には、最大で 1 つのSOAPFault
子要素を含めることができます。- パラメーター:
faultCode
- 設定する障害コードを提供するName
オブジェクト。使用中の SOAP 仕様のバージョンで定義されている障害コードの 1 つである必要がありますfaultString
- 障害の説明を提供するString
locale
-faultString
の母国語を示すLocale
SE オブジェクト- 戻り値:
- 新しい
SOAPFault
オブジェクト - 例外:
SOAPException
- SOAP エラーがある場合- 導入:
- 1.6、SAAJ 1.2
- 関連事項:
SOAPFault.setFaultCode(jakarta.xml.soap.Name)
,SOAPFault.setFaultString(java.lang.String)
addFault
SOAPFault addFault(QNameSE faultCode, StringSE faultString, LocaleSE locale) throws SOAPException
新しいSOAPFault
オブジェクトを作成し、それをこのSOAPBody
オブジェクトに追加します。SOAPFault
の型は、MessageFactory
インスタンスの作成時に指定されたprotocol
に応じて、SOAP 1.1 または SOAP1.2SOAPFault
になります。SOAP 1.2 の場合、
faultCode
パラメーターは Fault/Code/Value 要素の値であり、faultString
パラメーターは Fault/Reason/Text 要素の値です。SOAP 1.1 の場合、faultCode
パラメーターはfaultcode
エレメントの値であり、faultString
パラメーターはfaultstring
エレメントの値です。SOAPBody
には、最大で 1 つのSOAPFault
子要素を含めることができます。- パラメーター:
faultCode
- 設定する障害コードを提供するQName
オブジェクト。使用中の SOAP 仕様のバージョンで定義されている障害コードの 1 つである必要があります。faultString
- 障害の説明を提供するString
locale
-faultString
の母国語を示すLocale
SE オブジェクト- 戻り値:
- 新しい
SOAPFault
オブジェクト - 例外:
SOAPException
- SOAP エラーがある場合- 導入:
- 1.6、SAAJ 1.3
- 関連事項:
SOAPFault.setFaultCode(jakarta.xml.soap.Name)
,SOAPFault.setFaultString(java.lang.String)
,addFault(Name faultCode, String faultString, Locale locale)
addFault
SOAPFault addFault(Name faultCode, StringSE faultString) throws SOAPException
新しいSOAPFault
オブジェクトを作成し、それをこのSOAPBody
オブジェクトに追加します。SOAPFault
の型は、MessageFactory
インスタンスの作成時に指定されたprotocol
に応じて、SOAP 1.1 または SOAP1.2SOAPFault
になります。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
には、最大で 1 つのSOAPFault
子要素を含めることができます。- パラメーター:
faultCode
- 設定する障害コードを提供するName
オブジェクト。使用中の SOAP 仕様のバージョンで定義されている障害コードの 1 つである必要がありますfaultString
- 障害の説明を提供するString
- 戻り値:
- 新しい
SOAPFault
オブジェクト - 例外:
SOAPException
- SOAP エラーがある場合- 導入:
- 1.6、SAAJ 1.2
- 関連事項:
SOAPFault.setFaultCode(jakarta.xml.soap.Name)
,SOAPFault.setFaultString(java.lang.String)
addFault
SOAPFault addFault(QNameSE faultCode, StringSE faultString) throws SOAPException
新しいSOAPFault
オブジェクトを作成し、それをこのSOAPBody
オブジェクトに追加します。SOAPFault
の型は、MessageFactory
インスタンスの作成時に指定されたprotocol
に応じて、SOAP 1.1 または SOAP1.2SOAPFault
になります。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
には、最大で 1 つのSOAPFault
子要素を含めることができます- パラメーター:
faultCode
- 設定する障害コードを提供するQName
オブジェクト。使用中の SOAP 仕様のバージョンで定義されている障害コードの 1 つである必要がありますfaultString
- 障害の説明を提供するString
- 戻り値:
- 新しい
SOAPFault
オブジェクト - 例外:
SOAPException
- SOAP エラーがある場合- 導入:
- 1.6、SAAJ 1.3
- 関連事項:
SOAPFault.setFaultCode(jakarta.xml.soap.Name)
,SOAPFault.setFaultString(java.lang.String)
,addFault(Name faultCode, String faultString)
hasFault
boolean hasFault()
このSOAPBody
オブジェクトにSOAPFault
オブジェクトが存在するかどうかを示します。- 戻り値:
-
SOAPFault
オブジェクトがこのSOAPBody
オブジェクトに存在する場合はtrue
。それ以外の場合はfalse
getFault
SOAPFault getFault()
このSOAPBody
オブジェクト内のSOAPFault
オブジェクトを返します。- 戻り値:
- この
SOAPBody
オブジェクト内のSOAPFault
オブジェクトが存在する場合は null、それ以外の場合は null。
addBodyElement
SOAPBodyElement addBodyElement(Name name) throws SOAPException
指定された名前で新しいSOAPBodyElement
オブジェクトを作成し、それをこのSOAPBody
オブジェクトに追加します。- パラメーター:
name
- 新しいSOAPBodyElement
オブジェクトの名前を持つName
オブジェクト- 戻り値:
- 新しい
SOAPBodyElement
オブジェクト - 例外:
SOAPException
- SOAP エラーが発生した場合- 関連事項:
addBodyElement(javax.xml.namespace.QName)
addBodyElement
SOAPBodyElement addBodyElement(QNameSE qname) throws SOAPException
指定された QName で新しいSOAPBodyElement
オブジェクトを作成し、それをこのSOAPBody
オブジェクトに追加します。- パラメーター:
qname
- 新しいSOAPBodyElement
オブジェクトの qname を持つQName
オブジェクト- 戻り値:
- 新しい
SOAPBodyElement
オブジェクト - 例外:
SOAPException
- SOAP エラーが発生した場合- 導入:
- 1.6、SAAJ 1.3
- 関連事項:
addBodyElement(Name)
addDocument
SOAPBodyElement addDocument(DocumentSE document) throws SOAPException
DOMDocument
SE のルートノードをこのSOAPBody
オブジェクトに追加します。このメソッドを呼び出すと、
document
パラメーターが無効になります。クライアントアプリケーションは、addDocument
を呼び出すときに、このDocument
とその内容へのすべての参照を破棄する必要があります。このような参照を引き続き使用するアプリケーションの動作は定義されていません。- パラメーター:
document
- ルートノードがこのSOAPBody
に追加されるDocument
オブジェクト。- 戻り値:
- 追加されたルートノードを表す
SOAPBodyElement
。 - 例外:
SOAPException
-Document
を追加できない場合- 導入:
- 1.6、SAAJ 1.2
extractContentAsDocument
DocumentSE extractContentAsDocument() throws SOAPException
- 戻り値:
SOAPBody
コンテンツのDocument
SE 表現。- 例外:
SOAPException
-SOAPBody
の子SOAPElement
が 1 つだけではない場合。- 導入:
- 1.6、SAAJ 1.3