org.apache.flink.streaming.runtime.partitioner.CustomPartitionerWrapper Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of flink-streaming-java Show documentation
There is a newer version: 1.19.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.flink.streaming.runtime.partitioner;

import org.apache.flink.annotation.Internal;
import org.apache.flink.api.common.functions.Partitioner;
import org.apache.flink.api.java.functions.KeySelector;
import org.apache.flink.runtime.io.network.api.writer.SubtaskStateMapper;
import org.apache.flink.runtime.plugable.SerializationDelegate;
import org.apache.flink.streaming.runtime.streamrecord.StreamRecord;
import org.apache.flink.util.InstantiationUtil;

import java.io.IOException;
import java.util.Objects;

/**
 * Partitioner that selects the channel with a user defined partitioner function on a key.
 *
 * @param  Type of the key
 * @param  Type of the data
 */
@Internal
public class CustomPartitionerWrapper extends StreamPartitioner {
    private static final long serialVersionUID = 1L;

    Partitioner partitioner;
    KeySelector keySelector;

    public CustomPartitionerWrapper(Partitioner partitioner, KeySelector keySelector) {
        this.partitioner = partitioner;
        this.keySelector = keySelector;
    }

    @Override
    public int selectChannel(SerializationDelegate> record) {
        K key;
        try {
            key = keySelector.getKey(record.getInstance().getValue());
        } catch (Exception e) {
            throw new RuntimeException("Could not extract key from " + record.getInstance(), e);
        }

        return partitioner.partition(key, numberOfChannels);
    }

    @Override
    public SubtaskStateMapper getDownstreamSubtaskStateMapper() {
        // fully rely on filtering downstream
        // note that custom partitioners are not officially supported - the user has to force
        // rescaling in that case, we assume that the custom partitioner is deterministic
        return SubtaskStateMapper.FULL;
    }

    @Override
    public StreamPartitioner copy() {
        try {
            // clone partitioner to ensure that any internal state is also replicated
            return new CustomPartitionerWrapper<>(
                    InstantiationUtil.clone(partitioner), keySelector);
        } catch (ClassNotFoundException | IOException e) {
            throw new IllegalStateException("Cannot clone custom partitioner", e);
        }
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        final CustomPartitionerWrapper that = (CustomPartitionerWrapper) o;
        return numberOfChannels == that.numberOfChannels
                && Objects.equals(partitioner, that.partitioner)
                && Objects.equals(keySelector, that.keySelector);
    }

    @Override
    public int hashCode() {
        return Objects.hash(super.hashCode(), partitioner, keySelector);
    }

    @Override
    public boolean isPointwise() {
        return false;
    }

    @Override
    public String toString() {
        return "CUSTOM";
    }
}