org.apache.kafka.connect.mirror

Class RemoteClusterUtils

java.lang.Object

org.apache.kafka.connect.mirror.RemoteClusterUtils

public final class RemoteClusterUtils
extends java.lang.Object

Convenience methods for multi-cluster environments. Wraps MirrorClient (@see MirrorClient).

Properties passed to these methods are used to construct internal Admin and Consumer clients. Sub-configs like "admin.xyz" are also supported. For example:

      bootstrap.servers = host1:9092
      consumer.client.id = mm2-client
  

See Also:

for additional properties used by the internal MirrorClient.

Method Summary

Modifier and Type	Method and Description
static java.util.Set<java.lang.String>	checkpointTopics(java.util.Map<java.lang.String,java.lang.Object> properties) Find all checkpoint topics
static java.util.Set<java.lang.String>	heartbeatTopics(java.util.Map<java.lang.String,java.lang.Object> properties) Find all heartbeat topics
static int	replicationHops(java.util.Map<java.lang.String,java.lang.Object> properties, java.lang.String upstreamClusterAlias) Find shortest number of hops from an upstream cluster.
static java.util.Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndMetadata>	translateOffsets(java.util.Map<java.lang.String,java.lang.Object> properties, java.lang.String remoteClusterAlias, java.lang.String consumerGroupId, java.time.Duration timeout) Translate a remote consumer group's offsets into corresponding local offsets.
static java.util.Set<java.lang.String>	upstreamClusters(java.util.Map<java.lang.String,java.lang.Object> properties) Find all upstream clusters

Methods inherited from class java.lang.Object

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

Method Detail

replicationHops

public static int replicationHops(java.util.Map<java.lang.String,java.lang.Object> properties,
                                  java.lang.String upstreamClusterAlias)
                           throws java.lang.InterruptedException,
                                  java.util.concurrent.TimeoutException

Find shortest number of hops from an upstream cluster. Returns -1 if the cluster is unreachable

Throws:

java.lang.InterruptedException

java.util.concurrent.TimeoutException

heartbeatTopics

public static java.util.Set<java.lang.String> heartbeatTopics(java.util.Map<java.lang.String,java.lang.Object> properties)
                                                       throws java.lang.InterruptedException,
                                                              java.util.concurrent.TimeoutException

Find all heartbeat topics

Throws:

java.lang.InterruptedException

java.util.concurrent.TimeoutException

checkpointTopics

public static java.util.Set<java.lang.String> checkpointTopics(java.util.Map<java.lang.String,java.lang.Object> properties)
                                                        throws java.lang.InterruptedException,
                                                               java.util.concurrent.TimeoutException

Find all checkpoint topics

Throws:

java.lang.InterruptedException

java.util.concurrent.TimeoutException

upstreamClusters

public static java.util.Set<java.lang.String> upstreamClusters(java.util.Map<java.lang.String,java.lang.Object> properties)
                                                        throws java.lang.InterruptedException,
                                                               java.util.concurrent.TimeoutException

Find all upstream clusters

Throws:

java.lang.InterruptedException

java.util.concurrent.TimeoutException

translateOffsets

public static java.util.Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndMetadata> translateOffsets(java.util.Map<java.lang.String,java.lang.Object> properties,
                                                                                                                                         java.lang.String remoteClusterAlias,
                                                                                                                                         java.lang.String consumerGroupId,
                                                                                                                                         java.time.Duration timeout)
                                                                                                                                  throws java.lang.InterruptedException,
                                                                                                                                         java.util.concurrent.TimeoutException

Translate a remote consumer group's offsets into corresponding local offsets. Topics are automatically renamed according to the ReplicationPolicy.

Parameters:

properties - @see MirrorClientConfig

consumerGroupId - group ID of remote consumer group

remoteClusterAlias - alias of remote cluster

timeout - timeout

Throws:

java.lang.InterruptedException

java.util.concurrent.TimeoutException