org.opendaylight.infrautils.jobcoordinator.internal

Class JobCoordinatorImpl

java.lang.Object

org.opendaylight.infrautils.jobcoordinator.internal.JobCoordinatorImpl

All Implemented Interfaces:

JobCoordinator, JobCoordinatorMonitor

@Singleton
 @OsgiServiceProvider(classes={JobCoordinator.class,JobCoordinatorMonitor.class})
public class JobCoordinatorImpl
extends Object
implements JobCoordinator, JobCoordinatorMonitor

Field Summary

Fields inherited from interface org.opendaylight.infrautils.jobcoordinator.JobCoordinator

DEFAULT_MAX_RETRIES

Constructor Summary

Constructors

Constructor and Description
JobCoordinatorImpl() Deprecated. This no-arg constructor (and related changes) temporarily allowing a JobCoordinatorImpl without specifying a global shared MetricProvider will be removed again as soon as https://git.opendaylight.org/gerrit/#/c/67516/ and https://git.opendaylight.org/gerrit/#/c/67641/ are finally merged...
JobCoordinatorImpl(MetricProvider metricProvider)

Method Summary

Modifier and Type	Method and Description
void	destroy()
void	enqueueJob(String key, Callable<List<com.google.common.util.concurrent.ListenableFuture<Void>>> mainWorker) Enqueues a job with DEFAULT_MAX_RETRIES (3) retries.
void	enqueueJob(String key, Callable<List<com.google.common.util.concurrent.ListenableFuture<Void>>> mainWorker, int maxRetries) Enqueues a job with max retries.
void	enqueueJob(String key, Callable<List<com.google.common.util.concurrent.ListenableFuture<Void>>> mainWorker, RollbackCallable rollbackWorker) Enqueues a job with a rollback task and DEFAULT_MAX_RETRIES (3) retries..
void	enqueueJob(String key, Callable<List<com.google.common.util.concurrent.ListenableFuture<Void>>> mainWorker, RollbackCallable rollbackWorker, int maxRetries) Enqueues a job with a rollback task and max retries.
long	getClearedTaskCount() Returns the cleared task count.
long	getCreatedTaskCount() Returns the created task count.
long	getExecuteAttempts() Returns the job execution attempts.
long	getFailedJobCount() Returns the failed jobs count.
long	getIncompleteTaskCount() Returns the incomplete task count.
protected Thread	getJobQueueHandlerThread()
long	getPendingTaskCount() Returns the pending task count.
long	getRetriesCount() Returns the retry jobs count.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JobCoordinatorImpl

@Deprecated
public JobCoordinatorImpl()

Deprecated. This no-arg constructor (and related changes) temporarily allowing a JobCoordinatorImpl without specifying a global shared MetricProvider will be removed again as soon as https://git.opendaylight.org/gerrit/#/c/67516/ and https://git.opendaylight.org/gerrit/#/c/67641/ are finally merged...

Deprecated constructor with ugly temporary hack.

JobCoordinatorImpl

@Inject
public JobCoordinatorImpl(MetricProvider metricProvider)

Method Detail

destroy

@PreDestroy
public void destroy()

enqueueJob

public void enqueueJob(String key,
                       Callable<List<com.google.common.util.concurrent.ListenableFuture<Void>>> mainWorker)

Description copied from interface: JobCoordinator

Enqueues a job with DEFAULT_MAX_RETRIES (3) retries.

Specified by:

enqueueJob in interface JobCoordinator

Parameters:

key - The job's key. Jobs with the same key are run sequentially. Jobs with different keys are run in parallel.

mainWorker - The task that runs for the job.

enqueueJob

public void enqueueJob(String key,
                       Callable<List<com.google.common.util.concurrent.ListenableFuture<Void>>> mainWorker,
                       RollbackCallable rollbackWorker)

Description copied from interface: JobCoordinator

Enqueues a job with a rollback task and DEFAULT_MAX_RETRIES (3) retries..

Specified by:

enqueueJob in interface JobCoordinator

rollbackWorker - The rollback task which runs in case the job's main task fails.

See Also:

JobCoordinator.enqueueJob(String, Callable)

enqueueJob

public void enqueueJob(String key,
                       Callable<List<com.google.common.util.concurrent.ListenableFuture<Void>>> mainWorker,
                       int maxRetries)

Description copied from interface: JobCoordinator

Enqueues a job with max retries. In case the job's main task fails, it will be retried until it succeeds or the specified maximum number of retries has been reached.

Specified by:

enqueueJob in interface JobCoordinator

maxRetries - The maximum number of retries for the job's main task until it succeeds.

See Also:

JobCoordinator.enqueueJob(String, Callable)

enqueueJob

public void enqueueJob(String key,
                       Callable<List<com.google.common.util.concurrent.ListenableFuture<Void>>> mainWorker,
                       @Nullable
                       RollbackCallable rollbackWorker,
                       int maxRetries)

Description copied from interface: JobCoordinator

Enqueues a job with a rollback task and max retries.

Specified by:

enqueueJob in interface JobCoordinator

rollbackWorker - The rollback task which runs in case the job's main task fails.

maxRetries - The maximum number of retries for the job's main task until it succeeds.

See Also:

JobCoordinator.enqueueJob(String, Callable, RollbackCallable), JobCoordinator.enqueueJob(String, Callable, int)

getClearedTaskCount

public long getClearedTaskCount()

Description copied from interface: JobCoordinatorMonitor

Returns the cleared task count.

Specified by:

getClearedTaskCount in interface JobCoordinatorMonitor

getCreatedTaskCount

public long getCreatedTaskCount()

Description copied from interface: JobCoordinatorMonitor

Returns the created task count.

Specified by:

getCreatedTaskCount in interface JobCoordinatorMonitor

getIncompleteTaskCount

public long getIncompleteTaskCount()

Description copied from interface: JobCoordinatorMonitor

Returns the incomplete task count.

Specified by:

getIncompleteTaskCount in interface JobCoordinatorMonitor

getPendingTaskCount

public long getPendingTaskCount()

Description copied from interface: JobCoordinatorMonitor

Returns the pending task count.

Specified by:

getPendingTaskCount in interface JobCoordinatorMonitor

getFailedJobCount

public long getFailedJobCount()

Description copied from interface: JobCoordinatorMonitor

Returns the failed jobs count.

Specified by:

getFailedJobCount in interface JobCoordinatorMonitor

getRetriesCount

public long getRetriesCount()

Description copied from interface: JobCoordinatorMonitor

Returns the retry jobs count.

Specified by:

getRetriesCount in interface JobCoordinatorMonitor

getExecuteAttempts

public long getExecuteAttempts()

Description copied from interface: JobCoordinatorMonitor

Returns the job execution attempts.

Specified by:

getExecuteAttempts in interface JobCoordinatorMonitor

getJobQueueHandlerThread

protected Thread getJobQueueHandlerThread()

toString

public String toString()

Specified by:

toString in interface JobCoordinatorMonitor

Overrides:

toString in class Object