Overview Package Class Use Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.apache.axis.attachments

Class AttachmentPart

Implemented Interfaces:
Part, java.io.Serializable
public class AttachmentPart
extends AttachmentPart
implements Part
An attachment part.

Field Summary

protected static Log
log
Field log

Constructor Summary

AttachmentPart()
Bulds a new AttachmentPart.
AttachmentPart(DataHandler dh)
Bulds a new AttachmentPart with a DataHandler.

Method Summary

void
addMimeHeader(String header, String value)
Add the specified MIME header, as per JAXM.
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.
void
dispose()
when an attachment part is disposed, any associated files are deleted, and the datahandler itself nulled.
protected void
finalize()
On death, we clean up our file.
DataHandler
getActivationDataHandler()
Get the data handler.
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.
String
getContentId()
Get the content ID.
String
getContentIdRef()
Content ID.
String
getContentLocation()
Get the content location.
String
getContentType()
getContentType
DataHandler
getDataHandler()
Gets the DataHandler object for this AttachmentPart object.
String
getFirstMimeHeader(String header)
Get the specified MIME header.
Iterator
getMatchingMimeHeaders(String[] match)
Get an Iterator over all headers that match any item in match.
String[]
getMimeHeader(String name)
Gets all the values of the header identified by the given String.
Iterator
getNonMatchingMimeHeaders(String[] match)
Get all headers that do not match.
int
getSize()
Returns the number of bytes in this AttachmentPart object.
boolean
matches(MimeHeaders headers)
check if this Part's mimeheaders matches the one passed in.
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
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
setContentId(String newCid)
Sets Content-Id of this part.
void
setContentLocation(String loc)
Set content location.
void
setDataHandler(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

addMimeHeader, clearContent, getAllMimeHeaders, getContent, getContentId, getContentLocation, getContentType, getDataHandler, getMatchingMimeHeaders, getMimeHeader, getNonMatchingMimeHeaders, getSize, removeAllMimeHeaders, removeMimeHeader, setContent, setContentId, setContentLocation, setContentType, setDataHandler, setMimeHeader

Field Details

log

protected static Log log
Field log

Constructor Details

AttachmentPart

public AttachmentPart()
Bulds a new AttachmentPart.

AttachmentPart

public AttachmentPart(DataHandler dh)
Bulds a new AttachmentPart with a DataHandler.
Parameters:
dh - the DataHandler

Method Details

addMimeHeader

public void addMimeHeader(String header,
                          String value)
Add the specified MIME header, as per JAXM.
Specified by:
addMimeHeader in interface Part
Overrides:
addMimeHeader in interface AttachmentPart
Parameters:
header -
value -

clearContent

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

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.

dispose

public void dispose()
when an attachment part is disposed, any associated files are deleted, and the datahandler itself nulled. The object is no longer completely usable, at this point

finalize

protected void finalize()
            throws Throwable
On death, we clean up our file.

getActivationDataHandler

public DataHandler getActivationDataHandler()
Get the data handler.
Returns:
the activation DataHandler

getAllMimeHeaders

public Iterator getAllMimeHeaders()
Retrieves all the headers for this AttachmentPart object as an iterator over the MimeHeader objects.
Overrides:
getAllMimeHeaders in interface AttachmentPart
Returns:
an Iterator object with all of the Mime headers for this AttachmentPart object

getAttachmentFile

public String getAttachmentFile()
Get the filename of this attachment.
Returns:
the filename or null for an uncached file

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 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 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 and a javax.xml.transform.StreamSource object corresponding to a content stream with a Content-Type value of text/xml. 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.

Overrides:
getContent in interface AttachmentPart
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

getContentId

public String getContentId()
Get the content ID.
Specified by:
getContentId in interface Part
Overrides:
getContentId in interface AttachmentPart
Returns:
the content ID

getContentIdRef

public String getContentIdRef()
Content ID.
Specified by:
getContentIdRef in interface Part
Returns:
the contentId reference value that should be used directly as an href in a SOAP element to reference this attachment. Not part of JAX-RPC, JAX-M, SAAJ, etc.

getContentLocation

public String getContentLocation()
Get the content location.
Specified by:
getContentLocation in interface Part
Overrides:
getContentLocation in interface AttachmentPart
Returns:
a String giving the location

getContentType

public String getContentType()
getContentType
Specified by:
getContentType in interface Part
Overrides:
getContentType in interface AttachmentPart
Returns:
content type

getDataHandler

public DataHandler getDataHandler()
            throws SOAPException
Gets the DataHandler object for this AttachmentPart object.
Overrides:
getDataHandler in interface AttachmentPart
Returns:
the DataHandler object associated with this AttachmentPart object
Throws:
SOAPException - if there is no data in this AttachmentPart object

getFirstMimeHeader

public String getFirstMimeHeader(String header)
Get the specified MIME header.
Parameters:
header -
Returns:

getMatchingMimeHeaders

public Iterator getMatchingMimeHeaders(String[] match)
Get an Iterator over all headers that match any item in match.
Specified by:
getMatchingMimeHeaders in interface Part

getMimeHeader

public String[] getMimeHeader(String name)
Gets all the values of the header identified by the given String.
Specified by:
getMimeHeader in interface Part
Overrides:
getMimeHeader in interface AttachmentPart
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)

getNonMatchingMimeHeaders

public Iterator getNonMatchingMimeHeaders(String[] match)
Get all headers that do not match.
Specified by:
getNonMatchingMimeHeaders in interface Part

getSize

public int getSize()
            throws SOAPException
Returns the number of bytes in this AttachmentPart object.
Overrides:
getSize in interface AttachmentPart
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.

matches

public boolean matches(MimeHeaders headers)
check if this Part's mimeheaders matches the one passed in. TODO: Am not sure about the logic.
Parameters:
headers - the MimeHeaders to check
Returns:
true if all header name, values in headers are found, false otherwise

removeAllMimeHeaders

public void removeAllMimeHeaders()
Removes all the MIME header entries.
Overrides:
removeAllMimeHeaders in interface AttachmentPart

removeMimeHeader

public void removeMimeHeader(String header)
Removes all MIME headers that match the given name.
Overrides:
removeMimeHeader in interface AttachmentPart
Parameters:
header - - the string name of the MIME header/s to be removed

setAttachmentFile

protected void setAttachmentFile(String path)
Set the filename of this attachment part.
Parameters:
path - the new file path

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.
Overrides:
setContent in interface AttachmentPart
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
See Also:
getContent()

setContentId

public void setContentId(String newCid)
Sets Content-Id of this part. already defined.
Specified by:
setContentId in interface Part
Overrides:
setContentId in interface AttachmentPart
Parameters:
newCid - new Content-Id

setContentLocation

public void setContentLocation(String loc)
Set content location.
Specified by:
setContentLocation in interface Part
Overrides:
setContentLocation in interface AttachmentPart
Parameters:
loc - the new location

setDataHandler

public 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.
Overrides:
setDataHandler in interface AttachmentPart
Parameters:
datahandler - DataHandler object to be set

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.

Overrides:
setMimeHeader in interface AttachmentPart
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

Overview Package Class Use Tree Index Deprecated About
Copyright © 2005 Apache Web Services Project. All Rights Reserved.