Package javax.xml.soap
Class SOAPFactory
- java.lang.Object
-
- javax.xml.soap.SOAPFactory
-
public abstract class SOAPFactory extends java.lang.Object
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 theSOAPHeaderElement
orSOAPBodyElement
orSOAPEnvelope
.SOAPFactory
also has methods to createjavax.xml.soap.Detail
objects as well asjava.xml.soap.Name
objects.
-
-
Constructor Summary
Constructors Constructor Description SOAPFactory()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract Detail
createDetail()
Creates a newDetail
object which serves as a container forDetailEntry
objects.abstract SOAPElement
createElement(java.lang.String localName)
Create aSOAPElement
object initialized with the given local name.abstract SOAPElement
createElement(java.lang.String localName, java.lang.String prefix, java.lang.String uri)
Create a newSOAPElement
object with the given local name, prefix and uri.SOAPElement
createElement(javax.xml.namespace.QName qname)
Creates a SOAPElement object initialized with the given QName object.abstract SOAPElement
createElement(Name name)
Create aSOAPElement
object initialized with the givenName
object.SOAPElement
createElement(org.w3c.dom.Element element)
Creates a SOAPElement object from an existing DOM Element.abstract SOAPFault
createFault()
abstract SOAPFault
createFault(java.lang.String reasonText, javax.xml.namespace.QName faultCode)
abstract Name
createName(java.lang.String localName)
Creates a newName
object initialized with the given local name.abstract Name
createName(java.lang.String localName, java.lang.String prefix, java.lang.String uri)
Creates a newName
object initialized with the given local name, namespace prefix, and namespace URI.static SOAPFactory
newInstance()
Creates a new instance ofSOAPFactory
.static SOAPFactory
newInstance(java.lang.String protocol)
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.
-
-
-
Method Detail
-
createElement
public abstract SOAPElement createElement(Name name) throws SOAPException
Create aSOAPElement
object initialized with the givenName
object.- Parameters:
name
- aName
object with the XML name for the new element- Returns:
- the new
SOAPElement
object that was created - Throws:
SOAPException
- if there is an error in creating theSOAPElement
object
-
createElement
public abstract SOAPElement createElement(java.lang.String localName) throws SOAPException
Create aSOAPElement
object initialized with the given local name.- Parameters:
localName
- aString
giving the local name for the new element- Returns:
- the new
SOAPElement
object that was created - Throws:
SOAPException
- if there is an error in creating theSOAPElement
object
-
createElement
public abstract SOAPElement createElement(java.lang.String localName, java.lang.String prefix, java.lang.String uri) throws SOAPException
Create a newSOAPElement
object with the given local name, prefix and uri.- Parameters:
localName
- aString
giving the local name for the new elementprefix
- the prefix for thisSOAPElement
uri
- aString
giving the URI of the namespace to which the new element belongs- Returns:
- the new
SOAPElement
object that was created - Throws:
SOAPException
- if there is an error in creating theSOAPElement
object
-
createDetail
public abstract Detail createDetail() throws SOAPException
Creates a newDetail
object which serves as a container forDetailEntry
objects. This factory method createsDetail
objects for use in situations where it is not practical to use theSOAPFault
abstraction.- Returns:
- a
Detail
object - Throws:
SOAPException
- if there is a SOAP error
-
createName
public abstract Name createName(java.lang.String localName, java.lang.String prefix, java.lang.String uri) throws SOAPException
Creates a newName
object initialized with the given local name, namespace prefix, and namespace URI. This factory method createsName
objects for use in situations where it is not practical to use theSOAPEnvelope
abstraction.- Parameters:
localName
- aString
giving the local nameprefix
- aString
giving the prefix of the namespaceuri
- aString
giving the URI of the namespace- Returns:
- a
Name
object initialized with the given local name, namespace prefix, and namespace URI - Throws:
SOAPException
- if there is a SOAP error
-
createName
public abstract Name createName(java.lang.String localName) throws SOAPException
Creates a newName
object initialized with the given local name. This factory method createsName
objects for use in situations where it is not practical to use theSOAPEnvelope
abstraction.- Parameters:
localName
- aString
giving the local name- Returns:
- a
Name
object initialized with the given local name - Throws:
SOAPException
- if there is a SOAP error
-
newInstance
public static SOAPFactory newInstance() throws SOAPException
Creates a new instance ofSOAPFactory
.- Returns:
- a new instance of a
SOAPFactory
- Throws:
SOAPException
- if there was an error creating the defaultSOAPFactory
-
newInstance
public static SOAPFactory newInstance(java.lang.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.- Parameters:
protocol
- - a string constant representing the protocol of the specified SOAP factory implementation. May be either DYNAMIC_SOAP_PROTOCOL, DEFAULT_SOAP_PROTOCOL (which is the same as) SOAP_1_1_PROTOCOL, or SOAP_1_2_PROTOCOL. Returns: a new instance of a SOAPFactory- Returns:
- javax.xml.soap.SOAPFactory
- Throws:
SOAPException
- - if there is an error creating the specified SOAPFactory- See Also:
SAAJMetaFactory
-
createElement
public SOAPElement createElement(org.w3c.dom.Element element) 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.- Parameters:
domElement
- - the Element to be copied.- Returns:
- a new SOAPElement that is a copy of domElement.
- Throws:
SOAPException
- - if there is an error in creating the SOAPElement object- Since:
- SAAJ 1.3
- See Also:
SOAPFactoryImpl
-
createElement
public SOAPElement createElement(javax.xml.namespace.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} Envelope would cause a SOAPEnvelope that supports SOAP 1.2 behavior to be created.- Parameters:
qname
- - a QName object with the XML name for the new element- Returns:
- the new SOAPElement object that was created
- Throws:
SOAPException
- - if there is an error in creating the SOAPElement object- See Also:
SOAPFactoryImpl
-
createFault
public abstract SOAPFault createFault() throws SOAPException
- Throws:
SOAPException
-
createFault
public abstract SOAPFault createFault(java.lang.String reasonText, javax.xml.namespace.QName faultCode) throws SOAPException
- Throws:
SOAPException
-
-