org.apache.flink.runtime.jobmaster

Class JobMasterServiceLeadershipRunner

java.lang.Object

org.apache.flink.runtime.jobmaster.JobMasterServiceLeadershipRunner

All Implemented Interfaces:

AutoCloseable, JobManagerRunner, LeaderContender, AutoCloseableAsync

public class JobMasterServiceLeadershipRunner
extends Object
implements JobManagerRunner, LeaderContender

Leadership runner for the JobMasterServiceProcess.

The responsibility of this component is to manage the leadership of the JobMasterServiceProcess. This means that the runner will create an instance of the process when it obtains the leadership. The process is stopped once the leadership is revoked.

This component only accepts signals (job result completion, initialization failure) as long as it is running and as long as the signals are coming from the current leader process. This ensures that only the current leader can affect this component.

All leadership operations are serialized. This means that granting the leadership has to complete before the leadership can be revoked and vice versa.

The resultFuture can be completed with the following values: * *

• JobManagerRunnerResult to signal an initialization failure of the JobMasterService or the completion of a job
• Exception to signal an unexpected failure

Constructor Summary

Constructors

Constructor and Description
JobMasterServiceLeadershipRunner(JobMasterServiceProcessFactory jobMasterServiceProcessFactory, LeaderElectionService leaderElectionService, JobResultStore jobResultStore, LibraryCacheManager.ClassLoaderLease classLoaderLease, FatalErrorHandler fatalErrorHandler)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Acknowledge>	cancel(Time timeout) Cancels the currently executed job.
CompletableFuture<Void>	closeAsync() Trigger the closing of the resource and return the corresponding close future.
JobID	getJobID() Get the job id of the executed job.
CompletableFuture<JobMasterGateway>	getJobMasterGateway() Get the JobMasterGateway of the JobMaster.
CompletableFuture<JobManagerRunnerResult>	getResultFuture() Get the result future of this runner.
void	grantLeadership(UUID leaderSessionID) Callback method which is called by the LeaderElectionService upon selecting this instance as the new leader.
void	handleError(Exception exception) Callback method which is called by LeaderElectionService in case of an error in the service thread.
boolean	isInitialized() Flag indicating if the JobManagerRunner has been initialized.
CompletableFuture<ExecutionGraphInfo>	requestJob(Time timeout) Requests the ExecutionGraphInfo of the executed job.
CompletableFuture<JobDetails>	requestJobDetails(Time timeout) Request the details of the executed job.
CompletableFuture<JobStatus>	requestJobStatus(Time timeout) Requests the current job status.
void	revokeLeadership() Callback method which is called by the LeaderElectionService upon revoking the leadership of a former leader.
void	start() Start the execution of the JobMaster.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.flink.util.AutoCloseableAsync

close

Methods inherited from interface org.apache.flink.runtime.leaderelection.LeaderContender

getDescription

Constructor Detail

JobMasterServiceLeadershipRunner

public JobMasterServiceLeadershipRunner(JobMasterServiceProcessFactory jobMasterServiceProcessFactory,
                                        LeaderElectionService leaderElectionService,
                                        JobResultStore jobResultStore,
                                        LibraryCacheManager.ClassLoaderLease classLoaderLease,
                                        FatalErrorHandler fatalErrorHandler)

Method Detail

closeAsync

public CompletableFuture<Void> closeAsync()

Description copied from interface: AutoCloseableAsync

Trigger the closing of the resource and return the corresponding close future.

Specified by:

closeAsync in interface AutoCloseableAsync

Returns:

Future which is completed once the resource has been closed

start

public void start()
           throws Exception

Description copied from interface: JobManagerRunner

Start the execution of the JobMaster.

Specified by:

start in interface JobManagerRunner

Throws:

Exception - if the JobMaster cannot be started

getJobMasterGateway

public CompletableFuture<JobMasterGateway> getJobMasterGateway()

Description copied from interface: JobManagerRunner

Get the JobMasterGateway of the JobMaster. The future is only completed if the JobMaster becomes leader.

Specified by:

getJobMasterGateway in interface JobManagerRunner

Returns:

Future with the JobMasterGateway once the underlying JobMaster becomes leader

getResultFuture

public CompletableFuture<JobManagerRunnerResult> getResultFuture()

Description copied from interface: JobManagerRunner

Get the result future of this runner. The future is completed once the executed job reaches a globally terminal state or if the initialization of the JobMaster fails. If the result future is completed exceptionally via JobNotFinishedException, then this signals that the job has not been completed successfully. All other exceptional completions denote an unexpected exception which leads to a process restart.

Specified by:

getResultFuture in interface JobManagerRunner

Returns:

Future which is completed with the job result

getJobID

public JobID getJobID()

Description copied from interface: JobManagerRunner

Get the job id of the executed job.

Specified by:

getJobID in interface JobManagerRunner

Returns:

job id of the executed job

cancel

public CompletableFuture<Acknowledge> cancel(Time timeout)

Description copied from interface: JobManagerRunner

Cancels the currently executed job.

Specified by:

cancel in interface JobManagerRunner

Parameters:

timeout - of this operation

Returns:

Future acknowledge of the operation

requestJobStatus

public CompletableFuture<JobStatus> requestJobStatus(Time timeout)

Description copied from interface: JobManagerRunner

Requests the current job status.

Specified by:

requestJobStatus in interface JobManagerRunner

Parameters:

timeout - for the rpc call

Returns:

Future containing the current job status

requestJobDetails

public CompletableFuture<JobDetails> requestJobDetails(Time timeout)

Description copied from interface: JobManagerRunner

Request the details of the executed job.

Specified by:

requestJobDetails in interface JobManagerRunner

Parameters:

timeout - for the rpc call

Returns:

Future details of the executed job

requestJob

public CompletableFuture<ExecutionGraphInfo> requestJob(Time timeout)

Description copied from interface: JobManagerRunner

Requests the ExecutionGraphInfo of the executed job.

Specified by:

requestJob in interface JobManagerRunner

Parameters:

timeout - for the rpc call

Returns:

Future which is completed with the ExecutionGraphInfo of the executed job

isInitialized

public boolean isInitialized()

Description copied from interface: JobManagerRunner

Flag indicating if the JobManagerRunner has been initialized.

Specified by:

isInitialized in interface JobManagerRunner

Returns:

true if the JobManagerRunner has been initialized.

grantLeadership

public void grantLeadership(UUID leaderSessionID)

Description copied from interface: LeaderContender

Callback method which is called by the LeaderElectionService upon selecting this instance as the new leader. The method is called with the new leader session ID.

Specified by:

grantLeadership in interface LeaderContender

Parameters:

leaderSessionID - New leader session ID

revokeLeadership

public void revokeLeadership()

Description copied from interface: LeaderContender

Callback method which is called by the LeaderElectionService upon revoking the leadership of a former leader. This might happen in case that multiple contenders have been granted leadership.

Specified by:

revokeLeadership in interface LeaderContender

handleError

public void handleError(Exception exception)

Description copied from interface: LeaderContender

Callback method which is called by LeaderElectionService in case of an error in the service thread.

Specified by:

handleError in interface LeaderContender

Parameters:

exception - Caught exception