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

インタフェースSOAPElement

  • すべてのスーパー・インタフェース:
    Element, Node, Node
    既知のすべてのサブインタフェース:
    Detail, DetailEntry, SOAPBody, SOAPBodyElement, SOAPEnvelope, SOAPFault, SOAPFaultElement, SOAPHeader, SOAPHeaderElement

    public interface SOAPElement
extends Node, Element
    SOAPメッセージの要素を示すオブジェクトです。SOAPの仕様で許可されていますが、明確に規定されているわけではありません。 このインタフェースは、SOAP仕様で明確に規定されたオブジェクトの基本インタフェースとしてサービスを実行します。

    SAAJ固有のオブジェクトを返す必要のあるこのインタフェースのメソッドは、正しい型のオブジェクトを正常に返す必要があるため、ツリー内のノードを通知することなく置き換えます。 詳細については、getChildElements()とjavax.xml.soapを参照してください。

    導入されたバージョン:
    1.6

    • メソッドの詳細

      • addChildElement

        SOAPElement addChildElement​(Name name)
                     throws SOAPException
        指定のNameオブジェクトで初期化したSOAPElementオブジェクトを新しく作成し、その新規要素をこのSOAPElementオブジェクトに追加します。

        このメソッドは、addChildElement(javax.xml.namespace.QName)との関係で、SAAJの将来のリリースで非推奨になる可能性があります。

        パラメータ:
        name - 新規要素のXML名を持つNameオブジェクト
        戻り値:
        作成された新しいSOAPElementオブジェクト
        例外:
        SOAPException - SOAPElementオブジェクトの作成時にエラーが発生した場合
        関連項目:
        addChildElement(javax.xml.namespace.QName)

      • addChildElement

        SOAPElement addChildElement​(QName qname)
                     throws SOAPException
        指定のQNameオブジェクトで初期化したSOAPElementオブジェクトを新しく作成し、その新規要素をこのSOAPElementオブジェクトに追加します。 新しいSOAPElementの名前空間、ローカル名、および接頭辞は、すべてqname引数から取得します。
        パラメータ:
        qname - 新規要素のXML名を持つQNameオブジェクト
        戻り値:
        作成された新しいSOAPElementオブジェクト
        例外:
        SOAPException - SOAPElementオブジェクトの作成時にエラーが発生した場合
        導入されたバージョン:
        1.6, SAAJ 1.3
        関連項目:
        addChildElement(Name)

      • addChildElement

        SOAPElement addChildElement​(String localName)
                     throws SOAPException
        指定のローカル名で初期化したSOAPElementオブジェクトを新しく作成し、その新規要素をこのSOAPElementオブジェクトに追加します。 新しいSOAPElementは、デフォルトの名前空間の範囲をすべて継承しています。
        パラメータ:
        localName - 要素のローカル名を示すString
        戻り値:
        作成された新しいSOAPElementオブジェクト
        例外:
        SOAPException - SOAPElementオブジェクトの作成時にエラーが発生した場合

      • addChildElement

        SOAPElement addChildElement​(String localName,
                            String prefix)
                     throws SOAPException
        指定のローカル名と接頭辞で初期化したSOAPElementオブジェクトを新しく作成し、その新規要素をこのSOAPElementオブジェクトに追加します。
        パラメータ:
        localName - 新規要素のローカル名を示すString
        prefix - 新規要素の名前空間の接頭辞を示すString
        戻り値:
        作成された新しいSOAPElementオブジェクト
        例外:
        SOAPException - prefixがこのSOAPElementのコンテキストで有効でない場合、またはSOAPElementオブジェクトの作成でエラーが発生した場合

      • addChildElement

        SOAPElement addChildElement​(String localName,
                            String prefix,
                            String uri)
                     throws SOAPException
        指定のローカル名、接頭辞、およびURIで初期化したSOAPElementオブジェクトを新しく作成し、その新規要素をこのSOAPElementオブジェクトに追加します。
        パラメータ:
        localName - 新規要素のローカル名を示すString
        prefix - 新規要素の名前空間の接頭辞を示すString
        uri - 新規要素が属する名前空間のURIを指定するString
        戻り値:
        作成された新しいSOAPElementオブジェクト
        例外:
        SOAPException - SOAPElementオブジェクトの作成時にエラーが発生した場合

      • addChildElement

        SOAPElement addChildElement​(SOAPElement element)
                     throws SOAPException
        このSOAPElementインスタンスの子としてSOAPElementを追加します。 SOAPElementは、SOAPFactoryで作成することが前提です。 呼出し側は、XMLツリーにそのまま追加される要素インスタンスを信用してはいけません。 異なるSOAPElement実装のインスタンスに渡されたSOAPElementのコンテンツをコピーして、実装が終わる可能性があります。 たとえば、addChildElement()がSOAPHeaderで呼び出される場合、elementはSOAPHeaderElementのインスタンスにコピーされます。

        elementにルートされたフラグメントは全体として追加されます。ただし、エラーが発生した場合は1つも追加されません。

        elementにルートされたフラグメントには、SOAP名前空間に「Envelope」、「Header」、「Body」という名前の要素を保有できません。 フラグメントに存在する名前空間の接頭辞は、そのフラグメント内部で適切な名前空間宣言を使用して完全に解決される必要があります。

        パラメータ:
        element - 新しい子として追加されるSOAPElement
        戻り値:
        実際にツリーに追加された新しいSOAP要素を示すインスタンス。
        例外:
        SOAPException - この要素を子として追加するときにエラーが発生した場合

      • removeContents

        void removeContents​()
        このSOAPElementのすべての子を切り離します。

        このメソッドは、エラー状態の検出時に障害を送信する準備として、SOAPHeadersやSOAPBodysを構築が完成している部分までロールバックするのに役立ちます。 また、SOAPメッセージ内のドキュメントの一部の再利用にも役立ちます。

        導入されたバージョン:
        1.6, SAAJ 1.2

      • addTextNode

        SOAPElement addTextNode​(String text)
                 throws SOAPException
        指定のStringで初期化されたTextオブジェクトを新しく作成し、このSOAPElementオブジェクトに追加します。
        パラメータ:
        text - 追加するテキスト・コンテンツを持つStringオブジェクト
        戻り値:
        新しいTextオブジェクトが挿入されたSOAPElementオブジェクト
        例外:
        SOAPException - 新しいTextオブジェクトの作成でエラーが発生した場合、またはこのSOAPElementに子として添付することが許可されていない場合

      • addAttribute

        SOAPElement addAttribute​(Name name,
                         String value)
                  throws SOAPException
        指定の名前と値を保持する属性を、このSOAPElementオブジェクトに追加します。
        パラメータ:
        name - 属性名を持つNameオブジェクト
        value - 属性値を提供するString
        戻り値:
        属性が挿入されたSOAPElementオブジェクト
        例外:
        SOAPException - 属性の作成でエラーが発生した場合、またはName nameを持つ属性をこのSOAPElementに設定することが無効な場合。
        関連項目:
        addAttribute(javax.xml.namespace.QName, String)

      • addAttribute

        SOAPElement addAttribute​(QName qname,
                         String value)
                  throws SOAPException
        指定の名前と値を保持する属性を、このSOAPElementオブジェクトに追加します。
        パラメータ:
        qname - 属性名を持つQNameオブジェクト
        value - 属性値を提供するString
        戻り値:
        属性が挿入されたSOAPElementオブジェクト
        例外:
        SOAPException - 属性の作成でエラーが発生した場合、またはQName qnameを持つ属性をこのSOAPElementに設定することが無効な場合。
        導入されたバージョン:
        1.6, SAAJ 1.3
        関連項目:
        addAttribute(Name, String)

      • addNamespaceDeclaration

        SOAPElement addNamespaceDeclaration​(String prefix,
                                    String uri)
                             throws SOAPException
        指定の接頭辞とURIを保持する名前空間宣言を、このSOAPElementオブジェクトに追加します。
        パラメータ:
        prefix - 名前空間の接頭辞を指定するString
        uri - 名前空間のURIを指定するString
        戻り値:
        この名前空間宣言が挿入されたSOAPElementオブジェクト。
        例外:
        SOAPException - 名前空間の作成でエラーが発生した場合

      • getAttributeValue

        String getAttributeValue​(Name name)
        指定された名前を保持する属性の値を返します。
        パラメータ:
        name - 属性名を持つNameオブジェクト
        戻り値:
        指定の属性の値を示すString、またはそのような属性がない場合はNull
        関連項目:
        getAttributeValue(javax.xml.namespace.QName)

      • getAttributeValue

        String getAttributeValue​(QName qname)
        指定されたqnameを保持する属性の値を返します。
        パラメータ:
        qname - 属性のqnameを持つQNameオブジェクト
        戻り値:
        指定の属性の値を示すString、またはそのような属性がない場合はNull
        導入されたバージョン:
        1.6, SAAJ 1.3
        関連項目:
        getAttributeValue(Name)

      • getAllAttributes

        Iterator<Name> getAllAttributes​()
        このSOAPElementオブジェクト内のすべての属性NameオブジェクトについてのIteratorを返します。 イテレータは属性名の取得に使用し、getAttributeValueメソッドへ渡して各属性の値を取得できます。
        戻り値:
        属性名のイテレータ
        関連項目:
        getAllAttributesAsQNames()

      • getAllAttributesAsQNames

        Iterator<QName> getAllAttributesAsQNames​()
        このSOAPElement内のすべての属性についてのIteratorをQNameオブジェクトとして返します。 イテレータは属性QNameの取得に使用し、getAttributeValueメソッドへ渡して各属性の値を取得できます。
        戻り値:
        属性のQNameのイテレータ
        導入されたバージョン:
        1.6, SAAJ 1.3
        関連項目:
        getAllAttributes()

      • getNamespaceURI

        String getNamespaceURI​(String prefix)
        指定の接頭辞を持つ名前空間のURIを返します。
        パラメータ:
        prefix - 検索する名前空間の接頭辞を指定するString
        戻り値:
        指定の接頭辞を持つ名前空間のURIを保持するString

      • getNamespacePrefixes

        Iterator<String> getNamespacePrefixes​()
        この要素で宣言されている名前空間接頭辞のStringのIteratorを返します。 このイテレータで返された接頭辞をgetNamespaceURIメソッドに渡し、各名前空間のURIを取得できます。
        戻り値:
        このSOAPElementオブジェクトの名前空間接頭辞のイテレータ

      • getVisibleNamespacePrefixes

        Iterator<String> getVisibleNamespacePrefixes​()
        この要素に表示されている名前空間接頭辞のStringのIteratorを返します。 このイテレータで返された接頭辞をgetNamespaceURIメソッドに渡し、各名前空間のURIを取得できます。
        戻り値:
        このSOAPElementオブジェクトのスコープ内にある名前空間接頭辞のイテレータ
        導入されたバージョン:
        1.6, SAAJ 1.2

      • createQName

        QName createQName​(String localName,
                  String prefix)
           throws SOAPException
        名前空間URIが、このSOAPElementのコンテキストのパラメータprefixに関連しているQNameを作成します。 新しいQNameの残りの要素は、パラメータ、localName、およびprefixから直接取得します。
        パラメータ:
        localName - 名前のローカル部分を含むString。
        prefix - 名前の接頭辞を含むString。
        戻り値:
        指定のlocalNameとprefix、およびこのSOAPElementのコンテキストのprefixに関連した名前空間を持つQName。 このネームスペースは、パラメータとしてprefixが与えられた場合、getNamespaceURI(String)によって返されるネームスペースと同じになります。
        例外:
        SOAPException - QNameを作成できない場合。
        導入されたバージョン:
        1.6, SAAJ 1.3

      • getElementName

        Name getElementName​()
        SOAPElementオブジェクトの名前を返します。
        戻り値:
        このSOAPElementオブジェクトの名前を持つNameオブジェクト

      • getElementQName

        QName getElementQName​()
        このSOAPElementオブジェクトのqnameを返します。
        戻り値:
        このSOAPElementオブジェクトのqnameを持つQNameオブジェクト
        導入されたバージョン:
        1.6, SAAJ 1.3
        関連項目:
        getElementName()

      • setElementQName

        SOAPElement setElementQName​(QName newName)
                     throws SOAPException
        可能であれば、このElementの名前をnewNameに変更します。 SOAPEnvelope、SOAPHeader、SOAPBodyなどのようなSOAP Defined要素は、このメソッドを使用して名前を変更できません。 変更しようとすると、SOAPExceptionがスローされます。

        呼出し側は、そのまま名前変更される要素インスタンスを信用してはいけません。 SOAPElementのコンテンツを、名前変更したインスタンスにコピーして実装が終わる可能性があります。

        パラメータ:
        newName - Elementの新しい名前。
        戻り値:
        名前が変更されたNode
        例外:
        SOAPException - このElementの名前変更が許可されていない場合。
        導入されたバージョン:
        1.6, SAAJ 1.3

      • removeAttribute

        boolean removeAttribute​(Name name)
        指定された名前の属性を削除します。
        パラメータ:
        name - 削除する属性の名前を持つNameオブジェクト
        戻り値:
        属性が正常に削除された場合はtrue、正常に削除されなかった場合はfalse
        関連項目:
        removeAttribute(javax.xml.namespace.QName)

      • removeAttribute

        boolean removeAttribute​(QName qname)
        指定されたqnameの属性を削除します。
        パラメータ:
        qname - 削除する属性のqnameを持つQNameオブジェクト
        戻り値:
        属性が正常に削除された場合はtrue、正常に削除されなかった場合はfalse
        導入されたバージョン:
        1.6, SAAJ 1.3
        関連項目:
        removeAttribute(Name)

      • removeNamespaceDeclaration

        boolean removeNamespaceDeclaration​(String prefix)
        指定の接頭辞に対応した名前空間宣言を削除します。
        パラメータ:
        prefix - 検索する接頭辞を指定するString
        戻り値:
        名前空間宣言が正常に削除された場合はtrue、正常に削除されなかった場合はfalse

      • getChildElements

        Iterator<Node> getChildElements​()
        この要素の直接の子NodeすべてにわたるIteratorを返します。 これにはSOAPElementオブジェクトだけでなくjavax.xml.soap.Textオブジェクトも含まれます。

        このメソッドを呼び出すと、子ノードElement、SOAPElement、およびorg.w3c.dom.Textノードが、この親ノードのタイプに応じて、SOAPElement、SOAPHeaderElement、SOAPBodyElementまたはjavax.xml.soap.Textノードに置き換えられる必要があります。 結果として、アプリケーションを呼び出す場合、DOM APIで取得されたこれらの子のノードに対する既存の参照は、すべて無効として扱う必要があるため、それらを破棄するか、このIteratorで返された値でリフレッシュする必要があります。 この動作は、同等のDOM APIを呼び出すことで回避できます。 詳細はjavax.xml.soapを参照してください。

        戻り値:
        このSOAPElementオブジェクトのコンテンツを持つイテレータ

      • getChildElements

        Iterator<Node> getChildElements​(Name name)
        指定の名前を持つこの要素の直接の子NodeすべてについてのIteratorを返します。 これらの子はすべてSOAPElementノードになります。

        このメソッドを呼び出すと、子ノードElement、SOAPElement、およびorg.w3c.dom.Textノードが、この親ノードのタイプに応じて、SOAPElement、SOAPHeaderElement、SOAPBodyElementまたはjavax.xml.soap.Textノードに置き換えられる必要があります。 結果として、アプリケーションを呼び出す場合、DOM APIで取得されたこれらの子のノードに対する既存の参照は、すべて無効として扱う必要があるため、それらを破棄するか、このIteratorで返された値でリフレッシュする必要があります。 この動作は、同等のDOM APIを呼び出すことで回避できます。 詳細はjavax.xml.soapを参照してください。

        パラメータ:
        name - 返される子要素の名前を持つNameオブジェクト
        戻り値:
        指定の名前を持つこのSOAPElementオブジェクトの要素すべてにわたるIteratorオブジェクト
        関連項目:
        getChildElements(javax.xml.namespace.QName)

      • getChildElements

        Iterator<Node> getChildElements​(QName qname)
        指定のqnameを持つこの要素の直接の子NodeすべてにわたるIteratorを返します。 これらの子はすべてSOAPElementノードになります。

        このメソッドを呼び出すと、子ノードElement、SOAPElement、およびorg.w3c.dom.Textノードが、この親ノードのタイプに応じて、SOAPElement、SOAPHeaderElement、SOAPBodyElementまたはjavax.xml.soap.Textノードに置き換えられる必要があります。 結果として、アプリケーションを呼び出す場合、DOM APIで取得されたこれらの子のノードに対する既存の参照は、すべて無効として扱う必要があるため、それらを破棄するか、このIteratorで返された値でリフレッシュする必要があります。 この動作は、同等のDOM APIを呼び出すことで回避できます。 詳細はjavax.xml.soapを参照してください。

        パラメータ:
        qname - 返される子要素のqnameを持つQNameオブジェクト
        戻り値:
        指定のqnameを持つこのSOAPElementオブジェクトの要素すべてにわたるIteratorオブジェクト
        導入されたバージョン:
        1.6, SAAJ 1.3
        関連項目:
        getChildElements(Name)

      • setEncodingStyle

        void setEncodingStyle​(String encodingStyle)
               throws SOAPException
        このSOAPElementオブジェクトのエンコーディング・スタイルを指定のものに設定します。
        パラメータ:
        encodingStyle - エンコーディング・スタイルを指定するString
        例外:
        IllegalArgumentException - 設定するエンコーディング・スタイルに問題があった場合。
        SOAPException - このSOAPElementに対するencodingStyleの設定が無効の場合。
        関連項目:
        getEncodingStyle()

      • getEncodingStyle

        String getEncodingStyle​()
        このSOAPElementオブジェクトのエンコーディング・スタイルを返します。
        戻り値:
        エンコーディング・スタイルを指定するString
        関連項目:
        setEncodingStyle(java.lang.String)