org.apache.axis2.saaj
Class AttachmentPartImpl

java.lang.Object
  extended byjavax.xml.soap.AttachmentPart
      extended byorg.apache.axis2.saaj.AttachmentPartImpl

public class AttachmentPartImpl
extends AttachmentPart


Constructor Summary
AttachmentPartImpl()
           
 
Method Summary
 void addMimeHeader(String name, String value)
          Adds a MIME header with the specified name and value to this AttachmentPart object.
 void clearContent()
          Clears out the content of this AttachmentPart object.
 void detachAttachmentFile()
          Detach the attachment file from this class, so it is not cleaned up.
 Iterator getAllMimeHeaders()
          Retrieves all the headers for this AttachmentPart object as an iterator over the MimeHeader objects.
 String getAttachmentFile()
          Get the filename of this attachment.
 Object getContent()
          Gets the content of this AttachmentPart object as a Java object.
 javax.activation.DataHandler getDataHandler()
          Gets the DataHandler object for this AttachmentPart object.
 Iterator getMatchingMimeHeaders(String[] names)
          Retrieves all MimeHeader objects that match a name in the given array.
 String[] getMimeHeader(String name)
          Gets all the values of the header identified by the given String.
 Iterator getNonMatchingMimeHeaders(String[] names)
          Retrieves all MimeHeader objects whose name does not match a name in the given array.
 org.apache.axiom.om.OMText getOMText()
          Retrieve the OMText
 int getSize()
          Returns the number of bytes in this AttachmentPart object.
 org.apache.axiom.om.impl.dom.TextImpl getText(org.apache.axiom.om.impl.dom.DocumentImpl doc)
           
 boolean isAttachmentReferenced()
           
 boolean matches(MimeHeaders headers)
          Check whether at least one of the headers of this object matches a provided header
 void removeAllMimeHeaders()
          Removes all the MIME header entries.
 void removeMimeHeader(String header)
          Removes all MIME headers that match the given name.
protected  void setAttachmentFile(String path)
          Set the filename of this attachment part.
 void setAttachmentReferenced(boolean attachmentReferenced)
           
 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.
 void setDataHandler(javax.activation.DataHandler datahandler)
          Sets the given DataHandler object as the data handler for this AttachmentPart object.
 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.
 
Methods inherited from class javax.xml.soap.AttachmentPart
getContentId, getContentLocation, getContentType, setContentId, setContentLocation, setContentType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AttachmentPartImpl

public AttachmentPartImpl()
Method Detail

matches

public boolean matches(MimeHeaders headers)
Check whether at least one of the headers of this object matches a provided header

Parameters:
headers -
Returns:
true if at least one header of this AttachmentPart matches a header in the provided headers parameter, false if none of the headers of this AttachmentPart matches at least one of the header in the provided headers parameter

isAttachmentReferenced

public boolean isAttachmentReferenced()

setAttachmentReferenced

public void setAttachmentReferenced(boolean attachmentReferenced)

getSize

public int getSize()
            throws SOAPException
Returns the number of bytes in this AttachmentPart object.

Returns:
the size of this AttachmentPart object in bytes or -1 if the size cannot be determined
Throws:
SOAPException - if the content of this attachment is corrupted of if there was an exception while trying to determine the size.

clearContent

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


getContent

public 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
  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 JAXM-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.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:
a Java object with the content of this AttachmentPart object
Throws:
SOAPException - if there is no content set into this AttachmentPart object or if there was a data transformation error

setContent

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. 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 for this attachment part
contentType - the MIME string that specifies the type of the content
Throws:
IllegalArgumentException - 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()

getDataHandler

public javax.activation.DataHandler getDataHandler()
                                            throws SOAPException
Gets the DataHandler object for this AttachmentPart object.

Returns:
the DataHandler object associated with this AttachmentPart object
Throws:
SOAPException - if there is no data in this AttachmentPart object

setDataHandler

public 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.

Parameters:
datahandler - DataHandler object to be set
Throws:
IllegalArgumentException - if there was a problem with the specified DataHandler object

removeMimeHeader

public void removeMimeHeader(String header)
Removes all MIME headers that match the given name.

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

removeAllMimeHeaders

public void removeAllMimeHeaders()
Removes all the MIME header entries.


getMimeHeader

public String[] getMimeHeader(String name)
Gets all the values of the header identified by the given String.

Parameters:
name - the name of the header; example: "Content-Type"
Returns:
a String array giving the value for the specified header
See Also:
setMimeHeader(java.lang.String, java.lang.String)

setMimeHeader

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. 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
value - a String giving the value to be set for the header whose name matches the given name
Throws:
IllegalArgumentException - if there was a problem with the specified mime header name or value

addMimeHeader

public 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 - a String giving the name of the header to be added
value - a String giving the value of the header to be added
Throws:
IllegalArgumentException - if there was a problem with the specified mime header name or value

getAllMimeHeaders

public Iterator getAllMimeHeaders()
Retrieves all the headers for this AttachmentPart object as an iterator over the MimeHeader objects.

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

getMatchingMimeHeaders

public Iterator getMatchingMimeHeaders(String[] names)
Retrieves all MimeHeader objects that match a name in the given array.

Parameters:
names - a String array with the name(s) of the MIME headers to be returned
Returns:
all of the MIME headers that match one of the names in the given array as an Iterator object

getNonMatchingMimeHeaders

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 the MIME headers not to be returned
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.

getOMText

public org.apache.axiom.om.OMText getOMText()
                                     throws SOAPException
Retrieve the OMText

Returns:
the OMText
Throws:
SOAPException - If omText is not available

getText

public org.apache.axiom.om.impl.dom.TextImpl getText(org.apache.axiom.om.impl.dom.DocumentImpl doc)

setAttachmentFile

protected void setAttachmentFile(String path)
Set the filename of this attachment part.

Parameters:
path - the new file path

detachAttachmentFile

public void detachAttachmentFile()
Detach the attachment file from this class, so it is not cleaned up. This has the side-effect of making subsequent calls to getAttachmentFile() return null.


getAttachmentFile

public String getAttachmentFile()
Get the filename of this attachment.

Returns:
the filename or null for an uncached file