com.ibm.cloud.objectstorage.services.s3.internal

Class MultiFileOutputStream

java.lang.Object

java.io.OutputStream

com.ibm.cloud.objectstorage.services.s3.internal.MultiFileOutputStream

All Implemented Interfaces:

OnFileDelete, Closeable, Flushable, AutoCloseable

public class MultiFileOutputStream
extends OutputStream
implements OnFileDelete

Used to split an output stream into multiple files for purposes such as parallel uploads.

Constructor Summary

Constructors

Constructor and Description
MultiFileOutputStream() Construct an instance to use the default temporary directory and temp file naming convention.
MultiFileOutputStream(File root, String namePrefix) Construct an instance to use the specified directory for temp file creations, and the specified prefix for temp file naming.

Method Summary

Modifier and Type	Method and Description
void	cleanup()
void	close()
void	flush()
long	getDiskLimit()
File	getFile(int partNumber)
String	getNamePrefix()
int	getNumFilesWritten()
long	getPartSize()
File	getRoot()
long	getTotalBytesWritten()
MultiFileOutputStream	init(UploadObjectObserver observer, long partSize, long diskLimit) Used to initialized this stream.
boolean	isClosed()
void	onFileDelete(FileDeletionEvent event) Called upon a file deletion event.
void	write(byte[] b) This method would block as necessary if running out of disk space.
void	write(byte[] b, int off, int len) This method would block as necessary if running out of disk space.
void	write(int b) This method would block as necessary if running out of disk space.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiFileOutputStream

public MultiFileOutputStream()

Construct an instance to use the default temporary directory and temp file naming convention. The MultiFileOutputStream.init(UploadObjectObserver, long, long) must be called before this stream is considered fully initialized.

MultiFileOutputStream

public MultiFileOutputStream(File root,
                             String namePrefix)

Construct an instance to use the specified directory for temp file creations, and the specified prefix for temp file naming. The MultiFileOutputStream.init(UploadObjectObserver, long, long) must be called before this stream is considered fully initialized.

Method Detail

init

public MultiFileOutputStream init(UploadObjectObserver observer,
                                  long partSize,
                                  long diskLimit)

Used to initialized this stream. This method is an SPI (service provider interface) that is called from AmazonS3EncryptionClient.

Implementation of this method should never block.

Parameters:

observer - the upload object observer

partSize - part size for multi-part upload

diskLimit - the maximum disk space to be used for this multi-part upload

Returns:

this object

write

public void write(int b)
           throws IOException

This method would block as necessary if running out of disk space.

Specified by:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] b)
           throws IOException

This method would block as necessary if running out of disk space.

Overrides:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] b,
                  int off,
                  int len)
           throws IOException

This method would block as necessary if running out of disk space.

Overrides:

write in class OutputStream

Throws:

IOException

onFileDelete

public void onFileDelete(FileDeletionEvent event)

Description copied from interface: OnFileDelete

Called upon a file deletion event.

Implementation of this method should never block.

Specified by:

onFileDelete in interface OnFileDelete

Parameters:

event - file deletion event

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException

cleanup

public void cleanup()

getNumFilesWritten

public int getNumFilesWritten()

Returns:

the number of files written with the specified prefix with the part number as the file extension.

getFile

public File getFile(int partNumber)

getPartSize

public long getPartSize()

getRoot

public File getRoot()

getNamePrefix

public String getNamePrefix()

getTotalBytesWritten

public long getTotalBytesWritten()

isClosed

public boolean isClosed()

getDiskLimit

public long getDiskLimit()