Package org.apache.hadoop.fs

Class FSOutputSummer

java.lang.Object

java.io.OutputStream

org.apache.hadoop.fs.FSOutputSummer

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable, StreamCapabilities

@LimitedPrivate("HDFS")
@Unstable
public abstract class FSOutputSummer
extends java.io.OutputStream
implements StreamCapabilities

This is a generic output stream for generating checksums for data before it is written to the underlying stream

Nested Class Summary

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

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

Modifier	Constructor	Description
protected	FSOutputSummer(DataChecksum sum)

Method Summary

Modifier and Type	Method	Description
protected abstract void	checkClosed()	Check if the implementing OutputStream is closed and should no longer accept writes.
static byte[]	convertToByteStream(java.util.zip.Checksum sum, int checksumSize)	Converts a checksum integer value to a byte stream
protected org.apache.hadoop.tracing.TraceScope	createWriteTraceScope()
void	flush()	Checksums all complete data chunks and flushes them to the underlying stream.
protected void	flushBuffer()
protected int	flushBuffer(boolean keep, boolean flushPartial)
protected int	getBufferedDataSize()	Return the number of valid bytes currently in the buffer.
protected int	getChecksumSize()
protected DataChecksum	getDataChecksum()
boolean	hasCapability(java.lang.String capability)	Query the stream for a specific capability.
protected void	resetChecksumBufSize()
protected void	setChecksumBufSize(int size)	Resets existing buffer with a new one of the specified size.
void	write(byte[] b, int off, int len)	Writes len bytes from the specified byte array starting at offset off and generate a checksum for each data chunk.
void	write(int b)	Write one byte
protected abstract void	writeChunk(byte[] b, int bOffset, int bLen, byte[] checksum, int checksumOffset, int checksumLen)

Methods inherited from class java.io.OutputStream

close, nullOutputStream, write

Methods inherited from class java.lang.Object

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

Constructor Detail

FSOutputSummer

protected FSOutputSummer(DataChecksum sum)

Method Detail

writeChunk

protected abstract void writeChunk(byte[] b,
                                   int bOffset,
                                   int bLen,
                                   byte[] checksum,
                                   int checksumOffset,
                                   int checksumLen)
                            throws java.io.IOException

Throws:

java.io.IOException

checkClosed

protected abstract void checkClosed()
                             throws java.io.IOException

Check if the implementing OutputStream is closed and should no longer accept writes. Implementations should do nothing if this stream is not closed, and should throw an IOException if it is closed.

Throws:

java.io.IOException - if this stream is already closed.

write

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

Write one byte

Specified by:

write in class java.io.OutputStream

Throws:

java.io.IOException

write

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

Writes len bytes from the specified byte array starting at offset off and generate a checksum for each data chunk.

This method stores bytes from the given array into this stream's buffer before it gets checksumed. The buffer gets checksumed and flushed to the underlying output stream when all data in a checksum chunk are in the buffer. If the buffer is empty and requested length is at least as large as the size of next checksum chunk size, this method will checksum and write the chunk directly to the underlying output stream. Thus it avoids unnecessary data copy.

Overrides:

write in class java.io.OutputStream

Parameters:

b - the data.

off - the start offset in the data.

len - the number of bytes to write.

Throws:

java.io.IOException - if an I/O error occurs.

flushBuffer

protected void flushBuffer()
                    throws java.io.IOException

Throws:

java.io.IOException

flushBuffer

protected int flushBuffer(boolean keep,
                          boolean flushPartial)
                   throws java.io.IOException

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Checksums all complete data chunks and flushes them to the underlying stream. If there is a trailing partial chunk, it is not flushed and is maintained in the buffer.

Specified by:

flush in interface java.io.Flushable

Overrides:

flush in class java.io.OutputStream

Throws:

java.io.IOException

getBufferedDataSize

protected int getBufferedDataSize()

Return the number of valid bytes currently in the buffer.

Returns:

buffer data size.

getChecksumSize

protected int getChecksumSize()

Returns:

the size for a checksum.

getDataChecksum

protected DataChecksum getDataChecksum()

createWriteTraceScope

protected org.apache.hadoop.tracing.TraceScope createWriteTraceScope()

convertToByteStream

public static byte[] convertToByteStream(java.util.zip.Checksum sum,
                                         int checksumSize)

Converts a checksum integer value to a byte stream

Parameters:

sum - check sum.

checksumSize - check sum size.

Returns:

byte stream.

setChecksumBufSize

protected void setChecksumBufSize(int size)

Resets existing buffer with a new one of the specified size.

Parameters:

size - size.

resetChecksumBufSize

protected void resetChecksumBufSize()

hasCapability

public boolean hasCapability(java.lang.String capability)

Description copied from interface: StreamCapabilities

Query the stream for a specific capability.

Specified by:

hasCapability in interface StreamCapabilities

Parameters:

capability - string to query the stream support for.

Returns:

True if the stream supports capability.