javax.xml.soap API 1.4.0 · javax.xml.soap.AttachmentPart

A single attachment to a SOAPMessage object. A SOAPMessage object may contain zero, one, or many AttachmentPart objects. Each AttachmentPart object consists of two parts, application-specific content and associated MIME headers. The MIME headers consists of name/value pairs that can be used to identify and describe the content.

An AttachmentPart object must conform to certain standards.

It must conform to MIME [RFC2045] standards
It MUST contain content
The header portion MUST include the following header:
- Content-Type
  This header identifies the type of data in the content of an AttachmentPart object and MUST conform to [RFC2045]. The following is an example of a Content-Type header:
```
      Content-Type:  application/xml
      
```
  The following line of code, in which ap is an AttachmentPart object, sets the header shown in the previous example.
```
      ap.setMimeHeader("Content-Type", "application/xml");
      
```

There are no restrictions on the content portion of an AttachmentPart object. The content may be anything from a simple plain text object to a complex XML document or image file.

An AttachmentPart object is created with the method SOAPMessage.createAttachmentPart. After setting its MIME headers, the AttachmentPart object is added to the message that created it with the method SOAPMessage.addAttachmentPart.

The following code fragment, in which m is a SOAPMessage object and contentStringl is a String, creates an instance of AttachmentPart, sets the AttachmentPart object with some content and header information, and adds the AttachmentPart object to the SOAPMessage object.

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

The following code fragment creates and adds a second AttachmentPart instance to the same message. jpegData is a binary byte buffer representing the jpeg file.

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

The getContent method retrieves the contents and header from an AttachmentPart object. Depending on the DataContentHandler objects present, the returned Object can either be a typed Java object corresponding to the MIME type or an InputStream object that contains the content as bytes.

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

The method clearContent removes all the content from an AttachmentPart object but does not affect its header information.

    ap1.clearContent();

Constructor Summary

Access	Constructor and Description
public	AttachmentPart()

Method Summary

