|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Access the Attachments of a Message. This interface essentially firewalls the rest of Axis from any dependencies on javax.activation.
If javax.activation is not available, this is the *only* class that will be compiled in org.apache.axis.attachments.
Field Summary | |
static java.lang.String |
CIDprefix
The prefix used to assoc. |
static int |
SEND_TYPE_DEFAULT
The default attatchment type. |
static int |
SEND_TYPE_DIME
Use the DIME attatchment type. |
static int |
SEND_TYPE_MAX
|
static int |
SEND_TYPE_MIME
Use the SOAP with MIME attatchment send type. |
static int |
SEND_TYPE_NONE
Use the DIME attatchment type. |
static 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()
Create a new attachment Part in this Message. |
Part |
createAttachmentPart(java.lang.Object part)
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(java.lang.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. |
java.util.Collection |
getAttachments()
This method will return all attachments as a collection. |
java.util.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. |
java.lang.String |
getContentType()
Write the content to the stream. |
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(java.lang.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(java.lang.String reference)
This method uses getAttacmentByReference() to look for attachment. |
void |
setAttachmentParts(java.util.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(java.io.OutputStream os)
Write the content to the stream. |
Field Detail |
public static final int SEND_TYPE_NOTSET
public static final int SEND_TYPE_MIME
public static final int SEND_TYPE_DIME
public static final int SEND_TYPE_NONE
public static final int SEND_TYPE_MAX
public static final int SEND_TYPE_DEFAULT
public static final java.lang.String CIDprefix
Method Detail |
public Part addAttachmentPart(Part newPart) throws AxisFault
newPart
- new part to add
AxisFault
public Part removeAttachmentPart(java.lang.String reference) throws AxisFault
reference
- The reference that referers to an attachment.
AxisFault
public void removeAllAttachments()
AttachmentPart
objects that have
been added to this SOAPMessage
object.
This method does not touch the SOAP part.
public Part getAttachmentByReference(java.lang.String reference) throws AxisFault
reference
- The reference in the xml that referers to an attachment.
AxisFault
public java.util.Collection getAttachments() throws AxisFault
AxisFault
public java.util.Iterator getAttachments(MimeHeaders headers)
AttachmentPart
objects
that have header entries that match the specified headers.
Note that a returned attachment could have headers in
addition to those specified.
headers
- a MimeHeaders
object containing the MIME headers for which to
search
public Part createAttachmentPart(java.lang.Object part) throws AxisFault
part
- The part that is referenced
AxisFault
public Part createAttachmentPart() throws AxisFault
AxisFault
public void setAttachmentParts(java.util.Collection parts) throws AxisFault
parts
-
AxisFault
public Part getRootPart()
public void setRootPart(Part newRoot)
newRoot
- the new root Part
public long getContentLength() throws AxisFault
AxisFault
public void writeContentToStream(java.io.OutputStream os) throws AxisFault
os
- the stream
AxisFault
public java.lang.String getContentType() throws AxisFault
AxisFault
public int getAttachmentCount()
public boolean isAttachment(java.lang.Object value)
value
- the value that is to be determined if
its an attachment.
public void setSendType(int sendtype)
sendtype
- the format to send.
SEND_TYPE_MIME for Multipart Releated Mail type attachments.
SEND_TYPE_DIME for DIME type attachments.public int getSendType()
public void dispose()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |