com.varra.util

Class SafeThread

java.lang.Object

com.varra.util.SafeThread

All Implemented Interfaces:

TimerTaskReceiver, Runnable

Direct Known Subclasses:

GlobalThread

@InterfaceAudience.Public
 @InterfaceStability.Evolving
public class SafeThread
extends Object
implements Runnable, TimerTaskReceiver

An Synchronized RealTime Event storing and processing thread. It will be very helpful in replacing the existing thread implementations, can be used in any context. It receives the events from the different sources and be processed based on the business logic provided.
It Provides the successful event execution guaranteed with the help of a thread pool. It will not miss even a single event from the execution.
Use onTimerTask(EnhancedTimerTask) to add an event to this thread for execution.
It has backing with a synchronized FIFOQueue to store and to execute.
It automatically be in waiting mode if doesn't have packful of events, else execute them and clears the Queue.
Also provides notifications interested in the events based on their execution/completion status
@see TimerTaskListener
Use addTimerTaskListener(TimerTaskListener, Class) to register for notifications.
Use removeTimerTaskListener(TimerTaskListener, Class) to unregister from notifications.

Version:

1.0

Author:

Rajakrishna V. Reddy

Constructor Summary

Constructors

Constructor and Description
SafeThread(ExecutorService threadPool) Instantiates a new safe thread.
SafeThread(String name, ExecutorService threadPool) Instantiates a new safe thread.

Method Summary

Modifier and Type	Method and Description
boolean	addTimerTaskListener(TimerTaskListener listener, Class<? extends EnhancedTimerTask> type) Adds the timer task listener.
long	getInterval() Gets the interval.
Map<Class<? extends EnhancedTimerTask>,TimerTaskListener>	getListeners() Gets the listeners.
boolean	isRunning() Checks if it is running.
void	onTimerTask(EnhancedTimerTask timerTask) Updates the processing Engine with the EnhancedTimerTask, and it should be a light weight implementation and synchronized.
boolean	removeTimerTaskListener(TimerTaskListener listener, Class<? extends EnhancedTimerTask> type) Removes the timer task listener.
void	run()
void	setInterval(long interval) Sets the interval.
void	shutdown() Shutdowns the backGround SafeThread.
void	start() Causes this thread to begin execution;.
void	stop() Forces the thread to stop executing.

Methods inherited from class java.lang.Object

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

Constructor Detail

SafeThread

public SafeThread(ExecutorService threadPool)

Instantiates a new safe thread.

Parameters:

threadPool - the thread pool

SafeThread

public SafeThread(String name,
                  ExecutorService threadPool)

Instantiates a new safe thread.

Parameters:

name - the name

threadPool - the thread pool

Method Detail

start

public void start()

Causes this thread to begin execution;.

stop

public void stop()

Forces the thread to stop executing.

isRunning

public boolean isRunning()

Checks if it is running.

Returns:

the isRunning

shutdown

public void shutdown()

Shutdowns the backGround SafeThread.

getListeners

public Map<Class<? extends EnhancedTimerTask>,TimerTaskListener> getListeners()

Gets the listeners.

Returns:

the tasks

addTimerTaskListener

public boolean addTimerTaskListener(TimerTaskListener listener,
                                    Class<? extends EnhancedTimerTask> type)

Adds the timer task listener.

Parameters:

listener - the listener

type - the type

Returns:

true, if successful

removeTimerTaskListener

public boolean removeTimerTaskListener(TimerTaskListener listener,
                                       Class<? extends EnhancedTimerTask> type)

Removes the timer task listener.

Parameters:

listener - the listener

type - the type

Returns:

true, if successful

onTimerTask

public void onTimerTask(EnhancedTimerTask timerTask)

Description copied from interface: TimerTaskReceiver

Updates the processing Engine with the EnhancedTimerTask, and it should be a light weight implementation and synchronized.

Specified by:

onTimerTask in interface TimerTaskReceiver

Parameters:

timerTask - the timer task

setInterval

public void setInterval(long interval)

Sets the interval.

Parameters:

interval - the interval to set

getInterval

public long getInterval()

Gets the interval.

Returns:

the interval

run

public void run()

Specified by:

run in interface Runnable