FileDocCategorySizeDatePackage
SOAPFactory.javaAPI DocApache Axis 1.45687Sat Apr 22 18:57:28 BST 2006javax.xml.soap

SOAPFactory

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.

Fields Summary
private static final String
SF_PROPERTY
private static final String
DEFAULT_SF
Constructors Summary
public SOAPFactory()

Methods Summary
public abstract javax.xml.soap.DetailcreateDetail()
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.
return
a Detail object
throws
SOAPException if there is a SOAP error
public abstract javax.xml.soap.SOAPElementcreateElement(javax.xml.soap.Name name)
Create a SOAPElement object initialized with the
given Name object.
param
name a Name object with the XML name for
the new element
return
the new SOAPElement object that was
created
throws
SOAPException if there is an error in creating the
SOAPElement object
public abstract javax.xml.soap.SOAPElementcreateElement(java.lang.String localName)
Create a SOAPElement object initialized with the
given local name.
param
localName a String giving the local name for
the new element
return
the new SOAPElement object that was
created
throws
SOAPException if there is an error in creating the
SOAPElement object
public abstract javax.xml.soap.SOAPElementcreateElement(java.lang.String localName, java.lang.String prefix, java.lang.String uri)
Create a new SOAPElement object with the given
local name, prefix and uri.
param
localName a String giving the local name
for the new element
param
prefix the prefix for this SOAPElement
param
uri a String giving the URI of the
namespace to which the new element belongs
return
the new SOAPElement object that was
created
throws
SOAPException if there is an error in creating the
SOAPElement object
public abstract javax.xml.soap.NamecreateName(java.lang.String localName, java.lang.String prefix, java.lang.String uri)
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.
param
localName a String giving the local name
param
prefix a String giving the prefix of the namespace
param
uri a String giving the URI of the namespace
return
a Name object initialized with the given
local name, namespace prefix, and namespace URI
throws
SOAPException if there is a SOAP error
public abstract javax.xml.soap.NamecreateName(java.lang.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.
param
localName a String giving the local name
return
a Name object initialized with the given
local name
throws
SOAPException if there is a SOAP error
public static javax.xml.soap.SOAPFactorynewInstance()
Creates a new instance of SOAPFactory.
return
a new instance of a SOAPFactory
throws
SOAPException if there was an error creating the
default SOAPFactory

        try {
            return (SOAPFactory) FactoryFinder.find(SF_PROPERTY, DEFAULT_SF);
        } catch (Exception exception) {
            throw new SOAPException("Unable to create SOAP Factory: "
                                    + exception.getMessage());
        }