io.axual.common.resolver

Interface TopicResolver

All Superinterfaces:

org.apache.kafka.common.Configurable, Resolver

All Known Implementing Classes:

TopicPatternResolver

public interface TopicResolver
extends Resolver

A topic resolver can translate Kafka topic names from an application's internal representation to one found externally (or "physically") on Kafka clusters. The conversion from internal to external representation is done through resolveTopic(String) and similar calls. The reverse is done through {link #unresolveTopic(String)} and similar calls.

Field Summary

Fields inherited from interface io.axual.common.resolver.Resolver

DEFAULT_PREFIX

Method Summary

Modifier and Type	Method and Description
java.lang.String	resolveTopic(java.lang.String topic) Translates the internal representation of topic name to the external one.
org.apache.kafka.common.TopicPartition	resolveTopic(org.apache.kafka.common.TopicPartition topicPartition) Translates the internal representation of topic name to the external one.
java.util.Set<org.apache.kafka.common.TopicPartition>	resolveTopicPartitions(java.util.Collection<org.apache.kafka.common.TopicPartition> topicPartitions) Translates the internal representation of topic partitions to the external ones.
java.util.regex.Pattern	resolveTopicPattern(java.util.regex.Pattern pattern) Translates the internal representation of topic pattern to the external one.
java.util.Set<java.lang.String>	resolveTopics(java.util.Collection<java.lang.String> topics) Translates the internal representation of topic names to the external ones.
<V> java.util.Map<org.apache.kafka.common.TopicPartition,V>	resolveTopics(java.util.Map<org.apache.kafka.common.TopicPartition,V> topicPartitionMap) Translates the internal representation of a topic partition map to the external one.
java.lang.String	unresolveTopic(java.lang.String topic) Translates the external representation of topic name to the internal one.
org.apache.kafka.common.TopicPartition	unresolveTopic(org.apache.kafka.common.TopicPartition topicPartition) Translates the external representation of topic partition to the internal one.
java.util.Set<org.apache.kafka.common.TopicPartition>	unresolveTopicPartitions(java.util.Collection<org.apache.kafka.common.TopicPartition> topicPartitions) Translates the external representation of topic partitions to the internal ones.
java.util.Set<java.lang.String>	unresolveTopics(java.util.Collection<java.lang.String> topics) Translates the external representation of topic names to the internal ones.
<V> java.util.Map<org.apache.kafka.common.TopicPartition,V>	unresolveTopics(java.util.Map<org.apache.kafka.common.TopicPartition,V> topicPartitionMap) Translates the external representation of topic partition to the internal one.

Methods inherited from interface io.axual.common.resolver.Resolver

configure, getNameFromContext, resolve, unresolve, unresolveContext

Method Detail

resolveTopic

java.lang.String resolveTopic(java.lang.String topic)

Translates the internal representation of topic name to the external one.

Parameters:

topic - the application's internal topic name

Returns:

the external representation of the topic

resolveTopicPattern

java.util.regex.Pattern resolveTopicPattern(java.util.regex.Pattern pattern)

Translates the internal representation of topic pattern to the external one.

Parameters:

pattern - the application's internal topic pattern

Returns:

the external representation of the topic pattern

resolveTopic

org.apache.kafka.common.TopicPartition resolveTopic(org.apache.kafka.common.TopicPartition topicPartition)

Translates the internal representation of topic name to the external one.

Parameters:

topicPartition - the application's internal topic partition

Returns:

the external representation of the topic partition

resolveTopics

java.util.Set<java.lang.String> resolveTopics(java.util.Collection<java.lang.String> topics)

Translates the internal representation of topic names to the external ones.

Parameters:

topics - the application's internal topic names

Returns:

the external representation of the topics

resolveTopicPartitions

java.util.Set<org.apache.kafka.common.TopicPartition> resolveTopicPartitions(java.util.Collection<org.apache.kafka.common.TopicPartition> topicPartitions)

Translates the internal representation of topic partitions to the external ones.

Parameters:

topicPartitions - the application's internal topic partitions

Returns:

the external representation of the topic partitions

resolveTopics

<V> java.util.Map<org.apache.kafka.common.TopicPartition,V> resolveTopics(java.util.Map<org.apache.kafka.common.TopicPartition,V> topicPartitionMap)

Translates the internal representation of a topic partition map to the external one.

Type Parameters:

V - any type used as Value in the Map

Parameters:

topicPartitionMap - the map containing the application's internal topic partitions as Keys

Returns:

the map containing the external representation of the topic partitions as Keys

unresolveTopic

java.lang.String unresolveTopic(java.lang.String topic)

Translates the external representation of topic name to the internal one.

Parameters:

topic - the external topic name

Returns:

the internal consumer topic name

unresolveTopic

org.apache.kafka.common.TopicPartition unresolveTopic(org.apache.kafka.common.TopicPartition topicPartition)

Translates the external representation of topic partition to the internal one.

Parameters:

topicPartition - the external topic partition

Returns:

the internal consumer topic partition

unresolveTopics

java.util.Set<java.lang.String> unresolveTopics(java.util.Collection<java.lang.String> topics)

Translates the external representation of topic names to the internal ones.

Parameters:

topics - the external topic names

Returns:

the internal consumer topic names

unresolveTopicPartitions

java.util.Set<org.apache.kafka.common.TopicPartition> unresolveTopicPartitions(java.util.Collection<org.apache.kafka.common.TopicPartition> topicPartitions)

Translates the external representation of topic partitions to the internal ones.

Parameters:

topicPartitions - the external topic partitions

Returns:

the internal consumer topic partitions

unresolveTopics

<V> java.util.Map<org.apache.kafka.common.TopicPartition,V> unresolveTopics(java.util.Map<org.apache.kafka.common.TopicPartition,V> topicPartitionMap)

Translates the external representation of topic partition to the internal one.

Type Parameters:

V - any type used as Value in the Map

Parameters:

topicPartitionMap - the map containing the application's external topic partitions as keys

Returns:

the map containing the internal representation of the topic partitions as keys