| javax.xml.soap |
|
Provides the API for creating and building SOAP messages. This package
is defined in the SOAP with Attachments API for JavaTM (SAAJ) 1.3 specification.
The API in the javax.xml.soap package allows you to do the
following:
- create a point-to-point connection to a specified endpoint
- create a SOAP message
- create an XML fragment
- add content to the header of a SOAP message
- add content to the body of a SOAP message
- create attachment parts and add content to them
- access/add/modify parts of a SOAP message
- create/add/modify SOAP fault information
- extract content from a SOAP message
- send a SOAP request-response message
In addition the APIs in the javax.xml.soap package extend
their counterparts in the org.w3c.dom package. This means that
the SOAPPart of a SOAPMessage is also a DOM Level
2 Document, and can be manipulated as such by applications,
tools and libraries that use DOM (see http://www.w3.org/DOM/ for more information).
It is important to note that, while it is possible to use DOM APIs to add
ordinary DOM nodes to a SAAJ tree, the SAAJ APIs are still required to return
SAAJ types when examining or manipulating the tree. In order to accomplish
this the SAAJ APIs (specifically {@link javax.xml.soap.SOAPElement#getChildElements()})
are allowed to silently replace objects that are incorrectly typed relative
to SAAJ requirements with equivalent objects of the required type. These
replacements must never cause the logical structure of the tree to change,
so from the perspective of the DOM APIs the tree will remain unchanged. However,
the physical composition of the tree will have changed so that references
to the nodes that were replaced will refer to nodes that are no longer a
part of the tree. The SAAJ APIs are not allowed to make these replacements
if they are not required so the replacement objects will never subsequently
be silently replaced by future calls to the SAAJ API.
What this means in
practical terms is that an application that starts to use SAAJ APIs on a
tree after manipulating it using DOM APIs must assume that the tree has been
translated into an all SAAJ tree and that any references to objects within
the tree that were obtained using DOM APIs are no longer valid. Switching
from SAAJ APIs to DOM APIs is not allowed to cause invalid references and
neither is using SAAJ APIs exclusively. It is only switching from using DOM
APIs on a particular SAAJ tree to using SAAJ APIs that causes the risk of
invalid references.
|
| Java Source File Name | Type | Comment |
| AttachmentPart.java | Class | A single attachment to a SOAPMessage object. |
| Detail.java | Interface | A container for DetailEntry objects. |
| DetailEntry.java | Interface | The content for a Detail object, giving details for
a SOAPFault object. |
| FactoryFinder.java | Class | |
| MessageFactory.java | Class | A factory for creating SOAPMessage objects.
A SAAJ client can create a MessageFactory object
using the method newInstance, as shown in the following
lines of code.
MessageFactory mf = MessageFactory.newInstance();
MessageFactory mf12 = MessageFactory.newInstance(SOAPConstants.SOAP_1_2_PROTOCOL);
All MessageFactory objects, regardless of how they are
created, will produce SOAPMessage objects that
have the following elements by default:
- A
SOAPPart object
- A
SOAPEnvelope object
- A
SOAPBody object
- A
SOAPHeader object
In some cases, specialized MessageFactory objects may be obtained that produce messages
prepopulated with additional entries in the SOAPHeader object and the
SOAPBody object. |
| MimeHeader.java | Class | An object that stores a MIME header name and its value. |
| MimeHeaders.java | Class | A container for MimeHeader objects, which represent
the MIME headers present in a MIME part of a message.
This class is used primarily when an application wants to
retrieve specific attachments based on certain MIME headers and
values. |
| Name.java | Interface | A representation of an XML name. |
| Node.java | Interface | A representation of a node (element) in an XML document. |
| SAAJMetaFactory.java | Class | The access point for the implementation classes of the factories defined in the
SAAJ API. |
| SAAJResult.java | Class | Acts as a holder for the results of a JAXP transformation or a JAXB
marshalling, in the form of a SAAJ tree. |
| SOAPBody.java | Interface | An object that represents the contents of the SOAP body
element in a SOAP message. |
| SOAPBodyElement.java | Interface | A SOAPBodyElement object represents the contents in
a SOAPBody object. |
| SOAPConnection.java | Class | A point-to-point connection that a client can use for sending messages
directly to a remote party (represented by a URL, for instance).
The SOAPConnection class is optional. |
| SOAPConnectionFactory.java | Class | A factory for creating SOAPConnection objects. |
| SOAPConstants.java | Interface | The definition of constants pertaining to the SOAP protocol. |
| SOAPElement.java | Interface | An object representing an element of a SOAP message that is allowed but not
specifically prescribed by a SOAP specification. |
| SOAPElementFactory.java | Class | SOAPElementFactory is a factory for XML fragments that
will eventually end up in the SOAP part. |
| SOAPEnvelope.java | Interface | The container for the SOAPHeader and SOAPBody portions of a
SOAPPart object. |
| SOAPException.java | Class | An exception that signals that a SOAP exception has occurred. |
| SOAPFactory.java | Class | 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. |
| SOAPFault.java | Interface | An element in the SOAPBody object that contains
error and/or status information. |
| SOAPFaultElement.java | Interface | A representation of the contents in
a SOAPFault object. |
| SOAPHeader.java | Interface | A representation of the SOAP header
element. |
| SOAPHeaderElement.java | Interface | An object representing the contents in the SOAP header part of the
SOAP envelope. |
| SOAPMessage.java | Class | The root class for all SOAP messages. |
| SOAPPart.java | Class | The container for the SOAP-specific portion of a SOAPMessage
object. |
| Text.java | Interface | A representation of a node whose value is text. |