kafka.tier.state

Class ChecksumMigration

java.lang.Object

kafka.tier.state.ChecksumMigration

public class ChecksumMigration
extends Object

Constructor Summary

Constructors

Constructor and Description
ChecksumMigration()

Method Summary

Modifier and Type	Method and Description
static void	maybeMigrateChecksumFormat(Algorithm checksumAlgorithm, short checksumSuperBlockLength, Path path) maybeMigrateChecksumFormat is a helper util to migrate a given file path into the checksumAlgorithm file format.
static void	maybeRemovePreviousFormatPath(Path path) maybeRemovePreviousFormatPath is a helper util to delete (if exists) the previous format file.
static Path	previousFormatPath(Path path) previousFormatPath is a helper util to generate the path for previous format path.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChecksumMigration

public ChecksumMigration()

Method Detail

maybeMigrateChecksumFormat

public static void maybeMigrateChecksumFormat(Algorithm checksumAlgorithm,
                                              short checksumSuperBlockLength,
                                              Path path)
                                       throws IOException

maybeMigrateChecksumFormat is a helper util to migrate a given file path into the checksumAlgorithm file format. There can be four different cases based on the file present before migration (referred as previous file) (1) If the previous file is already in the desired format -> No migration performed (2) If there exists only one previous file in a different format (OtherChecksumType) -> Perform migration (3) If there exists multiple files in various formats (MultiChecksumType) -> Only keep the logically latest file (based on tier epoch, offset) and delete the other file -> Perform migration (if required) based on the logically latest file type (4) If there exists no file in any format -> Nothing done

Parameters:

checksumAlgorithm - the destination checksum algorithm to be migrated to

checksumSuperBlockLength - the checksum super block length for destination

path - the input file path

Throws:

IOException - If any I/O error occurs

previousFormatPath

public static Path previousFormatPath(Path path)

previousFormatPath is a helper util to generate the path for previous format path. if path in NO_CHECKSUM format (somePath/tierMetadata) -> ADLER format (somePath/tierMetadata.adler) if path in ADLER format (somePath/tierMetadata.adler) -> NO_CHECKSUM format (somePath/tierMetadata)

Parameters:

path - the input file path

Returns:

the expected older file path

maybeRemovePreviousFormatPath

public static void maybeRemovePreviousFormatPath(Path path)
                                          throws IOException

maybeRemovePreviousFormatPath is a helper util to delete (if exists) the previous format file. This method is typically called before open or openOrCreate to avoid MultiChecksumType exception.

Parameters:

path - the current file path

Throws:

IOException - If any I/O error occurs