org.apache.flink.runtime.resourcemanager

Class JobLeaderIdService

java.lang.Object

org.apache.flink.runtime.resourcemanager.JobLeaderIdService

public class JobLeaderIdService
extends Object

Service which retrieves for a registered job the current job leader id (the leader id of the job manager responsible for the job). The leader id will be exposed as a future via the getLeaderId(JobID). The future will only be completed with an exception in case the service will be stopped.

Constructor Summary

Constructors

Constructor and Description
JobLeaderIdService(HighAvailabilityServices highAvailabilityServices, ScheduledExecutor scheduledExecutor, Time jobTimeout)

Method Summary

Modifier and Type	Method and Description
void	addJob(JobID jobId) Add a job to be monitored to retrieve the job leader id.
void	clear() Stop and clear the currently registered job leader id listeners.
boolean	containsJob(JobID jobId) Check whether the given job is being monitored or not.
CompletableFuture<JobMasterId>	getLeaderId(JobID jobId)
boolean	isStarted() Checks whether the service has been started.
boolean	isValidTimeout(JobID jobId, UUID timeoutId)
void	removeJob(JobID jobId) Remove the given job from being monitored by the service.
void	start(JobLeaderIdActions initialJobLeaderIdActions) Start the service with the given job leader actions.
void	stop() Stop the service.

Methods inherited from class java.lang.Object

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

Constructor Detail

JobLeaderIdService

public JobLeaderIdService(HighAvailabilityServices highAvailabilityServices,
                          ScheduledExecutor scheduledExecutor,
                          Time jobTimeout)
                   throws Exception

Throws:

Exception

Method Detail

start

public void start(JobLeaderIdActions initialJobLeaderIdActions)
           throws Exception

Start the service with the given job leader actions.

Parameters:

initialJobLeaderIdActions - to use for job leader id actions

Throws:

Exception - which is thrown when clearing up old state

stop

public void stop()
          throws Exception

Stop the service.

Throws:

Exception - which is thrown in case a retrieval service cannot be stopped properly

isStarted

public boolean isStarted()

Checks whether the service has been started.

Returns:

True if the service has been started; otherwise false

clear

public void clear()
           throws Exception

Stop and clear the currently registered job leader id listeners.

Throws:

Exception - which is thrown in case a retrieval service cannot be stopped properly

addJob

public void addJob(JobID jobId)
            throws Exception

Add a job to be monitored to retrieve the job leader id.

Parameters:

jobId - identifying the job to monitor

Throws:

Exception - if the job could not be added to the service

removeJob

public void removeJob(JobID jobId)
               throws Exception

Remove the given job from being monitored by the service.

Parameters:

jobId - identifying the job to remove from monitor

Throws:

Exception - if removing the job fails

containsJob

public boolean containsJob(JobID jobId)

Check whether the given job is being monitored or not.

Parameters:

jobId - identifying the job

Returns:

True if the job is being monitored; otherwise false

getLeaderId

public CompletableFuture<JobMasterId> getLeaderId(JobID jobId)
                                           throws Exception

Throws:

Exception

isValidTimeout

public boolean isValidTimeout(JobID jobId,
                              UUID timeoutId)