kafka.tier.tools

Class RecoveryUtils

java.lang.Object

kafka.tier.tools.RecoveryUtils

public class RecoveryUtils
extends Object

Provides a set of static functions for recovery related tooling.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPARISON_TOOL_INPUT
static String	COMPARISON_TOOL_INPUT_DOC
static String	COMPARISON_TOOL_OUTPUT
static String	COMPARISON_TOOL_OUTPUT_DOC
static String	FENCE_TARGET_PARTITIONS_CONFIG_FILE_FORMAT
static String	TIER_PROPERTIES_CONFIG_FILE
static String	TIER_PROPERTIES_CONFIG_FILE_DOC

Constructor Summary

Constructors

Constructor and Description
RecoveryUtils()

Method Summary

Modifier and Type	Method and Description
static org.apache.kafka.clients.producer.Producer<byte[],byte[]>	createTierTopicProducer(Properties properties, String clientId) Create and return a new TierTopic Producer object.
static int	getNumPartitions(org.apache.kafka.clients.producer.Producer<byte[],byte[]> producer, String topicName) Discovers and returns the number of partitions in the provided topicName.
static org.apache.kafka.clients.producer.RecordMetadata	injectTierTopicEvent(org.apache.kafka.clients.producer.Producer<byte[],byte[]> producer, AbstractTierMetadata event, String tierTopicName, int numTierTopicPartitions) Injects an event into the TierTopic, using the provided TierTopic producer object.
static String	makeArgument(String arg)
static Map<TopicIdPartition,Boolean>	parseFencingInformation(List<String> allPartitionsFencingInfo) Converts a list of formatted TopicIdPartition strings to a list of TopicIdPartition.
static void	validatePartitions(Properties properties, Set<org.apache.kafka.common.TopicPartition> inputPartitions)

Methods inherited from class java.lang.Object

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

Field Detail

TIER_PROPERTIES_CONFIG_FILE

public static final String TIER_PROPERTIES_CONFIG_FILE

See Also:

Constant Field Values

TIER_PROPERTIES_CONFIG_FILE_DOC

public static final String TIER_PROPERTIES_CONFIG_FILE_DOC

See Also:

Constant Field Values

COMPARISON_TOOL_INPUT

public static final String COMPARISON_TOOL_INPUT

See Also:

Constant Field Values

COMPARISON_TOOL_INPUT_DOC

public static final String COMPARISON_TOOL_INPUT_DOC

See Also:

Constant Field Values

COMPARISON_TOOL_OUTPUT

public static final String COMPARISON_TOOL_OUTPUT

See Also:

Constant Field Values

COMPARISON_TOOL_OUTPUT_DOC

public static final String COMPARISON_TOOL_OUTPUT_DOC

See Also:

Constant Field Values

FENCE_TARGET_PARTITIONS_CONFIG_FILE_FORMAT

public static final String FENCE_TARGET_PARTITIONS_CONFIG_FILE_FORMAT

See Also:

Constant Field Values

Constructor Detail

RecoveryUtils

public RecoveryUtils()

Method Detail

getNumPartitions

public static int getNumPartitions(org.apache.kafka.clients.producer.Producer<byte[],byte[]> producer,
                                   String topicName)

Discovers and returns the number of partitions in the provided topicName.

Parameters:

topicName - the name of the topic (should be non-empty and valid)

Returns:

the number of partitions in the provided topicName.

createTierTopicProducer

public static org.apache.kafka.clients.producer.Producer<byte[],byte[]> createTierTopicProducer(Properties properties,
                                                                                                String clientId)

Create and return a new TierTopic Producer object.

Parameters:

properties - properties object to pass to the producer

clientId - the client ID to be used to construct the producer

Returns:

a newly created TierTopic producer object

injectTierTopicEvent

public static org.apache.kafka.clients.producer.RecordMetadata injectTierTopicEvent(org.apache.kafka.clients.producer.Producer<byte[],byte[]> producer,
                                                                                    AbstractTierMetadata event,
                                                                                    String tierTopicName,
                                                                                    int numTierTopicPartitions)
                                                                             throws InterruptedException,
                                                                                    ExecutionException

Injects an event into the TierTopic, using the provided TierTopic producer object.

Parameters:

producer - the TierTopic producer object

event - the event to be injected into the TierTopic

tierTopicName - the name of the TierTopic

numTierTopicPartitions - the number of TierTopic partitions

Returns:

the RecordMetadata obtained after successfully producing the event into the TierTopic

Throws:

InterruptedException - if there was an error in producing the event

ExecutionException - if there was an error in producing the event

parseFencingInformation

public static Map<TopicIdPartition,Boolean> parseFencingInformation(List<String> allPartitionsFencingInfo)

Converts a list of formatted TopicIdPartition strings to a list of TopicIdPartition. Each item in the input list should be a CSV string according to the format described at RecoveryUtils.FENCE_TARGET_PARTITIONS_CONFIG_FILE_FORMAT

Parameters:

allPartitionsFencingInfo - the list of formatted TopicIdPartition strings

Returns:

a map of TopicIdPartition -> freezeMergedLogStartOffset

makeArgument

public static String makeArgument(String arg)

validatePartitions

public static void validatePartitions(Properties properties,
                                      Set<org.apache.kafka.common.TopicPartition> inputPartitions)
                               throws CancellationException,
                                      IllegalArgumentException

Throws:

CancellationException

IllegalArgumentException