FrameworkIntf (cssoftware-app 1.0.16 API)

All Superinterfaces:

Serializable

All Known Subinterfaces:

DataStoreIntf, EngineIntf, TransportIntf

All Known Implementing Classes:

ConnectionPool, DataFlowEngine, DataProcess, EngineBase, FrameworkBase, FrameworkBaseThread, JDCConnection, JVMService, KafkaReader, KafkaTransport, KafkaWriter, PoolMgr, Queue, QueueMgr, QueueReader, QueueTransport, QueueWriter, ThreadMgr, TimerEngine, WorkerThread, WorkerThreadQueue, WorkerThreadTransport
```
public interface FrameworkIntf
extends Serializable
```
This interface is used by all services for broadcasting Registration, Status, Event, Etc. type messages.

Author:

Steve Crombie

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CATEGROY_ADAPTER`
`static String`	`CATEGROY_APP`
`static String`	`CATEGROY_DB_CON`
`static String`	`CATEGROY_DB_POOL`
`static String`	`CATEGROY_ENGINE`
`static String`	`CATEGROY_MODULE`
`static String`	`CATEGROY_POOL_MGR`
`static String`	`CATEGROY_QUEUE`
`static String`	`CATEGROY_THREAD_MGR`
`static String`	`CATEGROY_WORKER`
`static String`	`COMMAND_DEREGISTER_KEY`
`static String`	`COMMAND_PAUSE`
`static String`	`COMMAND_REGISTER_KEY`
`static String`	`COMMAND_RESTART`
`static String`	`COMMAND_SHUTDOWN`
`static String`	`COMMAND_START`
`static String`	`COMMAND_STOP`
`static Boolean`	`FLAG_FALSE`
`static Boolean`	`FLAG_TRUE`
`static String`	`PARAM_JVM_STR`
`static String`	`PARAM_JVMID_STR`
`static String`	`PARAM_SERVERNAME_STR`
`static String`	`PARAM_SERVICEACTIVE_STR`
`static String`	`PARAM_SERVICECATAGORY_STR`
`static String`	`PARAM_SERVICENAME_STR`
`static String`	`PARAM_SERVICERUNNING_STR`
`static int`	`TYPE_CLUSTER`
`static String[]`	`TYPE_DISPLAY_STR`
`static int`	`TYPE_EVENT`
`static Integer`	`TYPE_JVM`
`static String`	`TYPE_JVM_STR`
`static int`	`TYPE_MAX`
`static int`	`TYPE_SERVER`
`static int`	`TYPE_SERVICE`

Method Summary

All Methods Instance Methods Abstract Methods
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(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
`long`	`getInProcess()` This method will return the Total Number of Messages in process.
`String`	`getJvmId()`
`FrameworkIntf`	`getJvmService()`
`String`	`getName()`
`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(FrameworkIntf aFramework)` This method is called to register the service
`void`	`resetTotals()`
`void`	`setActive(boolean aFlag)`
`void`	`setRunning(boolean aFlag)`
`void`	`subtractInProcess()` This method will add 1 to the total message in process.

- Field Detail
  - TYPE_JVM
```
static final Integer TYPE_JVM
```
  - TYPE_SERVER
```
static final int TYPE_SERVER
```
    See Also:
    
    Constant Field Values
  - TYPE_CLUSTER
```
static final int TYPE_CLUSTER
```
    See Also:
    
    Constant Field Values
  - TYPE_SERVICE
```
static final int TYPE_SERVICE
```
    See Also:
    
    Constant Field Values
  - TYPE_EVENT
```
static final int TYPE_EVENT
```
    See Also:
    
    Constant Field Values
  - TYPE_MAX
```
static final int TYPE_MAX
```
    See Also:
    
    Constant Field Values
  - TYPE_JVM_STR
```
static final String TYPE_JVM_STR
```
    See Also:
    
    Constant Field Values
  - PARAM_JVM_STR
```
static final String PARAM_JVM_STR
```
    See Also:
    
    Constant Field Values
  - PARAM_JVMID_STR
```
static final String PARAM_JVMID_STR
```
    See Also:
    
    Constant Field Values
  - PARAM_SERVICENAME_STR
```
static final String PARAM_SERVICENAME_STR
```
    See Also:
    
    Constant Field Values
  - PARAM_SERVICERUNNING_STR
```
static final String PARAM_SERVICERUNNING_STR
```
    See Also:
    
    Constant Field Values
  - PARAM_SERVICEACTIVE_STR
```
static final String PARAM_SERVICEACTIVE_STR
```
    See Also:
    
    Constant Field Values
  - PARAM_SERVICECATAGORY_STR
```
static final String PARAM_SERVICECATAGORY_STR
```
    See Also:
    
    Constant Field Values
  - PARAM_SERVERNAME_STR
```
static final String PARAM_SERVERNAME_STR
```
    See Also:
    
    Constant Field Values
  - FLAG_TRUE
```
static final Boolean FLAG_TRUE
```
  - FLAG_FALSE
```
static final Boolean FLAG_FALSE
```
  - TYPE_DISPLAY_STR
```
static final String[] TYPE_DISPLAY_STR
```
  - COMMAND_DEREGISTER_KEY
```
static final String COMMAND_DEREGISTER_KEY
```
    See Also:
    
    Constant Field Values
  - COMMAND_RESTART
```
static final String COMMAND_RESTART
```
    See Also:
    
    Constant Field Values
  - COMMAND_REGISTER_KEY
```
static final String COMMAND_REGISTER_KEY
```
    See Also:
    
    Constant Field Values
  - COMMAND_PAUSE
```
static final String COMMAND_PAUSE
```
    See Also:
    
    Constant Field Values
  - COMMAND_SHUTDOWN
```
static final String COMMAND_SHUTDOWN
```
    See Also:
    
    Constant Field Values
  - COMMAND_START
```
static final String COMMAND_START
```
    See Also:
    
    Constant Field Values
  - COMMAND_STOP
```
static final String COMMAND_STOP
```
    See Also:
    
    Constant Field Values
  - CATEGROY_ADAPTER
```
static final String CATEGROY_ADAPTER
```
    See Also:
    
    Constant Field Values
  - CATEGROY_WORKER
```
static final String CATEGROY_WORKER
```
    See Also:
    
    Constant Field Values
  - CATEGROY_APP
```
static final String CATEGROY_APP
```
    See Also:
    
    Constant Field Values
  - CATEGROY_ENGINE
```
static final String CATEGROY_ENGINE
```
    See Also:
    
    Constant Field Values
  - CATEGROY_THREAD_MGR
```
static final String CATEGROY_THREAD_MGR
```
    See Also:
    
    Constant Field Values
  - CATEGROY_POOL_MGR
```
static final String CATEGROY_POOL_MGR
```
    See Also:
    
    Constant Field Values
  - CATEGROY_MODULE
```
static final String CATEGROY_MODULE
```
    See Also:
    
    Constant Field Values
  - CATEGROY_QUEUE
```
static final String CATEGROY_QUEUE
```
    See Also:
    
    Constant Field Values
  - CATEGROY_DB_POOL
```
static final String CATEGROY_DB_POOL
```
    See Also:
    
    Constant Field Values
  - CATEGROY_DB_CON
```
static final String CATEGROY_DB_CON
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getName
```
String getName()
```
  - register
