alluxio.underfs.obs

Class OBSOutputStream

java.lang.Object

java.io.OutputStream

alluxio.underfs.obs.OBSOutputStream

All Implemented Interfaces:

ContentHashable, Closeable, Flushable, AutoCloseable

@NotThreadSafe
public final class OBSOutputStream
extends OutputStream
implements ContentHashable

A stream for writing a file into OBS. The data will be persisted to a temporary directory on the local disk and copied as a complete file when the close() method is called.

Constructor Summary

Constructors

Constructor and Description
OBSOutputStream(String bucketName, String key, com.obs.services.ObsClient client, List<String> tmpDirs) Creates a name instance of OBSOutputStream.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this output stream.
void	flush() Flushes this output stream and forces any buffered output bytes to be written out.
Optional<String>	getContentHash()
void	write(byte[] b) Writes the given byte array to this output stream.
void	write(byte[] b, int off, int len) Writes the given number of bytes from the given byte array starting at the given offset to this output stream.
void	write(int b) Writes the given bytes to this output stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

OBSOutputStream

public OBSOutputStream(String bucketName,
                       String key,
                       com.obs.services.ObsClient client,
                       List<String> tmpDirs)
                throws IOException

Creates a name instance of OBSOutputStream.

Parameters:

bucketName - the name of the bucket

key - the key of the file

client - the OBS client

tmpDirs - a list of temporary directories

Throws:

IOException

Method Detail

write

public void write(int b)
           throws IOException

Writes the given bytes to this output stream. Before close, the bytes are all written to local file.

Specified by:

write in class OutputStream

Parameters:

b - the bytes to write

Throws:

IOException

write

public void write(byte[] b)
           throws IOException

Writes the given byte array to this output stream. Before close, the bytes are all written to local file.

Overrides:

write in class OutputStream

Parameters:

b - the byte array

Throws:

IOException

write

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

Writes the given number of bytes from the given byte array starting at the given offset to this output stream. Before close, the bytes are all written to local file.

Overrides:

write in class OutputStream

Parameters:

b - the byte array

off - the start offset in the data

len - the number of bytes to write

Throws:

IOException

flush

public void flush()
           throws IOException

Flushes this output stream and forces any buffered output bytes to be written out. Before close, the data are flushed to local file.

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

Closes this output stream. When an output stream is closed, the local temporary file is uploaded to OSS Service. Once the file is uploaded, the temporary file is deleted.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException

getContentHash

public Optional<String> getContentHash()

Specified by:

getContentHash in interface ContentHashable

Returns:

the content hash of the file written to the UFS if available after the stream has been closed