|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectorg.apache.axis.attachments.AttachmentsImpl
Implements the Attachment interface, via an actual Hashmap of actual AttachmentParts.
| Field Summary | |
protected java.lang.String |
contentLocation
This is the content location as specified in SOAP with Attachments. |
protected static org.apache.commons.logging.Log |
log
|
protected MultiPartInputStream |
mpartStream
The actual stream to manage the multi-related input stream. |
protected int |
sendtype
The form of the attachments, whether MIME or DIME. |
protected SOAPPart |
soapPart
Field soapPart. |
| Fields inherited from interface org.apache.axis.attachments.Attachments |
CIDprefix, SEND_TYPE_DEFAULT, SEND_TYPE_DIME, SEND_TYPE_MAX, SEND_TYPE_MIME, SEND_TYPE_MTOM, SEND_TYPE_NONE, SEND_TYPE_NOTSET |
| Constructor Summary | |
AttachmentsImpl(java.lang.Object intialContents,
java.lang.String contentType,
java.lang.String contentLocation)
Construct one of these on a parent Message. |
|
| 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 datahandler)
Create a new attachment Part in this Message. |
protected DimeMultiPart |
createDimeMessage()
Creates the DIME 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()
Gets the content type for the whole stream. |
IncomingAttachmentStreams |
getIncomingAttachmentStreams()
Once this method is called, attachments can only be accessed via the InputStreams. |
Part |
getRootPart()
From the complex stream return the root part. |
int |
getSendType()
Determine if an object is to be treated as an attchment. |
static int |
getSendType(java.lang.String value)
Determine how an object typically sent as attachments are to be represented. |
static java.lang.String |
getSendTypeString(int value)
For a given sendType value, return a string representation. |
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)
Add the collection of parts. |
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. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
protected static org.apache.commons.logging.Log log
protected SOAPPart soapPart
protected MultiPartInputStream mpartStream
protected int sendtype
protected java.lang.String contentLocation
| Constructor Detail |
public AttachmentsImpl(java.lang.Object intialContents,
java.lang.String contentType,
java.lang.String contentLocation)
throws AxisFault
intialContents - should be anything but today only a stream is
supported.contentType - The mime content type of the stream for transports
that provide it.contentLocation -
AxisFault| Method Detail |
public Part removeAttachmentPart(java.lang.String reference)
throws AxisFault
removeAttachmentPart in interface Attachmentsreference - The reference that referers to an attachment.
AxisFault
public Part addAttachmentPart(Part newPart)
throws AxisFault
addAttachmentPart in interface AttachmentsnewPart - new part to add
AxisFault
public Part createAttachmentPart(java.lang.Object datahandler)
throws AxisFault
Attachments
createAttachmentPart in interface Attachmentsdatahandler - The part that is referenced
AxisFault
public void setAttachmentParts(java.util.Collection parts)
throws AxisFault
setAttachmentParts in interface Attachmentsparts -
AxisFault
public Part getAttachmentByReference(java.lang.String reference)
throws AxisFault
getAttachmentByReference in interface Attachmentsreference - The reference in the xml that referers to an attachment.
AxisFault
public java.util.Collection getAttachments()
throws AxisFault
getAttachments in interface AttachmentsAxisFaultpublic Part getRootPart()
getRootPart in interface AttachmentsPartpublic void setRootPart(Part newRoot)
Attachments
setRootPart in interface AttachmentsnewRoot - the new root Part
public long getContentLength()
throws AxisFault
getContentLength in interface AttachmentsAxisFault
protected DimeMultiPart createDimeMessage()
throws AxisFault
AxisFault - if the part could not be built
public void writeContentToStream(java.io.OutputStream os)
throws AxisFault
writeContentToStream in interface Attachmentsos -
AxisFault
public java.lang.String getContentType()
throws AxisFault
getContentType in interface AttachmentsAxisFaultpublic int getAttachmentCount()
getAttachmentCount in interface Attachmentspublic boolean isAttachment(java.lang.Object value)
isAttachment in interface Attachmentsvalue - the value that is to be determined if
its an attachment.
public void removeAllAttachments()
AttachmentPart objects that have
been added to this SOAPMessage object.
This method does not touch the SOAP part.
removeAllAttachments in interface Attachmentspublic 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.
getAttachments in interface Attachmentsheaders - a MimeHeaders
object containing the MIME headers for which to
search
public Part createAttachmentPart()
throws AxisFault
createAttachmentPart in interface AttachmentsAxisFaultpublic void setSendType(int sendtype)
Attachments
setSendType in interface Attachmentssendtype - the format to send.
SEND_TYPE_MIME for Multipart Releated Mail type attachments.
SEND_TYPE_DIME for DIME type attachments.public int getSendType()
Attachments
getSendType in interface Attachmentspublic void dispose()
dispose in interface Attachmentspublic static int getSendType(java.lang.String value)
value - a String representing a sending type, treated in a
case-insensetive manner
int send type codepublic static java.lang.String getSendTypeString(int value)
value - a type code integer
String representation of valuepublic IncomingAttachmentStreams getIncomingAttachmentStreams()
getIncomingAttachmentStreams in interface Attachments
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||