org.apache.flink.streaming.runtime.operators.sink.StreamingGlobalCommitterOperator Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of flink-streaming-java_2.11 Show documentation
There is a newer version: 1.14.6
Show newest version
/*
 * 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.operators.sink;

import org.apache.flink.annotation.Internal;
import org.apache.flink.api.connector.sink.GlobalCommitter;
import org.apache.flink.core.io.SimpleVersionedSerializer;
import org.apache.flink.streaming.api.operators.BoundedOneInput;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

import static org.apache.flink.util.Preconditions.checkNotNull;

/**
 * Runtime {@link org.apache.flink.streaming.api.operators.StreamOperator} for executing {@link
 * GlobalCommitter} in the streaming execution mode.
 *
 * @param  The committable type of the {@link GlobalCommitter}.
 * @param  The global committable type of the {@link GlobalCommitter}.
 */
@Internal
public final class StreamingGlobalCommitterOperator
        extends AbstractStreamingCommitterOperator implements BoundedOneInput {

    /**
     * Aggregate committables to global committables and commit the global committables to the
     * external system.
     */
    private final GlobalCommitter globalCommitter;

    /**
     * The global committables that might need to be committed again after recovering from a
     * failover.
     */
    private final List recoveredGlobalCommittables;

    private boolean endOfInput;

    StreamingGlobalCommitterOperator(
            GlobalCommitter globalCommitter,
            SimpleVersionedSerializer committableSerializer) {
        super(committableSerializer);
        this.globalCommitter = checkNotNull(globalCommitter);

        this.recoveredGlobalCommittables = new ArrayList<>();
        this.endOfInput = false;
    }

    @Override
    void recoveredCommittables(List committables) throws IOException {
        final List recovered =
                globalCommitter.filterRecoveredCommittables(checkNotNull(committables));
        recoveredGlobalCommittables.addAll(recovered);
    }

    @Override
    List prepareCommit(List input) throws IOException {
        checkNotNull(input);
        final List result = new ArrayList<>(recoveredGlobalCommittables);
        recoveredGlobalCommittables.clear();

        if (!input.isEmpty()) {
            result.add(globalCommitter.combine(input));
        }
        return result;
    }

    @Override
    List commit(List committables) throws Exception {
        return globalCommitter.commit(checkNotNull(committables));
    }

    @Override
    public void endInput() {
        endOfInput = true;
    }

    @Override
    public void close() throws Exception {
        super.close();
        globalCommitter.close();
    }

    @Override
    public void notifyCheckpointComplete(long checkpointId) throws Exception {
        super.notifyCheckpointComplete(checkpointId);
        if (endOfInput) {
            globalCommitter.endOfInput();
        }
    }
}