com.cs.software.engine.threadpool

Class ThreadMgr

java.lang.Object

com.cs.software.engine.FrameworkBase

com.cs.software.engine.threadpool.ThreadMgr

All Implemented Interfaces:

FrameworkIntf, Serializable

public class ThreadMgr
extends FrameworkBase

This class ThreadMgr is used to manager all Pool Managers.

Author:

Steve Crombie

See Also:

Serialized Form

Field Summary

Fields inherited from class com.cs.software.engine.FrameworkBase

active, initMessage, inProcess, jvmService, running, serviceData, totalErrors, totalMessages, totalProcessed

Fields inherited from interface com.cs.software.api.FrameworkIntf

CATEGROY_ADAPTER, CATEGROY_APP, CATEGROY_DB_CON, CATEGROY_DB_POOL, CATEGROY_ENGINE, CATEGROY_MODULE, CATEGROY_POOL_MGR, CATEGROY_QUEUE, CATEGROY_THREAD_MGR, CATEGROY_WORKER, COMMAND_DEREGISTER_KEY, COMMAND_PAUSE, COMMAND_REGISTER_KEY, COMMAND_RESTART, COMMAND_SHUTDOWN, COMMAND_START, COMMAND_STOP, FLAG_FALSE, FLAG_TRUE, PARAM_JVM_STR, PARAM_JVMID_STR, PARAM_SERVERNAME_STR, PARAM_SERVICEACTIVE_STR, PARAM_SERVICECATAGORY_STR, PARAM_SERVICENAME_STR, PARAM_SERVICERUNNING_STR, TYPE_CLUSTER, TYPE_DISPLAY_STR, TYPE_EVENT, TYPE_JVM, TYPE_JVM_STR, TYPE_MAX, TYPE_SERVER, TYPE_SERVICE

Method Summary

Modifier and Type	Method and Description
void	decrementThreadCount() This method will decrease the number of threads by one
int	getDefError()
String	getGroupName() This method will return the group name of this Thread Manager.
static ThreadMgr	getInstance() This method getInstance will return the instance (singleton) of Thread manager.
static ThreadMgr	getInstance(String aGroupName) This method getInstance will return the instance (singleton) of Thread manager by name.
PoolMgr	getPoolMgr(String aName) This method getPoolMgr will return the Pool Manager associated with the supplied name
List<PoolMgr>	getPoolMgrs() This method getPoolMgr will return the list of pool managers.
int	getThreadMax() Will return the maximum number of threads allowed to be used by all thread pools associated with this Thread Manager.
int	getTotalThreads() Will return the maximum number of threads allowed to be used by all thread pools associated with this Thread Manager.
MessageIntf	getTreadServiceData(String aName) This method will return a new ServiceData based on the suppplied serice name.
WorkerThread	getWorkerThread(PoolMgr aPoolMgr, String aName, Class<ServicesIntf> aWorkerClass) This method will return a worker thread from the pool manager.
void	reapThreads() This method is called by a cleanup thread to removed unused and inactive threads.
void	reapThreads(boolean aForce)
void	setGroupName(String aGroupName) This method will set the group name for this thread group.
void	setPoolMgr(String aName, String aClassName, int aMinPool, int aMaxPool, int aPriority) This method setPoolMgr willl add a new pool manager.
void	setThreadMax(int aMax) Will set the maximum number of threads allowed to be used by all thread pools associated with this Thread Manager
void	shutdown() This method is called to greacfully shutdown, stop the threads and free resources.
void	shutdownPoolMgr(String aPoolMgrName) This method is called to greacfully shutdown a Pool Manager by name
static void	shutdownThreadMgrs() This methdo will shutdown all thread managers

Methods inherited from class com.cs.software.engine.FrameworkBase

addInProcess, addTotalErrorNumber, addTotalMsgNumber, addTotalProcessed, deRegister, deRegister, doEventMessage, doMessage, getInProcess, getJvmId, getJvmService, getName, getService, getServiceData, getServiceName, getStats, getTotalErrorNumber, getTotalMsgNumber, getTotalProcessed, initMessage, isActive, isRunning, register, register, resetTotals, setActive, setRunning, setServiceData, subtractInProcess

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static ThreadMgr getInstance()

This method getInstance will return the instance (singleton) of Thread manager.

Returns:

a ThreadMgr Singleton Object

getInstance

public static ThreadMgr getInstance(String aGroupName)

This method getInstance will return the instance (singleton) of Thread manager by name.

Parameters:

aGroupName - a String Name of thread group

Returns:

a ThreadMgr Singleton Object by name

getGroupName

public String getGroupName()

This method will return the group name of this Thread Manager.

Returns:

a String The thread group name.

setGroupName

public void setGroupName(String aGroupName)

This method will set the group name for this thread group.

Parameters:

aGroupName - String Name of the Thread Group

getTreadServiceData

public MessageIntf getTreadServiceData(String aName)

This method will return a new ServiceData based on the suppplied serice name.

Parameters:

aName - string Service Name

Returns:

ServiceData New instance

setThreadMax

public void setThreadMax(int aMax)

Will set the maximum number of threads allowed to be used by all thread pools associated with this Thread Manager

Parameters:

aMax - int Maximum number of threads

getThreadMax

public int getThreadMax()

Will return the maximum number of threads allowed to be used by all thread pools associated with this Thread Manager.

Returns:

int Maximum number of threads

getTotalThreads

public int getTotalThreads()

Will return the maximum number of threads allowed to be used by all thread pools associated with this Thread Manager.

Returns:

int Maximum number of threads

getPoolMgr

public PoolMgr getPoolMgr(String aName)

This method getPoolMgr will return the Pool Manager associated with the supplied name

Parameters:

aName - a String Pool Manager Name

Returns:

a PoolMgr Pool Manager Object

getPoolMgrs

public List<PoolMgr> getPoolMgrs()

This method getPoolMgr will return the list of pool managers.

Returns:

a PoolMgr Array List of Pool Managers

setPoolMgr

public void setPoolMgr(String aName,
                       String aClassName,
                       int aMinPool,
                       int aMaxPool,
                       int aPriority)
                throws Exception

This method setPoolMgr willl add a new pool manager.

Parameters:

aName - a String Pool Manager Name

aClassName - a String Worker Class Name

aMinPool - an int Min Threads

aMaxPool - an int Max Threads

aPriority - an int Thread Priority

Throws:

Exception - ex

getWorkerThread

public WorkerThread getWorkerThread(PoolMgr aPoolMgr,
                                    String aName,
                                    Class<ServicesIntf> aWorkerClass)

This method will return a worker thread from the pool manager.

Parameters:

aPoolMgr - a PoolMgr Pool Manager Object

aName - a String Pool Manager Name

aWorkerClass - an Object Object used to initialize

Returns:

worker

decrementThreadCount

public void decrementThreadCount()

This method will decrease the number of threads by one

shutdownThreadMgrs

public static void shutdownThreadMgrs()

This methdo will shutdown all thread managers

shutdown

public void shutdown()

This method is called to greacfully shutdown, stop the threads and free resources.

shutdownPoolMgr

public void shutdownPoolMgr(String aPoolMgrName)

This method is called to greacfully shutdown a Pool Manager by name

Parameters:

aPoolMgrName - a String Pool Manager Name

reapThreads

public void reapThreads()

This method is called by a cleanup thread to removed unused and inactive threads.

reapThreads

public void reapThreads(boolean aForce)

getDefError

public int getDefError()

Overrides:

getDefError in class FrameworkBase