Package com.sun.xml.messaging.saaj.soap

Class SOAPFactoryImpl

java.lang.Object

jakarta.xml.soap.SOAPFactory

com.sun.xml.messaging.saaj.soap.SOAPFactoryImpl

Direct Known Subclasses:

SOAPFactory1_1Impl, SOAPFactory1_2Impl, SOAPFactoryDynamicImpl

public abstract class SOAPFactoryImpl
extends SOAPFactory

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SOAPFactoryImpl()

Method Summary

Modifier and Type	Method	Description
Detail	createDetail()	Creates a new Detail object which serves as a container for DetailEntry objects.
protected abstract SOAPDocumentImpl	createDocument()
SOAPElement	createElement(Name name)	Creates a SOAPElement object initialized with the given Name object.
SOAPElement	createElement(String tagName)	Creates a SOAPElement object initialized with the given local name.
SOAPElement	createElement(String localName, String prefix, String uri)	Creates a new SOAPElement object with the given local name, prefix and uri.
SOAPElement	createElement(QName qname)	Creates a SOAPElement object initialized with the given QName object.
SOAPElement	createElement(Element domElement)	Creates a SOAPElement object from an existing DOM Element.
SOAPFault	createFault()	Creates a new default SOAPFault object
SOAPFault	createFault(String reasonText, QName faultCode)	Creates a new SOAPFault object initialized with the given reasonText and faultCode
Name	createName(String localName)	Creates a new Name object initialized with the given local name.
Name	createName(String localName, String prefix, String uri)	Creates a new Name object initialized with the given local name, namespace prefix, and namespace URI.

Methods inherited from class jakarta.xml.soap.SOAPFactory

newInstance, newInstance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SOAPFactoryImpl

protected SOAPFactoryImpl()

Method Detail

createDocument

protected abstract SOAPDocumentImpl createDocument()

createElement

public SOAPElement createElement(String tagName)
                          throws SOAPException

Description copied from class: SOAPFactory

Creates a SOAPElement object initialized with the given local name.

Specified by:

createElement in class SOAPFactory

Parameters:

tagName - a String 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 the SOAPElement object

createElement

public SOAPElement createElement(Name name)
                          throws SOAPException

Description copied from class: SOAPFactory

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.

Specified by:

createElement in class SOAPFactory

Parameters:

name - a Name 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:

SOAPFactory.createElement(javax.xml.namespace.QName)

createElement

public SOAPElement createElement(QName qname)
                          throws SOAPException

Description copied from class: SOAPFactory

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.

Overrides:

createElement in class SOAPFactory

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:

SOAPFactory.createElement(Name)

createElement

public SOAPElement createElement(String localName,
                                 String prefix,
                                 String uri)
                          throws SOAPException

Description copied from class: SOAPFactory

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.

Specified by:

createElement in class SOAPFactory

Parameters:

localName - a String giving the local name for the new element

prefix - the prefix for this SOAPElement

uri - a String 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 the SOAPElement object

createName

public Name createName(String localName,
                       String prefix,
                       String uri)
                throws SOAPException

Description copied from class: SOAPFactory

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.

Specified by:

createName in class SOAPFactory

Parameters:

localName - a String giving the local name

prefix - a String giving the prefix of the namespace

uri - a String 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 Name createName(String localName)
                throws SOAPException

Description copied from class: SOAPFactory

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.

Specified by:

createName in class SOAPFactory

Parameters:

localName - a String giving the local name

Returns:

a Name object initialized with the given local name

Throws:

SOAPException - if there is a SOAP error

createElement

public SOAPElement createElement(Element domElement)
                          throws SOAPException

Description copied from class: SOAPFactory

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.

Overrides:

createElement in class SOAPFactory

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

createDetail

public Detail createDetail()
                    throws SOAPException

Description copied from class: SOAPFactory

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.

Specified by:

createDetail in class SOAPFactory

Returns:

a Detail object

Throws:

SOAPException - if there is a SOAP error

createFault

public SOAPFault createFault(String reasonText,
                             QName faultCode)
                      throws SOAPException

Description copied from class: SOAPFactory

Creates a new SOAPFault object initialized with the given reasonText and faultCode

Specified by:

createFault in class SOAPFactory

Parameters:

reasonText - the ReasonText/FaultString for the fault

faultCode - the FaultCode for the fault

Returns:

a SOAPFault object

Throws:

SOAPException - if there is a SOAP error

createFault

public SOAPFault createFault()
                      throws SOAPException

Description copied from class: SOAPFactory

Creates a new default SOAPFault object

Specified by:

createFault in class SOAPFactory

Returns:

a SOAPFault object

Throws:

SOAPException - if there is a SOAP error