org.apache.flink.runtime.scheduler.stopwithsavepoint

Class StopWithSavepointTerminationHandlerImpl

java.lang.Object

org.apache.flink.runtime.scheduler.stopwithsavepoint.StopWithSavepointTerminationHandlerImpl

All Implemented Interfaces:

StopWithSavepointTerminationHandler

public class StopWithSavepointTerminationHandlerImpl
extends Object
implements StopWithSavepointTerminationHandler

StopWithSavepointTerminationHandlerImpl implements StopWithSavepointTerminationHandler.

The operation only succeeds if both steps, the savepoint creation and the successful termination of the job, succeed. If the former step fails, the operation fails exceptionally without any further actions. If the latter one fails, a global fail-over is triggered before failing the operation.

The implementation expects the savepoint creation being completed before the executions terminate.

See Also:

StopWithSavepointTerminationManager

Constructor Summary

Constructors

Constructor and Description
StopWithSavepointTerminationHandlerImpl(JobID jobId, S schedulerWithCheckpointing, org.slf4j.Logger log)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<String>	getSavepointPath() Returns the a CompletableFuture referring to the result of the stop-with-savepoint operation.
void	handleExecutionsTermination(Collection<ExecutionState> terminatedExecutionStates) Handles the termination of the job based on the passed terminated ExecutionStates.
void	handleSavepointCreation(CompletedCheckpoint completedSavepoint, Throwable throwable) Handles the result of a CompletableFuture holding a CompletedCheckpoint.

Methods inherited from class java.lang.Object

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

Constructor Detail

StopWithSavepointTerminationHandlerImpl

public StopWithSavepointTerminationHandlerImpl(JobID jobId,
                                               S schedulerWithCheckpointing,
                                               org.slf4j.Logger log)

Method Detail

getSavepointPath

public CompletableFuture<String> getSavepointPath()

Description copied from interface: StopWithSavepointTerminationHandler

Returns the a CompletableFuture referring to the result of the stop-with-savepoint operation.

Specified by:

getSavepointPath in interface StopWithSavepointTerminationHandler

Returns:

the CompletableFuture containing the path to the created savepoint in case of success.

handleSavepointCreation

public void handleSavepointCreation(CompletedCheckpoint completedSavepoint,
                                    Throwable throwable)

Description copied from interface: StopWithSavepointTerminationHandler

Handles the result of a CompletableFuture holding a CompletedCheckpoint. Only one of the two parameters are allowed to be set.

Specified by:

handleSavepointCreation in interface StopWithSavepointTerminationHandler

Parameters:

completedSavepoint - the CompletedCheckpoint referring to the created savepoint

throwable - an error that was caught during savepoint creation

handleExecutionsTermination

public void handleExecutionsTermination(Collection<ExecutionState> terminatedExecutionStates)

Description copied from interface: StopWithSavepointTerminationHandler

Handles the termination of the job based on the passed terminated ExecutionStates. stop-with-savepoint expects the terminatedExecutionStates to only contain ExecutionState.FINISHED to succeed.

Specified by:

handleExecutionsTermination in interface StopWithSavepointTerminationHandler

Parameters:

terminatedExecutionStates - The terminated ExecutionStates of the underlying job.