Package org.apache.hadoop.hdfs.server.datanode

Class BlockMetadataHeader

java.lang.Object

org.apache.hadoop.hdfs.server.datanode.BlockMetadataHeader

@Private
@Evolving
public class BlockMetadataHeader
extends java.lang.Object

BlockMetadataHeader manages metadata for data blocks on Datanodes. This is not related to the Block related functionality in Namenode. The biggest part of data block metadata is CRC for the block.

Field Summary

Fields

Modifier and Type	Field	Description
static short	VERSION

Constructor Summary

Constructors

Constructor	Description
BlockMetadataHeader(short version, org.apache.hadoop.util.DataChecksum checksum)

Method Summary

Modifier and Type	Method	Description
org.apache.hadoop.util.DataChecksum	getChecksum()	Get the checksum
static int	getHeaderSize()	Returns the size of the header
short	getVersion()	Get the version
static BlockMetadataHeader	preadHeader(java.nio.channels.FileChannel fc)	Read the header without changing the position of the FileChannel.
static org.apache.hadoop.util.DataChecksum	readDataChecksum(java.io.DataInputStream metaIn, java.lang.Object name)	Read the checksum header from the meta input stream.
static org.apache.hadoop.util.DataChecksum	readDataChecksum(java.io.FileInputStream inputStream, int bufSize, java.io.File metaFile)	Read the checksum header from the meta file.
static BlockMetadataHeader	readHeader(java.io.DataInputStream in)	This reads all the fields till the beginning of checksum.
static BlockMetadataHeader	readHeader(java.io.FileInputStream fis)	Reads header at the top of metadata file and returns the header.
static BlockMetadataHeader	readHeader(java.io.RandomAccessFile raf)	Read the header at the beginning of the given block meta file.
static void	writeHeader(java.io.DataOutputStream out, BlockMetadataHeader header)	This writes all the fields till the beginning of checksum.
static void	writeHeader(java.io.DataOutputStream out, org.apache.hadoop.util.DataChecksum checksum)	Writes all the fields till the beginning of checksum.

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final short VERSION

See Also:

Constant Field Values

Constructor Detail

BlockMetadataHeader

@VisibleForTesting
public BlockMetadataHeader(short version,
                           org.apache.hadoop.util.DataChecksum checksum)

Method Detail

getVersion

public short getVersion()

Get the version

getChecksum

public org.apache.hadoop.util.DataChecksum getChecksum()

Get the checksum

readDataChecksum

public static org.apache.hadoop.util.DataChecksum readDataChecksum(java.io.FileInputStream inputStream,
                                                                   int bufSize,
                                                                   java.io.File metaFile)
                                                            throws java.io.IOException

Read the checksum header from the meta file. inputStream must be closed by the caller.

Returns:

the data checksum obtained from the header.

Throws:

java.io.IOException

readDataChecksum

public static org.apache.hadoop.util.DataChecksum readDataChecksum(java.io.DataInputStream metaIn,
                                                                   java.lang.Object name)
                                                            throws java.io.IOException

Read the checksum header from the meta input stream.

Returns:

the data checksum obtained from the header.

Throws:

java.io.IOException

preadHeader

public static BlockMetadataHeader preadHeader(java.nio.channels.FileChannel fc)
                                       throws java.io.IOException

Read the header without changing the position of the FileChannel. This is used by the client for short-circuit reads.

Parameters:

fc - The FileChannel to read.

Returns:

the Metadata Header.

Throws:

java.io.IOException - on error.

readHeader

public static BlockMetadataHeader readHeader(java.io.DataInputStream in)
                                      throws java.io.IOException

This reads all the fields till the beginning of checksum.

Returns:

Metadata Header

Throws:

java.io.IOException

readHeader

public static BlockMetadataHeader readHeader(java.io.FileInputStream fis)
                                      throws java.io.IOException

Reads header at the top of metadata file and returns the header. Closes the input stream after reading the header.

Returns:

metadata header for the block

Throws:

java.io.IOException

readHeader

public static BlockMetadataHeader readHeader(java.io.RandomAccessFile raf)
                                      throws java.io.IOException

Read the header at the beginning of the given block meta file. The current file position will be altered by this method. If an error occurs, the file is not closed.

Throws:

java.io.IOException

writeHeader

@VisibleForTesting
public static void writeHeader(java.io.DataOutputStream out,
                               BlockMetadataHeader header)
                        throws java.io.IOException

This writes all the fields till the beginning of checksum.

Parameters:

out - DataOutputStream

Throws:

java.io.IOException

writeHeader

public static void writeHeader(java.io.DataOutputStream out,
                               org.apache.hadoop.util.DataChecksum checksum)
                        throws java.io.IOException

Writes all the fields till the beginning of checksum.

Throws:

java.io.IOException - on error

getHeaderSize

public static int getHeaderSize()

Returns the size of the header