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

Class SOAPFactory


  • public abstract class SOAPFactory
extends Object
    SOAPFactory是用于创建SOAP XML树中存在的各种对象的工厂。 可以使用SOAPFactory创建最终将在SOAP部分中的XML片段。 这些片段可作为SOAPHeaderElement或SOAPBodyElement或SOAPEnvelope或其他SOAPElement对象的子代插入。 SOAPFactory也有创建javax.xml.soap.Detail对象以及java.xml.soap.Name对象的方法。
    从以下版本开始：
    1.6

    • 构造方法详细信息

      • SOAPFactory

        public SOAPFactory​()

    • 方法详细信息

      • createElement

        public SOAPElement createElement​(Element domElement)
                          throws SOAPException
        从现有的DOM Element创建一个SOAPElement对象。 如果作为参数传入的DOM Element已经是一个SOAPElement那么这个方法必须不经修改地返回它，而无需任何进一步的工作。 否则，将创建一个新的SOAPElement ，并深入复制domElement参数。 返回值的具体类型将取决于domElement参数的名称。 如果根据domElement的树的任何部分违反SOAP规则，将抛出一个SOAPException 。
        参数
        domElement - - 要复制的 Element 。
        结果
        新 SOAPElement是副本 domElement 。
        异常
        SOAPException - 如果在创建 SOAPElement对象时出错
        从以下版本开始：
        1.6，SAAJ 1.3

      • createElement

        public abstract SOAPElement createElement​(Name name)
                                   throws SOAPException
        创建使用给定的SOAPElement对象初始化的Name对象。 返回值的具体类型将取决于给定的新的名称SOAPElement的名称。 例如，一个名为“{http://www.w3.org/2003/05/soap-envelope}Envelope”的新的SOAPElement将导致一个SOAPEnvelope支持SOAP 1.2行为被创建。
        参数
        name - 具有新元素的XML名称的 Name对象
        结果
        创建的新的 SOAPElement对象
        异常
        SOAPException - 如果在创建 SOAPElement对象时出错
        另请参见：
        createElement(javax.xml.namespace.QName)

      • createElement

        public SOAPElement createElement​(QName qname)
                          throws SOAPException
        创建使用给定的SOAPElement对象初始化的QName对象。 返回值的具体类型取决于给定的新名称SOAPElement的名称。 例如，名为“{http://www.w3.org/2003/05/soap-envelope}Envelope”的新的SOAPElement将导致一个SOAPEnvelope支持SOAP 1.2行为被创建。
        参数
        qname - 具有新元素的XML名称的 QName对象
        结果
        创建的新的 SOAPElement对象
        异常
        SOAPException - 如果在创建 SOAPElement对象时出错
        从以下版本开始：
        1.6，SAAJ 1.3
        另请参见：
        createElement(Name)

      • createElement

        public abstract SOAPElement createElement​(String localName)
                                   throws SOAPException
        创建使用给定的本地名称初始化的 SOAPElement对象。
        参数
        localName - 一个 String给出新元素的本地名称
        结果
        新建的 SOAPElement对象
        异常
        SOAPException - 如果在创建 SOAPElement对象时出错

      • createElement

        public abstract SOAPElement createElement​(String localName,
                                          String prefix,
                                          String uri)
                                   throws SOAPException
        使用给定的本地名称，前缀和uri创建一个新的SOAPElement对象。 返回值的具体类型将取决于给予新的SOAPElement的名称。 例如，一个名为“{http://www.w3.org/2003/05/soap-envelope}Envelope”的新的SOAPElement将导致一个SOAPEnvelope支持SOAP 1.2行为被创建。
        参数
        localName - 一个 String给出新元素的本地名称
        prefix - 这个 SOAPElement的前缀
        uri - 一个 String给出新元素所属的命名空间的URI
        结果
        创建的新的 SOAPElement对象
        异常
        SOAPException - 如果在创建 SOAPElement对象时出错

      • createDetail

        public abstract Detail createDetail​()
                             throws SOAPException
        创建一个新的Detail对象，作为DetailEntry对象的容器。

        这种工厂方法创建Detail对象，用于在不实用的情况下使用SOAPFault抽象。

        结果
        一个 Detail对象
        异常
        SOAPException - 如果存在SOAP错误
        UnsupportedOperationException - 如果为SOAPFactory指定的协议是 DYNAMIC_SOAP_PROTOCOL

      • createFault

        public abstract SOAPFault createFault​(String reasonText,
                                      QName faultCode)
                               throws SOAPException
        创建一个新的 SOAPFault对象，初始化为给定的 reasonText和 faultCode
        参数
        reasonText - 故障的ReasonText / FaultString
        faultCode - 故障的FaultCode
        结果
        一个 SOAPFault对象
        异常
        SOAPException - 如果存在SOAP错误
        从以下版本开始：
        1.6，SAAJ 1.3

      • createFault

        public abstract SOAPFault createFault​()
                               throws SOAPException
        创建一个新的默认值 SOAPFault对象
        结果
        一个 SOAPFault对象
        异常
        SOAPException - 如果存在SOAP错误
        从以下版本开始：
        1.6，SAAJ 1.3

      • createName

        public abstract Name createName​(String localName,
                                String prefix,
                                String uri)
                         throws SOAPException
        创建使用给定的本地名称，命名空间前缀和命名空间URI初始化的新的Name对象。

        这种工厂方法创建Name对象，以便在不实用的情况下使用SOAPEnvelope抽象。

        参数
        localName - 一个 String给出本地名称
        prefix - 一个 String给出命名空间的前缀
        uri - 一个 String给出命名空间的URI
        结果
        用给定的本地名称，命名空间前缀和命名空间URI初始化的一个 Name对象
        异常
        SOAPException - 如果存在SOAP错误

      • createName

        public abstract Name createName​(String localName)
                         throws SOAPException
        创建使用给定的本地名称初始化的新的Name对象。

        这种工厂方法创建Name对象，用于在使用SOAPEnvelope抽象时不实际的SOAPEnvelope 。

        参数
        localName - 一个 String给出本地名称
        结果
        一个 Name对象使用给定的本地名称初始化
        异常
        SOAPException - 如果存在SOAP错误

      • newInstance

        public static SOAPFactory newInstance​()
                               throws SOAPException
        创建一个新的SOAPFactory对象，该对象是默认实现（SOAP 1.1）的一个实例。 此方法使用javax.xml.soap中指定的查找过程来定位并加载SOAPFactory类。
        结果
        一个新的实例 SOAPFactory
        异常
        SOAPException -如果有一个错误创建默认 SOAPFactory
        另请参见：
        SAAJMetaFactory

      • newInstance

        public static SOAPFactory newInstance​(String protocol)
                               throws SOAPException
        创建一个新的 SOAPFactory对象，该对象是指定实现的实例，此方法使用SAAJMetaFactory来定位实现类并创建SOAPFactory实例。
        参数
        protocol - 表示指定的SOAP工厂实现的协议的字符串常量。 可以是DYNAMIC_SOAP_PROTOCOL ， DEFAULT_SOAP_PROTOCOL （其是相同的） SOAP_1_1_PROTOCOL ，或SOAP_1_2_PROTOCOL 。
        结果
        一个新的实例 SOAPFactory
        异常
        SOAPException - 如果创建指定的 SOAPFactory有错误
        从以下版本开始：
        1.6，SAAJ 1.3
        另请参见：
        SAAJMetaFactory