org.apache.axiom.attachments
Class Attachments

java.lang.Object
  org.apache.axiom.attachments.Attachments

All Implemented Interfaces:

OMAttachmentAccessor

public class Attachments
extends Object
implements OMAttachmentAccessor

Field Summary

protected static org.apache.commons.logging.Log

log

Constructor Summary

Attachments()
Use this constructor when instantiating this to store the attachments set programatically through the SwA API.

Attachments(InputStream inStream, String contentTypeString)
Sets file cache to false.

Attachments(InputStream inStream, String contentTypeString, boolean fileCacheEnable, String attachmentRepoDir, String fileThreshold)
Moves the pointer to the beginning of the first MIME part.

Attachments(InputStream inStream, String contentTypeString, boolean fileCacheEnable, String attachmentRepoDir, String fileThreshold, int contentLength)
Moves the pointer to the beginning of the first MIME part.

Attachments(LifecycleManager manager, InputStream inStream, String contentTypeString, boolean fileCacheEnable, String attachmentRepoDir, String fileThreshold)
Moves the pointer to the beginning of the first MIME part.

Attachments(LifecycleManager manager, InputStream inStream, String contentTypeString, boolean fileCacheEnable, String attachmentRepoDir, String fileThreshold, int contentLength)
Moves the pointer to the beginning of the first MIME part.

Method Summary

void	addDataHandler(String contentID, javax.activation.DataHandler dataHandler) Programatically adding an SOAP with Attachments(SwA) Attachment.
String[]	getAllContentIDs()
String	getAttachmentSpecType()
List	getContentIDList()
Set	getContentIDSet()
long	getContentLength() If the Attachments is backed by an InputStream, then this method returns the length of the message contents (Length of the entire message - Length of the Transport Headers)
javax.activation.DataHandler	getDataHandler(String blobContentID) Checks whether the MIME part is already parsed by checking the attachments HashMap.
InputStream	getIncomingAttachmentsAsSingleStream() Returns the rest of mime stream.
IncomingAttachmentStreams	getIncomingAttachmentStreams() Stream based access
LifecycleManager	getLifecycleManager()
Map	getMap()
String	getSOAPPartContentID()
String	getSOAPPartContentType()
InputStream	getSOAPPartInputStream()
void	removeDataHandler(String blobContentID) Removes the DataHandler corresponding to the given contenID.
protected void	setEndOfStream(boolean value) endOfStreamReached will be set to true if the message ended in MIME Style having "--" suffix with the last mime boundary
void	setLifecycleManager(LifecycleManager manager)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected static org.apache.commons.logging.Log log

Constructor Detail

Attachments

public Attachments(LifecycleManager manager,
                   InputStream inStream,
                   String contentTypeString,
                   boolean fileCacheEnable,
                   String attachmentRepoDir,
                   String fileThreshold)
            throws OMException

Moves the pointer to the beginning of the first MIME part. Reads till first MIME boundary is found or end of stream is reached.

Parameters:

inStream -

contentTypeString -

fileCacheEnable -

attachmentRepoDir -

Throws:

OMException

Attachments

public Attachments(LifecycleManager manager,
                   InputStream inStream,
                   String contentTypeString,
                   boolean fileCacheEnable,
                   String attachmentRepoDir,
                   String fileThreshold,
                   int contentLength)
            throws OMException

Moves the pointer to the beginning of the first MIME part. Reads till first MIME boundary is found or end of stream is reached.

Parameters:

inStream -

contentTypeString -

fileCacheEnable -

attachmentRepoDir -

fileThreshold -

contentLength -

Throws:

OMException

Attachments

public Attachments(InputStream inStream,
                   String contentTypeString,
                   boolean fileCacheEnable,
                   String attachmentRepoDir,
                   String fileThreshold)
            throws OMException

Moves the pointer to the beginning of the first MIME part. Reads till first MIME boundary is found or end of stream is reached.

Parameters:

inStream -

contentTypeString -

fileCacheEnable -

attachmentRepoDir -

Throws:

