Save This Page
Home » openjdk-7 » javax » xml » soap » [javadoc | source]
javax.xml.soap
abstract public class: SOAPFactory [javadoc | source]
java.lang.Object
   javax.xml.soap.SOAPFactory
SOAPFactory is a factory for creating various objects that exist in the SOAP XML tree. SOAPFactory can be used to create XML fragments that will eventually end up in the SOAP part. These fragments can be inserted as children of the SOAPHeaderElement or SOAPBodyElement or SOAPEnvelope or other SOAPElement objects. SOAPFactory also has methods to create javax.xml.soap.Detail objects as well as java.xml.soap.Name objects.
Method from javax.xml.soap.SOAPFactory Summary:
createDetail,   createElement,   createElement,   createElement,   createElement,   createElement,   createFault,   createFault,   createName,   createName,   newInstance,   newInstance
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.xml.soap.SOAPFactory Detail:
 abstract public Detail createDetail() throws SOAPException
    Creates a new Detail object which serves as a container for DetailEntry objects.

    This factory method creates Detail objects for use in situations where it is not practical to use the SOAPFault abstraction.

 public SOAPElement createElement(Element domElement) throws SOAPException 
    Creates a SOAPElement object from an existing DOM Element. If the DOM Element that is passed in as an argument is already a SOAPElement then this method must return it unmodified without any further work. Otherwise, a new SOAPElement is created and a deep copy is made of the domElement argument. The concrete type of the return value will depend on the name of the domElement argument. If any part of the tree rooted in domElement violates SOAP rules, a SOAPException will be thrown.
 abstract public SOAPElement createElement(Name name) throws SOAPException
    Creates a SOAPElement object initialized with the given Name object. The concrete type of the return value will depend on the name given to the new SOAPElement. For instance, a new SOAPElement with the name "{http://www.w3.org/2003/05/soap-envelope}Envelope" would cause a SOAPEnvelope that supports SOAP 1.2 behavior to be created.
 public SOAPElement createElement(QName qname) throws SOAPException 
    Creates a SOAPElement object initialized with the given QName object. The concrete type of the return value will depend on the name given to the new SOAPElement. For instance, a new SOAPElement with the name "{http://www.w3.org/2003/05/soap-envelope}Envelope" would cause a SOAPEnvelope that supports SOAP 1.2 behavior to be created.
 abstract public SOAPElement createElement(String localName) throws SOAPException
    Creates a SOAPElement object initialized with the given local name.
 abstract public SOAPElement createElement(String localName,
    String prefix,
    String uri) throws SOAPException
    Creates a new SOAPElement object with the given local name, prefix and uri. The concrete type of the return value will depend on the name given to the new SOAPElement. For instance, a new SOAPElement with the name "{http://www.w3.org/2003/05/soap-envelope}Envelope" would cause a SOAPEnvelope that supports SOAP 1.2 behavior to be created.
 abstract public SOAPFault createFault() throws SOAPException
    Creates a new default SOAPFault object
 abstract public SOAPFault createFault(String reasonText,
    QName faultCode) throws SOAPException
    Creates a new SOAPFault object initialized with the given reasonText and faultCode
 abstract public Name createName(String localName) throws SOAPException
    Creates a new Name object initialized with the given local name.

    This factory method creates Name objects for use in situations where it is not practical to use the SOAPEnvelope abstraction.

 abstract public Name createName(String localName,
    String prefix,
    String uri) throws SOAPException
    Creates a new Name object initialized with the given local name, namespace prefix, and namespace URI.

    This factory method creates Name objects for use in situations where it is not practical to use the SOAPEnvelope abstraction.

 public static SOAPFactory newInstance() throws SOAPException 
    Creates a new SOAPFactory object that is an instance of the default implementation (SOAP 1.1), This method uses the following ordered lookup procedure to determine the SOAPFactory implementation class to load:
    • Use the javax.xml.soap.SOAPFactory system property.
    • Use the properties file "lib/jaxm.properties" in the JRE directory. This configuration file is in standard java.util.Properties format and contains the fully qualified name of the implementation class with the key being the system property defined above.
    • Use the Services API (as detailed in the JAR specification), if available, to determine the classname. The Services API will look for a classname in the file META-INF/services/javax.xml.soap.SOAPFactory in jars available to the runtime.
    • Use the SAAJMetaFactory instance to locate the SOAPFactory implementation class.
 public static SOAPFactory newInstance(String protocol) throws SOAPException 
    Creates a new SOAPFactory object that is an instance of the specified implementation, this method uses the SAAJMetaFactory to locate the implementation class and create the SOAPFactory instance.