| |
|
| java.lang.Object javax.xml.soap.AttachmentPart
All known Subclasses: com.sun.xml.messaging.saaj.soap.AttachmentPartImpl,
AttachmentPart | abstract public class AttachmentPart (Code) | | 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:
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();
|
Method Summary | |
abstract public void | addMimeHeader(String name, String value) Adds a MIME header with the specified name and value to this
AttachmentPart object. | abstract public void | clearContent() Clears out the content of this AttachmentPart object. | abstract public Iterator | getAllMimeHeaders() Retrieves all the headers for this AttachmentPart object
as an iterator over the MimeHeader objects. | abstract public 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. | abstract public Object | getContent() Gets the content of this AttachmentPart object as a Java
object. | public String | getContentId() Gets the value of the MIME header whose name is "Content-ID". | public String | getContentLocation() Gets the value of the MIME header whose name is "Content-Location". | public String | getContentType() Gets the value of the MIME header whose name is "Content-Type". | abstract public DataHandler | getDataHandler() Gets the DataHandler object for this AttachmentPart
object. | abstract public Iterator | getMatchingMimeHeaders(String[] names) Retrieves all MimeHeader objects that match a name in
the given array. | abstract public String[] | getMimeHeader(String name) Gets all the values of the header identified by the given
String . | abstract public Iterator | getNonMatchingMimeHeaders(String[] names) Retrieves all MimeHeader objects whose name does
not match a name in the given array.
Parameters: names - a String array with the name(s) of theMIME headers not to be returned all of the MIME headers in this AttachmentPart objectexcept those that match one of the names in thegiven array. | abstract public 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. | abstract public 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 . | abstract public int | getSize() Returns the number of bytes in this AttachmentPart
object. | abstract public void | removeAllMimeHeaders() Removes all the MIME header entries. | abstract public void | removeMimeHeader(String header) Removes all MIME headers that match the given name. | abstract public void | setBase64Content(InputStream content, 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. | abstract public 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. | public void | setContentId(String contentId) Sets the MIME header whose name is "Content-ID" with the given value. | public void | setContentLocation(String contentLocation) Sets the MIME header whose name is "Content-Location" with the given value. | public void | setContentType(String contentType) Sets the MIME header whose name is "Content-Type" with the given value. | abstract public void | setDataHandler(DataHandler dataHandler) Sets the given DataHandler object as the data handler
for this AttachmentPart object. | abstract public 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. | abstract public void | setRawContent(InputStream content, 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 . | abstract public void | setRawContentBytes(byte[] content, int offset, int len, 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 . |
addMimeHeader | abstract public void addMimeHeader(String name, String value)(Code) | | 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 - a String giving the name of the header to be added Parameters: value - a String giving the value of the header to be added exception: IllegalArgumentException - if there was a problem withthe specified mime header name or value |
clearContent | abstract public void clearContent()(Code) | | Clears out the content of this AttachmentPart object.
The MIME header portion is left untouched.
|
getAllMimeHeaders | abstract public Iterator getAllMimeHeaders()(Code) | | Retrieves all the headers for this AttachmentPart object
as an iterator over the MimeHeader objects.
an Iterator object with all of the Mimeheaders for this AttachmentPart object |
getBase64Content | abstract public InputStream getBase64Content() throws SOAPException(Code) | | 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.
an InputStream from which the Base64 encodedAttachmentPart 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 |
getContent | abstract public Object getContent() throws SOAPException(Code) | | 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.
a Java object with the content of this AttachmentPart object exception: SOAPException - if there is no content set into thisAttachmentPart object or if there was a datatransformation error |
getContentId | public String getContentId()(Code) | | Gets the value of the MIME header whose name is "Content-ID".
a String giving the value of the"Content-ID" header or null if thereis none See Also: AttachmentPart.setContentId |
getContentLocation | public String getContentLocation()(Code) | | Gets the value of the MIME header whose name is "Content-Location".
a String giving the value of the"Content-Location" header or null if thereis none |
getContentType | public String getContentType()(Code) | | Gets the value of the MIME header whose name is "Content-Type".
a String giving the value of the"Content-Type" header or null if thereis none |
getDataHandler | abstract public DataHandler getDataHandler() throws SOAPException(Code) | | Gets the DataHandler object for this AttachmentPart
object.
the DataHandler object associated with thisAttachmentPart object exception: SOAPException - if there is no data inthis AttachmentPart object |
getMatchingMimeHeaders | abstract public Iterator getMatchingMimeHeaders(String[] names)(Code) | | Retrieves all MimeHeader objects that match a name in
the given array.
Parameters: names - a String array with the name(s) of theMIME headers to be returned all of the MIME headers that match one of the names in thegiven array as an Iterator object |
getMimeHeader | abstract public String[] getMimeHeader(String name)(Code) | | Gets all the values of the header identified by the given
String .
Parameters: name - the name of the header; example: "Content-Type" a String array giving the value for thespecified header See Also: AttachmentPart.setMimeHeader |
getNonMatchingMimeHeaders | abstract public Iterator getNonMatchingMimeHeaders(String[] names)(Code) | | Retrieves all MimeHeader objects whose name does
not match a name in the given array.
Parameters: names - a String array with the name(s) of theMIME headers not to be returned all of the MIME headers in this AttachmentPart objectexcept those that match one of the names in thegiven array. The nonmatching MIME headers are returned as an Iterator object. |
getRawContent | abstract public InputStream getRawContent() throws SOAPException(Code) | | 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
AttachmentPart.getRawContentBytes API
should be used instead.
an InputStream from which the raw data contained bythe 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 Also: AttachmentPart.getRawContentBytes |
getRawContentBytes | abstract public byte[] getRawContentBytes() throws SOAPException(Code) | | 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 .
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 |
getSize | abstract public int getSize() throws SOAPException(Code) | | Returns the number of bytes in this AttachmentPart
object.
the size of this AttachmentPart object in bytesor -1 if the size cannot be determined exception: SOAPException - if the content of this attachment iscorrupted of if there was an exception while tryingto determine the size. |
removeAllMimeHeaders | abstract public void removeAllMimeHeaders()(Code) | | Removes all the MIME header entries.
|
removeMimeHeader | abstract public void removeMimeHeader(String header)(Code) | | Removes all MIME headers that match the given name.
Parameters: header - the string name of the MIME header/s tobe removed |
setBase64Content | abstract public void setBase64Content(InputStream content, String contentType) throws SOAPException(Code) | | 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 - the base64 encoded data to add to the attachment part Parameters: 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 |
setContent | abstract public void setContent(Object object, String contentType)(Code) | | 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 - the Java object that makes up the content forthis attachment part Parameters: contentType - the MIME string that specifies the type ofthe content exception: IllegalArgumentException - may be thrown if the contentType does not match the type of the content object, or if therewas no DataContentHandler object for thiscontent object See Also: AttachmentPart.getContent |
setContentId | public void setContentId(String contentId)(Code) | | Sets the MIME header whose name is "Content-ID" with the given value.
Parameters: contentId - a String giving the value of the"Content-ID" header exception: IllegalArgumentException - if there was a problem withthe specified contentId value See Also: AttachmentPart.getContentId |
setContentLocation | public void setContentLocation(String contentLocation)(Code) | | Sets the MIME header whose name is "Content-Location" with the given value.
Parameters: contentLocation - a String giving the value of the"Content-Location" header exception: IllegalArgumentException - if there was a problem withthe specified content location |
setContentType | public void setContentType(String contentType)(Code) | | Sets the MIME header whose name is "Content-Type" with the given value.
Parameters: contentType - a String giving the value of the"Content-Type" header exception: IllegalArgumentException - if there was a problem withthe specified content type |
setDataHandler | abstract public void setDataHandler(DataHandler dataHandler)(Code) | | 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 - the DataHandler object to be set exception: IllegalArgumentException - if there was a problem withthe specified DataHandler object |
setMimeHeader | abstract public void setMimeHeader(String name, String value)(Code) | | 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 - a String giving the name of the header for which to search Parameters: value - a String giving the value to be set forthe header whose name matches the given name exception: IllegalArgumentException - if there was a problem withthe specified mime header name or value |
setRawContent | abstract public void setRawContent(InputStream content, String contentType) throws SOAPException(Code) | | 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 - the raw data to add to the attachment part Parameters: 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 |
setRawContentBytes | abstract public void setRawContentBytes(byte[] content, int offset, int len, String contentType) throws SOAPException(Code) | | 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 - the raw data to add to the attachment part Parameters: contentType - the value to set into the Content-Type header Parameters: offset - the offset in the byte array of the content Parameters: 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 |
|
|
|