com.cs.software.engine

Class FrameworkBase

java.lang.Object

com.cs.software.engine.FrameworkBase

All Implemented Interfaces:

FrameworkIntf, Serializable

Direct Known Subclasses:

ConnectionPool, JDCConnection, PoolMgr, Queue, QueueMgr, ThreadMgr

public class FrameworkBase
extends Object
implements FrameworkIntf

This class is used for all services which need to be monitored

Author:

Steve Crombie

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	active
protected MessageIntf	initMessage
protected long	inProcess
protected JVMService	jvmService
protected boolean	running
protected MessageIntf	serviceData
protected long	totalErrors
protected long	totalMessages
protected long	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

Constructor Summary

Constructors

Constructor and Description
FrameworkBase() Construct - creates a new ServiceBase object

Method Summary

Modifier and Type	Method and Description
void	addInProcess() This method will add 1 to the total message in process.
void	addTotalErrorNumber() This method will add 1 to the total error number.
void	addTotalMsgNumber() This method will add 1 to the total message received.
void	addTotalProcessed() This method will add 1 to the total number of message processed.
void	deRegister() This method is called to de-register the service
void	deRegister(FrameworkIntf aFramework) This method is called to de-register the service
void	doEventMessage(MessageIntf aData) This method is called to send the service event message
void	doMessage(MessageIntf aData) This method is called to send the service status message
int	getDefError()
long	getInProcess() This method will return the Total Number of Messages in process.
String	getJvmId()
FrameworkIntf	getJvmService()
String	getName() This method is called to send a snapshot of performance data
FrameworkIntf	getService() This method will return the Service interface
MessageIntf	getServiceData() This method will return the Service data interface
String	getServiceName() This method will return the Server Name
MessageIntf	getStats() This method is called to send a snapshot of performance data
long	getTotalErrorNumber() This method will return the Total Number of Errors processed.
long	getTotalMsgNumber() This method will return the Total Number of Messages received.
long	getTotalProcessed() This method will return the Total Number of Messages processed.
void	initMessage(MessageIntf aData)
boolean	isActive()
boolean	isRunning()
void	register() This method is called to register the service
void	register(FrameworkIntf aFramework) This method is called to register the service
void	resetTotals()
void	setActive(boolean aFlag)
void	setRunning(boolean aFlag)
void	setServiceData(MessageIntf aData) This method will set the Service Data interface Must be called to allow messages to be broadcast, and to be monitored, Clustering, Etc.
void	subtractInProcess() This method will add 1 to the total message in process.

Methods inherited from class java.lang.Object

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

Field Detail

jvmService

protected JVMService jvmService

serviceData

protected MessageIntf serviceData

initMessage

protected MessageIntf initMessage

totalMessages

protected long totalMessages

totalErrors

protected long totalErrors

inProcess

protected long inProcess

totalProcessed

protected long totalProcessed

running

protected boolean running

active

protected boolean active

Constructor Detail

FrameworkBase

public FrameworkBase()

Construct - creates a new ServiceBase object

Method Detail

getServiceName

public String getServiceName()

This method will return the Server Name

Returns:

String Server Name

getService

public FrameworkIntf getService()

This method will return the Service interface

Returns:

ServiceIntf Service Interface

getServiceData

public MessageIntf getServiceData()

This method will return the Service data interface

Returns:

ServiceDataIntf Service Data Interface

setServiceData

public void setServiceData(MessageIntf aData)

This method will set the Service Data interface Must be called to allow messages to be broadcast, and to be monitored, Clustering, Etc.

Parameters:

aData - ServiceDataIntf Service Data

register

public void register()

This method is called to register the service

deRegister

public void deRegister()

This method is called to de-register the service

getJvmService

public FrameworkIntf getJvmService()

Specified by:

getJvmService in interface FrameworkIntf

getJvmId

public String getJvmId()

Specified by:

getJvmId in interface FrameworkIntf

isRunning

public boolean isRunning()

Specified by:

isRunning in interface FrameworkIntf

setRunning

public void setRunning(boolean aFlag)

Specified by:

setRunning in interface FrameworkIntf

isActive

public boolean isActive()

Specified by:

isActive in interface FrameworkIntf

setActive

public void setActive(boolean aFlag)

Specified by:

setActive in interface FrameworkIntf

getTotalErrorNumber

public long getTotalErrorNumber()

This method will return the Total Number of Errors processed.

Specified by:

getTotalErrorNumber in interface FrameworkIntf

Returns:

long Total Number of Messages

addTotalErrorNumber

public void addTotalErrorNumber()

This method will add 1 to the total error number.

Specified by:

addTotalErrorNumber in interface FrameworkIntf

getTotalProcessed

public long getTotalProcessed()

This method will return the Total Number of Messages processed.

Specified by:

getTotalProcessed in interface FrameworkIntf

Returns:

long Total Number of Messages

addTotalProcessed

public void addTotalProcessed()

This method will add 1 to the total number of message processed.

Specified by:

addTotalProcessed in interface FrameworkIntf

getInProcess

public long getInProcess()

This method will return the Total Number of Messages in process.

Specified by:

getInProcess in interface FrameworkIntf

Returns:

long Total Number of Messages in process

addInProcess

public void addInProcess()

This method will add 1 to the total message in process.

Specified by:

addInProcess in interface FrameworkIntf

subtractInProcess

public void subtractInProcess()

This method will add 1 to the total message in process.

Specified by:

subtractInProcess in interface FrameworkIntf

getTotalMsgNumber

public long getTotalMsgNumber()

This method will return the Total Number of Messages received.

Specified by:

getTotalMsgNumber in interface FrameworkIntf

Returns:

long Total Number of Messages received

addTotalMsgNumber

public void addTotalMsgNumber()

This method will add 1 to the total message received.

Specified by:

addTotalMsgNumber in interface FrameworkIntf

resetTotals

public void resetTotals()

Specified by:

resetTotals in interface FrameworkIntf

getName

public String getName()

This method is called to send a snapshot of performance data

Specified by:

getName in interface FrameworkIntf

register

public void register(FrameworkIntf aFramework)

Description copied from interface: FrameworkIntf

This method is called to register the service

Specified by:

register in interface FrameworkIntf

Parameters:

aFramework - ServerBaseIntf Service Object

initMessage

public void initMessage(MessageIntf aData)
                 throws Exception

Specified by:

initMessage in interface FrameworkIntf

Throws:

Exception

deRegister

public void deRegister(FrameworkIntf aFramework)

Description copied from interface: FrameworkIntf

This method is called to de-register the service

Specified by:

deRegister in interface FrameworkIntf

Parameters:

aFramework - ServerBaseIntf Service Object

doMessage

public void doMessage(MessageIntf aData)

Description copied from interface: FrameworkIntf

This method is called to send the service status message

Specified by:

doMessage in interface FrameworkIntf

Parameters:

aData - ServiceDataintf Service Data

doEventMessage

public void doEventMessage(MessageIntf aData)

Description copied from interface: FrameworkIntf

This method is called to send the service event message

Specified by:

doEventMessage in interface FrameworkIntf

Parameters:

aData - ServiceDataintf Service Data

getStats

public MessageIntf getStats()

Description copied from interface: FrameworkIntf

This method is called to send a snapshot of performance data

Specified by:

getStats in interface FrameworkIntf

Returns:

message

getDefError

public int getDefError()