org.apache.axiom.attachments

Class PartContentOnFile

java.lang.Object

org.apache.axiom.attachments.PartContent

org.apache.axiom.attachments.PartContentOnFile

class PartContentOnFile
extends PartContent

Stores the content of a MIME part in a file. This implementation is used for very large attachments to reduce the in-memory footprint.

See Also:

PartContentFactory

Field Summary

Fields

Modifier and Type	Field and Description
private FileAccessor	fileAccessor
private LifecycleManager	manager

Constructor Summary

Constructors

Constructor and Description
PartContentOnFile(LifecycleManager manager, java.io.InputStream is1, java.io.InputStream is2, java.lang.String attachmentDir) Constructor.

Method Summary

Modifier and Type	Method and Description
(package private) void	destroy() Release all resources used to store the content of the MIME part.
(package private) javax.activation.DataSource	getDataSource(java.lang.String contentType) Get a DataSource implementation specific for this buffering strategy, if supported.
(package private) java.io.InputStream	getInputStream() Get an InputStream representing the buffered MIME part content.
(package private) long	getSize() Get the size of the MIME part, more precisely the number of bytes in the decoded content of the MIME part.
(package private) void	writeTo(java.io.OutputStream out) Write the buffered MIME part content to the given output stream.

Methods inherited from class java.lang.Object

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

Field Detail

fileAccessor

private final FileAccessor fileAccessor

manager

private final LifecycleManager manager

Constructor Detail

PartContentOnFile

PartContentOnFile(LifecycleManager manager,
                  java.io.InputStream is1,
                  java.io.InputStream is2,
                  java.lang.String attachmentDir)
           throws java.io.IOException

Constructor.

Parameters:

manager - the lifecycle manager that will be used for managing temporary files created by this instance

in1 - InputStream containing data

in2 - InputStream containing data

attachmentDir - the file system location where temporary files are created; this value will be used in calls to LifecycleManager.create(String)

Throws:

java.io.IOException

Method Detail

getInputStream

java.io.InputStream getInputStream()
                            throws java.io.IOException

Description copied from class: PartContent

Get an InputStream representing the buffered MIME part content. Note that a new InputStream object must be returned each time this method is called, and the stream must be positioned at the beginning of the data.

Specified by:

getInputStream in class PartContent

Returns:

the stream representing the content of this MIME part

Throws:

java.io.IOException - if an error occurs while accessing the buffered content

getDataSource

javax.activation.DataSource getDataSource(java.lang.String contentType)

Description copied from class: PartContent

Get a DataSource implementation specific for this buffering strategy, if supported. If no DataSource is returned, then a default implementation will be used. If a DataSource is returned, it should implement SizeAwareDataSource.

Specified by:

getDataSource in class PartContent

Parameters:

contentType - the content type for the DataSource, which must be returned by DataSource.getContentType()

Returns:

the DataSource implementation or null if a default DataSource implementation should be used

writeTo

void writeTo(java.io.OutputStream out)
      throws java.io.IOException

Description copied from class: PartContent

Write the buffered MIME part content to the given output stream. Note that the implementation must not consume the content, i.e. the content must still be available after this method completes.

Specified by:

writeTo in class PartContent

Parameters:

out - the output stream to write the content to

Throws:

java.io.IOException - if an I/O error occurs (either while reading the buffered content or while writing to the output stream)

getSize

long getSize()

Description copied from class: PartContent

Get the size of the MIME part, more precisely the number of bytes in the decoded content of the MIME part.

Specified by:

getSize in class PartContent

Returns:

the size of the MIME part

destroy

void destroy()
      throws java.io.IOException

Description copied from class: PartContent

Release all resources used to store the content of the MIME part. The content will no longer be accessible after this method is called.

Specified by:

destroy in class PartContent

Throws:

java.io.IOException - if an I/O error occurs