Modifier and Type	Method and Description
public abstract void	addMimeHeader(String a `String` giving the name of the header to be added name, String a `String` giving the value of the header to be added value) Adds a MIME header with the specified name and value to this `AttachmentPart` object.
public abstract void	clearContent() Clears out the content of this `AttachmentPart` object.
public abstract Iterator<MimeHeader>	Returns: an `Iterator` object with all of the Mime headers for this `AttachmentPart` object getAllMimeHeaders() Retrieves all the headers for this `AttachmentPart` object as an iterator over the `MimeHeader` objects.
public abstract InputStream	Returns: an `InputStream` from which the Base64 encoded `AttachmentPart` can be read. 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.
public abstract Object	Returns: a Java object with the content of this `AttachmentPart` object getContent() Gets the content of this `AttachmentPart` object as a Java object.
public String	Returns: a `String` giving the value of the "Content-ID" header or `null` if there is none getContentId() Gets the value of the MIME header whose name is "Content-ID".
public String	Returns: a `String` giving the value of the "Content-Location" header or `null` if there is none getContentLocation() Gets the value of the MIME header whose name is "Content-Location".
public String	Returns: a `String` giving the value of the "Content-Type" header or `null` if there is none getContentType() Gets the value of the MIME header whose name is "Content-Type".
public abstract DataHandler	Returns: the `DataHandler` object associated with this `AttachmentPart` object getDataHandler() Gets the `DataHandler` object for this `AttachmentPart` object.
public abstract Iterator<MimeHeader>	Returns: all of the MIME headers that match one of the names in the given array as an `Iterator` object getMatchingMimeHeaders(String[] a `String` array with the name(s) of the MIME headers to be returned names) Retrieves all `MimeHeader` objects that match a name in the given array.
public abstract String[]	Returns: a `String` array giving the value for the specified header getMimeHeader(String the name of the header; example: "Content-Type" name) Gets all the values of the header identified by the given `String`.
public abstract Iterator<MimeHeader>	Returns: 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. getNonMatchingMimeHeaders(String[] a `String` array with the name(s) of the MIME headers not to be returned names) Retrieves all `MimeHeader` objects whose name does not match a name in the given array.
public abstract InputStream	Returns: an `InputStream` from which the raw data contained by the `AttachmentPart` can be accessed. 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`.
public abstract byte[]	Returns: a `byte[]` array containing the raw data of the `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`.
public abstract int	Returns: the size of this `AttachmentPart` object in bytes or -1 if the size cannot be determined getSize() Returns the number of bytes in this `AttachmentPart` object.
public abstract void	removeAllMimeHeaders() Removes all the MIME header entries.
public abstract void	removeMimeHeader(String the string name of the MIME header/s to be removed header) Removes all MIME headers that match the given name.
public abstract void	setBase64Content(InputStream the base64 encoded data to add to the attachment part content, String the value to set into the `Content-Type` header 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.
public abstract void	setContent(Object the Java object that makes up the content for this attachment part object, String the MIME string that specifies the type of the content 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.
public void	setContentId(String a `String` giving the value of the "Content-ID" header contentId) Sets the MIME header whose name is "Content-ID" with the given value.
public void	setContentLocation(String a `String` giving the value of the "Content-Location" header contentLocation) Sets the MIME header whose name is "Content-Location" with the given value.
public void	setContentType(String a `String` giving the value of the "Content-Type" header contentType) Sets the MIME header whose name is "Content-Type" with the given value.
public abstract void	setDataHandler(DataHandler the `DataHandler` object to be set dataHandler) Sets the given `DataHandler` object as the data handler for this `AttachmentPart` object.
public abstract void	setMimeHeader(String a `String` giving the name of the header for which to search name, String a `String` giving the value to be set for the header whose name matches the given name value) Changes the first header entry that matches the given name to the given value, adding a new header if no existing header matches.
public abstract void	setRawContent(InputStream the raw data to add to the attachment part content, String the value to set into the `Content-Type` header 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`.
public abstract void	setRawContentBytes(byte[] the raw data to add to the attachment part content, int the offset in the byte array of the content offset, int the number of bytes that form the content len, String the value to set into the `Content-Type` header 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`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

AttachmentPart	back to summary
public AttachmentPart()

Method Detail

addMimeHeader back to summary

addMimeHeader	back to summary
public abstract void addMimeHeader(String name, 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. Parameters name:String a `String` giving the name of the header to be added value:String a `String` giving the value of the header to be added Exceptions IllegalArgumentException: if there was a problem with the specified mime header name or value

public abstract void addMimeHeader(String name, 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.

Parameters

name:String: a String giving the name of the header to be added
value:String: a String giving the value of the header to be added

Exceptions

IllegalArgumentException:: if there was a problem with the specified mime header name or value

clearContent	back to summary
public abstract void clearContent() Clears out the content of this `AttachmentPart` object. The MIME header portion is left untouched.

getAllMimeHeaders back to summary

getAllMimeHeaders	back to summary
public abstract Iterator<MimeHeader> getAllMimeHeaders() Retrieves all the headers for this `AttachmentPart` object as an iterator over the `MimeHeader` objects. Returns:Iterator<MimeHeader> an `Iterator` object with all of the Mime headers for this `AttachmentPart` object

public abstract Iterator<MimeHeader> getAllMimeHeaders()

Retrieves all the headers for this AttachmentPart object as an iterator over the MimeHeader objects.

Returns:Iterator<MimeHeader>: an Iterator object with all of the Mime headers for this AttachmentPart object

getBase64Content back to summary

getBase64Content	back to summary
public abstract InputStream getBase64Content() throws SOAPException 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. Returns:InputStream an `InputStream` from which the Base64 encoded `AttachmentPart` can be read. Exceptions SOAPException: if there is no content set into this `AttachmentPart` object or if there was a data transformation error. Since 1.6, SAAJ 1.3

public abstract InputStream getBase64Content() throws SOAPException

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.

Returns:InputStream

an InputStream from which the Base64 encoded AttachmentPart can be read.

Exceptions

SOAPException:: if there is no content set into this AttachmentPart object or if there was a data transformation error.

Since

1.6, SAAJ 1.3

getContent back to summary

getContent	back to summary
public abstract Object getContent() throws SOAPException 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. Returns:Object a Java object with the content of this `AttachmentPart` object Exceptions SOAPException: if there is no content set into this `AttachmentPart` object or if there was a data transformation error

public abstract Object getContent() throws SOAPException

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.

Returns:Object

a Java object with the content of this AttachmentPart object

Exceptions

SOAPException:: if there is no content set into this AttachmentPart object or if there was a data transformation error

getContentId back to summary

getContentId	back to summary
public String getContentId() Gets the value of the MIME header whose name is "Content-ID". Returns:String a `String` giving the value of the "Content-ID" header or `null` if there is none See Also `setContentId`

public String getContentId()

Gets the value of the MIME header whose name is "Content-ID".

Returns:String: a String giving the value of the "Content-ID" header or null if there is none
See Also: setContentId

getContentLocation back to summary

getContentLocation	back to summary
public String getContentLocation() Gets the value of the MIME header whose name is "Content-Location". Returns:String a `String` giving the value of the "Content-Location" header or `null` if there is none

public String getContentLocation()

Gets the value of the MIME header whose name is "Content-Location".

Returns:String: a String giving the value of the "Content-Location" header or null if there is none

getContentType back to summary

getContentType	back to summary
public String getContentType() Gets the value of the MIME header whose name is "Content-Type". Returns:String a `String` giving the value of the "Content-Type" header or `null` if there is none

public String getContentType()

Gets the value of the MIME header whose name is "Content-Type".

Returns:String: a String giving the value of the "Content-Type" header or null if there is none

getDataHandler back to summary

getDataHandler	back to summary
public abstract DataHandler getDataHandler() throws SOAPException Gets the `DataHandler` object for this `AttachmentPart` object. Returns:DataHandler the `DataHandler` object associated with this `AttachmentPart` object Exceptions SOAPException: if there is no data in this `AttachmentPart` object

public abstract DataHandler getDataHandler() throws SOAPException

Gets the DataHandler object for this AttachmentPart object.

Returns:DataHandler

the DataHandler object associated with this AttachmentPart object

Exceptions

SOAPException:: if there is no data in this AttachmentPart object

getMatchingMimeHeaders back to summary

getMatchingMimeHeaders	back to summary
public abstract Iterator<MimeHeader> getMatchingMimeHeaders(String[] names) Retrieves all `MimeHeader` objects that match a name in the given array. Parameters names:String[] a `String` array with the name(s) of the MIME headers to be returned Returns:Iterator<MimeHeader> all of the MIME headers that match one of the names in the given array as an `Iterator` object

public abstract Iterator<MimeHeader> getMatchingMimeHeaders(String[] names)

Retrieves all MimeHeader objects that match a name in the given array.

Parameters

names:String[]: a String array with the name(s) of the MIME headers to be returned

Returns:Iterator<MimeHeader>

all of the MIME headers that match one of the names in the given array as an Iterator object

getMimeHeader back to summary

getMimeHeader	back to summary
public abstract String[] getMimeHeader(String name) Gets all the values of the header identified by the given `String`. Parameters name:String the name of the header; example: "Content-Type" Returns:String[] a `String` array giving the value for the specified header See Also `setMimeHeader`

public abstract String[] getMimeHeader(String name)

Gets all the values of the header identified by the given String.

Parameters

name:String: the name of the header; example: "Content-Type"

Returns:String[]

a String array giving the value for the specified header

See Also

setMimeHeader

getNonMatchingMimeHeaders back to summary

getNonMatchingMimeHeaders	back to summary
public abstract Iterator<MimeHeader> getNonMatchingMimeHeaders(String[] names) Retrieves all `MimeHeader` objects whose name does not match a name in the given array. Parameters names:String[] a `String` array with the name(s) of the MIME headers not to be returned Returns:Iterator<MimeHeader> 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 Iterator<MimeHeader> getNonMatchingMimeHeaders(String[] names)

Retrieves all MimeHeader objects whose name does not match a name in the given array.

Parameters

names:String[]: a String array with the name(s) of the MIME headers not to be returned

Returns:Iterator<MimeHeader>

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.

getRawContent back to summary

getRawContent	back to summary
public abstract InputStream getRawContent() throws SOAPException 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. Returns:InputStream an `InputStream` from which the raw data contained by the `AttachmentPart` can be accessed. Exceptions SOAPException: if there is no content set into this `AttachmentPart` object or if there was a data transformation error. Since 1.6, SAAJ 1.3 See Also `getRawContentBytes`

public abstract InputStream getRawContent() throws SOAPException

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.

Returns:InputStream

an InputStream from which the raw data contained by the AttachmentPart can be accessed.

Exceptions

SOAPException:: if there is no content set into this AttachmentPart object or if there was a data transformation error.

Since

1.6, SAAJ 1.3

See Also

getRawContentBytes

getRawContentBytes back to summary

getRawContentBytes	back to summary
public abstract byte[] getRawContentBytes() throws SOAPException 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`. Returns:byte[] a `byte[]` array containing the raw data of the `AttachmentPart`. Exceptions SOAPException: if there is no content set into this `AttachmentPart` object or if there was a data transformation error. Since 1.6, SAAJ 1.3

public abstract byte[] getRawContentBytes() throws SOAPException

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.

Returns:byte[]

a byte[] array containing the raw data of the AttachmentPart.

Exceptions

SOAPException:: if there is no content set into this AttachmentPart object or if there was a data transformation error.

Since

1.6, SAAJ 1.3

getSize back to summary

getSize	back to summary
public abstract int getSize() throws SOAPException Returns the number of bytes in this `AttachmentPart` object. Returns:int the size of this `AttachmentPart` object in bytes or -1 if the size cannot be determined Exceptions SOAPException: if the content of this attachment is corrupted of if there was an exception while trying to determine the size.

public abstract int getSize() throws SOAPException

Returns the number of bytes in this AttachmentPart object.

Returns:int

the size of this AttachmentPart object in bytes or -1 if the size cannot be determined

Exceptions

SOAPException:: if the content of this attachment is corrupted of if there was an exception while trying to determine the size.

removeAllMimeHeaders	back to summary
public abstract void removeAllMimeHeaders() Removes all the MIME header entries.

removeMimeHeader	back to summary
public abstract void removeMimeHeader(String header) Removes all MIME headers that match the given name. Parameters header:String the string name of the MIME header/s to be removed

removeMimeHeader

back to summary

public abstract void removeMimeHeader(String header)

Removes all MIME headers that match the given name.

Parameters

header:String: the string name of the MIME header/s to be removed

setBase64Content back to summary

setBase64Content	back to summary
public abstract void setBase64Content(InputStream content, String contentType) throws SOAPException 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. Parameters content:InputStream the base64 encoded data to add to the attachment part contentType:String the value to set into the `Content-Type` header Exceptions SOAPException: if an there is an error in setting the content NullPointerException: if `content` is null Since 1.6, SAAJ 1.3

public abstract void setBase64Content(InputStream content, String contentType) throws SOAPException

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.

Parameters

content:InputStream: the base64 encoded data to add to the attachment part
contentType:String: the value to set into the Content-Type header

Exceptions

SOAPException:: if an there is an error in setting the content
NullPointerException:: if content is null

Since

1.6, SAAJ 1.3

setContent back to summary

setContent	back to summary
public abstract void setContent(Object object, 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. Parameters object:Object the Java object that makes up the content for this attachment part contentType:String the MIME string that specifies the type of the content Exceptions 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 Also `getContent`

public abstract void setContent(Object object, 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.

Parameters

object:Object: the Java object that makes up the content for this attachment part
contentType:String: the MIME string that specifies the type of the content

Exceptions

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 Also

getContent

setContentId back to summary

setContentId	back to summary
public void setContentId(String contentId) Sets the MIME header whose name is "Content-ID" with the given value. Parameters contentId:String a `String` giving the value of the "Content-ID" header Exceptions IllegalArgumentException: if there was a problem with the specified `contentId` value See Also `getContentId`

public void setContentId(String contentId)

Sets the MIME header whose name is "Content-ID" with the given value.

Parameters

contentId:String: a String giving the value of the "Content-ID" header

Exceptions

IllegalArgumentException:: if there was a problem with the specified contentId value

See Also

getContentId

setContentLocation back to summary

setContentLocation	back to summary
public void setContentLocation(String contentLocation) Sets the MIME header whose name is "Content-Location" with the given value. Parameters contentLocation:String a `String` giving the value of the "Content-Location" header Exceptions IllegalArgumentException: if there was a problem with the specified content location

public void setContentLocation(String contentLocation)

Sets the MIME header whose name is "Content-Location" with the given value.

Parameters

contentLocation:String: a String giving the value of the "Content-Location" header

Exceptions

IllegalArgumentException:: if there was a problem with the specified content location

setContentType back to summary

setContentType	back to summary
public void setContentType(String contentType) Sets the MIME header whose name is "Content-Type" with the given value. Parameters contentType:String a `String` giving the value of the "Content-Type" header Exceptions IllegalArgumentException: if there was a problem with the specified content type

public void setContentType(String contentType)

Sets the MIME header whose name is "Content-Type" with the given value.

Parameters

contentType:String: a String giving the value of the "Content-Type" header

Exceptions

IllegalArgumentException:: if there was a problem with the specified content type

setDataHandler back to summary

setDataHandler	back to summary
public abstract void setDataHandler(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. Parameters dataHandler:DataHandler the `DataHandler` object to be set Exceptions IllegalArgumentException: if there was a problem with the specified `DataHandler` object

public abstract void setDataHandler(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.

Parameters

dataHandler:DataHandler: the DataHandler object to be set

Exceptions

IllegalArgumentException:: if there was a problem with the specified DataHandler object

setMimeHeader back to summary

setMimeHeader	back to summary
public abstract void setMimeHeader(String name, 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. Parameters name:String a `String` giving the name of the header for which to search value:String a `String` giving the value to be set for the header whose name matches the given name Exceptions IllegalArgumentException: if there was a problem with the specified mime header name or value

public abstract void setMimeHeader(String name, 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.

Parameters

name:String: a String giving the name of the header for which to search
value:String: a String giving the value to be set for the header whose name matches the given name

Exceptions

IllegalArgumentException:: if there was a problem with the specified mime header name or value

setRawContent back to summary

setRawContent	back to summary
public abstract void setRawContent(InputStream content, String contentType) throws SOAPException 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. Parameters content:InputStream the raw data to add to the attachment part contentType:String the value to set into the `Content-Type` header Exceptions SOAPException: if an there is an error in setting the content NullPointerException: if `content` is null Since 1.6, SAAJ 1.3

public abstract void setRawContent(InputStream content, String contentType) throws SOAPException

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.

Parameters

content:InputStream: the raw data to add to the attachment part
contentType:String: the value to set into the Content-Type header

Exceptions

SOAPException:: if an there is an error in setting the content
NullPointerException:: if content is null

Since

1.6, SAAJ 1.3

setRawContentBytes back to summary

setRawContentBytes	back to summary
public abstract void setRawContentBytes(byte[] content, int offset, int len, String contentType) throws SOAPException 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`. Parameters content:byte[] the raw data to add to the attachment part offset:int the offset in the byte array of the content len:int the number of bytes that form the content contentType:String the value to set into the `Content-Type` header Exceptions SOAPException: if an there is an error in setting the content or content is null Since 1.6, SAAJ 1.3

public abstract void setRawContentBytes(byte[] content, int offset, int len, String contentType) throws SOAPException

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.

Parameters

content:byte[]: the raw data to add to the attachment part
offset:int: the offset in the byte array of the content
len:int: the number of bytes that form the content
contentType:String: the value to set into the Content-Type header

Exceptions

SOAPException:: if an there is an error in setting the content or content is null

Since

1.6, SAAJ 1.3

public abstract Class AttachmentPart

Constructor Summary

Method Summary

Constructor Detail

Method Detail