io.streamnative.pulsar.handlers.kop.utils.KopTopic Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulsar-protocol-handler-kafka Show documentation
Kafka on Pulsar implemented using Pulsar Protocol Handler
There is a newer version: 3.3.1.5
Show newest version
/**
 * Copyright (c) 2019 - 2024 StreamNative, Inc.. All Rights Reserved.
 */
/**
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.streamnative.pulsar.handlers.kop.utils;

import static org.apache.kafka.common.internals.Topic.GROUP_METADATA_TOPIC_NAME;
import static org.apache.kafka.common.internals.Topic.TRANSACTION_STATE_TOPIC_NAME;
import static org.apache.pulsar.common.naming.TopicName.PARTITIONED_TOPIC_SUFFIX;

import io.streamnative.pulsar.handlers.kop.exceptions.KoPTopicException;
import java.util.function.Function;
import lombok.Getter;
import org.apache.kafka.common.TopicPartition;
import org.apache.pulsar.common.naming.TopicName;

/**
 * KopTopic maintains two topic name, one is the original topic name, the other is the full topic name used in Pulsar.
 * We shouldn't use the original topic name directly in KoP source code. Instead, we should
 *   1. getOriginalName() when read a Kafka request from client or write a Kafka response to client.
 *   2. getFullName() when access Pulsar resources.
 */
public class KopTopic {

    private static final String persistentDomain = "persistent://";

    /**
     * Convert the full topic name to the topic name.
     * When we list topics from Pulsar, the topic name is the full topic name like "persistent://tenant/ns/topic".
     * However, since we recommend users to use "topic" for topic names in the default namespace and "tenant/ns/topic"
     * in non-default namespaces
     *
     * @param fullTopicName the full topic name
     * @param defaultNamespace the default namespace
     * @return the topic name returned to Kafka clients
     */
    public static String convert(String fullTopicName, String defaultNamespace) {
        if (fullTopicName.startsWith(persistentDomain)) {
            fullTopicName = fullTopicName.substring(persistentDomain.length());
        }
        if (!defaultNamespace.endsWith("/")) {
            defaultNamespace = defaultNamespace + "/";
        }
        if (fullTopicName.startsWith(defaultNamespace)) {
            return fullTopicName.substring(defaultNamespace.length());
        } else {
            return fullTopicName;
        }
    }

    @Getter
    private final String originalName;
    @Getter
    private final String fullName;

    public static class KoPTopicIllegalArgumentException extends KoPTopicException {

        public KoPTopicIllegalArgumentException(String message) {
            super(message);
        }
    }

    public KopTopic(String topic, String namespacePrefix) {
        originalName = topic;
        fullName = expandToFullName(topic, namespacePrefix);
    }

    private String expandToFullName(String topic, String namespacePrefix) {
        if (topic.startsWith(persistentDomain)) {
            if (topic.substring(persistentDomain.length()).split("/").length != 3) {
                throw new KoPTopicIllegalArgumentException("Invalid topic name '" + topic + "', it should be "
                        + " persistent:////");
            }
            return topic;
        }

        String[] parts = topic.split("/");
        if (parts.length == 3) {
            return persistentDomain + topic;
        } else if (parts.length == 1 && namespacePrefix != null) {
            return persistentDomain + namespacePrefix + "/" + topic;
        } else {
            throw new KoPTopicIllegalArgumentException(
                    "Invalid short topic name '" + topic + "', it should be in the format"
                    + " of // or ");
        }
    }

    public String getPartitionName(int partition) {
        if (partition < 0) {
            throw new KoPTopicIllegalArgumentException(
                    "Invalid partition " + partition + ", it should be non-negative number");
        }
        return fullName + PARTITIONED_TOPIC_SUFFIX + partition;
    }

    public static boolean isFullTopicName(String topic) {
        return topic.startsWith(persistentDomain);
    }

    public static String toString(TopicPartition topicPartition, String namespacePrefix) {
        return (new KopTopic(topicPartition.topic(), namespacePrefix)).getPartitionName(topicPartition.partition());
    }

    public static String toString(String topic, int partition, String namespacePrefix) {
        return (new KopTopic(topic, namespacePrefix)).getPartitionName(partition);
    }

    private static boolean validateTopic(final String fullTopicName,
                                         final String namespace,
                                         final Function topicValidation) {
        final TopicName topicName = TopicName.get(fullTopicName);
        if (!topicName.getNamespacePortion().equals(namespace)) {
            return false;
        }

        final String localName = topicName.getLocalName();
        return topicValidation.apply(topicName.isPartitioned()
                ? localName.substring(0, localName.lastIndexOf(PARTITIONED_TOPIC_SUFFIX))
                : localName);
    }

    public static boolean isInternalTopic(final String fullTopicName, final String metadataNamespace) {
        return validateTopic(fullTopicName, metadataNamespace,
                topic -> topic.equals(GROUP_METADATA_TOPIC_NAME) || topic.equals(TRANSACTION_STATE_TOPIC_NAME));
    }

    public static boolean isGroupMetadataTopicName(final String fullTopicName, final String metadataNamespace) {
        return validateTopic(fullTopicName, metadataNamespace, topic -> topic.equals(GROUP_METADATA_TOPIC_NAME));
    }

    public static boolean isTransactionMetadataTopicName(final String fullTopicName, final String metadataNamespace) {
        return validateTopic(fullTopicName, metadataNamespace, topic -> topic.equals(TRANSACTION_STATE_TOPIC_NAME));
    }

}