JobLeaderIdActions.java

/*
 * 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.resourcemanager;

import org.apache.flink.api.common.JobID;

import java.util.UUID;

/**
 * Interface for actions called by the {@link JobLeaderIdService}.
 */
public interface JobLeaderIdActions {

	/**
	 * Callback when a monitored job leader lost its leadership.
	 *
	 * @param jobId identifying the job whose leader lost leadership
	 * @param oldJobLeaderId of the job manager which lost leadership
	 */
	void jobLeaderLostLeadership(JobID jobId, UUID oldJobLeaderId);

	/**
	 * Notify a job timeout. The job is identified by the given JobID. In order to check
	 * for the validity of the timeout the timeout id of the triggered timeout is provided.
	 *
	 * @param jobId JobID which identifies the timed out job
	 * @param timeoutId Id of the calling timeout to differentiate valid from invalid timeouts
	 */
	void notifyJobTimeout(JobID jobId, UUID timeoutId);

	/**
	 * Callback to report occurring errors.
	 *
	 * @param error which has occurred
	 */
	void handleError(Throwable error);
}