com.stackify.api.common.concurrent

Class BackgroundService

java.lang.Object

com.stackify.api.common.concurrent.BackgroundService

Direct Known Subclasses:

LogBackgroundService

public abstract class BackgroundService
extends java.lang.Object

BackgroundService

Author:

Eric Martin

Constructor Summary

Constructors

Constructor and Description
BackgroundService()

Method Summary

Modifier and Type	Method and Description
protected abstract long	getNextScheduleDelayMilliseconds()
boolean	isRunning()
protected abstract void	runOneIteration() Run one iteration of the background service
protected abstract void	shutDown() Shut down the background service
void	start() Start the background service/thread
protected abstract void	startUp() Start the background service
void	stop() Stops the background service/thread

Methods inherited from class java.lang.Object

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

Constructor Detail

BackgroundService

public BackgroundService()

Method Detail

startUp

protected abstract void startUp()
                         throws java.lang.Exception

Start the background service

Throws:

java.lang.Exception

runOneIteration

protected abstract void runOneIteration()
                                 throws java.lang.Exception

Run one iteration of the background service

Throws:

java.lang.Exception

getNextScheduleDelayMilliseconds

protected abstract long getNextScheduleDelayMilliseconds()

Returns:

The next schedule delay (between iterations) in milliseconds

shutDown

protected abstract void shutDown()
                          throws java.lang.Exception

Shut down the background service

Throws:

java.lang.Exception

start

public void start()

Start the background service/thread

isRunning

public boolean isRunning()

Returns:

True if the background service is running, false otherwise

stop

public void stop()

Stops the background service/thread