Module  java.xml.ws
软件包  javax.xml.soap

Interface SOAPBody

  • All Superinterfaces:
    Element ， Node ， Node ， SOAPElement 

    public interface SOAPBody
extends SOAPElement
    表示SOAP消息中SOAP主体元素内容的对象。 SOAP主体元素由影响应用程序特定内容处理方式的XML数据组成。

    一个SOAPBody对象包含SOAPBodyElement对象，它们具有SOAP主体的内容。 甲SOAPFault对象，其携带状态和/或错误信息，是一个的例子SOAPBodyElement对象。

    从以下版本开始：
    1.6
    另请参见：
    SOAPFault

    • 方法详细信息

      • addFault

        SOAPFault addFault​()
            throws SOAPException
        创建一个新的SOAPFault对象，并将其添加到此SOAPBody对象。 新的SOAPFault将为强制子元素设置默认值。 的类型的SOAPFault将是SOAP 1.1或SOAP 1.2 SOAPFault取决于protocol而创建指定MessageFactory实例。

        A SOAPBody可能包含一个SOAPFault子元素。

        结果
        新的 SOAPFault对象
        异常
        SOAPException - 如果存在SOAP错误

      • addFault

        SOAPFault addFault​(Name faultCode,
                   String faultString,
                   Locale locale)
            throws SOAPException
        创建一个新的SOAPFault对象，并将其添加到此SOAPBody对象。 的类型的SOAPFault将是SOAP 1.1或SOAP 1.2 SOAPFault取决于protocol而创建指定MessageFactory实例。

        对于SOAP faultCode参数是Fault / Code / Value元素的值， faultString参数是Fault / Reason / Text元素的值。 对于SOAP faultCode参数是faultcode元素的值，而faultString参数是faultstring元素的值。

        A SOAPBody可能包含一个SOAPFault子元素。

        参数
        faultCode - 给出要设置故障代码的Name对象; 必须是在使用的SOAP规范版本中定义的故障代码之一
        faultString - a String给出了故障的解释
        locale -一个Locale对象，指示的母语faultString
        结果
        新的 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将是SOAP 1.1或SOAP 1.2 SOAPFault取决于protocol而创建指定MessageFactory实例。

        对于SOAP faultCode参数是Fault / Code / Value元素的值， faultString参数是Fault / Reason / Text元素的值。 对于SOAP faultCode参数是faultcode元素的值，而faultString参数是faultstring元素的值。

        A SOAPBody可能包含一个SOAPFault子元素。

        参数
        faultCode - 给出要设置故障代码的QName对象; 必须是在使用的SOAP规范版本中定义的故障代码之一。
        faultString - a String给出了故障的解释
        locale -一个Locale对象，指示的母语faultString
        结果
        新的 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将是SOAP 1.1或SOAP 1.2 SOAPFault取决于protocol而创建指定MessageFactory实例。

        对于SOAP faultCode参数是Fault / Code / Value元素的值， faultString参数是Fault / Reason / Text元素的值。 对于SOAP faultCode参数是faultcode元素的值，而faultString参数是faultstring元素的值。

        在发生SOAP 1.2故障的情况下， Fault / Reason / Text元素上的强制性xml:lang属性的默认值将设置为java.util.Locale.getDefault()

        A SOAPBody可能包含一个SOAPFault子元素。

        参数
        faultCode - 给出要设置故障代码的Name对象; 必须是在使用的SOAP规范版本中定义的故障代码之一
        faultString - a 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将是SOAP 1.1或SOAP 1.2 SOAPFault取决于protocol而创建指定MessageFactory实例。

        对于SOAP faultCode参数是Fault / Code / Value元素的值， faultString参数是Fault / Reason / Text元素的值。 对于SOAP faultCode参数是faultcode元素的值，而faultString参数是faultstring元素的值。

        在发生SOAP 1.2故障的情况下， Fault / Reason / Text元素上的强制性xml:lang属性的默认值将设置为java.util.Locale.getDefault()

        A SOAPBody可能包含一个SOAPFault子元素

        参数
        faultCode - 给出要设置故障代码的QName对象; 必须是在使用的SOAP规范版本中定义的故障代码之一
        faultString - a 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​()
        指示是否 SOAPFault在此存在对象 SOAPBody对象。
        结果
        true如果此SOAPFault对象中存在SOAPBody对象; 否则为false

      • getFault

        SOAPFault getFault​()
        返回此 SOAPFault对象中的 SOAPBody对象。
        结果
        该 SOAPFault对象中的 SOAPBody对象如果存在，否则为空。

      • addBodyElement

        SOAPBodyElement addBodyElement​(QName qname)
                        throws SOAPException
        使用指定的QName创建一个新的 SOAPBodyElement对象，并将其添加到此 SOAPBody对象。
        参数
        qname -一个 QName对象与qname的新 SOAPBodyElement对象
        结果
        新的 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作为过程的一部分被删除。
        结果
        该Document表示SOAPBody内容。
        异常
        SOAPException - 如果没有完全一个孩子 SOAPElement的 SOAPBody 。
        从以下版本开始：
        1.6，SAAJ 1.3