| |
|
| java.lang.Object
 javax.xml.soap.SOAPFactory
| SOAPFactory | | abstract public class SOAPFactory (Code) | | 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 Summary | |
| abstract public Detail | createDetail()
Creates a new Detail object which serves as a container
for DetailEntry objects. | | public SOAPElement | createElement(Element domElement)
Creates a SOAPElement object from an existing DOM
Element. | | abstract public SOAPElement | createElement(Name name)
Creates a SOAPElement object initialized with the
given Name object. | | public SOAPElement | createElement(QName qname)
Creates a SOAPElement object initialized with the
given QName object. | | abstract public SOAPElement | createElement(String localName)
Creates a SOAPElement object initialized with the
given local name. | | abstract public SOAPElement | createElement(String localName, String prefix, String uri)
Creates a new SOAPElement object with the given
local name, prefix and uri. | | abstract public SOAPFault | createFault(String reasonText, QName faultCode)
| | abstract public SOAPFault | createFault()
| | abstract public Name | createName(String localName, String prefix, String uri)
Creates a new Name object initialized with the
given local name, namespace prefix, and namespace URI. | | abstract public Name | createName(String localName)
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. | | public static SOAPFactory | newInstance()
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.
| | public static SOAPFactory | newInstance(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.
a new instance of a SOAPFactory
Parameters:
protocol - a string constant representing the protocol of thespecified SOAP factory implementation. |
| createDetail | | abstract public Detail createDetail() throws SOAPException(Code) | | 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.
a Detail object
throws:
SOAPException - if there is a SOAP error
throws:
UnsupportedOperationException - if the protocol specified for the SOAPFactory was DYNAMIC_SOAP_PROTOCOL |
| createElement | | public SOAPElement createElement(Element domElement) throws SOAPException(Code) | | 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. a new SOAPElement that is a copy of domElement.
exception:
SOAPException - if there is an error in creating theSOAPElement object
since:
SAAJ 1.3 |
| createElement | | abstract public SOAPElement createElement(Name name) throws SOAPException(Code) | | 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.
Parameters:
name - a Name object with the XML name forthe new element the new SOAPElement object that wascreated
exception:
SOAPException - if there is an error in creating theSOAPElement object
See Also: SOAPFactory.createElement(javax.xml.namespace.QName) |
| createElement | | public SOAPElement createElement(QName qname) throws SOAPException(Code) | | 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.
Parameters:
qname - a QName object with the XML name forthe new element the new SOAPElement object that wascreated
exception:
SOAPException - if there is an error in creating theSOAPElement object
See Also: SOAPFactory.createElement(Name)
since:
SAAJ 1.3 |
| createElement | | abstract public SOAPElement createElement(String localName) throws SOAPException(Code) | | Creates a SOAPElement object initialized with the
given local name.
Parameters:
localName - a String giving the local name forthe new element the new SOAPElement object that wascreated
exception:
SOAPException - if there is an error in creating theSOAPElement object |
| createElement | | abstract public SOAPElement createElement(String localName, String prefix, String uri) throws SOAPException(Code) | | 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.
Parameters:
localName - a String giving the local namefor the new element
Parameters:
prefix - the prefix for this SOAPElement
Parameters:
uri - a String giving the URI of thenamespace to which the new element belongs
exception:
SOAPException - if there is an error in creating theSOAPElement object |
| createFault | | abstract public SOAPFault createFault(String reasonText, QName faultCode) throws SOAPException(Code) | | Creates a new SOAPFault object initialized with the given reasonText
and faultCode
Parameters:
reasonText - the ReasonText/FaultString for the fault
Parameters:
faultCode - the FaultCode for the fault a SOAPFault object
throws:
SOAPException - if there is a SOAP error
since:
SAAJ 1.3 |
| createName | | abstract public Name createName(String localName, String prefix, String uri) throws SOAPException(Code) | | 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.
Parameters:
localName - a String giving the local name
Parameters:
prefix - a String giving the prefix of the namespace
Parameters:
uri - a String giving the URI of the namespace a Name object initialized with the givenlocal name, namespace prefix, and namespace URI
throws:
SOAPException - if there is a SOAP error |
| createName | | abstract public Name createName(String localName) throws SOAPException(Code) | | 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.
Parameters:
localName - a String giving the local name a Name object initialized with the givenlocal name
throws:
SOAPException - if there is a SOAP error |
| newInstance | | public static SOAPFactory newInstance() throws SOAPException(Code) | | 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.
a new instance of a SOAPFactory
exception:
SOAPException - if there was an error creating thedefault SOAPFactory
See Also: SAAJMetaFactory |
| newInstance | | public static SOAPFactory newInstance(String protocol) throws SOAPException(Code) | | 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.
a new instance of a SOAPFactory
Parameters:
protocol - a string constant representing the protocol of thespecified SOAP factory implementation. May beeither DYNAMIC_SOAP_PROTOCOL,DEFAULT_SOAP_PROTOCOL (which is the sameas) SOAP_1_1_PROTOCOL, orSOAP_1_2_PROTOCOL.
exception:
SOAPException - if there was an error creating thespecified SOAPFactory
See Also: SAAJMetaFactory
since:
SAAJ 1.3 |
|
|
|