org.apache.flink.runtime.highavailability.JobResultStore Maven / Gradle / Ivy

Go to download
/*
 * 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.runtime.highavailability;

import org.apache.flink.annotation.Internal;
import org.apache.flink.api.common.JobID;
import org.apache.flink.runtime.jobmaster.JobResult;

import java.io.IOException;
import java.util.NoSuchElementException;
import java.util.Set;

/**
 * A storage for the results of globally terminated jobs. These results can have the following
 * states:
 *
 * 
 *   {@code dirty} - indicating that the corresponding job is not properly cleaned up, yet.
 *   
{@code clean} - indicating that the cleanup of the corresponding job is performed and no
 *       further actions need to be applied.
 * 
 */
@Internal
public interface JobResultStore {

    /**
     * Registers the passed {@link JobResultEntry} instance as {@code dirty} which indicates that
     * clean-up operations still need to be performed. Once the job resource cleanup has been
     * finalized, we can mark the {@code JobResultEntry} as {@code clean} result using {@link
     * #markResultAsClean(JobID)}.
     *
     * @param jobResultEntry The job result we wish to persist.
     * @throws IOException if the creation of the dirty result failed for IO reasons.
     * @throws IllegalStateException if the passed {@code jobResultEntry} has a {@code JobID}
     *     attached that is already registered in this {@code JobResultStore}.
     */
    void createDirtyResult(JobResultEntry jobResultEntry) throws IOException, IllegalStateException;

    /**
     * Marks an existing {@link JobResultEntry} as {@code clean}. This indicates that no more
     * resource cleanup steps need to be performed. No actions should be triggered if the passed
     * {@code JobID} belongs to a job that was already marked as clean.
     *
     * @param jobId Ident of the job we wish to mark as clean.
     * @throws IOException if marking the {@code dirty} {@code JobResultEntry} as {@code clean}
     *     failed for IO reasons.
     * @throws NoSuchElementException if there is no corresponding {@code dirty} job present in the
     *     store for the given {@code JobID}.
     */
    void markResultAsClean(JobID jobId) throws IOException, NoSuchElementException;

    /**
     * Returns whether the store already contains an entry for a job.
     *
     * @param jobId Ident of the job we wish to check the store for.
     * @return {@code true} if a {@code dirty} or {@code clean} {@link JobResultEntry} exists for
     *     the given {@code JobID}; otherwise {@code false}.
     * @throws IOException if determining whether a job entry is present in the store failed for IO
     *     reasons.
     */
    default boolean hasJobResultEntry(JobID jobId) throws IOException {
        return hasDirtyJobResultEntry(jobId) || hasCleanJobResultEntry(jobId);
    }

    /**
     * Returns whether the store already contains a {@code dirty} entry for the given {@code JobID}.
     *
     * @param jobId Ident of the job we wish to check the store for.
     * @return {@code true}, if a {@code dirty} entry exists for the given {@code JobID}; otherwise
     *     {@code false}.
     * @throws IOException if determining whether a job entry is present in the store failed for IO
     *     reasons.
     */
    boolean hasDirtyJobResultEntry(JobID jobId) throws IOException;

    /**
     * Returns whether the store already contains a {@code clean} entry for the given {@code JobID}.
     *
     * @param jobId Ident of the job we wish to check the store for.
     * @return {@code true}, if a {@code clean} entry exists for the given {@code JobID}; otherwise
     *     {@code false}.
     * @throws IOException if determining whether a job entry is present in the store failed for IO
     *     reasons.
     */
    boolean hasCleanJobResultEntry(JobID jobId) throws IOException;

    /**
     * Get the persisted {@link JobResult} instances that are marked as {@code dirty}. This is
     * useful for recovery of finalization steps.
     *
     * @return A set of dirty {@code JobResults} from the store.
     * @throws IOException if collecting the set of dirty results failed for IO reasons.
     */
    Set getDirtyResults() throws IOException;
}