public abstract class SOAPFactory extends 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 the SOAPHeaderElement
or
SOAPBodyElement
or SOAPEnvelope
.
SOAPFactory
also has methods to create javax.xml.soap.Detail
objects as
well as java.xml.soap.Name
objects.Constructor and Description |
---|
SOAPFactory() |
Modifier and Type | Method and Description |
---|---|
abstract Detail |
createDetail()
Creates a new
Detail object which serves as a container for
DetailEntry objects. |
SOAPElement |
createElement(Element element)
Creates a SOAPElement object from an existing DOM Element.
|
abstract SOAPElement |
createElement(Name name)
Create a
SOAPElement object initialized with the given Name
object. |
SOAPElement |
createElement(QName qname)
Creates a SOAPElement object initialized with the given QName object.
|
abstract SOAPElement |
createElement(String localName)
Create a
SOAPElement object initialized with the given local name. |
abstract SOAPElement |
createElement(String localName,
String prefix,
String uri)
Create a new
SOAPElement object with the given local name, prefix and uri. |
abstract SOAPFault |
createFault() |
abstract SOAPFault |
createFault(String reasonText,
QName faultCode) |
abstract Name |
createName(String localName)
Creates a new
Name object initialized with the given local name. |
abstract Name |
createName(String localName,
String prefix,
String uri)
Creates a new
Name object initialized with the given local name, namespace
prefix, and namespace URI. |
static SOAPFactory |
newInstance()
Creates a new instance of
SOAPFactory . |
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.
|
public abstract SOAPElement createElement(Name name) throws SOAPException
SOAPElement
object initialized with the given Name
object.name
- a Name
object with the XML name for the new elementSOAPElement
object that was createdSOAPException
- if there is an error in creating the SOAPElement
objectpublic abstract SOAPElement createElement(String localName) throws SOAPException
SOAPElement
object initialized with the given local name.localName
- a String
giving the local name for the new elementSOAPElement
object that was createdSOAPException
- if there is an error in creating the SOAPElement
objectpublic abstract SOAPElement createElement(String localName, String prefix, String uri) throws SOAPException
SOAPElement
object with the given local name, prefix and uri.localName
- a String
giving the local name for the new elementprefix
- the prefix for this SOAPElement
uri
- a String
giving the URI of the namespace to which the new
element belongsSOAPElement
object that was createdSOAPException
- if there is an error in creating the SOAPElement
objectpublic abstract Detail createDetail() throws SOAPException
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.Detail
objectSOAPException
- if there is a SOAP errorpublic abstract Name createName(String localName, String prefix, String uri) throws SOAPException
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.localName
- a String
giving the local nameprefix
- a String
giving the prefix of the namespaceuri
- a String
giving the URI of the namespaceName
object initialized with the given local name, namespace prefix,
and namespace URISOAPException
- if there is a SOAP errorpublic abstract Name createName(String localName) throws SOAPException
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.localName
- a String
giving the local nameName
object initialized with the given local nameSOAPException
- if there is a SOAP errorpublic static SOAPFactory newInstance() throws SOAPException
SOAPFactory
.SOAPFactory
SOAPException
- if there was an error creating the default SOAPFactory
public static SOAPFactory newInstance(String protocol) throws SOAPException
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 SOAPFactorySOAPException
- - if there is an error creating the specified SOAPFactorySAAJMetaFactory
public SOAPElement createElement(Element element) throws SOAPException
domElement
- - the Element to be copied.SOAPException
- - if there is an error in creating the SOAPElement objectSOAPFactoryImpl
public SOAPElement createElement(QName qname) throws SOAPException
qname
- - a QName object with the XML name for the new elementSOAPException
- - if there is an error in creating the SOAPElement objectSOAPFactoryImpl
public abstract SOAPFault createFault() throws SOAPException
SOAPException
public abstract SOAPFault createFault(String reasonText, QName faultCode) throws SOAPException
SOAPException
Copyright © 2015. All Rights Reserved.