org.apache.kafka.connect.mirror

Class MirrorClient

java.lang.Object

org.apache.kafka.connect.mirror.MirrorClient

All Implemented Interfaces:

AutoCloseable

public class MirrorClient
extends Object
implements AutoCloseable

Client to interact with MirrorMaker internal topics (checkpoints, heartbeats) on a given cluster. Whenever possible use the methods from RemoteClusterUtils instead of directly using MirrorClient.

Constructor Summary

Constructors

Constructor and Description
MirrorClient(Map<String,Object> props)
MirrorClient(MirrorClientConfig config)

Method Summary

Modifier and Type	Method and Description
Set<String>	checkpointTopics() Finds all checkpoints topics on this cluster.
void	close() Closes internal clients.
Set<String>	heartbeatTopics() Finds all heartbeats topics on this cluster.
Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndMetadata>	remoteConsumerOffsets(String consumerGroupId, String remoteClusterAlias, Duration timeout) Translates a remote consumer group's offsets into corresponding local offsets.
Set<String>	remoteTopics() Finds all remote topics on this cluster.
Set<String>	remoteTopics(String source) Finds all remote topics that have been replicated directly from the given source cluster.
int	replicationHops(String upstreamClusterAlias) Computes the shortest number of hops from an upstream source cluster.
ReplicationPolicy	replicationPolicy() Gets the ReplicationPolicy instance used to interpret remote topics.
Set<String>	upstreamClusters() Finds upstream clusters, which may be multiple hops away, based on incoming heartbeats.

Methods inherited from class java.lang.Object

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

Constructor Detail

MirrorClient

public MirrorClient(Map<String,Object> props)

MirrorClient

public MirrorClient(MirrorClientConfig config)

Method Detail

close

public void close()

Closes internal clients.

Specified by:

close in interface AutoCloseable

replicationPolicy

public ReplicationPolicy replicationPolicy()

Gets the ReplicationPolicy instance used to interpret remote topics. This instance is constructed based on relevant configuration properties, including replication.policy.class.

replicationHops

public int replicationHops(String upstreamClusterAlias)
                    throws InterruptedException

Computes the shortest number of hops from an upstream source cluster. For example, given replication flow A->B->C, there are two hops from A to C. Returns -1 if the upstream cluster is unreachable.

Throws:

InterruptedException

heartbeatTopics

public Set<String> heartbeatTopics()
                            throws InterruptedException

Finds all heartbeats topics on this cluster. Heartbeats topics are replicated from other clusters.

Throws:

InterruptedException

checkpointTopics

public Set<String> checkpointTopics()
                             throws InterruptedException

Finds all checkpoints topics on this cluster.

Throws:

InterruptedException

upstreamClusters

public Set<String> upstreamClusters()
                             throws InterruptedException

Finds upstream clusters, which may be multiple hops away, based on incoming heartbeats.

Throws:

InterruptedException

remoteTopics

public Set<String> remoteTopics()
                         throws InterruptedException

Finds all remote topics on this cluster. This does not include internal topics (heartbeats, checkpoints).

Throws:

InterruptedException

remoteTopics

public Set<String> remoteTopics(String source)
                         throws InterruptedException

Finds all remote topics that have been replicated directly from the given source cluster.

Throws:

InterruptedException

remoteConsumerOffsets

public Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndMetadata> remoteConsumerOffsets(String consumerGroupId,
                                                                                                                             String remoteClusterAlias,
                                                                                                                             Duration timeout)

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

Parameters:

consumerGroupId - The group ID of remote consumer group

remoteClusterAlias - The alias of remote cluster

timeout - The maximum time to block when consuming from the checkpoints topic