Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS (src)    NEXT CLASS (src) FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.jboss.axis.attachments
Class AttachmentsImpl

java.lang.Object
  extended byorg.jboss.axis.attachments.AttachmentsImpl
All Implemented Interfaces:
Attachments (src)
public class AttachmentsImpl
extends java.lang.Object
implements Attachments (src)

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  MultiPartInputStream (src) mpartStream
          The actual stream to manage the multi-related input stream.
protected  int sendtype
          The form of the attachments, whether MIME or DIME.
protected  MessagePart (src) soapPart
          Field soapPart.
 
Fields inherited from interface org.jboss.axis.attachments.Attachments (src)
CIDprefix, SEND_TYPE_DEFAULT, SEND_TYPE_DIME, SEND_TYPE_MAX, SEND_TYPE_MIME, 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 (src) addAttachmentPart(Part (src)  newPart)
          Adds an existing attachment to this list.
 Part (src) createAttachmentPart()
          Create a new attachment Part in this Message.
 Part (src) createAttachmentPart(java.lang.Object datahandler)
          Create a new attachment Part in this Message.
protected  DimeMultiPart (src) createDimeMessage()
          Creates the DIME message
 void dispose()
          dispose of the attachments and their files; do not use the object after making this call.
 Part (src) 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 (src)  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.
 Part (src) 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 (src) 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 (src)  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

soapPart

protected MessagePart (src)  soapPart
Field soapPart.

mpartStream

protected MultiPartInputStream (src)  mpartStream
The actual stream to manage the multi-related input stream.

sendtype

protected int sendtype
The form of the attachments, whether MIME or DIME.

contentLocation

protected java.lang.String contentLocation
This is the content location as specified in SOAP with Attachments. This maybe null if the message had no Content-Location specifed.

Constructor Detail

AttachmentsImpl

public AttachmentsImpl(java.lang.Object intialContents,
                       java.lang.String contentType,
                       java.lang.String contentLocation)
                throws AxisFault (src)
Construct one of these on a parent Message. Should only ever be called by Message constructor!

1. mime-type: [unknown] do nothing

2. mime-type: multipart/related 2.1 create a MultiPartRelatedInputStream that does the parsing of the input stream 2.2 create a SOAPPart from the MultiPartRelatedInputStream

3. mime-type: application/dime 3.1 create a MultiPartDimeInputStream that does the parsing of the input stream 3.2 create a SOAPPart from the MultiPartDimeInputStream

Parameters:
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 -
Throws:
AxisFault (src)
Method Detail

removeAttachmentPart

public Part (src)  removeAttachmentPart(java.lang.String reference)
                          throws AxisFault (src)
This method uses getAttacmentByReference() to look for attachment. If attachment has been found, it will be removed from the list, and returned to the user.

Specified by:
removeAttachmentPart in interface Attachments (src)
Parameters:
reference - The reference that referers to an attachment.
Returns:
The part associated with the removed attachment, or null.
Throws:
AxisFault (src)

addAttachmentPart

public Part (src)  addAttachmentPart(Part (src)  newPart)
                       throws AxisFault (src)
Adds an existing attachment to this list. Note: Passed part will be bound to this message.

Specified by:
addAttachmentPart in interface Attachments (src)
Parameters:
newPart - new part to add
Returns:
Part old attachment with the same Content-ID, or null.
Throws:
AxisFault (src)

createAttachmentPart

public Part (src)  createAttachmentPart(java.lang.Object datahandler)
                          throws AxisFault (src)
Description copied from interface: Attachments (src)
Create a new attachment Part in this Message. Will actually, and always, return an AttachmentPart.

Specified by:
createAttachmentPart in interface Attachments (src)
Parameters:
datahandler - The part that is referenced
Returns:
a new attachment part
Throws:
AxisFault (src)

setAttachmentParts

public void setAttachmentParts(java.util.Collection parts)
                        throws AxisFault (src)
Add the collection of parts.

Specified by:
setAttachmentParts in interface Attachments (src)
Parameters:
parts -
Throws:
AxisFault (src)

getAttachmentByReference

public Part (src)  getAttachmentByReference(java.lang.String reference)
                              throws AxisFault (src)
This method should look at a refernce and determine if it is a CID: or url to look for attachment.
Note: if Content-Id or Content-Location headers have changed by outside code, lookup will not return proper values. In order to change these values attachment should be removed, then added again.

