public interface SOAPFactory extends OMFactory
createOMAttribute, createOMComment, createOMDocType, createOMDocument, createOMElement, createOMElement, createOMElement, createOMElement, createOMElement, createOMElement, createOMElement, createOMElement, createOMEntityReference, createOMNamespace, createOMProcessingInstruction, createOMText, createOMText, createOMText, createOMText, createOMText, createOMText, createOMText, createOMText, createOMText, createOMText, createOMText, createOMText, getMetaFactory
String getSoapVersionURI()
SOAPVersion getSOAPVersion()
SOAPMessage createSOAPMessage()
SOAPMessage createSOAPMessage(OMXMLParserWrapper builder)
SOAPEnvelope createSOAPEnvelope() throws SOAPProcessingException
SOAPConstants.SOAP_DEFAULT_NAMESPACE_PREFIX
. It will also have a corresponding
namespace declaration.SOAPProcessingException
SOAPEnvelope createSOAPEnvelope(OMNamespace ns)
ns
- the namespace information for the SOAP envelopeSOAPHeader createSOAPHeader(SOAPEnvelope envelope) throws SOAPProcessingException
SOAPHeader
as a child of the given SOAPEnvelope
.
Note that for most use cases, it is preferable to use
SOAPEnvelope.getOrCreateHeader()
instead of this method.
envelope
- the parent of the SOAPHeader
SOAPHeader
SOAPProcessingException
SOAPHeader createSOAPHeader() throws SOAPProcessingException
SOAPProcessingException
SOAPHeaderBlock createSOAPHeaderBlock(String localName, OMNamespace ns, SOAPHeader parent) throws SOAPProcessingException
localName
- ns
- SOAPProcessingException
SOAPHeaderBlock createSOAPHeaderBlock(String localName, OMNamespace ns) throws SOAPProcessingException
SOAPProcessingException
SOAPHeaderBlock createSOAPHeaderBlock(OMDataSource source)
SOAPHeaderBlock
from an OMDataSource
. The semantics of the method
parameters are the same as for OMFactory.createOMElement(OMDataSource)
.source
- the data source; must not be null
SOAPHeaderBlock createSOAPHeaderBlock(String localName, OMNamespace ns, OMDataSource source) throws SOAPProcessingException
SOAPHeaderBlock
from an OMDataSource
with a known local name and
namespace URI. The semantics of the method parameters are the same as for
OMFactory.createOMElement(OMDataSource, String, OMNamespace)
.localName
- the local part of the name of the element produced by the data source; must not be
null
ns
- the namespace of the element produced by the data source, or null
if
the element has no namespacesource
- the data source; must not be null
SOAPProcessingException
SOAPFault createSOAPFault(SOAPBody parent, Exception e) throws SOAPProcessingException
parent
- e
- SOAPProcessingException
SOAPFault createSOAPFault(SOAPBody parent) throws SOAPProcessingException
SOAPProcessingException
SOAPFault createSOAPFault() throws SOAPProcessingException
SOAPProcessingException
SOAPBody createSOAPBody(SOAPEnvelope envelope) throws SOAPProcessingException
envelope
- SOAPProcessingException
SOAPBody createSOAPBody() throws SOAPProcessingException
SOAPProcessingException
SOAPFaultCode createSOAPFaultCode(SOAPFault parent) throws SOAPProcessingException
parent
- SOAPProcessingException
SOAPFaultCode createSOAPFaultCode() throws SOAPProcessingException
SOAPProcessingException
SOAPFaultValue createSOAPFaultValue(SOAPFaultCode parent) throws SOAPProcessingException
parent
- SOAPProcessingException
SOAPFaultValue createSOAPFaultValue() throws SOAPProcessingException
SOAPProcessingException
SOAPFaultValue createSOAPFaultValue(SOAPFaultSubCode parent) throws SOAPProcessingException
parent
- SOAPProcessingException
SOAPFaultSubCode createSOAPFaultSubCode(SOAPFaultCode parent) throws SOAPProcessingException
SOAPProcessingException
SOAPFaultSubCode createSOAPFaultSubCode() throws SOAPProcessingException
SOAPProcessingException
SOAPFaultSubCode createSOAPFaultSubCode(SOAPFaultSubCode parent) throws SOAPProcessingException
parent
- SOAPProcessingException
SOAPFaultReason createSOAPFaultReason(SOAPFault parent) throws SOAPProcessingException
parent
- SOAPProcessingException
SOAPFaultReason createSOAPFaultReason() throws SOAPProcessingException
SOAPProcessingException
SOAPFaultText createSOAPFaultText(SOAPFaultReason parent) throws SOAPProcessingException
parent
- SOAPProcessingException
SOAPFaultText createSOAPFaultText() throws SOAPProcessingException
SOAPProcessingException
SOAPFaultNode createSOAPFaultNode(SOAPFault parent) throws SOAPProcessingException
parent
- SOAPProcessingException
SOAPFaultNode createSOAPFaultNode() throws SOAPProcessingException
SOAPProcessingException
SOAPFaultRole createSOAPFaultRole(SOAPFault parent) throws SOAPProcessingException
parent
- SOAPProcessingException
SOAPFaultRole createSOAPFaultRole() throws SOAPProcessingException
SOAPProcessingException
SOAPFaultDetail createSOAPFaultDetail(SOAPFault parent) throws SOAPProcessingException
parent
- SOAPProcessingException
SOAPFaultDetail createSOAPFaultDetail() throws SOAPProcessingException
SOAPProcessingException
SOAPEnvelope getDefaultEnvelope() throws SOAPProcessingException
SOAPMessage
or OMDocument
instance and the
parent of the returned SOAPEnvelope
is null
.
Note: This method is typically used in conjunction with
SOAPEnvelope.getHeader()
. In order to avoid generating unnecessary empty SOAP
headers, you should consider using createDefaultSOAPMessage()
together with
SOAPEnvelope.getOrCreateHeader()
instead. This method may be deprecated and/or
removed in future Axiom versions.
SOAPProcessingException
SOAPMessage createDefaultSOAPMessage()
Since no SOAP header is added to the envelope, this method should be used in conjunction with
SOAPEnvelope.getOrCreateHeader()
(if SOAP header blocks need to be added).
SOAPEnvelope getDefaultFaultEnvelope() throws SOAPProcessingException
SOAPProcessingException
OMNamespace getNamespace()
OMNamespace
instance has the following properties:
SOAPConstants.SOAP_DEFAULT_NAMESPACE_PREFIX
(which is the
same as the prefix used by methods such as createSOAPEnvelope()
).
getSoapVersionURI()
.
Copyright © The Apache Software Foundation. All Rights Reserved.