Package org.apache.hadoop.fs.azure

Class BlockBlobAppendStream

java.lang.Object

java.io.OutputStream

org.apache.hadoop.fs.azure.BlockBlobAppendStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable, org.apache.hadoop.fs.StreamCapabilities, org.apache.hadoop.fs.Syncable

public class BlockBlobAppendStream
extends java.io.OutputStream
implements org.apache.hadoop.fs.Syncable, org.apache.hadoop.fs.StreamCapabilities

Stream object that implements append for Block Blobs in WASB. The stream object implements hflush/hsync and block compaction. Block compaction is the process of replacing a sequence of small blocks with one big block. Azure Block blobs supports up to 50000 blocks and every hflush/hsync generates one block. When the number of blocks is above 32000, the process of compaction decreases the total number of blocks, if possible. If compaction is disabled, hflush/hsync are empty functions. The stream object uses background threads for uploading the blocks and the block blob list. Blocks can be uploaded concurrently. However, when the block list is uploaded, block uploading should stop. If a block is uploaded before the block list and the block id is not in the list, the block will be lost. If the block is uploaded after the block list and the block id is in the list, the block list upload will fail. The exclusive access for the block list upload is managed by uploadingSemaphore.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.fs.StreamCapabilities

org.apache.hadoop.fs.StreamCapabilities.StreamCapability

Field Summary

Fields inherited from interface org.apache.hadoop.fs.StreamCapabilities

ABORTABLE_STREAM, DROPBEHIND, HFLUSH, HSYNC, IOSTATISTICS, IOSTATISTICS_CONTEXT, PREADBYTEBUFFER, READAHEAD, READBYTEBUFFER, UNBUFFER, VECTOREDIO

Constructor Summary

Constructors

Constructor	Description
BlockBlobAppendStream(org.apache.hadoop.fs.azure.StorageInterface.CloudBlockBlobWrapper blob, java.lang.String aKey, int bufferSize, boolean compactionEnabled, com.microsoft.azure.storage.OperationContext opContext)	BlockBlobAppendStream constructor.

Method Summary

Modifier and Type	Method	Description
void	close()	Force all data in the output stream to be written to Azure storage.
void	flush()	Flushes this output stream and forces any buffered output bytes to be written out.
boolean	hasCapability(java.lang.String capability)	The Synchronization capabilities of this stream depend upon the compaction policy.
void	hflush()	Force all data in the output stream to be written to Azure storage.
void	hsync()	Force all data in the output stream to be written to Azure storage.
void	sync()	Deprecated.
void	write(byte[] data, int offset, int length)	Writes length bytes from the specified byte array starting at offset to this output stream.
void	write(int byteVal)	Writes the specified byte to this output stream.

Methods inherited from class java.io.OutputStream

nullOutputStream, write

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockBlobAppendStream

public BlockBlobAppendStream(org.apache.hadoop.fs.azure.StorageInterface.CloudBlockBlobWrapper blob,
                             java.lang.String aKey,
                             int bufferSize,
                             boolean compactionEnabled,
                             com.microsoft.azure.storage.OperationContext opContext)
                      throws java.io.IOException

BlockBlobAppendStream constructor.

Parameters:

blob - Azure Block Blob

aKey - blob's name

bufferSize - the maximum size of a blob block.

compactionEnabled - is the compaction process enabled for this blob

opContext - Azure Store operation context for the blob

Throws:

java.io.IOException - if an I/O error occurs. In particular, an IOException may be thrown if the output stream cannot be used for append operations

Method Detail

write

public void write(int byteVal)
           throws java.io.IOException

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Specified by:

write in class java.io.OutputStream

Parameters:

byteVal - the byteValue to write.

Throws:

java.io.IOException - if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

write

public void write(byte[] data,
                  int offset,
                  int length)
           throws java.io.IOException

Writes length bytes from the specified byte array starting at offset to this output stream.

Overrides:

write in class java.io.OutputStream

Parameters:

data - the byte array to write.

offset - the start offset in the data.

length - the number of bytes to write.

Throws:

java.io.IOException - if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

flush

public void flush()
           throws java.io.IOException

Flushes this output stream and forces any buffered output bytes to be written out. If any data remains in the payload it is committed to the service. Data is queued for writing and forced out to the service before the call returns.

Specified by:

flush in interface java.io.Flushable

Overrides:

flush in class java.io.OutputStream

Throws:

java.io.IOException

hsync

public void hsync()
           throws java.io.IOException

Force all data in the output stream to be written to Azure storage. Wait to return until this is complete.

Specified by:

hsync in interface org.apache.hadoop.fs.Syncable

Throws:

java.io.IOException

sync

@Deprecated
public void sync()
          throws java.io.IOException

Deprecated.

Specified by:

sync in interface org.apache.hadoop.fs.Syncable

Throws:

java.io.IOException

hflush

public void hflush()
            throws java.io.IOException

Force all data in the output stream to be written to Azure storage. Wait to return until this is complete.

Specified by:

hflush in interface org.apache.hadoop.fs.Syncable

Throws:

java.io.IOException

hasCapability

public boolean hasCapability(java.lang.String capability)

The Synchronization capabilities of this stream depend upon the compaction policy.

Specified by:

hasCapability in interface org.apache.hadoop.fs.StreamCapabilities

Parameters:

capability - string to query the stream support for.

Returns:

true for hsync and hflush when compaction is enabled.

close

public void close()
           throws java.io.IOException

Force all data in the output stream to be written to Azure storage. Wait to return until this is complete. Close the access to the stream and shutdown the upload thread pool. If the blob was created, its lease will be released. Any error encountered caught in threads and stored will be rethrown here after cleanup.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Overrides:

close in class java.io.OutputStream

Throws:

java.io.IOException