kafka.utils.checksum

Class NoChecksumFileIO

java.lang.Object

kafka.utils.checksum.CheckedFileIO

kafka.utils.checksum.NoChecksumFileIO

All Implemented Interfaces:

AutoCloseable

public class NoChecksumFileIO
extends CheckedFileIO

NoChecksumFileIO is an I/O package which extends CheckedFileIO and is used for ChecksumAlgorithm type NO_CHECKSUM.

Field Summary

Fields

Modifier and Type	Field and Description
static short	NO_CHECKSUM_SUPER_BLOCK_LENGTH_DEFAULT The super block length for NO_CHECKSUM should always be 0.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the file channel
void	flush() Flush method is used to flush the file onto storage.
long	position() Returns this channel's file relative position.
void	position(long newPosition) Sets this channel's file position from the input relative position.
void	read(ByteBuffer dst, long position) Read data from the channel to the given byte buffer from the input relative position until there are no bytes remaining in the buffer or the end of the file has been reached.
long	size() Size of file channel based on relative position.
String	toString()
void	truncate(long size) Truncate file channel to given size based on relative position.
boolean	validate() Validate compares with the value stored in header of the file with the checksum computed of the entire file.
void	write(ByteBuffer src) Write the given buffer into the file channel at the relative file channel position NOTE: File position is updated with the number of bytes written
void	write(ByteBuffer src, long position) Write the given buffer into the file channel at the input relative position in file channel.

Methods inherited from class kafka.utils.checksum.CheckedFileIO

checksum, create, isValidPath, migrateFile, open, open, openOrCreate, openOrCreate, transferFrom, transferTo, validPath, verifyOnlyValidFileExists

Methods inherited from class java.lang.Object

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

Field Detail

NO_CHECKSUM_SUPER_BLOCK_LENGTH_DEFAULT

public static final short NO_CHECKSUM_SUPER_BLOCK_LENGTH_DEFAULT

The super block length for NO_CHECKSUM should always be 0.

See Also:

Constant Field Values

Method Detail

validate

public boolean validate()
                 throws IOException,
                        InstantiationException,
                        IllegalAccessException

Description copied from class: CheckedFileIO

Validate compares with the value stored in header of the file with the checksum computed of the entire file. This method creates a new instance of the checksum package without any arguments, this can fail if the package is null or if we want to invoke a different constructor of the package. NOTE: The application also needs to ensure this method is invoked with a write lock, so no concurrent write happens while validation is being done.

Specified by:

validate in class CheckedFileIO

Returns:

true if the checksum for the file is valid, false indicates file content has been corrupted

Throws:

IOException - If any I/O error occurs

InstantiationException

IllegalAccessException

read

public void read(ByteBuffer dst,
                 long position)
          throws IOException

Description copied from class: CheckedFileIO

Read data from the channel to the given byte buffer from the input relative position until there are no bytes remaining in the buffer or the end of the file has been reached.

Specified by:

read in class CheckedFileIO

Parameters:

dst - The byte buffer to which bytes are to be transferred

position - The file position at which the transfer is to begin

Throws:

IOException - If any I/O error occurs

write

public void write(ByteBuffer src)
           throws IOException

Description copied from class: CheckedFileIO

Write the given buffer into the file channel at the relative file channel position NOTE: File position is updated with the number of bytes written

Specified by:

write in class CheckedFileIO

Parameters:

src - The buffer from which bytes are to be transferred

Throws:

IOException - If any I/O error occurs

write

public void write(ByteBuffer src,
                  long position)
           throws IOException

Description copied from class: CheckedFileIO

Write the given buffer into the file channel at the input relative position in file channel. In case the position is more than the size of file channel, then zeros are filled in the gap. NOTE: File position is not updated by this method

Specified by:

write in class CheckedFileIO

Parameters:

src - The buffer from which bytes are to be transferred

position - The file position at which the transfer is to begin

Throws:

IOException - If any I/O error occurs

position

public long position()
              throws IOException

Description copied from class: CheckedFileIO

Returns this channel's file relative position.

Specified by:

position in class CheckedFileIO

Returns:

This channel's file position

Throws:

IOException - If any I/O error occurs

position

public void position(long newPosition)
              throws IOException

Description copied from class: CheckedFileIO

Sets this channel's file position from the input relative position.

Specified by:

position in class CheckedFileIO

Parameters:

newPosition - The new position

Throws:

IOException - If any I/O error occurs

size

public long size()
          throws IOException

Description copied from class: CheckedFileIO

Size of file channel based on relative position. NOTE: This doesn't include the super block header at the beginning of the file

Specified by:

size in class CheckedFileIO

Returns:

The size of file channel

Throws:

IOException - If any I/O error occurs

truncate

public void truncate(long size)
              throws IOException

Description copied from class: CheckedFileIO

Truncate file channel to given size based on relative position. This method first truncates the file channel and then re-calculates the checksum for the entire file

Specified by:

truncate in class CheckedFileIO

Parameters:

size - The new size of file channel

Throws:

IOException - If any I/O error occurs

flush

public void flush()
           throws IOException

Description copied from class: CheckedFileIO

Flush method is used to flush the file onto storage. This method also writes the super block header before the flush to ensure consistency during re-open

Specified by:

flush in class CheckedFileIO

Throws:

IOException - If any I/O error occurs

close

public void close()
           throws IOException

Description copied from class: CheckedFileIO

Closes the file channel

Specified by:

close in interface AutoCloseable

Specified by:

close in class CheckedFileIO

Throws:

IOException - If any I/O error occurs

toString

public String toString()

Overrides:

toString in class Object