## Jakarta SOAP Attachments - 1.4
JavaDoc Assertion Detail

Totals | Total | Active | Deprecated | Removed
# of Assertions | 328 | 316 | 8 | 4
# of Required Assertions | 328 | 316 | 8 | 4
# of Optional Assertions | 0 | 0 | 0 | 0

ID | Return | Method/Field | Description | Required | Deprecated | Testable
SAAJ:JAVADOC:1 | void | javax.xml.soap.AttachmentPart.addMimeHeader ( String , String ) | Adds a MIME header with the specified name and value to this AttachmentPart object. Note that RFC822 headers can contain only US-ASCII characters. | true |  | true
SAAJ:JAVADOC:2 | AttachmentPart | javax.xml.soap.AttachmentPart.AttachmentPart |  | true |  | true
SAAJ:JAVADOC:3 | void | javax.xml.soap.AttachmentPart.clearContent | Clears out the content of this AttachmentPart object. The MIME header portion is left untouched. | true |  | true
SAAJ:JAVADOC:4 | Iterator | javax.xml.soap.AttachmentPart.getAllMimeHeaders | Retrieves all the headers for this AttachmentPart object as an iterator over the MimeHeader objects. | true |  | true
SAAJ:JAVADOC:5 | InputStream | javax.xml.soap.AttachmentPart.getBase64Content | Returns an InputStream which can be used to obtain the content of AttachmentPart as Base64 encoded character data, this method would base64 encode the raw bytes of the attachment and return. | true |  | true
SAAJ:JAVADOC:6 | InputStream | javax.xml.soap.AttachmentPart.getBase64Content throws SOAPException | if there is no content set into this AttachmentPart object or if there was a data transformation error. | true |  | true
SAAJ:JAVADOC:7 | Object | javax.xml.soap.AttachmentPart.getContent | Gets the content of this AttachmentPart object as a Java object. The type of the returned Java object depends on (1) the DataContentHandler object that is used to interpret the bytes and (2) the Content-Type given in the header. For the MIME content types "text/plain", "text/html" and "text/xml", the DataContentHandler object does the conversions to and from the Java types corresponding to the MIME types. For other MIME types,the DataContentHandler object can return an InputStream object that contains the content data as raw bytes. A SAAJ-compliant implementation must, as a minimum, return a java.lang.String object corresponding to any content stream with a Content-Type value of text/plain, a javax.xml.transform.stream.StreamSource object corresponding to a content stream with a Content-Type value of text/xml, a java.awt.Image object corresponding to a content stream with a Content-Type value of image/gif or image/jpeg. For those content types that an installed DataContentHandler object does not understand, the DataContentHandler object is required to return a java.io.InputStream object with the raw bytes. | true |  | true
SAAJ:JAVADOC:8 | Object | javax.xml.soap.AttachmentPart.getContent throws SOAPException | if there is no content set into this AttachmentPart object or if there was a data transformation error | true |  | true
SAAJ:JAVADOC:9 | String | javax.xml.soap.AttachmentPart.getContentId | Gets the value of the MIME header whose name is "Content-ID". | true |  | true
SAAJ:JAVADOC:10 | String | javax.xml.soap.AttachmentPart.getContentLocation | Gets the value of the MIME header whose name is "Content-Location". | true |  | true
SAAJ:JAVADOC:11 | String | javax.xml.soap.AttachmentPart.getContentType | Gets the value of the MIME header whose name is "Content-Type". | true |  | true
SAAJ:JAVADOC:14 | Iterator | javax.xml.soap.AttachmentPart.getMatchingMimeHeaders ( String[] ) | Retrieves all MimeHeader objects that match a name in the given array. | true |  | true
SAAJ:JAVADOC:15 | String[] | javax.xml.soap.AttachmentPart.getMimeHeader ( String ) | Gets all the values of the header identified by the given String. | true |  | true
SAAJ:JAVADOC:16 | Iterator | javax.xml.soap.AttachmentPart.getNonMatchingMimeHeaders ( String[] ) | Retrieves all MimeHeader objects whose name does not match a name in the given array. | true |  | true
SAAJ:JAVADOC:17 | InputStream | javax.xml.soap.AttachmentPart.getRawContent | Gets the content of this AttachmentPart object as an InputStream as if a call had been made to getContent and no DataContentHandler had been registered for the content-type of this AttachmentPart. Note that reading from the returned InputStream would result in consuming the data in the stream. It is the responsibility of the caller to reset the InputStream appropriately before calling a Subsequent API. If a copy of the raw attachment content is required then the #getRawContentBytes API should be used instead. | true |  | true
SAAJ:JAVADOC:18 | InputStream | javax.xml.soap.AttachmentPart.getRawContent throws SOAPException | if there is no content set into this AttachmentPart object or if there was a data transformation error. | true |  | true
SAAJ:JAVADOC:19 | byte[] | javax.xml.soap.AttachmentPart.getRawContentBytes | Gets the content of this AttachmentPart object as a byte[] array as if a call had been made to getContent and no DataContentHandler had been registered for the content-type of this AttachmentPart. | true |  | true
SAAJ:JAVADOC:20 | byte[] | javax.xml.soap.AttachmentPart.getRawContentBytes throws SOAPException | if there is no content set into this AttachmentPart object or if there was a data transformation error. | true |  | true
SAAJ:JAVADOC:21 | int | javax.xml.soap.AttachmentPart.getSize | Returns the number of bytes in this AttachmentPart object. | true |  | true
SAAJ:JAVADOC:22 | int | javax.xml.soap.AttachmentPart.getSize throws SOAPException | if the content of this attachment is corrupted of if there was an exception while trying to determine the size. | true |  | true
SAAJ:JAVADOC:23 | void | javax.xml.soap.AttachmentPart.removeAllMimeHeaders | Removes all the MIME header entries. | true |  | true
SAAJ:JAVADOC:24 | void | javax.xml.soap.AttachmentPart.removeMimeHeader ( String ) | Removes all MIME headers that match the given name. | true |  | true
SAAJ:JAVADOC:25 | void | javax.xml.soap.AttachmentPart.setBase64Content ( InputStream , String ) | Sets the content of this attachment part from the Base64 source InputStream and sets the value of the Content-Type header to the value contained in contentType, This method would first decode the base64 input and write the resulting raw bytes to the attachment. A subsequent call to getSize() may not be an exact measure of the content size. | true |  | true
SAAJ:JAVADOC:26 | void | javax.xml.soap.AttachmentPart.setBase64Content ( InputStream , String ) throws SOAPException | if an there is an error in setting the content | true |  | true
SAAJ:JAVADOC:27 | void | javax.xml.soap.AttachmentPart.setContent ( Object , String ) | Sets the content of this attachment part to that of the given Object and sets the value of the Content-Type header to the given type. The type of the Object should correspond to the value given for the Content-Type. This depends on the particular set of DataContentHandler objects in use. | true |  | true
SAAJ:JAVADOC:28 | void | javax.xml.soap.AttachmentPart.setContentId ( String ) | Sets the MIME header whose name is "Content-ID" with the given value. | true |  | true
SAAJ:JAVADOC:29 | void | javax.xml.soap.AttachmentPart.setContentLocation ( String ) | Sets the MIME header whose name is "Content-Location" with the given value. | true |  | true
SAAJ:JAVADOC:30 | void | javax.xml.soap.AttachmentPart.setContentType ( String ) | Sets the MIME header whose name is "Content-Type" with the given value. | true |  | true
SAAJ:JAVADOC:32 | void | javax.xml.soap.AttachmentPart.setMimeHeader ( String , String ) | Changes the first header entry that matches the given name to the given value, adding a new header if no existing header matches. This method also removes all matching headers but the first. Note that RFC822 headers can only contain US-ASCII characters. | true |  | true
SAAJ:JAVADOC:33 | void | javax.xml.soap.AttachmentPart.setRawContent ( InputStream , String ) | Sets the content of this attachment part to that contained by the InputStreamcontent and sets the value of the Content-Type header to the value contained in contentType. A subsequent call to getSize() may not be an exact measure of the content size. | true |  | true
SAAJ:JAVADOC:34 | void | javax.xml.soap.AttachmentPart.setRawContent ( InputStream , String ) throws SOAPException | if an there is an error in setting the content | true |  | true
SAAJ:JAVADOC:35 | void | javax.xml.soap.AttachmentPart.setRawContentBytes ( byte[] , int , int , String ) | Sets the content of this attachment part to that contained by the byte[] array content and sets the value of the Content-Type header to the value contained in contentType. | true |  | true
SAAJ:JAVADOC:36 | void | javax.xml.soap.AttachmentPart.setRawContentBytes ( byte[] , int , int , String ) throws SOAPException | if an there is an error in setting the content or content is null | true |  | true
SAAJ:JAVADOC:37 | DetailEntry | javax.xml.soap.Detail.addDetailEntry ( Name ) | Creates a new DetailEntry object with the given name and adds it to this Detail object. | true |  | true
SAAJ:JAVADOC:38 | DetailEntry | javax.xml.soap.Detail.addDetailEntry ( Name ) throws SOAPException | thrown when there is a problem in adding a DetailEntry object to this Detail object. | true |  | true
SAAJ:JAVADOC:39 | DetailEntry | javax.xml.soap.Detail.addDetailEntry ( QName ) | Creates a new DetailEntry object with the given QName and adds it to this Detail object. This method is the preferred over the one using Name. | true |  | true
SAAJ:JAVADOC:40 | DetailEntry | javax.xml.soap.Detail.addDetailEntry ( QName ) throws SOAPException | thrown when there is a problem in adding a DetailEntry object to this Detail object. | true |  | true
SAAJ:JAVADOC:41 | Iterator | javax.xml.soap.Detail.getDetailEntries | Gets an Iterator over all of the DetailEntrys in this Detail object. | true |  | true
SAAJ:JAVADOC:42 | SOAPMessage | javax.xml.soap.MessageFactory.createMessage | Creates a new SOAPMessage object with the default SOAPPart, SOAPEnvelope, SOAPBody, and SOAPHeader objects. Profile-specific message factories can choose to prepopulate the SOAPMessage object with profile-specific headers. Content can be added to this message's SOAPPart object, and the message can be sent "as is" when a message containing only a SOAP part is sufficient. Otherwise, the SOAPMessage object needs to create one or more AttachmentPart objects and add them to itself. Any content that is not in XML format must be in an AttachmentPart object. | true |  | true
SAAJ:JAVADOC:43 | SOAPMessage | javax.xml.soap.MessageFactory.createMessage throws SOAPException | if a SOAP error occurs | true |  | true
SAAJ:JAVADOC:44 | SOAPMessage | javax.xml.soap.MessageFactory.createMessage ( MimeHeaders , InputStream ) | Internalizes the contents of the given InputStream object into a new SOAPMessage object and returns the SOAPMessage object. | true |  | true
SAAJ:JAVADOC:45 | SOAPMessage | javax.xml.soap.MessageFactory.createMessage ( MimeHeaders , InputStream ) throws IOException | if there is a problem in reading data from the input stream | true |  | true
SAAJ:JAVADOC:46 | SOAPMessage | javax.xml.soap.MessageFactory.createMessage ( MimeHeaders , InputStream ) throws SOAPException | may be thrown if the message is invalid | true |  | true
SAAJ:JAVADOC:47 | MessageFactory | javax.xml.soap.MessageFactory.MessageFactory |  | true |  | true
SAAJ:JAVADOC:48 | MessageFactory | javax.xml.soap.MessageFactory.newInstance | Creates a new MessageFactory object that is an instance of the default implementation (SOAP 1.1). This method uses the lookup procedure specified in javax.xml.soap to locate and load the javax.xml.soap.MessageFactory class. | true |  | true
SAAJ:JAVADOC:49 | MessageFactory | javax.xml.soap.MessageFactory.newInstance throws SOAPException | if there was an error in creating the default implementation of the MessageFactory. | true |  | true
SAAJ:JAVADOC:50 | MessageFactory | javax.xml.soap.MessageFactory.newInstance ( String ) | Creates a new MessageFactory object that is an instance of the specified implementation. May be a dynamic message factory, a SOAP 1.1 message factory, or a SOAP 1.2 message factory. A dynamic message factory creates messages based on the MIME headers specified as arguments to the createMessage method. This method uses the SAAJMetaFactory to locate the implementation class and create the MessageFactory instance. | true |  | true
SAAJ:JAVADOC:51 | MessageFactory | javax.xml.soap.MessageFactory.newInstance ( String ) throws SOAPException | if there was an error in creating the specified implementation of MessageFactory. | true |  | true
SAAJ:JAVADOC:52 | String | javax.xml.soap.MimeHeader.getName | Returns the name of this MimeHeader object. | true |  | true
SAAJ:JAVADOC:53 | String | javax.xml.soap.MimeHeader.getValue | Returns the value of this MimeHeader object. | true |  | true
SAAJ:JAVADOC:54 | MimeHeader | javax.xml.soap.MimeHeader.MimeHeader ( String , String ) | Constructs a MimeHeader object initialized with the given name and value. | true |  | true
SAAJ:JAVADOC:55 | void | javax.xml.soap.MimeHeaders.addHeader ( String , String ) | Adds a MimeHeader object with the specified name and value to this MimeHeaders object's list of headers. Note that RFC822 headers can contain only US-ASCII characters. | true |  | true
SAAJ:JAVADOC:56 | Iterator | javax.xml.soap.MimeHeaders.getAllHeaders | Returns all the MimeHeaders in this MimeHeaders object. | true |  | true
SAAJ:JAVADOC:57 | String[] | javax.xml.soap.MimeHeaders.getHeader ( String ) | Returns all of the values for the specified header as an array of String objects. | true |  | true
SAAJ:JAVADOC:58 | Iterator | javax.xml.soap.MimeHeaders.getMatchingHeaders ( String[] ) | Returns all the MimeHeader objects whose name matches a name in the given array of names. | true |  | true
SAAJ:JAVADOC:59 | Iterator | javax.xml.soap.MimeHeaders.getNonMatchingHeaders ( String[] ) | Returns all of the MimeHeader objects whose name does not match a name in the given array of names. | true |  | true
SAAJ:JAVADOC:60 | MimeHeaders | javax.xml.soap.MimeHeaders.MimeHeaders | Constructs a default MimeHeaders object initialized with an empty Vector object. | true |  | true
SAAJ:JAVADOC:61 | void | javax.xml.soap.MimeHeaders.removeAllHeaders | Removes all the header entries from this MimeHeaders object. | true |  | true
SAAJ:JAVADOC:62 | void | javax.xml.soap.MimeHeaders.removeHeader ( String ) | Remove all MimeHeader objects whose name matches the given name. | true |  | true
SAAJ:JAVADOC:63 | void | javax.xml.soap.MimeHeaders.setHeader ( String , String ) | Replaces the current value of the first header entry whose name matches the given name with the given value, adding a new header if no existing header name matches. This method also removes all matching headers after the first one. Note that RFC822 headers can contain only US-ASCII characters. | true |  | true
SAAJ:JAVADOC:64 | String | javax.xml.soap.Name.getLocalName | Gets the local name part of the XML name that this Name object represents. | true |  | true
SAAJ:JAVADOC:65 | String | javax.xml.soap.Name.getPrefix | Returns the prefix that was specified when this Name object was initialized. This prefix is associated with the namespace for the XML name that this Name object represents. | true |  | true
SAAJ:JAVADOC:66 | String | javax.xml.soap.Name.getQualifiedName | Gets the namespace-qualified name of the XML name that this Name object represents. | true |  | true
SAAJ:JAVADOC:67 | String | javax.xml.soap.Name.getURI | Returns the URI of the namespace for the XML name that this Name object represents. | true |  | true
SAAJ:JAVADOC:68 | void | javax.xml.soap.Node.detachNode | Removes this Node object from the tree. | true |  | true
SAAJ:JAVADOC:69 | SOAPElement | javax.xml.soap.Node.getParentElement | Returns the parent element of this Node object. This method can throw an UnsupportedOperationException if the tree is not kept in memory. | true |  | true
SAAJ:JAVADOC:70 | String | javax.xml.soap.Node.getValue | Returns the value of this node if this is a Text node or the value of the immediate child of this node otherwise. If there is an immediate child of this Node that it is a Text node then it's value will be returned. If there is more than one Text node then the value of the first Text Node will be returned. Otherwise null is returned. | true |  | true
SAAJ:JAVADOC:71 | void | javax.xml.soap.Node.recycleNode | Notifies the implementation that this Node object is no longer being used by the application and that the implementation is free to reuse this object for nodes that may be created later. Calling the method recycleNode implies that the method detachNode has been called previously. | true |  | true
SAAJ:JAVADOC:72 | void | javax.xml.soap.Node.setParentElement ( SOAPElement ) | Sets the parent of this Node object to the given SOAPElement object. | true |  | true
SAAJ:JAVADOC:73 | void | javax.xml.soap.Node.setParentElement ( SOAPElement ) throws SOAPException | if there is a problem in setting the parent to the given element | true |  | true
SAAJ:JAVADOC:74 | void | javax.xml.soap.Node.setValue ( String ) | If this is a Text node then this method will set its value, otherwise it sets the value of the immediate (Text) child of this node. The value of the immediate child of this node can be set only if, there is one child node and that node is a Text node, or if there are no children in which case a child Text node will be created. | true |  | true
SAAJ:JAVADOC:75 | Node | javax.xml.soap.SAAJResult.getResult |  | true |  | true
SAAJ:JAVADOC:76 | SAAJResult | javax.xml.soap.SAAJResult.SAAJResult | Creates a SAAJResult that will present results in the form of a SAAJ tree that supports the default (SOAP 1.1) protocol. This kind of SAAJResult is meant for use in situations where the results will be used as a parameter to a method that takes a parameter whose type, such as SOAPElement, is drawn from the SAAJ API. When used in a transformation, the results are populated into the SOAPPart of a SOAPMessage that is created internally. The SOAPPart returned by DOMResult#getNode() is not guaranteed to be well-formed. | true |  | true
SAAJ:JAVADOC:77 | SAAJResult | javax.xml.soap.SAAJResult.SAAJResult ( String ) | Creates a SAAJResult that will present results in the form of a SAAJ tree that supports the specified protocol. The DYNAMIC_SOAP_PROTOCOL is ambiguous in this context and will cause this constructor to throw an UnsupportedOperationException. This kind of SAAJResult is meant for use in situations where the results will be used as a parameter to a method that takes a parameter whose type, such as SOAPElement, is drawn from the SAAJ API. When used in a transformation the results are populated into the SOAPPart of a SOAPMessage that is created internally. The SOAPPart returned by DOMResult#getNode() is not guaranteed to be well-formed. | true |  | true
SAAJ:JAVADOC:78 | SAAJResult | javax.xml.soap.SAAJResult.SAAJResult ( SOAPMessage ) | Creates a SAAJResult that will write the results into the SOAPPart of the supplied SOAPMessage. In the normal case these results will be written using DOM APIs and, as a result, the finished SOAPPart will not be guaranteed to be well-formed unless the data used to create it is also well formed. When used in a transformation the validity of the SOAPMessage after the transformation can be guaranteed only by means outside SAAJ specification. | true |  | true
SAAJ:JAVADOC:79 | SAAJResult | javax.xml.soap.SAAJResult.SAAJResult ( SOAPElement ) | Creates a SAAJResult that will write the results as a child node of the SOAPElement specified. In the normal case these results will be written using DOM APIs and as a result may invalidate the structure of the SAAJ tree. This kind of SAAJResult should only be used when the validity of the incoming data can be guaranteed by means outside of the SAAJ specification. | true |  | true
SAAJ:JAVADOC:80 | SOAPBodyElement | javax.xml.soap.SOAPBody.addBodyElement ( Name ) | Creates a new SOAPBodyElement object with the specified name and adds it to this SOAPBody object. | true |  | true
SAAJ:JAVADOC:81 | SOAPBodyElement | javax.xml.soap.SOAPBody.addBodyElement ( Name ) throws SOAPException | if a SOAP error occurs | true |  | true
SAAJ:JAVADOC:82 | SOAPBodyElement | javax.xml.soap.SOAPBody.addBodyElement ( QName ) | Creates a new SOAPBodyElement object with the specified QName and adds it to this SOAPBody object. | true |  | true
SAAJ:JAVADOC:83 | SOAPBodyElement | javax.xml.soap.SOAPBody.addBodyElement ( QName ) throws SOAPException | if a SOAP error occurs | true |  | true
SAAJ:JAVADOC:84 | SOAPBodyElement | javax.xml.soap.SOAPBody.addDocument ( Document ) | Adds the root node of the DOM org.w3c.dom.Document to this SOAPBody object. Calling this method invalidates the document parameter. The client application should discard all references to this Document and its contents upon calling addDocument. The behavior of an application that continues to use such references is undefined. | true |  | true
SAAJ:JAVADOC:85 | SOAPBodyElement | javax.xml.soap.SOAPBody.addDocument ( Document ) throws SOAPException | if the Document cannot be added | true |  | true
SAAJ:JAVADOC:86 | SOAPFault | javax.xml.soap.SOAPBody.addFault | Creates a new SOAPFault object and adds it to this SOAPBody object. The new SOAPFault will have default values set for the mandatory child elements. The type of the SOAPFault will be a SOAP 1.1 or a SOAP 1.2 SOAPFault depending on the protocol specified while creating the MessageFactory instance. A SOAPBody may contain at most one SOAPFault child element. | true |  | true
SAAJ:JAVADOC:87 | SOAPFault | javax.xml.soap.SOAPBody.addFault throws SOAPException | if there is a SOAP error | true |  | true
SAAJ:JAVADOC:88 | SOAPFault | javax.xml.soap.SOAPBody.addFault ( Name , String , Locale ) | Creates a new SOAPFault object and adds it to this SOAPBody object. The type of the SOAPFault will be a SOAP 1.1 or a SOAP 1.2 SOAPFault depending on the protocol specified while creating the MessageFactory instance. For SOAP 1.2 the faultCode parameter is the value of the Fault/Code/Value element and the faultString parameter is the value of the Fault/Reason/Text element. For SOAP 1.1 the faultCode parameter is the value of the faultcode element and the faultString parameter is the value of the faultstring element. A SOAPBody may contain at most one SOAPFault child element. | true |  | true
SAAJ:JAVADOC:89 | SOAPFault | javax.xml.soap.SOAPBody.addFault ( Name , String , Locale ) throws SOAPException | if there is a SOAP error | true |  | true
SAAJ:JAVADOC:90 | SOAPFault | javax.xml.soap.SOAPBody.addFault ( QName , String , Locale ) | Creates a new SOAPFault object and adds it to this SOAPBody object. The type of the SOAPFault will be a SOAP 1.1 or a SOAP 1.2 SOAPFault depending on the protocol specified while creating the MessageFactory instance. For SOAP 1.2 the faultCode parameter is the value of the Fault/Code/Value element and the faultString parameter is the value of the Fault/Reason/Text element. For SOAP 1.1 the faultCode parameter is the value of the faultcode element and the faultString parameter is the value of the faultstring element. A SOAPBody may contain at most one SOAPFault child element. | true |  | true
SAAJ:JAVADOC:91 | SOAPFault | javax.xml.soap.SOAPBody.addFault ( QName , String , Locale ) throws SOAPException | if there is a SOAP error | true |  | true
SAAJ:JAVADOC:92 | SOAPFault | javax.xml.soap.SOAPBody.addFault ( Name , String ) | Creates a new SOAPFault object and adds it to this SOAPBody object. The type of the SOAPFault will be a SOAP 1.1 or a SOAP 1.2 SOAPFault depending on the protocol specified while creating the MessageFactory instance. For SOAP 1.2 the faultCode parameter is the value of the Fault/Code/Value element and the faultString parameter is the value of the Fault/Reason/Text element. For SOAP 1.1 the faultCode parameter is the value of the faultcode element and the faultString parameter is the value of the faultstring element. In case of a SOAP 1.2 fault, the default value for the mandatory xml:lang attribute on the Fault/Reason/Text element will be set to java.util.Locale.getDefault() A SOAPBody may contain at most one SOAPFault child element. | true |  | true
SAAJ:JAVADOC:93 | SOAPFault | javax.xml.soap.SOAPBody.addFault ( Name , String ) throws SOAPException | if there is a SOAP error | true |  | true
SAAJ:JAVADOC:94 | SOAPFault | javax.xml.soap.SOAPBody.addFault ( QName , String ) | Creates a new SOAPFault object and adds it to this SOAPBody object. The type of the SOAPFault will be a SOAP 1.1 or a SOAP 1.2 SOAPFault depending on the protocol specified while creating the MessageFactory instance. For SOAP 1.2 the faultCode parameter is the value of the Fault/Code/Value element and the faultString parameter is the value of the Fault/Reason/Text element. For SOAP 1.1 the faultCode parameter is the value of the faultcode element and the faultString parameter is the value of the faultstring element. In case of a SOAP 1.2 fault, the default value for the mandatory xml:lang attribute on the Fault/Reason/Text element will be set to java.util.Locale.getDefault() A SOAPBody may contain at most one SOAPFault child element | true |  | true
SAAJ:JAVADOC:95 | SOAPFault | javax.xml.soap.SOAPBody.addFault ( QName , String ) throws SOAPException | if there is a SOAP error | true |  | true
SAAJ:JAVADOC:96 | Document | javax.xml.soap.SOAPBody.extractContentAsDocument | Creates a new DOM org.w3c.dom.Document and sets the first child of this SOAPBody as it's document element. The child SOAPElement is removed as part of the process. | true |  | true
SAAJ:JAVADOC:97 | Document | javax.xml.soap.SOAPBody.extractContentAsDocument throws SOAPException | if there is not exactly one child SOAPElement of the SOAPBody. | true |  | true
SAAJ:JAVADOC:98 | SOAPFault | javax.xml.soap.SOAPBody.getFault | Returns the SOAPFault object in this SOAPBody object. | true |  | true
SAAJ:JAVADOC:99 | boolean | javax.xml.soap.SOAPBody.hasFault | Indicates whether a SOAPFault object exists in this SOAPBody object. | true |  | true
SAAJ:JAVADOC:100 | SOAPMessage | javax.xml.soap.SOAPConnection.call ( SOAPMessage , Object ) | Sends the given message to the specified endpoint and blocks until it has returned the response. | true |  | true
SAAJ:JAVADOC:101 | SOAPMessage | javax.xml.soap.SOAPConnection.call ( SOAPMessage , Object ) throws SOAPException | if there is a SOAP error | true |  | true
SAAJ:JAVADOC:102 | void | javax.xml.soap.SOAPConnection.close | Closes this SOAPConnection object. | true |  | true
SAAJ:JAVADOC:103 | void | javax.xml.soap.SOAPConnection.close throws SOAPException | if there is a SOAP error | true |  | true
SAAJ:JAVADOC:104 | SOAPMessage | javax.xml.soap.SOAPConnection.get ( Object ) | Gets a message from a specific endpoint and blocks until it receives, | true |  | true
SAAJ:JAVADOC:105 | SOAPMessage | javax.xml.soap.SOAPConnection.get ( Object ) throws SOAPException | if there is a SOAP error | true |  | true
SAAJ:JAVADOC:106 | SOAPConnection | javax.xml.soap.SOAPConnection.SOAPConnection |  | true |  | true
SAAJ:JAVADOC:107 | SOAPConnection | javax.xml.soap.SOAPConnectionFactory.createConnection | Create a new SOAPConnection. | true |  | true
SAAJ:JAVADOC:108 | SOAPConnection | javax.xml.soap.SOAPConnectionFactory.createConnection throws SOAPException | if there was an exception creating the SOAPConnection object. | true |  | true
SAAJ:JAVADOC:109 | SOAPConnectionFactory | javax.xml.soap.SOAPConnectionFactory.newInstance | Creates an instance of the default SOAPConnectionFactory object. This method uses the lookup procedure specified in javax.xml.soap to locate and load the javax.xml.soap.SOAPConnectionFactory class. | true |  | true
SAAJ:JAVADOC:110 | SOAPConnectionFactory | javax.xml.soap.SOAPConnectionFactory.newInstance throws SOAPException | if there was an error creating the SOAPConnectionFactory | true |  | true
SAAJ:JAVADOC:111 | SOAPConnectionFactory | javax.xml.soap.SOAPConnectionFactory.newInstance throws UnsupportedOperationException | if newInstance is not supported. | true |  | true
SAAJ:JAVADOC:112 | SOAPConnectionFactory | javax.xml.soap.SOAPConnectionFactory.SOAPConnectionFactory |  | true |  | true
SAAJ:JAVADOC:113 | SOAPElement | javax.xml.soap.SOAPElement.addAttribute ( Name , String ) | Adds an attribute with the specified name and value to this SOAPElement object. | true |  | true
SAAJ:JAVADOC:114 | SOAPElement | javax.xml.soap.SOAPElement.addAttribute ( Name , String ) throws SOAPException | if there is an error in creating the Attribute, or it is invalid to set an attribute with Name name on this SOAPElement. | true |  | true
SAAJ:JAVADOC:115 | SOAPElement | javax.xml.soap.SOAPElement.addAttribute ( QName , String ) | Adds an attribute with the specified name and value to this SOAPElement object. | true |  | true
SAAJ:JAVADOC:116 | SOAPElement | javax.xml.soap.SOAPElement.addAttribute ( QName , String ) throws SOAPException | if there is an error in creating the Attribute, or it is invalid to set an attribute with QName qname on this SOAPElement. | true |  | true
SAAJ:JAVADOC:117 | SOAPElement | javax.xml.soap.SOAPElement.addChildElement ( Name ) | Creates a new SOAPElement object initialized with the given Name object and adds the new element to this SOAPElement object. This method may be deprecated in a future release of SAAJ in favor of addChildElement(javax.xml.namespace.QName) | true |  | true
SAAJ:JAVADOC:118 | SOAPElement | javax.xml.soap.SOAPElement.addChildElement ( Name ) throws SOAPException | if there is an error in creating the SOAPElement object | true |  | true
SAAJ:JAVADOC:119 | SOAPElement | javax.xml.soap.SOAPElement.addChildElement ( QName ) | Creates a new SOAPElement object initialized with the given QName object and adds the new element to this SOAPElement object. The namespace, localname and prefix of the new SOAPElement are all taken from the qname argument. | true |  | true
SAAJ:JAVADOC:120 | SOAPElement | javax.xml.soap.SOAPElement.addChildElement ( QName ) throws SOAPException | if there is an error in creating the SOAPElement object | true |  | true
SAAJ:JAVADOC:121 | SOAPElement | javax.xml.soap.SOAPElement.addChildElement ( String ) | Creates a new SOAPElement object initialized with the specified local name and adds the new element to this SOAPElement object. The new SOAPElement inherits any in-scope default namespace. | true |  | true
SAAJ:JAVADOC:122 | SOAPElement | javax.xml.soap.SOAPElement.addChildElement ( String ) throws SOAPException | if there is an error in creating the SOAPElement object | true |  | true
SAAJ:JAVADOC:123 | SOAPElement | javax.xml.soap.SOAPElement.addChildElement ( String , String ) | Creates a new SOAPElement object initialized with the specified local name and prefix and adds the new element to this SOAPElement object. | true |  | true
SAAJ:JAVADOC:124 | SOAPElement | javax.xml.soap.SOAPElement.addChildElement ( String , String ) throws SOAPException | if the prefix is not valid in the context of this SOAPElement or if there is an error in creating the SOAPElement object | true |  | true
SAAJ:JAVADOC:125 | SOAPElement | javax.xml.soap.SOAPElement.addChildElement ( String , String , String ) | Creates a new SOAPElement object initialized with the specified local name, prefix, and URI and adds the new element to this SOAPElement object. | true |  | true
SAAJ:JAVADOC:126 | SOAPElement | javax.xml.soap.SOAPElement.addChildElement ( String , String , String ) throws SOAPException | if there is an error in creating the SOAPElement object | true |  | true
SAAJ:JAVADOC:127 | SOAPElement | javax.xml.soap.SOAPElement.addChildElement ( SOAPElement ) | Add a SOAPElement as a child of this SOAPElement instance. The SOAPElement is expected to be created by a SOAPFactory. Callers should not rely on the element instance being added as is into the XML tree. Implementations could end up copying the content of the SOAPElement passed into an instance of a different SOAPElement implementation. For instance if addChildElement() is called on a SOAPHeader, element will be copied into an instance of a SOAPHeaderElement. The fragment rooted in element is either added as a whole or not at all, if there was an error. The fragment rooted in element cannot contain elements named "Envelope", "Header" or "Body" and in the SOAP namespace. Any namespace prefixes present in the fragment should be fully resolved using appropriate namespace declarations within the fragment itself. | true |  | true
SAAJ:JAVADOC:128 | SOAPElement | javax.xml.soap.SOAPElement.addChildElement ( SOAPElement ) throws SOAPException | if there was an error in adding this element as a child | true |  | true
SAAJ:JAVADOC:129 | SOAPElement | javax.xml.soap.SOAPElement.addNamespaceDeclaration ( String , String ) | Adds a namespace declaration with the specified prefix and URI to this SOAPElement object. | true |  | true
SAAJ:JAVADOC:130 | SOAPElement | javax.xml.soap.SOAPElement.addNamespaceDeclaration ( String , String ) throws SOAPException | if there is an error in creating the namespace | true |  | true
SAAJ:JAVADOC:131 | SOAPElement | javax.xml.soap.SOAPElement.addTextNode ( String ) | Creates a new Text object initialized with the given String and adds it to this SOAPElement object. | true |  | true
SAAJ:JAVADOC:132 | SOAPElement | javax.xml.soap.SOAPElement.addTextNode ( String ) throws SOAPException | if there is an error in creating the new Text object or if it is not legal to attach it as a child to this SOAPElement | true |  | true
SAAJ:JAVADOC:133 | QName | javax.xml.soap.SOAPElement.createQName ( String , String ) | Creates a QName whose namespace URI is the one associated with the parameter, prefix, in the context of this SOAPElement. The remaining elements of the new QName are taken directly from the parameters, localName and prefix. | true |  | true
SAAJ:JAVADOC:134 | QName | javax.xml.soap.SOAPElement.createQName ( String , String ) throws SOAPException | if the QName cannot be created. | true |  | true
SAAJ:JAVADOC:135 | Iterator | javax.xml.soap.SOAPElement.getAllAttributes | Returns an Iterator over all of the attribute Name objects in this SOAPElement object. The iterator can be used to get the attribute names, which can then be passed to the method getAttributeValue to retrieve the value of each attribute. | true |  | true
SAAJ:JAVADOC:136 | String | javax.xml.soap.SOAPElement.getAttributeValue ( Name ) | Returns the value of the attribute with the specified name. | true |  | true
SAAJ:JAVADOC:137 | String | javax.xml.soap.SOAPElement.getAttributeValue ( QName ) | Returns the value of the attribute with the specified qname. | true |  | true
SAAJ:JAVADOC:138 | Iterator | javax.xml.soap.SOAPElement.getChildElements | Returns an Iterator over all the immediate child Nodes of this element. This includes javax.xml.soap.Text objects as well as SOAPElement objects. Calling this method must cause child Element, SOAPElement and org.w3c.dom.Text nodes to be replaced by SOAPElement, SOAPHeaderElement, SOAPBodyElement or javax.xml.soap.Text nodes as appropriate for the type of this parent node. As a result the calling application must treat any existing references to these child nodes that have been obtained through DOM APIs as invalid and either discard them or refresh them with the values returned by this Iterator. This behavior can be avoided by calling the equivalent DOM APIs. See javax.xml.soap for more details. | true |  | true
SAAJ:JAVADOC:139 | Iterator | javax.xml.soap.SOAPElement.getChildElements ( Name ) | Returns an Iterator over all the immediate child Nodes of this element with the specified name. All of these children will be SOAPElement nodes. Calling this method must cause child Element, SOAPElement and org.w3c.dom.Text nodes to be replaced by SOAPElement, SOAPHeaderElement, SOAPBodyElement or javax.xml.soap.Text nodes as appropriate for the type of this parent node. As a result the calling application must treat any existing references to these child nodes that have been obtained through DOM APIs as invalid and either discard them or refresh them with the values returned by this Iterator. This behavior can be avoided by calling the equivalent DOM APIs. See javax.xml.soap for more details. | true |  | true
SAAJ:JAVADOC:140 | Iterator | javax.xml.soap.SOAPElement.getChildElements ( QName ) | Returns an Iterator over all the immediate child Nodes of this element with the specified qname. All of these children will be SOAPElement nodes. Calling this method must cause child Element, SOAPElement and org.w3c.dom.Text nodes to be replaced by SOAPElement, SOAPHeaderElement, SOAPBodyElement or javax.xml.soap.Text nodes as appropriate for the type of this parent node. As a result the calling application must treat any existing references to these child nodes that have been obtained through DOM APIs as invalid and either discard them or refresh them with the values returned by this Iterator. This behavior can be avoided by calling the equivalent DOM APIs. See javax.xml.soap for more details. | true |  | true
SAAJ:JAVADOC:141 | Name | javax.xml.soap.SOAPElement.getElementName | Returns the name of this SOAPElement object. | true |  | true
SAAJ:JAVADOC:142 | QName | javax.xml.soap.SOAPElement.getElementQName | Returns the qname of this SOAPElement object. | true |  | true
SAAJ:JAVADOC:143 | String | javax.xml.soap.SOAPElement.getEncodingStyle | Returns the encoding style for this SOAPElement object. | true |  | true
SAAJ:JAVADOC:144 | Iterator | javax.xml.soap.SOAPElement.getNamespacePrefixes | Returns an Iterator over the namespace prefix Strings declared by this element. The prefixes returned by this iterator can be passed to the method getNamespaceURI to retrieve the URI of each namespace. | true |  | true
SAAJ:JAVADOC:145 | String | javax.xml.soap.SOAPElement.getNamespaceURI ( String ) | Returns the URI of the namespace that has the given prefix. | true |  | true
SAAJ:JAVADOC:146 | Iterator | javax.xml.soap.SOAPElement.getVisibleNamespacePrefixes | Returns an Iterator over the namespace prefix Strings visible to this element. The prefixes returned by this iterator can be passed to the method getNamespaceURI to retrieve the URI of each namespace. | true |  | true
SAAJ:JAVADOC:147 | boolean | javax.xml.soap.SOAPElement.removeAttribute ( Name ) | Removes the attribute with the specified name. | true |  | true
SAAJ:JAVADOC:148 | boolean | javax.xml.soap.SOAPElement.removeAttribute ( QName ) | Removes the attribute with the specified qname. | true |  | true
SAAJ:JAVADOC:149 | void | javax.xml.soap.SOAPElement.removeContents | Detaches all children of this SOAPElement. This method is useful for rolling back the construction of partially completed SOAPHeaders and SOAPBodys in preparation for sending a fault when an error condition is detected. It is also useful for recycling portions of a document within a SOAP message. | true |  | true
SAAJ:JAVADOC:150 | boolean | javax.xml.soap.SOAPElement.removeNamespaceDeclaration ( String ) | Removes the namespace declaration corresponding to the given prefix. | true |  | true
SAAJ:JAVADOC:151 | SOAPElement | javax.xml.soap.SOAPElement.setElementQName ( QName ) | Changes the name of this Element to newName if possible. SOAP Defined elements such as SOAPEnvelope, SOAPHeader, SOAPBody etc. cannot have their names changed using this method. Any attempt to do so will result in a SOAPException being thrown. Callers should not rely on the element instance being renamed as is. Implementations could end up copying the content of the SOAPElement to a renamed instance. | true |  | true
SAAJ:JAVADOC:152 | SOAPElement | javax.xml.soap.SOAPElement.setElementQName ( QName ) throws SOAPException | if changing the name of this Element is not allowed. | true |  | true
SAAJ:JAVADOC:153 | void | javax.xml.soap.SOAPElement.setEncodingStyle ( String ) | Sets the encoding style for this SOAPElement object to one specified. | true |  | true
SAAJ:JAVADOC:154 | void | javax.xml.soap.SOAPElement.setEncodingStyle ( String ) throws SOAPException | if setting the encodingStyle is invalid for this SOAPElement. | true |  | true
SAAJ:JAVADOC:163 | SOAPBody | javax.xml.soap.SOAPEnvelope.addBody | Creates a SOAPBody object and sets it as the SOAPBody object for this SOAPEnvelope object. It is illegal to add a body when the envelope already contains a body. Therefore, this method should be called only after the existing body has been removed. | true |  | true
SAAJ:JAVADOC:164 | SOAPBody | javax.xml.soap.SOAPEnvelope.addBody throws SOAPException | if this SOAPEnvelope object already contains a valid SOAPBody object | true |  | true
SAAJ:JAVADOC:165 | SOAPHeader | javax.xml.soap.SOAPEnvelope.addHeader | Creates a SOAPHeader object and sets it as the SOAPHeader object for this SOAPEnvelope object. It is illegal to add a header when the envelope already contains a header. Therefore, this method should be called only after the existing header has been removed. | true |  | true
SAAJ:JAVADOC:166 | SOAPHeader | javax.xml.soap.SOAPEnvelope.addHeader throws SOAPException | if this SOAPEnvelope object already contains a valid SOAPHeader object | true |  | true
SAAJ:JAVADOC:167 | Name | javax.xml.soap.SOAPEnvelope.createName ( String , String , String ) | 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 the SOAP/XML document. | true |  | true
SAAJ:JAVADOC:168 | Name | javax.xml.soap.SOAPEnvelope.createName ( String , String , String ) throws SOAPException | if there is a SOAP error | true |  | true
SAAJ:JAVADOC:169 | Name | javax.xml.soap.SOAPEnvelope.createName ( String ) | Creates a new Name object initialized with the given local name. This factory method creates Name objects for use in the SOAP/XML document. | true |  | true
SAAJ:JAVADOC:170 | Name | javax.xml.soap.SOAPEnvelope.createName ( String ) throws SOAPException | if there is a SOAP error | true |  | true
SAAJ:JAVADOC:171 | SOAPBody | javax.xml.soap.SOAPEnvelope.getBody | Returns the SOAPBody object associated with this SOAPEnvelope object. A new SOAPMessage object is by default created with a SOAPEnvelope object that contains an empty SOAPBody object. As a result, the method getBody will always return a SOAPBody object unless the body has been removed and a new one has not been added. | true |  | true
SAAJ:JAVADOC:172 | SOAPBody | javax.xml.soap.SOAPEnvelope.getBody throws SOAPException | if there is a problem obtaining the SOAPBody object | true |  | true
SAAJ:JAVADOC:173 | SOAPHeader | javax.xml.soap.SOAPEnvelope.getHeader | Returns the SOAPHeader object for this SOAPEnvelope object. A new SOAPMessage object is by default created with a SOAPEnvelope object that contains an empty SOAPHeader object. As a result, the method getHeader will always return a SOAPHeader object unless the header has been removed and a new one has not been added. | true |  | true
SAAJ:JAVADOC:174 | SOAPHeader | javax.xml.soap.SOAPEnvelope.getHeader throws SOAPException | if there is a problem obtaining the SOAPHeader object | true |  | true
SAAJ:JAVADOC:175 | Throwable | javax.xml.soap.SOAPException.getCause | Returns the Throwable object embedded in this SOAPException if there is one. Otherwise, this method returns null. | true |  | true
SAAJ:JAVADOC:176 | String | javax.xml.soap.SOAPException.getMessage | Returns the detail message for this SOAPException object. If there is an embedded Throwable object, and if the SOAPException object has no detail message of its own, this method will return the detail message from the embedded Throwable object. | true |  | true
SAAJ:JAVADOC:177 | Throwable | javax.xml.soap.SOAPException.initCause ( Throwable ) | Initializes the cause field of this SOAPException object with the given Throwable object. This method can be called at most once. It is generally called from within the constructor or immediately after the constructor has returned a new SOAPException object. If this SOAPException object was created with the constructor #SOAPException(Throwable) or #SOAPException(String,Throwable), meaning that its cause field already has a value, this method cannot be called even once. | true |  | true
SAAJ:JAVADOC:178 | SOAPException | javax.xml.soap.SOAPException.SOAPException | Constructs a SOAPException object with no reason or embedded Throwable object. | true |  | true
SAAJ:JAVADOC:179 | SOAPException | javax.xml.soap.SOAPException.SOAPException ( String ) | Constructs a SOAPException object with the given String as the reason for the exception being thrown. | true |  | true
SAAJ:JAVADOC:180 | SOAPException | javax.xml.soap.SOAPException.SOAPException ( String , Throwable ) | Constructs a SOAPException object with the given String as the reason for the exception being thrown and the given Throwable object as an embedded exception. | true |  | true
SAAJ:JAVADOC:181 | SOAPException | javax.xml.soap.SOAPException.SOAPException ( Throwable ) | Constructs a SOAPException object initialized with the given Throwable object. | true |  | true
SAAJ:JAVADOC:182 | Detail | javax.xml.soap.SOAPFactory.createDetail | 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. | true |  | true
SAAJ:JAVADOC:183 | Detail | javax.xml.soap.SOAPFactory.createDetail throws SOAPException | if there is a SOAP error | true |  | true
SAAJ:JAVADOC:184 | SOAPElement | javax.xml.soap.SOAPFactory.createElement ( Element ) | 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. | true |  | true
SAAJ:JAVADOC:185 | SOAPElement | javax.xml.soap.SOAPFactory.createElement ( Element ) throws SOAPException | if there is an error in creating the SOAPElement object | true |  | true
SAAJ:JAVADOC:186 | SOAPElement | javax.xml.soap.SOAPFactory.createElement ( Name ) | 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. | true |  | true
SAAJ:JAVADOC:187 | SOAPElement | javax.xml.soap.SOAPFactory.createElement ( Name ) throws SOAPException | if there is an error in creating the SOAPElement object | true |  | true
SAAJ:JAVADOC:188 | SOAPElement | javax.xml.soap.SOAPFactory.createElement ( QName ) | 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. | true |  | true
SAAJ:JAVADOC:189 | SOAPElement | javax.xml.soap.SOAPFactory.createElement ( QName ) throws SOAPException | if there is an error in creating the SOAPElement object | true |  | true
SAAJ:JAVADOC:190 | SOAPElement | javax.xml.soap.SOAPFactory.createElement ( String ) | Creates a SOAPElement object initialized with the given local name. | true |  | true
SAAJ:JAVADOC:191 | SOAPElement | javax.xml.soap.SOAPFactory.createElement ( String ) throws SOAPException | if there is an error in creating the SOAPElement object | true |  | true
SAAJ:JAVADOC:192 | SOAPElement | javax.xml.soap.SOAPFactory.createElement ( String , String , String ) | 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. | true |  | true
SAAJ:JAVADOC:193 | SOAPElement | javax.xml.soap.SOAPFactory.createElement ( String , String , String ) throws SOAPException | if there is an error in creating the SOAPElement object | true |  | true
SAAJ:JAVADOC:194 | SOAPFault | javax.xml.soap.SOAPFactory.createFault ( String , QName ) | Creates a new SOAPFault object initialized with the given reasonText and faultCode | true |  | true
SAAJ:JAVADOC:195 | SOAPFault | javax.xml.soap.SOAPFactory.createFault ( String , QName ) throws SOAPException | if there is a SOAP error | true |  | true
SAAJ:JAVADOC:196 | SOAPFault | javax.xml.soap.SOAPFactory.createFault | Creates a new default SOAPFault object | true |  | true
SAAJ:JAVADOC:197 | SOAPFault | javax.xml.soap.SOAPFactory.createFault throws SOAPException | if there is a SOAP error | true |  | true
SAAJ:JAVADOC:198 | Name | javax.xml.soap.SOAPFactory.createName ( String , String , String ) | 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. | true |  | true
SAAJ:JAVADOC:199 | Name | javax.xml.soap.SOAPFactory.createName ( String , String , String ) throws SOAPException | if there is a SOAP error | true |  | true
SAAJ:JAVADOC:200 | Name | javax.xml.soap.SOAPFactory.createName ( String ) | 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. | true |  | true
SAAJ:JAVADOC:201 | Name | javax.xml.soap.SOAPFactory.createName ( String ) throws SOAPException | if there is a SOAP error | true |  | true
SAAJ:JAVADOC:202 | SOAPFactory | javax.xml.soap.SOAPFactory.newInstance | Creates a new SOAPFactory object that is an instance of the default implementation (SOAP 1.1). This method uses the lookup procedure specified in javax.xml.soap to locate and load the javax.xml.soap.SOAPFactory class. | true |  | true
SAAJ:JAVADOC:203 | SOAPFactory | javax.xml.soap.SOAPFactory.newInstance throws SOAPException | if there was an error creating the default SOAPFactory | true |  | true
SAAJ:JAVADOC:204 | SOAPFactory | javax.xml.soap.SOAPFactory.newInstance ( String ) | 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. | true |  | true
SAAJ:JAVADOC:205 | SOAPFactory | javax.xml.soap.SOAPFactory.newInstance ( String ) throws SOAPException | if there was an error creating the specified SOAPFactory | true |  | true
SAAJ:JAVADOC:206 | SOAPFactory | javax.xml.soap.SOAPFactory.SOAPFactory |  | true |  | true
SAAJ:JAVADOC:207 | Detail | javax.xml.soap.SOAPFault.addDetail | Creates an optional Detail object and sets it as the Detail object for this SOAPFault object. It is illegal to add a detail when the fault already contains a detail. Therefore, this method should be called only after the existing detail has been removed. | true |  | true
SAAJ:JAVADOC:208 | Detail | javax.xml.soap.SOAPFault.addDetail throws SOAPException | if this SOAPFault object already contains a valid Detail object | true |  | true
SAAJ:JAVADOC:209 | void | javax.xml.soap.SOAPFault.addFaultReasonText ( String , Locale ) | Appends or replaces a Reason Text item containing the specified text message and an xml:lang derived from locale. If a Reason Text item with this xml:lang already exists its text value will be replaced with text. The locale parameter should not be null Code sample: SOAPFault fault = ...; fault.addFaultReasonText("Version Mismatch", Locale.ENGLISH); | true |  | true
SAAJ:JAVADOC:210 | void | javax.xml.soap.SOAPFault.addFaultReasonText ( String , Locale ) throws SOAPException | if there was an error in adding the Reason text or the locale passed was null. | true |  | true
SAAJ:JAVADOC:211 | void | javax.xml.soap.SOAPFault.appendFaultSubcode ( QName ) | Adds a Subcode to the end of the sequence of Subcodes contained by this SOAPFault. Subcodes, which were introduced in SOAP 1.2, are represented by a recursive sequence of subelements rooted in the mandatory Code subelement of a SOAP Fault. | true |  | true
SAAJ:JAVADOC:212 | void | javax.xml.soap.SOAPFault.appendFaultSubcode ( QName ) throws SOAPException | if there was an error in setting the Subcode | true |  | true
SAAJ:JAVADOC:213 | Detail | javax.xml.soap.SOAPFault.getDetail | Returns the optional detail element for this SOAPFault object. A Detail object carries application-specific error information, the scope of the error information is restricted to faults in the SOAPBodyElement objects if this is a SOAP 1.1 Fault. | true |  | true
SAAJ:JAVADOC:214 | String | javax.xml.soap.SOAPFault.getFaultActor | Gets the fault actor for this SOAPFault object. If this SOAPFault supports SOAP 1.2 then this call is equivalent to #getFaultRole() | true |  | true
SAAJ:JAVADOC:215 | String | javax.xml.soap.SOAPFault.getFaultCode | Gets the fault code for this SOAPFault object. | true |  | true
SAAJ:JAVADOC:216 | Name | javax.xml.soap.SOAPFault.getFaultCodeAsName | Gets the mandatory SOAP 1.1 fault code for this SOAPFault object as a SAAJ Name object. The SOAP 1.1 specification requires the value of the "faultcode" element to be of type QName. This method returns the content of the element as a QName in the form of a SAAJ Name object. This method should be used instead of the getFaultCode method since it allows applications to easily access the namespace name without additional parsing. | true |  | true
SAAJ:JAVADOC:217 | QName | javax.xml.soap.SOAPFault.getFaultCodeAsQName | Gets the fault code for this SOAPFault object as a QName object. | true |  | true
SAAJ:JAVADOC:218 | String | javax.xml.soap.SOAPFault.getFaultNode | Returns the optional Node element value for this SOAPFault object. The Node element is optional in SOAP 1.2. | true |  | true
SAAJ:JAVADOC:219 | Iterator | javax.xml.soap.SOAPFault.getFaultReasonLocales | Returns an Iterator over a distinct sequence of Locales for which there are associated Reason Text items. Any of these Locales can be used in a call to getFaultReasonText in order to obtain a localized version of the Reason Text string. | true |  | true
SAAJ:JAVADOC:220 | Iterator | javax.xml.soap.SOAPFault.getFaultReasonLocales throws SOAPException | if there was an error in retrieving the fault Reason locales. | true |  | true
SAAJ:JAVADOC:221 | String | javax.xml.soap.SOAPFault.getFaultReasonText ( Locale ) | Returns the Reason Text associated with the given Locale. If more than one such Reason Text exists the first matching Text is returned | true |  | true
SAAJ:JAVADOC:222 | String | javax.xml.soap.SOAPFault.getFaultReasonText ( Locale ) throws SOAPException | if there was an error in retrieving the fault Reason text for the specified locale . | true |  | true
SAAJ:JAVADOC:223 | Iterator | javax.xml.soap.SOAPFault.getFaultReasonTexts | Returns an Iterator over a sequence of String objects containing all of the Reason Text items for this SOAPFault. | true |  | true
SAAJ:JAVADOC:224 | Iterator | javax.xml.soap.SOAPFault.getFaultReasonTexts throws SOAPException | if there was an error in retrieving the fault Reason texts. | true |  | true
SAAJ:JAVADOC:225 | String | javax.xml.soap.SOAPFault.getFaultRole | Returns the optional Role element value for this SOAPFault object. The Role element is optional in SOAP 1.2. | true |  | true
SAAJ:JAVADOC:226 | String | javax.xml.soap.SOAPFault.getFaultString | Gets the fault string for this SOAPFault object. If this SOAPFault is part of a message that supports SOAP 1.2 then this call is equivalent to: String reason = null; try { reason = (String) getFaultReasonTexts().next(); } catch (SOAPException e) {} return reason; | true |  | true
SAAJ:JAVADOC:227 | Locale | javax.xml.soap.SOAPFault.getFaultStringLocale | Gets the locale of the fault string for this SOAPFault object. If this SOAPFault is part of a message that supports SOAP 1.2 then this call is equivalent to: Locale locale = null; try { locale = (Locale) getFaultReasonLocales().next(); } catch (SOAPException e) {} return locale; | true |  | true
SAAJ:JAVADOC:228 | Iterator | javax.xml.soap.SOAPFault.getFaultSubcodes | Gets the Subcodes for this SOAPFault as an iterator over QNames. | true |  | true
SAAJ:JAVADOC:229 | boolean | javax.xml.soap.SOAPFault.hasDetail | Returns true if this SOAPFault has a Detail subelement and false otherwise. Equivalent to (getDetail()!=null). | true |  | true
SAAJ:JAVADOC:230 | void | javax.xml.soap.SOAPFault.removeAllFaultSubcodes | Removes any Subcodes that may be contained by this SOAPFault. Subsequent calls to getFaultSubcodes will return an empty iterator until a call to appendFaultSubcode is made. | true |  | true
SAAJ:JAVADOC:231 | void | javax.xml.soap.SOAPFault.setFaultActor ( String ) | Sets this SOAPFault object with the given fault actor. The fault actor is the recipient in the message path who caused the fault to happen. If this SOAPFault supports SOAP 1.2 then this call is equivalent to #setFaultRole(String) | true |  | true
SAAJ:JAVADOC:232 | void | javax.xml.soap.SOAPFault.setFaultActor ( String ) throws SOAPException | if there was an error in adding the faultActor to the underlying XML tree. | true |  | true
SAAJ:JAVADOC:233 | void | javax.xml.soap.SOAPFault.setFaultCode ( Name ) | Sets this SOAPFault object with the given fault code. Fault codes, which give information about the fault, are defined in the SOAP 1.1 specification. A fault code is mandatory and must be of type Name. This method provides a convenient way to set a fault code. For example, SOAPEnvelope se = ...; // Create a qualified name in the SOAP namespace with a localName // of "Client". Note that prefix parameter is optional and is null // here which causes the implementation to use an appropriate prefix. Name qname = se.createName("Client", null, SOAPConstants.URI_NS_SOAP_ENVELOPE); SOAPFault fault = ...; fault.setFaultCode(qname); It is preferable to use this method over #setFaultCode(String). | true |  | true
SAAJ:JAVADOC:234 | void | javax.xml.soap.SOAPFault.setFaultCode ( Name ) throws SOAPException | if there was an error in adding the faultcode element to the underlying XML tree. | true |  | true
SAAJ:JAVADOC:235 | void | javax.xml.soap.SOAPFault.setFaultCode ( QName ) | Sets this SOAPFault object with the given fault code. It is preferable to use this method over #setFaultCode(Name). | true |  | true
SAAJ:JAVADOC:236 | void | javax.xml.soap.SOAPFault.setFaultCode ( QName ) throws SOAPException | if there was an error in adding the faultcode element to the underlying XML tree. | true |  | true
SAAJ:JAVADOC:237 | void | javax.xml.soap.SOAPFault.setFaultCode ( String ) | Sets this SOAPFault object with the give fault code. Fault codes, which given information about the fault, are defined in the SOAP 1.1 specification. This element is mandatory in SOAP 1.1. Because the fault code is required to be a QName it is preferable to use the #setFaultCode(Name) form of this method. | true |  | true
SAAJ:JAVADOC:238 | void | javax.xml.soap.SOAPFault.setFaultCode ( String ) throws SOAPException | if there was an error in adding the faultCode to the underlying XML tree. | true |  | true
SAAJ:JAVADOC:239 | void | javax.xml.soap.SOAPFault.setFaultNode ( String ) | Creates or replaces any existing Node element value for this SOAPFault object. The Node element is optional in SOAP 1.2. | true |  | true
SAAJ:JAVADOC:240 | void | javax.xml.soap.SOAPFault.setFaultNode ( String ) throws SOAPException | if there was an error in setting the Node for this SOAPFault object. | true |  | true
SAAJ:JAVADOC:241 | void | javax.xml.soap.SOAPFault.setFaultRole ( String ) | Creates or replaces any existing Role element value for this SOAPFault object. The Role element is optional in SOAP 1.2. | true |  | true
SAAJ:JAVADOC:242 | void | javax.xml.soap.SOAPFault.setFaultRole ( String ) throws SOAPException | if there was an error in setting the Role for this SOAPFault object. | true |  | true
SAAJ:JAVADOC:243 | void | javax.xml.soap.SOAPFault.setFaultString ( String ) | Sets the fault string for this SOAPFault object to the given string. If this SOAPFault is part of a message that supports SOAP 1.2 then this call is equivalent to: addFaultReasonText(faultString, Locale.getDefault()); | true |  | true
SAAJ:JAVADOC:244 | void | javax.xml.soap.SOAPFault.setFaultString ( String ) throws SOAPException | if there was an error in adding the faultString to the underlying XML tree. | true |  | true
SAAJ:JAVADOC:245 | void | javax.xml.soap.SOAPFault.setFaultString ( String , Locale ) | Sets the fault string for this SOAPFault object to the given string and localized to the given locale. If this SOAPFault is part of a message that supports SOAP 1.2 then this call is equivalent to: addFaultReasonText(faultString, locale); | true |  | true
SAAJ:JAVADOC:246 | void | javax.xml.soap.SOAPFault.setFaultString ( String , Locale ) throws SOAPException | if there was an error in adding the faultString to the underlying XML tree. | true |  | true
SAAJ:JAVADOC:247 | SOAPHeaderElement | javax.xml.soap.SOAPHeader.addHeaderElement ( Name ) | Creates a new SOAPHeaderElement object initialized with the specified name and adds it to this SOAPHeader object. | true |  | true
SAAJ:JAVADOC:248 | SOAPHeaderElement | javax.xml.soap.SOAPHeader.addHeaderElement ( Name ) throws SOAPException | if a SOAP error occurs | true |  | true
SAAJ:JAVADOC:249 | SOAPHeaderElement | javax.xml.soap.SOAPHeader.addHeaderElement ( QName ) | Creates a new SOAPHeaderElement object initialized with the specified qname and adds it to this SOAPHeader object. | true |  | true
SAAJ:JAVADOC:250 | SOAPHeaderElement | javax.xml.soap.SOAPHeader.addHeaderElement ( QName ) throws SOAPException | if a SOAP error occurs | true |  | true
SAAJ:JAVADOC:251 | SOAPHeaderElement | javax.xml.soap.SOAPHeader.addNotUnderstoodHeaderElement ( QName ) | Creates a new NotUnderstood SOAPHeaderElement object initialized with the specified name and adds it to this SOAPHeader object. This operation is supported only by SOAP 1.2. | true |  | true
SAAJ:JAVADOC:252 | SOAPHeaderElement | javax.xml.soap.SOAPHeader.addNotUnderstoodHeaderElement ( QName ) throws SOAPException | if a SOAP error occurs. | true |  | true
SAAJ:JAVADOC:253 | SOAPHeaderElement | javax.xml.soap.SOAPHeader.addUpgradeHeaderElement ( Iterator ) | Creates a new Upgrade SOAPHeaderElement object initialized with the specified List of supported SOAP URIs and adds it to this SOAPHeader object. This operation is supported on both SOAP 1.1 and SOAP 1.2 header. | true |  | true
SAAJ:JAVADOC:254 | SOAPHeaderElement | javax.xml.soap.SOAPHeader.addUpgradeHeaderElement ( Iterator ) throws SOAPException | if a SOAP error occurs. | true |  | true
SAAJ:JAVADOC:255 | SOAPHeaderElement | javax.xml.soap.SOAPHeader.addUpgradeHeaderElement ( String[] ) | Creates a new Upgrade SOAPHeaderElement object initialized with the specified array of supported SOAP URIs and adds it to this SOAPHeader object. This operation is supported on both SOAP 1.1 and SOAP 1.2 header. | true |  | true
SAAJ:JAVADOC:256 | SOAPHeaderElement | javax.xml.soap.SOAPHeader.addUpgradeHeaderElement ( String[] ) throws SOAPException | if a SOAP error occurs. | true |  | true
SAAJ:JAVADOC:257 | SOAPHeaderElement | javax.xml.soap.SOAPHeader.addUpgradeHeaderElement ( String ) | Creates a new Upgrade SOAPHeaderElement object initialized with the specified supported SOAP URI and adds it to this SOAPHeader object. This operation is supported on both SOAP 1.1 and SOAP 1.2 header. | true |  | true
SAAJ:JAVADOC:258 | SOAPHeaderElement | javax.xml.soap.SOAPHeader.addUpgradeHeaderElement ( String ) throws SOAPException | if a SOAP error occurs. | true |  | true
SAAJ:JAVADOC:259 | Iterator | javax.xml.soap.SOAPHeader.examineAllHeaderElements | Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object. | true |  | true
SAAJ:JAVADOC:260 | Iterator | javax.xml.soap.SOAPHeader.examineHeaderElements ( String ) | Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object that have the specified actor. An actor is a global attribute that indicates the intermediate parties that should process a message before it reaches its ultimate receiver. An actor receives the message and processes it before sending it on to the next actor. The default actor is the ultimate intended recipient for the message, so if no actor attribute is included in a SOAPHeader object, it is sent to the ultimate receiver along with the message body. In SOAP 1.2 the env:actor attribute is replaced by the env:role attribute, but with essentially the same semantics. | true |  | true
SAAJ:JAVADOC:261 | Iterator | javax.xml.soap.SOAPHeader.examineMustUnderstandHeaderElements ( String ) | Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object that have the specified actor and that have a MustUnderstand attribute whose value is equivalent to true. In SOAP 1.2 the env:actor attribute is replaced by the env:role attribute, but with essentially the same semantics. | true |  | true
SAAJ:JAVADOC:262 | Iterator | javax.xml.soap.SOAPHeader.extractAllHeaderElements | Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object and detaches them from this SOAPHeader object. | true |  | true
SAAJ:JAVADOC:263 | Iterator | javax.xml.soap.SOAPHeader.extractHeaderElements ( String ) | Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object that have the specified actor and detaches them from this SOAPHeader object. This method allows an actor to process the parts of the SOAPHeader object that apply to it and to remove them before passing the message on to the next actor. In SOAP 1.2 the env:actor attribute is replaced by the env:role attribute, but with essentially the same semantics. | true |  | true
SAAJ:JAVADOC:264 | String | javax.xml.soap.SOAPHeaderElement.getActor | Returns the uri of the actor attribute of this SOAPHeaderElement. If this SOAPHeaderElement supports SOAP 1.2 then this call is equivalent to #getRole() | true |  | true
SAAJ:JAVADOC:265 | boolean | javax.xml.soap.SOAPHeaderElement.getMustUnderstand | Returns the boolean value of the mustUnderstand attribute for this SOAPHeaderElement. | true |  | true
SAAJ:JAVADOC:266 | boolean | javax.xml.soap.SOAPHeaderElement.getRelay | Returns the boolean value of the relay attribute for this SOAPHeaderElement | true |  | true
SAAJ:JAVADOC:267 | String | javax.xml.soap.SOAPHeaderElement.getRole | Returns the value of the Role attribute of this SOAPHeaderElement. | true |  | true
SAAJ:JAVADOC:268 | void | javax.xml.soap.SOAPHeaderElement.setActor ( String ) | Sets the actor associated with this SOAPHeaderElement object to the specified actor. The default value of an actor is: SOAPConstants.URI_SOAP_ACTOR_NEXT If this SOAPHeaderElement supports SOAP 1.2 then this call is equivalent to #setRole(String) | true |  | true
SAAJ:JAVADOC:269 | void | javax.xml.soap.SOAPHeaderElement.setMustUnderstand ( boolean ) | Sets the mustUnderstand attribute for this SOAPHeaderElement object to be either true or false. If the mustUnderstand attribute is on, the actor who receives the SOAPHeaderElement must process it correctly. This ensures, for example, that if the SOAPHeaderElement object modifies the message, that the message is being modified correctly. | true |  | true
SAAJ:JAVADOC:270 | void | javax.xml.soap.SOAPHeaderElement.setRelay ( boolean ) | Sets the relay attribute for this SOAPHeaderElement to be either true or false. The SOAP relay attribute is set to true to indicate that the SOAP header block must be relayed by any node that is targeted by the header block but not actually process it. This attribute is ignored on header blocks whose mustUnderstand attribute is set to true or that are targeted at the ultimate reciever (which is the default). The default value of this attribute is false. | true |  | true
SAAJ:JAVADOC:271 | void | javax.xml.soap.SOAPHeaderElement.setRelay ( boolean ) throws SOAPException | if there is a problem in setting the relay attribute. | true |  | true
SAAJ:JAVADOC:272 | void | javax.xml.soap.SOAPHeaderElement.setRole ( String ) | Sets the Role associated with this SOAPHeaderElement object to the specified Role. | true |  | true
SAAJ:JAVADOC:273 | void | javax.xml.soap.SOAPHeaderElement.setRole ( String ) throws SOAPException | if there is an error in setting the role | true |  | true
SAAJ:JAVADOC:274 | void | javax.xml.soap.SOAPMessage.addAttachmentPart ( AttachmentPart ) | Adds the given AttachmentPart object to this SOAPMessage object. An AttachmentPart object must be created before it can be added to a message. | true |  | true
SAAJ:JAVADOC:275 | int | javax.xml.soap.SOAPMessage.countAttachments | Gets a count of the number of attachments in this message. This count does not include the SOAP part. | true |  | true
SAAJ:JAVADOC:276 | AttachmentPart | javax.xml.soap.SOAPMessage.createAttachmentPart | Creates a new empty AttachmentPart object. Note that the method addAttachmentPart must be called with this new AttachmentPart object as the parameter in order for it to become an attachment to this SOAPMessage object. | true |  | true
SAAJ:JAVADOC:278 | AttachmentPart | javax.xml.soap.SOAPMessage.createAttachmentPart ( Object , String ) | Creates an AttachmentPart object and populates it with the specified data of the specified content type. The type of the Object should correspond to the value given for the Content-Type. | true |  | true
SAAJ:JAVADOC:279 | AttachmentPart | javax.xml.soap.SOAPMessage.getAttachment ( SOAPElement ) | Returns an AttachmentPart object that is associated with an attachment that is referenced by this SOAPElement or null if no such attachment exists. References can be made via an href attribute as described in SOAP Messages with Attachments, or via a single Text child node containing a URI as described in the WS-I Attachments Profile 1.0 for elements of schema type ref:swaRef. These two mechanisms must be supported. The support for references via href attribute also implies that this method should also be supported on an element that is an xop:Include element ( XOP). other reference mechanisms may be supported by individual implementations of this standard. Contact your vendor for details. | true |  | true
SAAJ:JAVADOC:280 | AttachmentPart | javax.xml.soap.SOAPMessage.getAttachment ( SOAPElement ) throws SOAPException | if there is an error in the attempt to access the attachment | true |  | true
SAAJ:JAVADOC:281 | Iterator | javax.xml.soap.SOAPMessage.getAttachments | Retrieves all the AttachmentPart objects that are part of this SOAPMessage object. | true |  | true
SAAJ:JAVADOC:282 | Iterator | javax.xml.soap.SOAPMessage.getAttachments ( MimeHeaders ) | Retrieves all the AttachmentPart objects that have header entries that match the specified headers. Note that a returned attachment could have headers in addition to those specified. | true |  | true
SAAJ:JAVADOC:283 | String | javax.xml.soap.SOAPMessage.getContentDescription | Retrieves a description of this SOAPMessage object's content. | true |  | true
SAAJ:JAVADOC:284 | MimeHeaders | javax.xml.soap.SOAPMessage.getMimeHeaders | Returns all the transport-specific MIME headers for this SOAPMessage object in a transport-independent fashion. | true |  | true
SAAJ:JAVADOC:285 | Object | javax.xml.soap.SOAPMessage.getProperty ( String ) | Retrieves value of the specified property. | true |  | true
SAAJ:JAVADOC:286 | Object | javax.xml.soap.SOAPMessage.getProperty ( String ) throws SOAPException | if the property name is not recognized. | true |  | true
SAAJ:JAVADOC:287 | SOAPBody | javax.xml.soap.SOAPMessage.getSOAPBody | Gets the SOAP Body contained in this SOAPMessage object. | true |  | true
SAAJ:JAVADOC:288 | SOAPBody | javax.xml.soap.SOAPMessage.getSOAPBody throws SOAPException | if the SOAP Body does not exist or cannot be retrieved | true |  | true
SAAJ:JAVADOC:289 | SOAPHeader | javax.xml.soap.SOAPMessage.getSOAPHeader | Gets the SOAP Header contained in this SOAPMessage object. | true |  | true
SAAJ:JAVADOC:290 | SOAPHeader | javax.xml.soap.SOAPMessage.getSOAPHeader throws SOAPException | if the SOAP Header does not exist or cannot be retrieved | true |  | true
SAAJ:JAVADOC:291 | SOAPPart | javax.xml.soap.SOAPMessage.getSOAPPart | Gets the SOAP part of this SOAPMessage object. SOAPMessage object contains one or more attachments, the SOAP Part must be the first MIME body part in the message. | true |  | true
SAAJ:JAVADOC:292 | void | javax.xml.soap.SOAPMessage.removeAllAttachments | Removes all AttachmentPart objects that have been added to this SOAPMessage object. This method does not touch the SOAP part. | true |  | true
SAAJ:JAVADOC:293 | void | javax.xml.soap.SOAPMessage.removeAttachments ( MimeHeaders ) | Removes all the AttachmentPart objects that have header entries that match the specified headers. Note that the removed attachment could have headers in addition to those specified. | true |  | true
SAAJ:JAVADOC:294 | void | javax.xml.soap.SOAPMessage.saveChanges | Updates this SOAPMessage object with all the changes that have been made to it. This method is called automatically when SOAPMessage#writeTo(OutputStream) is called. However, if changes are made to a message that was received or to one that has already been sent, the method saveChanges needs to be called explicitly in order to save the changes. The method saveChanges also generates any changes that can be read back (for example, a MessageId in profiles that support a message id). All MIME headers in a message that is created for sending purposes are guaranteed to have valid values only after saveChanges has been called. In addition, this method marks the point at which the data from all constituent AttachmentPart objects are pulled into the message. | true |  | true
SAAJ:JAVADOC:295 | void | javax.xml.soap.SOAPMessage.saveChanges throws SOAPException | if there was a problem saving changes to this message. | true |  | true
SAAJ:JAVADOC:296 | boolean | javax.xml.soap.SOAPMessage.saveRequired | Indicates whether this SOAPMessage object needs to have the method saveChanges called on it. | true |  | true
SAAJ:JAVADOC:297 | void | javax.xml.soap.SOAPMessage.setContentDescription ( String ) | Sets the description of this SOAPMessage object's content with the given description. | true |  | true
SAAJ:JAVADOC:298 | void | javax.xml.soap.SOAPMessage.setProperty ( String , Object ) | Associates the specified value with the specified property. If there was already a value associated with this property, the old value is replaced. The valid property names include SOAPMessage#WRITE_XML_DECLARATION and SOAPMessage#CHARACTER_SET_ENCODING. All of these standard SAAJ properties are prefixed by "javax.xml.soap". Vendors may also add implementation specific properties. These properties must be prefixed with package names that are unique to the vendor. Setting the property WRITE_XML_DECLARATION to "true" will cause an XML Declaration to be written out at the start of the SOAP message. The default value of "false" suppresses this declaration. The property CHARACTER_SET_ENCODING defaults to the value "utf-8" which causes the SOAP message to be encoded using UTF-8. Setting CHARACTER_SET_ENCODING to "utf-16" causes the SOAP message to be encoded using UTF-16. Some implementations may allow encodings in addition to UTF-8 and UTF-16. Refer to your vendor's documentation for details. | true |  | true
SAAJ:JAVADOC:299 | void | javax.xml.soap.SOAPMessage.setProperty ( String , Object ) throws SOAPException | if the property name is not recognized. | true |  | true
SAAJ:JAVADOC:300 | SOAPMessage | javax.xml.soap.SOAPMessage.SOAPMessage |  | true |  | true
SAAJ:JAVADOC:301 | void | javax.xml.soap.SOAPMessage.writeTo ( OutputStream ) | Writes this SOAPMessage object to the given output stream. The externalization format is as defined by the SOAP 1.1 with Attachments specification. If there are no attachments, just an XML stream is written out. For those messages that have attachments, writeTo writes a MIME-encoded byte stream. Note that this method does not write the transport-specific MIME Headers of the Message | true |  | true
SAAJ:JAVADOC:302 | void | javax.xml.soap.SOAPMessage.writeTo ( OutputStream ) throws SOAPException | if there was a problem in externalizing this SOAP message | true |  | true
SAAJ:JAVADOC:303 | void | javax.xml.soap.SOAPMessage.writeTo ( OutputStream ) throws IOException | if an I/O error occurs | true |  | true
SAAJ:JAVADOC:304 | void | javax.xml.soap.SOAPPart.addMimeHeader ( String , String ) | Creates a MimeHeader object with the specified name and value and adds it to this SOAPPart object. If a MimeHeader with the specified name already exists, this method adds the specified value to the already existing value(s). Note that RFC822 headers can contain only US-ASCII characters. | true |  | true
SAAJ:JAVADOC:305 | Iterator | javax.xml.soap.SOAPPart.getAllMimeHeaders | Retrieves all the headers for this SOAPPart object as an iterator over the MimeHeader objects. | true |  | true
SAAJ:JAVADOC:306 | Source | javax.xml.soap.SOAPPart.getContent | Returns the content of the SOAPEnvelope as a JAXP Source object. | true |  | true
SAAJ:JAVADOC:307 | Source | javax.xml.soap.SOAPPart.getContent throws SOAPException | if the implementation cannot convert the specified Source object | true |  | true
SAAJ:JAVADOC:308 | String | javax.xml.soap.SOAPPart.getContentId | Retrieves the value of the MIME header whose name is "Content-Id". | true |  | true
SAAJ:JAVADOC:309 | String | javax.xml.soap.SOAPPart.getContentLocation | Retrieves the value of the MIME header whose name is "Content-Location". | true |  | true
SAAJ:JAVADOC:310 | SOAPEnvelope | javax.xml.soap.SOAPPart.getEnvelope | Gets the SOAPEnvelope object associated with this SOAPPart object. Once the SOAP envelope is obtained, it can be used to get its contents. | true |  | true
SAAJ:JAVADOC:311 | SOAPEnvelope | javax.xml.soap.SOAPPart.getEnvelope throws SOAPException | if there is a SOAP error | true |  | true
SAAJ:JAVADOC:312 | Iterator | javax.xml.soap.SOAPPart.getMatchingMimeHeaders ( String[] ) | Retrieves all MimeHeader objects that match a name in the given array. | true |  | true
SAAJ:JAVADOC:313 | String[] | javax.xml.soap.SOAPPart.getMimeHeader ( String ) | Gets all the values of the MimeHeader object in this SOAPPart object that is identified by the given String. | true |  | true
SAAJ:JAVADOC:314 | Iterator | javax.xml.soap.SOAPPart.getNonMatchingMimeHeaders ( String[] ) | Retrieves all MimeHeader objects whose name does not match a name in the given array. | true |  | true
SAAJ:JAVADOC:315 | void | javax.xml.soap.SOAPPart.removeAllMimeHeaders | Removes all the MimeHeader objects for this SOAPEnvelope object. | true |  | true
SAAJ:JAVADOC:316 | void | javax.xml.soap.SOAPPart.removeMimeHeader ( String ) | Removes all MIME headers that match the given name. | true |  | true
SAAJ:JAVADOC:317 | void | javax.xml.soap.SOAPPart.setContent ( Source ) | Sets the content of the SOAPEnvelope object with the data from the given Source object. This Source must contain a valid SOAP document. | true |  | true
SAAJ:JAVADOC:318 | void | javax.xml.soap.SOAPPart.setContent ( Source ) throws SOAPException | if there is a problem in setting the source | true |  | true
SAAJ:JAVADOC:319 | void | javax.xml.soap.SOAPPart.setContentId ( String ) | Sets the value of the MIME header named "Content-Id" to the given String. | true |  | true
SAAJ:JAVADOC:320 | void | javax.xml.soap.SOAPPart.setContentLocation ( String ) | Sets the value of the MIME header "Content-Location" to the given String. | true |  | true
SAAJ:JAVADOC:321 | void | javax.xml.soap.SOAPPart.setMimeHeader ( String , String ) | Changes the first header entry that matches the given header name so that its value is the given value, adding a new header with the given name and value if no existing header is a match. If there is a match, this method clears all existing values for the first header that matches and sets the given value instead. If more than one header has the given name, this method removes all of the matching headers after the first one. Note that RFC822 headers can contain only US-ASCII characters. | true |  | true
SAAJ:JAVADOC:322 | SOAPPart | javax.xml.soap.SOAPPart.SOAPPart |  | true |  | true
SAAJ:JAVADOC:323 | boolean | javax.xml.soap.Text.isComment | Retrieves whether this Text object represents a comment. | true |  | true
SAAJ:JAVADOC:155 | SOAPElement | javax.xml.soap.SOAPElementFactory.create ( Name ) | Create a SOAPElement object initialized with the given Name object. | true | true | true
SAAJ:JAVADOC:156 | SOAPElement | javax.xml.soap.SOAPElementFactory.create ( Name ) throws SOAPException | if there is an error in creating the SOAPElement object | true | true | true
SAAJ:JAVADOC:157 | SOAPElement | javax.xml.soap.SOAPElementFactory.create ( String ) | Create a SOAPElement object initialized with the given local name. | true | true | true
SAAJ:JAVADOC:158 | SOAPElement | javax.xml.soap.SOAPElementFactory.create ( String ) throws SOAPException | if there is an error in creating the SOAPElement object | true | true | true
SAAJ:JAVADOC:159 | SOAPElement | javax.xml.soap.SOAPElementFactory.create ( String , String , String ) | Create a new SOAPElement object with the given local name, prefix and uri. | true | true | true
SAAJ:JAVADOC:160 | SOAPElement | javax.xml.soap.SOAPElementFactory.create ( String , String , String ) throws SOAPException | if there is an error in creating the SOAPElement object | true | true | true
SAAJ:JAVADOC:161 | SOAPElementFactory | javax.xml.soap.SOAPElementFactory.newInstance | Creates a new instance of SOAPElementFactory. | true | true | true
SAAJ:JAVADOC:162 | SOAPElementFactory | javax.xml.soap.SOAPElementFactory.newInstance throws SOAPException | if there was an error creating the default SOAPElementFactory | true | true | true
SAAJ:JAVADOC:324 | DataHandler | javax.xml.soap.AttachmentPart.getDataHandler | Gets the DataHandler object for this AttachmentPart object. | true |  | true
SAAJ:JAVADOC:325 | DataHandler | javax.xml.soap.AttachmentPart.getDataHandler throws SOAPException | if there is no data in this AttachmentPart object | true |  | true
SAAJ:JAVADOC:326 | void | javax.xml.soap.AttachmentPart.setDataHandler ( DataHandler ) | Sets the given DataHandler object as the data handler for this AttachmentPart object. Typically, on an incoming message, the data handler is automatically set. When a message is being created and populated with content, the setDataHandler method can be used to get data from various data sources into the message. | true |  | true
SAAJ:JAVADOC:327 | Iterator | javax.xml.soap.SOAPElement.getAllAttributesAsQNames | Returns an Iterator over all of the attributes in this SOAPElement as QName objects. The iterator can be used to get the attribute QName, which can then be passed to the method getAttributeValue to retrieve the value of each attribute. | true |  | true
SAAJ:JAVADOC:328 | AttachmentPart | javax.xml.soap.SOAPMessage.createAttachmentPart ( DataHandler ) | Creates an AttachmentPart object and populates it using the given DataHandler object. | true |  | true