org.apache.axis.attachments
public class AttachmentPart extends AttachmentPart implements 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() |
String | getAttachmentFile()
Get the filename of this attachment.
|
Object | getContent()
Gets the content of this AttachmentPart object
as a Java object. |
String | getContentId() |
String | getContentIdRef()
Content ID.
|
String | getContentLocation() |
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) |
String[] | getMimeHeader(String name)
Gets all the values of the header identified by the given
String . |
Iterator | getNonMatchingMimeHeaders(String[] 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) |
void | setContentLocation(String loc) |
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. |
AttachmentPart
.AttachmentPart
with a DataHandler
.
Parameters: dh the DataHandler
Parameters: header value
AttachmentPart
object. The MIME header portion is left
untouched.null
.Throws: Throwable if anything went wrong during finalization
Returns: the activation DataHandler
Returns: the filename or null for an uncached file
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.
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
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.
Returns: content type
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
Parameters: header
Returns:
String
.Parameters: name the name of the header; example: "Content-Type"
Returns: a String
array giving the value for the
specified header
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.
Parameters: headers the MimeHeaders
to check
Returns: true if all header name, values in headers
are
found, false otherwise
Parameters: header - the string name of the MIME header/s to be removed
Parameters: path the new file path
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: 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
object
See Also: getContent()
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: java.lang.IllegalArgumentException if
there was a problem with the specified
DataHandler
object
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: java.lang.IllegalArgumentException if there was a problem with the specified mime header name or value