QFlow

java.lang.Object
- org.qbroker.flow.QFlow

All Implemented Interfaces:

java.lang.Runnable, Service
```
public class QFlow
extends java.lang.Object
implements Service, java.lang.Runnable
```
QFlow is a light-weight container of JMS message flows for generic purposes. A message flow consists of a number of message nodes. There are three types of message nodes, MessageRecever, MessageNode and MessagePersister. The nodes of MessageReceiver and MessagePersister are for JMSMessage I/O. The nodes of MessageNode are for JMSMessage processing. With these three basic types of nodes, you can build various message flows, just like you can build objects with Lego components. Besides, QFlow also provides certain services to all the flows, like the supports for clutsering, load balancing and monitoring.

QFlow has a special internal queue called escalation. It is the internal escalation channel shared by all components. Its name, escalation, is one of the reserved name for XQueues. In fact, QFlow listens to this queue. It allows all components to escalate events or messages to the container. For a MessageFlow, it can only be used as an outLink by a MessageNode with the proper partition specified explicitly. Please make sure the container's EscalationCapacity is large enough for it. By default, it is 64.

QFlow supports the remote control and query synchronously via AdminServer. To enable this feature, you need to define the AdminServer in the master configuration file. AdminServer is a plugin to QFlow for direct queries or controls. In fact, its output XQueue is escalation. If it is defined, the user will be able to query or modify the status of the instance of QFlow directly.

If ClusterNode is defined, QFlow will run in cluster mode. The ClusterNode will monitor the status of the cluster and will update its own status frequently. It will also escalate information to the container via the escalation channel. In the cluster mode, you have to specify the DefauleStatus for the broker so that QFlow will be able to switch its status between SERVICE_RUNNING and the DefaultStatus. It also supports the failover actions to manage the resources at the failover.

If ConfigRepository is defined, QFlow will support on-demand reload of configuration changes from the repository. By design, QFlow supports multiple message flows via MessageFlow list. However, only the legacy configuration with a single flow has been tested. To make sure it is the legacy configuration, please always set MaxNumberFlow to 1.

It is MT-Safe.

Author:

yannanlu@yahoo.com

Field Summary

Fields
Modifier and Type Field and Description

protected static java.lang.String[] reportStatusText
- Fields inherited from interface org.qbroker.common.Service
  DEBUG_CTRL, DEBUG_DIFF, DEBUG_INIT, DEBUG_LOAD, DEBUG_LOOP, DEBUG_NONE, DEBUG_REPT, DEBUG_TRAN, DEBUG_UPDT, SERVICE_CLOSED, SERVICE_DISABLED, SERVICE_PAUSE, SERVICE_READY, SERVICE_RETRYING, SERVICE_RUNNING, SERVICE_STANDBY, SERVICE_STOPPED, statusText

Fields
Modifier and Type	Field and Description
`protected static java.lang.String[]`	`reportStatusText`

Constructor Summary

Constructors
Constructor and Description
`QFlow(java.util.Map props)` Creates new QFlow
`QFlow(java.util.Map props, int debugForReload, java.lang.String configFile)` Creates new QFlow

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`acknowledge(long[] state)` acknowledges the request msgs only
`void`	`close()` closes all opened resources
`int`	`doRequest(Event req, int timeout)` It processes requests according to the preconfigured rulesets.
`int`	`getDebugMode()` returns the debug mode of the service
`java.lang.String`	`getName()` returns the name of the service
`java.lang.String`	`getOperation()` returns the string of the operation
`static java.util.Map<java.lang.String,java.lang.Object>`	`getReport(java.lang.String rptName)` returns a copy of the report
`static java.lang.String[]`	`getReportNames()` returns all the names of the reports
`int`	`getStatus()` returns the status of the service
`static void`	`initReport(java.lang.String rptName, java.lang.String[] keyList, java.util.Map latest, int reportMode)` It is used for reporter to initialize the static report
`static void`	`main(java.lang.String[] args)`
`void`	`run()`
`void`	`setDebugMode(int debug)` sets the debug mode of the service
`void`	`start()` starts all threads and manages their states

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - reportStatusText
```
protected static final java.lang.String[] reportStatusText
```
- Constructor Detail
  - QFlow
```
public QFlow(java.util.Map props)
```
    Creates new QFlow
  - QFlow
```
public QFlow(java.util.Map props,
             int debugForReload,
             java.lang.String configFile)
```
    Creates new QFlow
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: Service
    
    returns the name of the service
    
    Specified by:
    
    getName in interface Service
  - getOperation
```
public java.lang.String getOperation()
```
    Description copied from interface: Service
    
    returns the string of the operation
    
    Specified by:
    
    getOperation in interface Service
  - getStatus
```
public int getStatus()
```
    Description copied from interface: Service
    
    returns the status of the service
    
    Specified by:
    
    getStatus in interface Service
  - getDebugMode
```
public int getDebugMode()
```
    Description copied from interface: Service
    
    returns the debug mode of the service
    
    Specified by:
    
    getDebugMode in interface Service
  - setDebugMode
```
public void setDebugMode(int debug)
```
    Description copied from interface: Service
    
    sets the debug mode of the service
    
    Specified by:
    
    setDebugMode in interface Service
  - doRequest
```
public int doRequest(Event req,
                     int timeout)
```
    It processes requests according to the preconfigured rulesets. If timeout is less than zero, there is no wait. If timeout is larger than zero, it will wait for the processed event until timeout. If timeout is zero, it blocks until the event is processed. It returns 1 for success, 0 for timed out and -1 for failure. The method is MT-Safe.
    
    A request is either a JMSEvent for remote queries and escalations or a non-JMS Event for local queries and escalations. In case of remote, the root XQueue of the default flow is used as the message gateway to request the remote objects. For local queries, the outlink of escalation is used to route the messages.
    
    N.B., The input request will be modified for the response.
    
    Specified by:
    
    doRequest in interface Service
  - acknowledge
```
public void acknowledge(long[] state)
                 throws javax.jms.JMSException
```
    acknowledges the request msgs only
    
    Throws:
    
    javax.jms.JMSException
  - close
```
public void close()
```
    Description copied from interface: Service
    
    closes all opened resources
    
    Specified by:
    
    close in interface Service
  - run
```
public void run()
```
    Specified by:
    
    run in interface java.lang.Runnable
  - initReport
```
public static void initReport(java.lang.String rptName,
                              java.lang.String[] keyList,
                              java.util.Map latest,
                              int reportMode)
```
    It is used for reporter to initialize the static report
  - getReport
```
public static java.util.Map<java.lang.String,java.lang.Object> getReport(java.lang.String rptName)
```
    returns a copy of the report
  - getReportNames
```
public static java.lang.String[] getReportNames()
```
    returns all the names of the reports
  - start
```
public void start()
```
    starts all threads and manages their states
  - main
```
public static void main(java.lang.String[] args)
```
    Parameters:
    
    args - the command line arguments

Class QFlow

Field Summary

Fields inherited from interface org.qbroker.common.Service

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

reportStatusText

Constructor Detail

QFlow

QFlow

Method Detail

getName

getOperation

getStatus

getDebugMode

setDebugMode

doRequest

acknowledge

close

run

initReport

getReport

getReportNames

start

main