org.apache.axiom.attachments.lifecycle

Interface LifecycleManager

All Known Implementing Classes:

LifecycleManagerImpl

public interface LifecycleManager

Lifecycle Manager will be used to manage the lifecycle of attachment files. Axiom forks attachment processing based on the size of attachment to be processed. Attachments are either processed by storing them in memory or by storing them in file system based on the size of the attachment file. Lifecycle Manager provides and organized way of managing attachments, by providing calls to create and delete attachments.

Method Summary

Modifier and Type	Method and Description
FileAccessor	create(java.lang.String attachmentDir) Create a unique file in the designated directory
void	delete(java.io.File file) Deletes attachment file
void	deleteOnExit(java.io.File file) Mark the file for deletion on application/VM exit
void	deleteOnTimeInterval(int interval, java.io.File file) Mark attachment file for deletion when designated time interval in seconds has elapsed.
FileAccessor	getFileAccessor(java.lang.String file) This method will return the file accessor associated with this file.

Method Detail

create

FileAccessor create(java.lang.String attachmentDir)
             throws java.io.IOException

Create a unique file in the designated directory

Parameters:

attachmentDir -

Returns:

the FileAccessor for the file created by this method

Throws:

java.io.IOException

delete

void delete(java.io.File file)
     throws java.io.IOException

Deletes attachment file

Parameters:

file -

Throws:

java.io.IOException

deleteOnExit

void deleteOnExit(java.io.File file)
           throws java.io.IOException

Mark the file for deletion on application/VM exit

Parameters:

file -

Throws:

java.io.IOException

deleteOnTimeInterval

void deleteOnTimeInterval(int interval,
                          java.io.File file)
                   throws java.io.IOException

Mark attachment file for deletion when designated time interval in seconds has elapsed.

Parameters:

interval -

file -

Throws:

java.io.IOException

getFileAccessor

FileAccessor getFileAccessor(java.lang.String file)
                      throws java.io.IOException

This method will return the file accessor associated with this file.

Parameters:

file -

Returns:

the FileAccessor object for the given file

Throws:

java.io.IOException