org.apache.axiom.attachments

Class PartDataHandler

java.lang.Object

javax.activation.DataHandler

org.apache.axiom.attachments.PartDataHandler

All Implemented Interfaces:

java.awt.datatransfer.Transferable, DataHandlerExt

class PartDataHandler
extends javax.activation.DataHandler
implements DataHandlerExt

DataHandler implementation for MIME parts read from a stream.

Field Summary

Fields

Modifier and Type	Field and Description
private javax.activation.DataSource	dataSource
private PartImpl	part

Constructor Summary

Constructors

Constructor and Description
PartDataHandler(PartImpl part)

Method Summary

Modifier and Type	Method and Description
void	deleteWhenReadOnce()
javax.activation.DataSource	getDataSource()
void	purgeDataSource() This method will give users an option to trigger a purge on temporary attachment files.
java.io.InputStream	readOnce() Get an InputStream that consumes the content of this data handler.
void	writeTo(java.io.OutputStream os)

Methods inherited from class javax.activation.DataHandler

getAllCommands, getBean, getCommand, getContent, getContentType, getInputStream, getName, getOutputStream, getPreferredCommands, getTransferData, getTransferDataFlavors, isDataFlavorSupported, setCommandMap, setDataContentHandlerFactory

Methods inherited from class java.lang.Object

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

Field Detail

part

private final PartImpl part

dataSource

private javax.activation.DataSource dataSource

Constructor Detail

PartDataHandler

public PartDataHandler(PartImpl part)

Method Detail

getDataSource

public javax.activation.DataSource getDataSource()

Overrides:

getDataSource in class javax.activation.DataHandler

writeTo

public void writeTo(java.io.OutputStream os)
             throws java.io.IOException

Overrides:

writeTo in class javax.activation.DataHandler

Throws:

java.io.IOException

readOnce

public java.io.InputStream readOnce()
                             throws java.io.IOException

Description copied from interface: DataHandlerExt

Get an InputStream that consumes the content of this data handler. This method is similar to DataHandler.getInputStream() except that it can be invoked only once. If the content has not been buffered yet, then the implementation may choose to enable streaming of the content.

The implementation ensures that after the returned input steam is consumed, the data handler will be in the same state as after a call to DataHandlerExt.purgeDataSource().

Specified by:

readOnce in interface DataHandlerExt

Returns:

the stream representing the content; never null

Throws:

java.io.IOException - if an error occurs

purgeDataSource

public void purgeDataSource()
                     throws java.io.IOException

Description copied from interface: DataHandlerExt

This method will give users an option to trigger a purge on temporary attachment files. Temp files are created for attachment data that is greater than a threshold limit. On client side These temp attachment files are not deleted untilthe virtual machine exits as user can choose to read this dataHandler. So if user is not going to use the data handlers provided on this temproray files they can choose to purge the file.

Specified by:

purgeDataSource in interface DataHandlerExt

Throws:

java.io.IOException

deleteWhenReadOnce

public void deleteWhenReadOnce()
                        throws java.io.IOException

Specified by:

deleteWhenReadOnce in interface DataHandlerExt

Throws:

java.io.IOException