Package org.apache.hadoop.fs.azurebfs.services

Class AbfsOutputStream

java.lang.Object

java.io.OutputStream

org.apache.hadoop.fs.azurebfs.services.AbfsOutputStream

All Implemented Interfaces:

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

public class AbfsOutputStream
extends java.io.OutputStream
implements org.apache.hadoop.fs.Syncable, org.apache.hadoop.fs.StreamCapabilities, org.apache.hadoop.fs.statistics.IOStatisticsSource

The BlobFsOutputStream for Rest AbfsClient.

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
AbfsOutputStream(AbfsOutputStreamContext abfsOutputStreamContext)

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.
org.apache.hadoop.fs.statistics.IOStatistics	getIOStatistics()
AbfsOutputStreamStatistics	getOutputStreamStatistics()	Getter method for AbfsOutputStream statistics.
java.lang.String	getStreamID()
int	getWriteOperationsSize()	Getter to get the size of the task queue.
boolean	hasCapability(java.lang.String capability)	Query the stream for a specific capability.
boolean	hasLease()
void	hflush()	Flush out the data in client's user buffer.
void	hsync()	Similar to posix fsync, flush out the data in client's user buffer all the way to the disk device (but the disk may have it in its cache).
boolean	isLeaseFreed()
void	registerListener(Listener listener1)
void	sync()	Deprecated.
java.lang.String	toString()	Appending AbfsOutputStream statistics to base toString().
void	waitForPendingUploads()
void	write(byte[] data, int off, int length)	Writes length bytes from the specified byte array starting at off 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, wait, wait, wait

Constructor Detail

AbfsOutputStream

public AbfsOutputStream(AbfsOutputStreamContext abfsOutputStreamContext)
                 throws java.io.IOException

Throws:

java.io.IOException

Method Detail

hasCapability

public boolean hasCapability(java.lang.String capability)

Query the stream for a specific capability.

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.

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 off,
                  int length)
           throws java.io.IOException

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

Overrides:

write in class java.io.OutputStream

Parameters:

data - the byte array to write.

off - the start off 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

Similar to posix fsync, flush out the data in client's user buffer all the way to the disk device (but the disk may have it in its cache).

Specified by:

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

Throws:

java.io.IOException - if error occurs

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

Flush out the data in client's user buffer. After the return of this call, new readers will see the data.

Specified by:

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

Throws:

java.io.IOException - if any error occurs

getStreamID

public java.lang.String getStreamID()

registerListener

public void registerListener(Listener listener1)

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

waitForPendingUploads

@VisibleForTesting
public void waitForPendingUploads()
                           throws java.io.IOException

Throws:

java.io.IOException

getOutputStreamStatistics

@VisibleForTesting
public AbfsOutputStreamStatistics getOutputStreamStatistics()

Getter method for AbfsOutputStream statistics.

Returns:

statistics for AbfsOutputStream.

getWriteOperationsSize

@VisibleForTesting
public int getWriteOperationsSize()

Getter to get the size of the task queue.

Returns:

the number of writeOperations in AbfsOutputStream.

getIOStatistics

public org.apache.hadoop.fs.statistics.IOStatistics getIOStatistics()

Specified by:

getIOStatistics in interface org.apache.hadoop.fs.statistics.IOStatisticsSource

isLeaseFreed

@VisibleForTesting
public boolean isLeaseFreed()

hasLease

@VisibleForTesting
public boolean hasLease()

toString

public java.lang.String toString()

Appending AbfsOutputStream statistics to base toString().

Overrides:

toString in class java.lang.Object

Returns:

String with AbfsOutputStream statistics.