Package org.apache.flink.runtime.highavailability

Class AbstractThreadsafeJobResultStore

java.lang.Object

org.apache.flink.runtime.highavailability.AbstractThreadsafeJobResultStore

All Implemented Interfaces:

JobResultStore

Direct Known Subclasses:

EmbeddedJobResultStore, FileSystemJobResultStore

public abstract class AbstractThreadsafeJobResultStore
extends Object
implements JobResultStore

An abstract class for threadsafe implementations of the JobResultStore.

Constructor Summary

Constructors

Constructor	Description
AbstractThreadsafeJobResultStore()

Method Summary

Modifier and Type	Method	Description
void	createDirtyResult(JobResultEntry jobResultEntry)	Registers the passed JobResultEntry instance as dirty which indicates that clean-up operations still need to be performed.
protected abstract void	createDirtyResultInternal(JobResultEntry jobResultEntry)
Set<JobResult>	getDirtyResults()	Get the persisted JobResult instances that are marked as dirty.
protected abstract Set<JobResult>	getDirtyResultsInternal()
boolean	hasCleanJobResultEntry(org.apache.flink.api.common.JobID jobId)	Returns whether the store already contains a clean entry for the given JobID.
protected abstract boolean	hasCleanJobResultEntryInternal(org.apache.flink.api.common.JobID jobId)
boolean	hasDirtyJobResultEntry(org.apache.flink.api.common.JobID jobId)	Returns whether the store already contains a dirty entry for the given JobID.
protected abstract boolean	hasDirtyJobResultEntryInternal(org.apache.flink.api.common.JobID jobId)
boolean	hasJobResultEntry(org.apache.flink.api.common.JobID jobId)	Returns whether the store already contains an entry for a job.
void	markResultAsClean(org.apache.flink.api.common.JobID jobId)	Marks an existing JobResultEntry as clean.
protected abstract void	markResultAsCleanInternal(org.apache.flink.api.common.JobID jobId)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractThreadsafeJobResultStore

public AbstractThreadsafeJobResultStore()

Method Detail

createDirtyResult

public void createDirtyResult(JobResultEntry jobResultEntry)
                       throws IOException

Description copied from interface: JobResultStore

Registers the passed JobResultEntry instance as dirty which indicates that clean-up operations still need to be performed. Once the job resource cleanup has been finalized, we can mark the JobResultEntry as clean result using JobResultStore.markResultAsClean(JobID).

Specified by:

createDirtyResult in interface JobResultStore

Parameters:

jobResultEntry - The job result we wish to persist.

Throws:

IOException - if the creation of the dirty result failed for IO reasons.

createDirtyResultInternal

protected abstract void createDirtyResultInternal(JobResultEntry jobResultEntry)
                                           throws IOException

Throws:

IOException

markResultAsClean

public void markResultAsClean(org.apache.flink.api.common.JobID jobId)
                       throws IOException,
                              NoSuchElementException

Description copied from interface: JobResultStore

Marks an existing JobResultEntry as clean. This indicates that no more resource cleanup steps need to be performed. No actions should be triggered if the passed JobID belongs to a job that was already marked as clean.

Specified by:

markResultAsClean in interface JobResultStore

Parameters:

jobId - Ident of the job we wish to mark as clean.

Throws:

IOException - if marking the dirty JobResultEntry as clean failed for IO reasons.

NoSuchElementException - if there is no corresponding dirty job present in the store for the given JobID.

markResultAsCleanInternal

protected abstract void markResultAsCleanInternal(org.apache.flink.api.common.JobID jobId)
                                           throws IOException,
                                                  NoSuchElementException

Throws:

IOException

NoSuchElementException

hasJobResultEntry

public boolean hasJobResultEntry(org.apache.flink.api.common.JobID jobId)
                          throws IOException

Description copied from interface: JobResultStore

Returns whether the store already contains an entry for a job.

Specified by:

hasJobResultEntry in interface JobResultStore

Parameters:

jobId - Ident of the job we wish to check the store for.

Returns:

true if a dirty or clean JobResultEntry exists for the given JobID; otherwise false.

Throws:

IOException - if determining whether a job entry is present in the store failed for IO reasons.

hasDirtyJobResultEntry

public boolean hasDirtyJobResultEntry(org.apache.flink.api.common.JobID jobId)
                               throws IOException

Description copied from interface: JobResultStore

Returns whether the store already contains a dirty entry for the given JobID.

Specified by:

hasDirtyJobResultEntry in interface JobResultStore

Parameters:

jobId - Ident of the job we wish to check the store for.

Returns:

true, if a dirty entry exists for the given JobID; otherwise false.

Throws:

IOException - if determining whether a job entry is present in the store failed for IO reasons.

hasDirtyJobResultEntryInternal

protected abstract boolean hasDirtyJobResultEntryInternal(org.apache.flink.api.common.JobID jobId)
                                                   throws IOException

Throws:

IOException

hasCleanJobResultEntry

public boolean hasCleanJobResultEntry(org.apache.flink.api.common.JobID jobId)
                               throws IOException

Description copied from interface: JobResultStore

Returns whether the store already contains a clean entry for the given JobID.

Specified by:

hasCleanJobResultEntry in interface JobResultStore

Parameters:

jobId - Ident of the job we wish to check the store for.

Returns:

true, if a clean entry exists for the given JobID; otherwise false.

Throws:

IOException - if determining whether a job entry is present in the store failed for IO reasons.

hasCleanJobResultEntryInternal

protected abstract boolean hasCleanJobResultEntryInternal(org.apache.flink.api.common.JobID jobId)
                                                   throws IOException

Throws:

IOException

getDirtyResults

public Set<JobResult> getDirtyResults()
                               throws IOException

Description copied from interface: JobResultStore

Get the persisted JobResult instances that are marked as dirty. This is useful for recovery of finalization steps.

Specified by:

getDirtyResults in interface JobResultStore

Returns:

A set of dirty JobResults from the store.

Throws:

IOException - if collecting the set of dirty results failed for IO reasons.

getDirtyResultsInternal

protected abstract Set<JobResult> getDirtyResultsInternal()
                                                   throws IOException

Throws:

IOException