/*
 * 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.flink.streaming.connectors.kafka.partitioner;

import java.io.Serializable;

/**
 * A partitioner ensuring that each internal Flink partition ends up in one Kafka partition.
 *
 * Note, one Kafka partition can contain multiple Flink partitions.
 *
 * Cases:
 * 	# More Flink partitions than kafka partitions
 * <pre>
 * 		Flink Sinks:		Kafka Partitions
 * 			1	---------------->	1
 * 			2   --------------/
 * 			3   -------------/
 * 			4	------------/
 * </pre>
 * Some (or all) kafka partitions contain the output of more than one flink partition
 *
 *# Fewer Flink partitions than Kafka
 * <pre>
 * 		Flink Sinks:		Kafka Partitions
 * 			1	---------------->	1
 * 			2	---------------->	2
 * 										3
 * 										4
 * 										5
 * </pre>
 *
 *  Not all Kafka partitions contain data
 *  To avoid such an unbalanced partitioning, use a round-robin kafka partitioner. (note that this will
 *  cause a lot of network connections between all the Flink instances and all the Kafka brokers
 *
 *
 */
public class FixedPartitioner<T> extends KafkaPartitioner<T> implements Serializable {
	private static final long serialVersionUID = 1627268846962918126L;

	private int targetPartition = -1;

	@Override
	public void open(int parallelInstanceId, int parallelInstances, int[] partitions) {
		if (parallelInstanceId < 0 || parallelInstances <= 0 || partitions.length == 0) {
			throw new IllegalArgumentException();
		}
		
		this.targetPartition = partitions[parallelInstanceId % partitions.length];
	}

	@Override
	public int partition(T next, byte[] serializedKey, byte[] serializedValue, int numPartitions) {
		if (targetPartition >= 0) {
			return targetPartition;
		} else {
			throw new RuntimeException("The partitioner has not been initialized properly");
		}
	}
}