|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectjavax.xml.soap.AttachmentPart
org.apache.axis.attachments.AttachmentPart
An attachment part.
| Field Summary | |
protected static org.apache.commons.logging.Log |
log
Field log |
| Constructor Summary | |
AttachmentPart()
Bulds a new AttachmentPart. |
|
AttachmentPart(javax.activation.DataHandler dh)
Bulds a new AttachmentPart with a DataHandler. |
|
| Method Summary | |
void |
addMimeHeader(java.lang.String header,
java.lang.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. |
javax.activation.DataHandler |
getActivationDataHandler()
Get the data handler. |
java.util.Iterator |
getAllMimeHeaders()
Retrieves all the headers for this
AttachmentPart object as an iterator over the
MimeHeader objects. |
java.lang.String |
getAttachmentFile()
Get the filename of this attachment. |
java.lang.Object |
getContent()
Gets the content of this AttachmentPart object
as a Java object. |
java.lang.String |
getContentId()
Get the content ID. |
java.lang.String |
getContentIdRef()
Content ID. |
java.lang.String |
getContentLocation()
Get the content location. |
java.lang.String |
getContentType()
getContentType |
javax.activation.DataHandler |
getDataHandler()
Gets the DataHandler object for this
AttachmentPart object. |
java.lang.String |
getFirstMimeHeader(java.lang.String header)
Get the specified MIME header. |
java.util.Iterator |
getMatchingMimeHeaders(java.lang.String[] match)
Get an Iterator over all headers that match any item in
match. |
java.lang.String[] |
getMimeHeader(java.lang.String name)
Gets all the values of the header identified by the given String. |
java.util.Iterator |
getNonMatchingMimeHeaders(java.lang.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(java.lang.String header)
Removes all MIME headers that match the given name. |
protected void |
setAttachmentFile(java.lang.String path)
Set the filename of this attachment part. |
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. |
void |
setContentId(java.lang.String newCid)
Sets Content-Id of this part. |
void |
setContentLocation(java.lang.String loc)
Set content location. |
void |
setDataHandler(javax.activation.DataHandler datahandler)
Sets the given DataHandler object as the
data handler for this AttachmentPart object. |
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. |
| Methods inherited from class javax.xml.soap.AttachmentPart |
setContentType |
| Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
protected static org.apache.commons.logging.Log log
| Constructor Detail |
public AttachmentPart()
AttachmentPart.
public AttachmentPart(javax.activation.DataHandler dh)
AttachmentPart with a DataHandler.
dh - the DataHandler| Method Detail |
protected void finalize()
throws java.lang.Throwable
java.lang.Throwable - if anything went wrong during finalizationpublic javax.activation.DataHandler getActivationDataHandler()
DataHandlerpublic java.lang.String getContentType()
getContentType in interface PartgetContentType in class AttachmentPart
public void addMimeHeader(java.lang.String header,
java.lang.String value)
addMimeHeader in interface PartaddMimeHeader in class AttachmentPartheader - value - public java.lang.String getFirstMimeHeader(java.lang.String header)
header -
public boolean matches(MimeHeaders headers)
headers - the MimeHeaders to check
headers are
found, false otherwisepublic java.lang.String getContentLocation()
Part
getContentLocation in interface PartgetContentLocation in class AttachmentPartString giving the value of the
"Content-Location" header or null if there
is nonepublic void setContentLocation(java.lang.String loc)
Part
setContentLocation in interface PartsetContentLocation in class AttachmentPartloc - a String
giving the value of the "Content-Location" headerpublic void setContentId(java.lang.String newCid)
Part
setContentId in interface PartsetContentId in class AttachmentPartnewCid - a String giving
the value of the "Content-Id" headergetContentId()public java.lang.String getContentId()
Part
getContentId in interface PartgetContentId in class AttachmentPartString giving the value of the
"Content-Id" header or null if there is
nonesetContentId(java.lang.String)public java.util.Iterator getMatchingMimeHeaders(java.lang.String[] match)
PartIterator over all headers that match any item in
match.
getMatchingMimeHeaders in interface PartgetMatchingMimeHeaders in class AttachmentPartmatch - a String array with
the name(s) of the MIME headers to be returned
Iterator
objectpublic java.util.Iterator getNonMatchingMimeHeaders(java.lang.String[] match)
Part
getNonMatchingMimeHeaders in interface PartgetNonMatchingMimeHeaders in class AttachmentPartmatch - a String array with
the name(s) of the MIME headers not to be returned
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 java.util.Iterator getAllMimeHeaders()
AttachmentPart
AttachmentPart object as an iterator over the
MimeHeader objects.
getAllMimeHeaders in class AttachmentPartIterator object with all of the Mime
headers for this AttachmentPart object
public void setMimeHeader(java.lang.String name,
java.lang.String value)
Note that RFC822 headers can only contain US-ASCII characters.
setMimeHeader in class AttachmentPartname - a String giving the
name of the header for which to searchvalue - a String giving the
value to be set for the header whose name matches the
given name
java.lang.IllegalArgumentException - if
there was a problem with the specified mime header name
or valuepublic void removeAllMimeHeaders()
removeAllMimeHeaders in class AttachmentPartpublic void removeMimeHeader(java.lang.String header)
removeMimeHeader in class AttachmentPartheader - - the string name of the MIME
header/s to be removed
public javax.activation.DataHandler getDataHandler()
throws SOAPException
DataHandler object for this
AttachmentPart object.
getDataHandler in class AttachmentPartDataHandler object associated with
this AttachmentPart object
SOAPException - if there is
no data in this AttachmentPart objectpublic void setDataHandler(javax.activation.DataHandler datahandler)
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.
setDataHandler in class AttachmentPartdatahandler - DataHandler object to
be set
java.lang.IllegalArgumentException - if
there was a problem with the specified
DataHandler object
public java.lang.Object getContent()
throws SOAPException
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.
getContent in class AttachmentPart
AttachmentPart object
SOAPException - if there is no content set
into this AttachmentPart object or if there
was a data transformation error
public void setContent(java.lang.Object object,
java.lang.String contentType)
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.
setContent in class AttachmentPartobject - the Java object that makes up
the content for this attachment partcontentType - the MIME string that
specifies the type of the content
java.lang.IllegalArgumentException - if
the contentType does not match the type of the content
object, or if there was no
DataContentHandler object for this content
objectgetContent()public void clearContent()
AttachmentPart object. The MIME header portion is left
untouched.
clearContent in class AttachmentPart
public int getSize()
throws SOAPException
AttachmentPart object.
getSize in class AttachmentPartAttachmentPart object
in bytes or -1 if the size cannot be determined
SOAPException - if the content of this
attachment is corrupted of if there was an exception
while trying to determine the size.public java.lang.String[] getMimeHeader(java.lang.String name)
String.
getMimeHeader in interface PartgetMimeHeader in class AttachmentPartname - the name of the header; example:
"Content-Type"
String array giving the value for the
specified headersetMimeHeader(java.lang.String, java.lang.String)public java.lang.String getContentIdRef()
getContentIdRef in interface Partprotected void setAttachmentFile(java.lang.String path)
path - the new file pathpublic void detachAttachmentFile()
null.
public java.lang.String getAttachmentFile()
public void dispose()
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||