TopicFactory.java

/**
 * Copyright 2016 LinkedIn Corp. 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.
 */
package com.linkedin.kmf.topicfactory;

import java.util.Properties;


/**
 * Constructs the monitor topic if it does not exist.
 *
 * Implementations of this class should have a public constructor with the following signature: <br/>
 *   Constructor(Map<String, ?> config) where config are additional configuration parameters passed in from the Kafka
 *   Monitor configuration.
 */
public interface TopicFactory {

  /**
   * Creates the specified topic if it does not exist.
   * @param zkUrl zookeeper connection url
   * @param topic topic name
   * @param replicationFactor the replication factor for the topic
   * @param partitionToBrokerRatio This is multiplied by the number brokers to compute the number of partitions in the topic.
   * @param topicProperties topic specific properties, for example where you would set min.insync.replicas.  Unfortunately
   *                        the underlying createTopic() uses Properties and not Map<String, ?>.
   * @return The number of partitions for the specified topic.
   */

  int createTopicIfNotExist(String zkUrl, String topic, int replicationFactor, double partitionToBrokerRatio, Properties topicProperties);

}