File	Doc	Category	Size	Date	Package
AttachmentPart.java	API Doc	Java SE 6 API	20963	Tue Jun 10 00:27:08 BST 2008	javax.xml.soap

AttachmentPart

• java.lang.Object

AttachmentPart ap1 = m.createAttachmentPart();
ap1.setContent(contentString1, "text/plain");
m.addAttachmentPart(ap1);

AttachmentPart ap2 = m.createAttachmentPart();
byte[] jpegData = ...;
ap2.setContent(new ByteArrayInputStream(jpegData), "image/jpeg");
m.addAttachmentPart(ap2);

String content1 = ap1.getContent();
java.io.InputStream content2 = ap2.getContent();

ap1.clearContent();

Fields Summary

Constructors Summary

Methods Summary
public abstract void	addMimeHeader(java.lang.String name, java.lang.String value) Adds a MIME header with the specified name and value to this AttachmentPart object. Note that RFC822 headers can contain only US-ASCII characters. param name a String giving the name of the header to be added param value a String giving the value of the header to be added exception IllegalArgumentException if there was a problem with the specified mime header name or value
public abstract void	clearContent() Clears out the content of this AttachmentPart object. The MIME header portion is left untouched.
public abstract java.util.Iterator	getAllMimeHeaders() Retrieves all the headers for this AttachmentPart object as an iterator over the MimeHeader objects. return an Iterator object with all of the Mime headers for this AttachmentPart object
public abstract java.io.InputStream	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. return an InputStream from which the Base64 encoded AttachmentPart can be read. throws SOAPException if there is no content set into this AttachmentPart object or if there was a data transformation error. since SAAJ 1.3
public abstract java.lang.Object	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. return a Java object with the content of this AttachmentPart object exception SOAPException if there is no content set into this AttachmentPart object or if there was a data transformation error
public java.lang.String	getContentId() Gets the value of the MIME header whose name is "Content-ID". return a String giving the value of the "Content-ID" header or null if there is none see #setContentId String[] values = getMimeHeader("Content-ID"); if (values != null && values.length > 0) return values[0]; return null;
public java.lang.String	getContentLocation() Gets the value of the MIME header whose name is "Content-Location". return a String giving the value of the "Content-Location" header or null if there is none String[] values = getMimeHeader("Content-Location"); if (values != null && values.length > 0) return values[0]; return null;
public java.lang.String	getContentType() Gets the value of the MIME header whose name is "Content-Type". return a String giving the value of the "Content-Type" header or null if there is none String[] values = getMimeHeader("Content-Type"); if (values != null && values.length > 0) return values[0]; return null;
public abstract javax.activation.DataHandler	getDataHandler() Gets the DataHandler object for this AttachmentPart object. return the DataHandler object associated with this AttachmentPart object exception SOAPException if there is no data in this AttachmentPart object
public abstract java.util.Iterator	getMatchingMimeHeaders(java.lang.String[] names) Retrieves all MimeHeader objects that match a name in the given array. param names a String array with the name(s) of the MIME headers to be returned return all of the MIME headers that match one of the names in the given array as an Iterator object
public abstract java.lang.String[]	getMimeHeader(java.lang.String name) Gets all the values of the header identified by the given String. param name the name of the header; example: "Content-Type" return a String array giving the value for the specified header see #setMimeHeader
public abstract java.util.Iterator	getNonMatchingMimeHeaders(java.lang.String[] names) Retrieves all MimeHeader objects whose name does not match a name in the given array. param names a String array with the name(s) of the MIME headers not to be returned return all of the MIME headers in this AttachmentPart object except those that match one of the names in the given array. The nonmatching MIME headers are returned as an Iterator object.
public abstract java.io.InputStream	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 {@link #getRawContentBytes} API should be used instead. return an InputStream from which the raw data contained by the AttachmentPart can be accessed. throws SOAPException if there is no content set into this AttachmentPart object or if there was a data transformation error. since SAAJ 1.3 see #getRawContentBytes
public abstract byte[]	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. return a byte[] array containing the raw data of the AttachmentPart. throws SOAPException if there is no content set into this AttachmentPart object or if there was a data transformation error. since SAAJ 1.3
public abstract int	getSize() Returns the number of bytes in this AttachmentPart object. return the size of this AttachmentPart object in bytes or -1 if the size cannot be determined exception SOAPException if the content of this attachment is corrupted of if there was an exception while trying to determine the size.
public abstract void	removeAllMimeHeaders() Removes all the MIME header entries.
public abstract void	removeMimeHeader(java.lang.String header) Removes all MIME headers that match the given name. param header the string name of the MIME header/s to be removed
public abstract void	setBase64Content(java.io.InputStream content, java.lang.String contentType) 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. param content the base64 encoded data to add to the attachment part param contentType the value to set into the Content-Type header exception SOAPException if an there is an error in setting the content exception NullPointerException if content is null since SAAJ 1.3
public abstract void	setContent(java.lang.Object object, java.lang.String contentType) 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. param object the Java object that makes up the content for this attachment part param contentType the MIME string that specifies the type of the content exception IllegalArgumentException may be thrown if the contentType does not match the type of the content object, or if there was no DataContentHandler object for this content object see #getContent
public void	setContentId(java.lang.String contentId) Sets the MIME header whose name is "Content-ID" with the given value. param contentId a String giving the value of the "Content-ID" header exception IllegalArgumentException if there was a problem with the specified contentId value see #getContentId setMimeHeader("Content-ID", contentId);
public void	setContentLocation(java.lang.String contentLocation) Sets the MIME header whose name is "Content-Location" with the given value. param contentLocation a String giving the value of the "Content-Location" header exception IllegalArgumentException if there was a problem with the specified content location setMimeHeader("Content-Location", contentLocation);
public void	setContentType(java.lang.String contentType) Sets the MIME header whose name is "Content-Type" with the given value. param contentType a String giving the value of the "Content-Type" header exception IllegalArgumentException if there was a problem with the specified content type setMimeHeader("Content-Type", contentType);
public abstract void	setDataHandler(javax.activation.DataHandler 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. param dataHandler the DataHandler object to be set exception IllegalArgumentException if there was a problem with the specified DataHandler object
public abstract void	setMimeHeader(java.lang.String name, java.lang.String value) 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. param name a String giving the name of the header for which to search param value a String giving the value to be set for the header whose name matches the given name exception IllegalArgumentException if there was a problem with the specified mime header name or value
public abstract void	setRawContent(java.io.InputStream content, java.lang.String contentType) Sets the content of this attachment part to that contained by the InputStream content 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. param content the raw data to add to the attachment part param contentType the value to set into the Content-Type header exception SOAPException if an there is an error in setting the content exception NullPointerException if content is null since SAAJ 1.3
public abstract void	setRawContentBytes(byte[] content, int offset, int len, java.lang.String contentType) 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. param content the raw data to add to the attachment part param contentType the value to set into the Content-Type header param offset the offset in the byte array of the content param len the number of bytes that form the content exception SOAPException if an there is an error in setting the content or content is null since SAAJ 1.3