概要  パッケージ   クラス  使用  階層ツリー  非推奨 API  索引  ヘルプ 
JavaTM Platform
Standard Ed. 6
 前のクラス   次のクラス フレームあり    フレームなし    
概要: 入れ子 | フィールド | コンストラクタ | メソッド 詳細: フィールド | コンストラクタ | メソッド

javax.xml.soap
インタフェース SOAPBody

すべてのスーパーインタフェース:
Element, Node, SOAPElement
public interface SOAPBody
extends SOAPElement

SOAP メッセージ内の SOAP 本体要素のコンテンツを表すオブジェクトです。SOAP 本体要素は XML データで構成されており、アプリケーション固有のコンテンツの処理方法に影響します。

SOAPBody オブジェクトには、SOAP 本体のコンテンツを持つ SOAPBodyElement オブジェクトが含まれています。ステータスやエラー情報を運ぶ SOAPFault オブジェクトは、SOAPBodyElement オブジェクトの一例です。

関連項目:
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(Name name)
          指定の名前で SOAPBodyElement オブジェクトを新しく作成し、この SOAPBody オブジェクトに追加します。
 SOAPBodyElement addBodyElement(QName qname)
          指定の QName で SOAPBodyElement オブジェクトを新しく作成し、この SOAPBody オブジェクトに追加します。
 SOAPBodyElement addDocument(Document document)
          DOM Document のルートノードを、この SOAPBody オブジェクトに追加します。
 SOAPFault addFault()
          SOAPFault オブジェクトを新しく作成し、この SOAPBody オブジェクトに追加します。
 SOAPFault addFault(Name faultCode, String faultString)
          SOAPFault オブジェクトを新しく作成し、この SOAPBody オブジェクトに追加します。
 SOAPFault addFault(Name faultCode, String faultString, Locale locale)
          SOAPFault オブジェクトを新しく作成し、この SOAPBody オブジェクトに追加します。
 SOAPFault addFault(QName faultCode, String faultString)
          SOAPFault オブジェクトを新しく作成し、この SOAPBody オブジェクトに追加します。
 SOAPFault addFault(QName faultCode, String faultString, Locale locale)
          SOAPFault オブジェクトを新しく作成し、この SOAPBody オブジェクトに追加します。
 Document extractContentAsDocument()
          DOM Document を新しく作成し、この SOAPBody の最初の子をドキュメント要素として設定します。
 SOAPFault getFault()
          この SOAPBody オブジェクトの SOAPFault オブジェクトを返します。
 boolean hasFault()
          この SOAPBody オブジェクト内に SOAPFault オブジェクトが存在するかどうかを示します。
 
インタフェース 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
 
インタフェース javax.xml.soap.Node から継承されたメソッド
detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue
 
インタフェース org.w3c.dom.Element から継承されたメソッド
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS
 
インタフェース 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
 

メソッドの詳細

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 エラーが存在する場合
導入されたバージョン:
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 エラーが存在する場合
導入されたバージョン:
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 エラーが存在する場合
導入されたバージョン:
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 エラーが存在する場合
導入されたバージョン:
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 エラーが発生した場合
導入されたバージョン:
SAAJ 1.3
関連項目:
addBodyElement(Name)

addDocument

SOAPBodyElement addDocument(Document document)
                            throws SOAPException
DOM Document のルートノードを、この SOAPBody オブジェクトに追加します。

このメソッドを呼び出すと、document パラメータが無効になります。クライアントアプリケーションは、addDocument の呼び出し時に、この Document とそのコンテンツに対するすべての参照を破棄します。継続してこのような参照を使用するアプリケーションの動作は、定義されていません。

パラメータ:
document - この SOAPBody に追加されるルートノードを持つ Document オブジェクト
戻り値:
追加されたルートノードを表す SOAPBodyElement
例外:
SOAPException - Document を追加できない場合
導入されたバージョン:
SAAJ 1.2

extractContentAsDocument

Document extractContentAsDocument()
                                  throws SOAPException
DOM Document を新しく作成し、この SOAPBody の最初の子をドキュメント要素として設定します。子の SOAPElement は、処理の過程で削除されます。

戻り値:
SOAPBody コンテンツの Document 表現
例外:
SOAPException - SOAPBody の子の SOAPElement が 1 つでない場合
導入されたバージョン:
SAAJ 1.3
概要  パッケージ   クラス  使用  階層ツリー  非推奨 API  索引  ヘルプ 
JavaTM Platform
Standard Ed. 6
 前のクラス   次のクラス フレームあり    フレームなし    
概要: 入れ子 | フィールド | コンストラクタ | メソッド 詳細: フィールド | コンストラクタ | メソッド
バグの報告と機能のリクエスト
さらに詳しい API リファレンスおよび開発者ドキュメントについては、Java SE 開発者用ドキュメントを参照してください。開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、およびコード実例が含まれています。

Copyright 2009 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。