パッケージ jakarta.xml.soap

インターフェース SOAPBody

  • すべてのスーパーインターフェース:
    ElementSE、Node、NodeSE、SOAPElement
    public interface SOAPBody
extends SOAPElement
    SOAP メッセージの SOAP 本体要素の内容を表すオブジェクト。SOAP 本体要素は、アプリケーション固有のコンテンツの処理方法に影響を与える XML データで構成されます。

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

    導入:
    1.6
    関連事項:
    SOAPFault

    • メソッドの詳細

      • addFault

        SOAPFault addFault()
            throws SOAPException
        新しい SOAPFault オブジェクトを作成し、それをこの SOAPBody オブジェクトに追加します。新しい SOAPFault には、必須の子要素にデフォルト値が設定されます。SOAPFault の型は、MessageFactory インスタンスの作成時に指定された protocol に応じて、SOAP 1.1 または SOAP1.2 SOAPFault になります。

        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.2 SOAPFault になります。

        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 の母国語を示す LocaleSE オブジェクト
        戻り値:
        新しい 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.2 SOAPFault になります。

        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 の母国語を示す LocaleSE オブジェクト
        戻り値:
        新しい 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.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 には、最大で 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.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 には、最大で 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
        DOM DocumentSE のルートノードをこの SOAPBody オブジェクトに追加します。

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

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

      • extractContentAsDocument

        DocumentSE extractContentAsDocument()
                           throws SOAPException
        新しい DOM DocumentSE を作成し、この SOAPBody の最初の子をドキュメント要素として設定します。子 SOAPElement は、プロセスの一部として削除されます。
        戻り値:
        SOAPBody コンテンツの DocumentSE 表現。
        例外:
        SOAPException - SOAPBody の子 SOAPElement が 1 つだけではない場合。
        導入:
        1.6、SAAJ 1.3