org.apache.axis.attachments
public interface Attachments extends Serializable
If javax.activation is not available, this is the *only* class that will be compiled in org.apache.axis.attachments.
Field Summary | |
---|---|
String | CIDprefix The prefix used to assoc. attachments as content-id |
int | SEND_TYPE_DEFAULT The default attatchment type. |
int | SEND_TYPE_DIME Use the DIME attatchment type. |
int | SEND_TYPE_MAX |
int | SEND_TYPE_MIME Use the SOAP with MIME attatchment send type. |
int | SEND_TYPE_MTOM Use the MTOM attatchment type. |
int | SEND_TYPE_NONE Use the DIME attatchment type. |
int | SEND_TYPE_NOTSET Use the default attatchment send type. |
Method Summary | |
---|---|
Part | addAttachmentPart(Part newPart)
Adds an existing attachment to this list.
|
Part | createAttachmentPart(Object part)
Create a new attachment Part in this Message.
|
Part | createAttachmentPart()
Create a new attachment Part in this Message.
|
void | dispose()
dispose of the attachments and their files; do not use the object
after making this call. |
Part | getAttachmentByReference(String reference)
This method should look at a refernce and determine if it is a CID: or url
to look for attachment.
|
int | getAttachmentCount()
This is the number of attachments.
|
Collection | getAttachments()
This method will return all attachments as a collection.
|
Iterator | getAttachments(MimeHeaders headers)
Retrieves all the AttachmentPart objects
that have header entries that match the specified headers.
|
long | getContentLength()
Get the content length of the stream.
|
String | getContentType()
Write the content to the stream.
|
IncomingAttachmentStreams | getIncomingAttachmentStreams()
Once this method is called, attachments can only be accessed via the InputStreams.
|
Part | getRootPart()
From the complex stream return the SOAP part. |
int | getSendType()
Determine if an object is to be treated as an attchment.
|
boolean | isAttachment(Object value)
Determine if an object is to be treated as an attchment.
|
void | removeAllAttachments()
Removes all AttachmentPart objects that have
been added to this SOAPMessage object.
|
Part | removeAttachmentPart(String reference)
This method uses getAttacmentByReference() to look for attachment.
|
void | setAttachmentParts(Collection parts)
Will the attachments of this message to that of the colleciton.
|
void | setRootPart(Part newRoot)
Sets the root part of this multipart block
|
void | setSendType(int sendtype)
Set the format for attachments.
|
void | writeContentToStream(OutputStream os)
Write the content to the stream.
|
Parameters: newPart new part to add
Returns: Part old attachment with the same Content-ID, or null.
Throws: org.apache.axis.AxisFault
Parameters: part The part that is referenced
Returns: a new attachment part
Throws: org.apache.axis.AxisFault
Returns: a new attachment part
Throws: org.apache.axis.AxisFault
Parameters: reference The reference in the xml that referers to an attachment.
Returns: The part associated with the attachment.
Throws: org.apache.axis.AxisFault
Returns: the number of attachments
Returns: A collection of attachments.
Throws: org.apache.axis.AxisFault
AttachmentPart
objects
that have header entries that match the specified headers.
Note that a returned attachment could have headers in
addition to those specified.Parameters: headers a MimeHeaders
object containing the MIME headers for which to
search
Returns: an iterator over all attachments that have a header that matches one of the given headers
Returns: the content length of
Throws: org.apache.axis.AxisFault
Returns: the content type
Throws: org.apache.axis.AxisFault
Returns: All of the attachment streams.
Returns: will return the root part if the stream is supported, otherwise null.
Returns: SEND_TYPE_MIME, SEND_TYPE_DIME, SEND_TYPE_NOTSET
Parameters: value the value that is to be determined if its an attachment.
Returns: True if value should be treated as an attchment.
AttachmentPart
objects that have
been added to this SOAPMessage
object.
This method does not touch the SOAP part.
Parameters: reference The reference that referers to an attachment.
Returns: The part associated with the removed attachment, or null.
Throws: org.apache.axis.AxisFault
Parameters: parts
Throws: org.apache.axis.AxisFault
Parameters: newRoot the new root Part
Parameters: sendtype the format to send. SEND_TYPE_MIME for Multipart Releated Mail type attachments. SEND_TYPE_DIME for DIME type attachments.
Parameters: os the stream
Throws: org.apache.axis.AxisFault