Specified by:
getAttachmentByReference in interface Attachments (src)
Parameters:
reference - The reference in the xml that referers to an attachment.
Returns:
The part associated with the attachment.
Throws:
AxisFault (src)

getAttachments

public java.util.Collection getAttachments()
                                    throws AxisFault (src)
This method will return all attachments as a collection.

Specified by:
getAttachments in interface Attachments (src)
Returns:
A collection of attachments.
Throws:
AxisFault (src)

getRootPart

public Part (src)  getRootPart()
From the complex stream return the root part. Today this is SOAP.

Specified by:
getRootPart in interface Attachments (src)
Returns:
the root Part

setRootPart

public void setRootPart(Part (src)  newRoot)
Description copied from interface: Attachments (src)
Sets the root part of this multipart block

Specified by:
setRootPart in interface Attachments (src)
Parameters:
newRoot - the new root Part

getContentLength

public long getContentLength()
                      throws AxisFault (src)
Get the content length of the stream.

Specified by:
getContentLength in interface Attachments (src)
Returns:
the content length of the stream
Throws:
AxisFault (src)

createDimeMessage

protected DimeMultiPart (src)  createDimeMessage()
                                   throws AxisFault (src)
Creates the DIME message

Returns:
a DIME part
Throws:
AxisFault (src) - if the part could not be built

writeContentToStream

public void writeContentToStream(java.io.OutputStream os)
                          throws AxisFault (src)
Write the content to the stream.

Specified by:
writeContentToStream in interface Attachments (src)
Parameters:
os -
Throws:
AxisFault (src)

getContentType

public java.lang.String getContentType()
                                throws AxisFault (src)
Gets the content type for the whole stream.

Specified by:
getContentType in interface Attachments (src)
Returns:
the content type for the whole stream
Throws:
AxisFault (src)

getAttachmentCount

public int getAttachmentCount()
This is the number of attachments.

Specified by:
getAttachmentCount in interface Attachments (src)
Returns:
the number of attachments

isAttachment

public boolean isAttachment(java.lang.Object value)
Determine if an object is to be treated as an attchment.

Specified by:
isAttachment in interface Attachments (src)
Parameters:
value - the value that is to be determined if its an attachment.
Returns:
True if value should be treated as an attchment.

removeAllAttachments

public void removeAllAttachments()
Removes all AttachmentPart objects that have been added to this SOAPMessage object.

This method does not touch the SOAP part.

Specified by:
removeAllAttachments in interface Attachments (src)

getAttachments

public java.util.Iterator getAttachments(MimeHeaders (src)  headers)
Retrieves all the AttachmentPart objects that have header entries that match the specified headers. Note that a returned attachment could have headers in addition to those specified.

Specified by:
getAttachments in interface Attachments (src)
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

createAttachmentPart

public Part (src)  createAttachmentPart()
                          throws AxisFault (src)
Create a new attachment Part in this Message. Will actually, and always, return an AttachmentPart.

Specified by:
createAttachmentPart in interface Attachments (src)
Returns:
a new attachment Part
Throws:
AxisFault (src)

setSendType

public void setSendType(int sendtype)
Description copied from interface: Attachments (src)
Set the format for attachments.

Specified by:
setSendType in interface Attachments (src)
Parameters:
sendtype - the format to send. SEND_TYPE_MIME for Multipart Releated Mail type attachments. SEND_TYPE_DIME for DIME type attachments.

getSendType

public int getSendType()
Description copied from interface: Attachments (src)
Determine if an object is to be treated as an attchment.

Specified by:
getSendType in interface Attachments (src)
Returns:
SEND_TYPE_MIME, SEND_TYPE_DIME, SEND_TYPE_NOTSET

dispose

public void dispose()
dispose of the attachments and their files; do not use the object after making this call.

Specified by:
dispose in interface Attachments (src)

getSendType

public static int getSendType(java.lang.String value)
Determine how an object typically sent as attachments are to be represented. Currently, MIME DIME and NONE are reccognised.

Parameters:
value - a String representing a sending type, treated in a case-insensetive manner
Returns:
an int send type code

getSendTypeString

public static java.lang.String getSendTypeString(int value)
For a given sendType value, return a string representation.

Parameters:
value - a type code integer
Returns:
a String representation of value
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS (src)    NEXT CLASS (src) FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD