モジュール java.xml.ws
パッケージ javax.xml.soap

インタフェースSOAPBody

  • すべてのスーパー・インタフェース:
    Element, Node, Node, 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または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
        DOM Documentのルート・ノードをこのSOAPBodyオブジェクトに追加します。

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

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

      • extractContentAsDocument

        Document extractContentAsDocument​()
                           throws SOAPException
        新しいDOM Documentを作成し、このSOAPBodyの最初の子をドキュメント要素として設定します。 子のSOAPElementは、処理の過程で削除されます。
        戻り値:
        SOAPBodyコンテンツのDocument表現。
        例外:
        SOAPException - SOAPBodyの子SOAPElementが1つも正確にない場合。
        導入されたバージョン:
        1.6, SAAJ 1.3