OMException

Attachments

public Attachments(InputStream inStream,
                   String contentTypeString,
                   boolean fileCacheEnable,
                   String attachmentRepoDir,
                   String fileThreshold,
                   int contentLength)
            throws OMException

Moves the pointer to the beginning of the first MIME part. Reads till first MIME boundary is found or end of stream is reached.

Parameters:

inStream -

contentTypeString -

fileCacheEnable -

attachmentRepoDir -

fileThreshold -

contentLength -

Throws:

OMException

Attachments

public Attachments(InputStream inStream,
                   String contentTypeString)
            throws OMException

Sets file cache to false.

Parameters:

inStream -

contentTypeString -

Throws:

OMException

Attachments

public Attachments()

Use this constructor when instantiating this to store the attachments set programatically through the SwA API.

Method Detail

getLifecycleManager

public LifecycleManager getLifecycleManager()

setLifecycleManager

public void setLifecycleManager(LifecycleManager manager)

getAttachmentSpecType

public String getAttachmentSpecType()

Returns:

whether Message Type is SOAP with Attachments or MTOM optimized, by checking the application type parameter in the Content Type.

getDataHandler

public javax.activation.DataHandler getDataHandler(String blobContentID)

Checks whether the MIME part is already parsed by checking the attachments HashMap. If it is not parsed yet then call the getNextPart() till the required part is found.

Specified by:

getDataHandler in interface OMAttachmentAccessor

Parameters:

blobContentID - (without the surrounding angle brackets and "cid:" prefix)

Returns:

The DataHandler of the mime part referred by the Content-Id or *null* if the mime part referred by the content-id does not exist

addDataHandler

public void addDataHandler(String contentID,
                           javax.activation.DataHandler dataHandler)

Programatically adding an SOAP with Attachments(SwA) Attachment. These attachments will get serialized only if SOAP with Attachments is enabled.

Parameters:

contentID -

dataHandler -

removeDataHandler

public void removeDataHandler(String blobContentID)

Removes the DataHandler corresponding to the given contenID. If it is not present, then trying to find it calling the getNextPart() till the required part is found.

Parameters:

blobContentID -

getSOAPPartInputStream

public InputStream getSOAPPartInputStream()
                                   throws OMException

Returns:

the InputStream which includes the SOAP Envelope. It assumes that the root mime part is always pointed by "start" parameter in content-type.

Throws:

OMException

getSOAPPartContentID

public String getSOAPPartContentID()

Returns:

the Content-ID of the SOAP part It'll be the value Start Parameter of Content-Type header if given in the Content type of the MIME message. Else it'll be the content-id of the first MIME part of the MIME message

getSOAPPartContentType

public String getSOAPPartContentType()

getIncomingAttachmentStreams

public IncomingAttachmentStreams getIncomingAttachmentStreams()
                                                       throws IllegalStateException

Stream based access

Returns:

The stream container of type IncomingAttachmentStreams

Throws:

IllegalStateException - if application has alreadt started using Part's directly

getAllContentIDs

public String[] getAllContentIDs()

getContentIDSet

public Set getContentIDSet()

getMap

public Map getMap()

getContentIDList

public List getContentIDList()

Returns:

List of content ids in order of appearance in message

getContentLength

public long getContentLength()
                      throws IOException

If the Attachments is backed by an InputStream, then this method returns the length of the message contents (Length of the entire message - Length of the Transport Headers)

Returns:

length of message content or -1 if Attachments is not backed by an InputStream

Throws:

IOException

See Also:

getMessageLength

setEndOfStream

protected void setEndOfStream(boolean value)

endOfStreamReached will be set to true if the message ended in MIME Style having "--" suffix with the last mime boundary

Parameters:

value -

getIncomingAttachmentsAsSingleStream

public InputStream getIncomingAttachmentsAsSingleStream()
                                                 throws IllegalStateException

Returns the rest of mime stream. It will contain all attachments without soappart (first attachment) with headers and mime boundary. Raw content!

Throws:

IllegalStateException