org.apache.kafka.streams.processor.TopicNameExtractor Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of kafka-streams Show documentation

There is a newer version: 3.8.0

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.kafka.streams.processor;

/**
 * An interface that allows to dynamically determine the name of the Kafka topic to send at the sink node of the topology.
 */
public interface TopicNameExtractor {

    /**
     * Extracts the topic name to send to. The topic name must already exist, since the Kafka Streams library will not
     * try to automatically create the topic with the extracted name.
     *
     * @param key           the record key
     * @param value         the record value
     * @param recordContext current context metadata of the record
     * @return              the topic name this record should be sent to
     */
    String extract(final K key, final V value, final RecordContext recordContext);
}