```
void register(FrameworkIntf aFramework)
```
    This method is called to register the service
    
    Parameters:
    
    aFramework - ServerBaseIntf Service Object
  - deRegister
```
void deRegister(FrameworkIntf aFramework)
```
    This method is called to de-register the service
    
    Parameters:
    
    aFramework - ServerBaseIntf Service Object
  - initMessage
```
void initMessage(MessageIntf aData)
          throws Exception
```
    Throws:
    
    Exception
  - doMessage
```
void doMessage(MessageIntf aData)
```
    This method is called to send the service status message
    
    Parameters:
    
    aData - ServiceDataintf Service Data
  - doEventMessage
```
void doEventMessage(MessageIntf aData)
```
    This method is called to send the service event message
    
    Parameters:
    
    aData - ServiceDataintf Service Data
  - getStats
```
MessageIntf getStats()
```
    This method is called to send a snapshot of performance data
    
    Returns:
    
    message
  - getJvmService
```
FrameworkIntf getJvmService()
```
  - getJvmId
```
String getJvmId()
```
  - isRunning
```
boolean isRunning()
```
  - setRunning
```
void setRunning(boolean aFlag)
```
  - isActive
```
boolean isActive()
```
  - setActive
```
void setActive(boolean aFlag)
```
  - getTotalErrorNumber
```
long getTotalErrorNumber()
```
    This method will return the Total Number of Errors processed.
    
    Returns:
    
    long Total Number of Messages
  - addTotalErrorNumber
```
void addTotalErrorNumber()
```
    This method will add 1 to the total error number.
  - getTotalProcessed
```
long getTotalProcessed()
```
    This method will return the Total Number of Messages processed.
    
    Returns:
    
    long Total Number of Messages
  - addTotalProcessed
```
void addTotalProcessed()
```
    This method will add 1 to the total number of message processed.
  - getInProcess
```
long getInProcess()
```
    This method will return the Total Number of Messages in process.
    
    Returns:
    
    long Total Number of Messages in process
  - addInProcess
```
void addInProcess()
```
    This method will add 1 to the total message in process.
  - subtractInProcess
```
void subtractInProcess()
```
    This method will add 1 to the total message in process.
  - getTotalMsgNumber
```
long getTotalMsgNumber()
```
    This method will return the Total Number of Messages received.
    
    Returns:
    
    long Total Number of Messages received
  - addTotalMsgNumber
```
void addTotalMsgNumber()
```
    This method will add 1 to the total message received.
  - resetTotals
```
void resetTotals()
```

Interface FrameworkIntf

Field Summary

Method Summary

Field Detail

TYPE_JVM

TYPE_SERVER

TYPE_CLUSTER

TYPE_SERVICE

TYPE_EVENT

TYPE_MAX

TYPE_JVM_STR

PARAM_JVM_STR

PARAM_JVMID_STR

PARAM_SERVICENAME_STR

PARAM_SERVICERUNNING_STR

PARAM_SERVICEACTIVE_STR

PARAM_SERVICECATAGORY_STR

PARAM_SERVERNAME_STR

FLAG_TRUE

FLAG_FALSE

TYPE_DISPLAY_STR

COMMAND_DEREGISTER_KEY

COMMAND_RESTART

COMMAND_REGISTER_KEY

COMMAND_PAUSE

COMMAND_SHUTDOWN

COMMAND_START

COMMAND_STOP

CATEGROY_ADAPTER

CATEGROY_WORKER

CATEGROY_APP

CATEGROY_ENGINE

CATEGROY_THREAD_MGR

CATEGROY_POOL_MGR

CATEGROY_MODULE

CATEGROY_QUEUE

CATEGROY_DB_POOL

CATEGROY_DB_CON

Method Detail

getName

register

deRegister

initMessage

doMessage

doEventMessage

getStats

getJvmService

getJvmId

isRunning

setRunning

isActive

setActive

getTotalErrorNumber

addTotalErrorNumber

getTotalProcessed

addTotalProcessed

getInProcess

addInProcess

subtractInProcess

getTotalMsgNumber

addTotalMsgNumber

resetTotals