java.lang.Object
jakarta.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
jakarta.xml.soap.Detail
objects as well as
java.xml.soap.Name
objects.
- Since:
- 1.6
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionabstract Detail
Creates a newDetail
object which serves as a container forDetailEntry
objects.abstract SOAPElement
createElement
(Name name) Creates aSOAPElement
object initialized with the givenName
object.abstract SOAPElement
createElement
(String localName) Creates aSOAPElement
object initialized with the given local name.abstract SOAPElement
createElement
(String localName, String prefix, String uri) Creates a newSOAPElement
object with the given local name, prefix and uri.createElement
(QName qname) Creates aSOAPElement
object initialized with the givenQName
object.createElement
(Element domElement) Creates aSOAPElement
object from an existing DOMElement
.abstract SOAPFault
Creates a new defaultSOAPFault
objectabstract SOAPFault
createFault
(String reasonText, QName faultCode) Creates a newSOAPFault
object initialized with the givenreasonText
andfaultCode
abstract Name
createName
(String localName) Creates a newName
object initialized with the given local name.abstract Name
createName
(String localName, String prefix, String uri) Creates a newName
object initialized with the given local name, namespace prefix, and namespace URI.static SOAPFactory
Creates a newSOAPFactory
object that is an instance of the default implementation (SOAP 1.1).static SOAPFactory
newInstance
(String protocol) Creates a newSOAPFactory
object that is an instance of the specified implementation, this method uses the SAAJMetaFactory to locate the implementation class and create the SOAPFactory instance.
-
Constructor Details
-
SOAPFactory
protected SOAPFactory()Default constructor.
-
-
Method Details
-
createElement
Creates aSOAPElement
object from an existing DOMElement
. If the DOMElement
that is passed in as an argument is already aSOAPElement
then this method must return it unmodified without any further work. Otherwise, a newSOAPElement
is created and a deep copy is made of thedomElement
argument. The concrete type of the return value will depend on the name of thedomElement
argument. If any part of the tree rooted indomElement
violates SOAP rules, aSOAPException
will be thrown.- Parameters:
domElement
- theElement
to be copied.- Returns:
- a new
SOAPElement
that is a copy ofdomElement
. - Throws:
SOAPException
- if there is an error in creating theSOAPElement
object- Since:
- 1.6, SAAJ 1.3
-
createElement
Creates aSOAPElement
object initialized with the givenName
object. The concrete type of the return value will depend on the name given to the newSOAPElement
. For instance, a newSOAPElement
with the name "{http://www.w3.org/2003/05/soap-envelope}Envelope" would cause aSOAPEnvelope
that supports SOAP 1.2 behavior to be created.- 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- See Also:
-
createElement
Creates aSOAPElement
object initialized with the givenQName
object. The concrete type of the return value will depend on the name given to the newSOAPElement
. For instance, a newSOAPElement
with the name "{http://www.w3.org/2003/05/soap-envelope}Envelope" would cause aSOAPEnvelope
that supports SOAP 1.2 behavior to be created.- Parameters:
qname
- aQName
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- Since:
- 1.6, SAAJ 1.3
- See Also:
-
createElement
Creates 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(String localName, String prefix, String uri) throws SOAPException Creates a newSOAPElement
object with the given local name, prefix and uri. The concrete type of the return value will depend on the name given to the newSOAPElement
. For instance, a newSOAPElement
with the name "{http://www.w3.org/2003/05/soap-envelope}Envelope" would cause aSOAPEnvelope
that supports SOAP 1.2 behavior to be created.- 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
Creates a newDetail
object which serves as a container forDetailEntry
objects.This factory method creates
Detail
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 errorUnsupportedOperationException
- if the protocol specified for the SOAPFactory wasDYNAMIC_SOAP_PROTOCOL
-
createFault
Creates a newSOAPFault
object initialized with the givenreasonText
andfaultCode
- Parameters:
reasonText
- the ReasonText/FaultString for the faultfaultCode
- the FaultCode for the fault- Returns:
- a
SOAPFault
object - Throws:
SOAPException
- if there is a SOAP errorIllegalArgumentException
- ifreasonText
orfaultCode
is null- Since:
- 1.6, SAAJ 1.3
-
createFault
Creates a new defaultSOAPFault
object- Returns:
- a
SOAPFault
object - Throws:
SOAPException
- if there is a SOAP error- Since:
- 1.6, SAAJ 1.3
-
createName
Creates a newName
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 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
Creates a newName
object initialized with the given local name.This factory method creates
Name
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
Creates a newSOAPFactory
object that is an instance of the default implementation (SOAP 1.1). This method uses the lookup procedure specified injakarta.xml.soap
to locate and load theSOAPFactory
class.- Returns:
- a new instance of a
SOAPFactory
- Throws:
SOAPException
- if there was an error creating the defaultSOAPFactory
- See Also:
-
newInstance
Creates a newSOAPFactory
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 eitherDYNAMIC_SOAP_PROTOCOL
,DEFAULT_SOAP_PROTOCOL
(which is the same as)SOAP_1_1_PROTOCOL
, orSOAP_1_2_PROTOCOL
.- Returns:
- a new instance of a
SOAPFactory
- Throws:
SOAPException
- if there was an error creating the specifiedSOAPFactory
- Since:
- 1.6, SAAJ 1.3
- See Also:
-