MessageNode

All Known Implementing Classes:

ActionNode, AggregateNode, CacheNode, CascadeNode, CollectNode, DeliverNode, DispatchNode, DistinguishNode, DuplicateNode, EventCorrelator, EventDispatcher, EventMonitor, FormatNode, FreeMarkerNode, JobNode, JSONPathNode, JSONTNode, MapReduceNode, MonitorNode, Node, ParserNode, PickupNode, PipeNode, PublishNode, RequestNode, ScreenNode, ScriptNode, SelectNode, ServiceNode, SortNode, SpreadNode, SwitchNode, XPathNode, XSLTNode
```
public interface MessageNode
```
MessageNode is an interface that pickes up JMS Messages from the only input XQueue and processes them according to the predefined rules and their content. Then it puts the processed messages to one of the output XQueues. MessageNode should never consume any messages. An incoming message has to go out of one of the output XQueues. However, it is OK for MessageNode to create new Messages as the reaction upon the incoming messages.

The transaction support is determined by the property of XAMode and the EXTERNAL_XA bit of the input XQueue. If the input XQueue has no EXTERNAL_XA bit set, XAMode can be either 0 as disabled or positive as enabled. Otherwise, XAMode should always be or reset to positive to enable the transction support. The transaction support is the only way to guarentee the EXTERNAL_XA feature is fulfilled.

If XAMode is set to 0 and the input XQueue has no EXTERNAL_XA bit set, the incoming message should be removed from the input XQueue once it is put to an output XQueue. In this case, the de-queue processes are fully separated at MessageNode. Otherwise, MessageNode should keep track on the status of the message until it is removed from the output XQueue. Only after it is removed from the output XQueue, MessageNode will remove the message from the input XQueue. So the de-queue processes will propagate in upstream direction. MessageNode should never acknowledge any messages unless something is really out of control. It should also enforce the propagation of EXTERNAL_XA bit for all output XQueues.

It is up to developers to decide whether to implement the support of dynamic rules. If not, all the rules will be static. They will not be changable on the fly. The support of checkpointing is not mandatory either. However, please make sure to document those methods and have them return -1 or null.

At any given time, MessageNode is on one of the following 8 different states:
NODE_READY all resources opened and ready to work
NODE_RUNNING running normally
NODE_RETRYING trying to reopen resources and get back to work
NODE_PAUSE pausing for a bit while still ready to run
NODE_STANDBY standby for a bit longer while still ready to run
NODE_DISABLED disabled temporarily while still ready to run
NODE_STOPPED completed the job and closed all resources
NODE_CLOSED closed all resources and ready to destroy object

Author:

yannanlu@yahoo.com

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ASSET_THR`
`static int`	`ASSET_URI`
`static int`	`ASSET_XQ`
`static int`	`META_MAP`
`static int`	`META_MSG`
`static int`	`META_OUT`
`static int`	`META_RULE`
`static int`	`META_XQ`
`static int`	`MSG_BID`
`static int`	`MSG_CID`
`static int`	`MSG_OID`
`static int`	`MSG_RID`
`static int`	`MSG_TID`
`static int`	`MSG_TIME`
`static int`	`NODE_CLOSED`
`static int`	`NODE_DISABLED`
`static int`	`NODE_PAUSE`
`static int`	`NODE_READY`
`static int`	`NODE_RETRYING`
`static int`	`NODE_RUNNING`
`static int`	`NODE_STANDBY`
`static int`	`NODE_STOPPED`
`static int`	`OUT_CAPACITY`
`static int`	`OUT_COUNT`
`static int`	`OUT_DEQ`
`static int`	`OUT_EXTRA`
`static int`	`OUT_LENGTH`
`static int`	`OUT_MODE`
`static int`	`OUT_NRULE`
`static int`	`OUT_OFFSET`
`static int`	`OUT_ORULE`
`static int`	`OUT_QDEPTH`
`static int`	`OUT_QIPPS`
`static int`	`OUT_QSTATUS`
`static int`	`OUT_QTIME`
`static int`	`OUT_SIZE`
`static int`	`OUT_STATUS`
`static int`	`OUT_TIME`
`static int`	`RULE_COUNT`
`static int`	`RULE_DMASK`
`static int`	`RULE_EXTRA`
`static int`	`RULE_GID`
`static int`	`RULE_MODE`
`static int`	`RULE_OID`
`static int`	`RULE_OPTION`
`static int`	`RULE_PEND`
`static int`	`RULE_PID`
`static int`	`RULE_SIZE`
`static int`	`RULE_STATUS`
`static int`	`RULE_TIME`
`static int`	`RULE_TTL`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`addRule(java.util.Map props)` adds a new rule defined by the property hash and returns the rule id
`java.util.Map<java.lang.String,java.lang.Object>`	`checkpoint()` returns the checkpoint hashmap for current state
`void`	`close()` closes all opened resources
`boolean`	`containsRule(java.lang.String ruleName)` returns true if the rule exists or false otherwise
`boolean`	`containsXQ(java.lang.String outlinkName)` returns true if the node has the outlink
`int`	`getCapacity()` returns the capacity of the uplink
`int`	`getCapacity(int i)` returns the capacity of the i-th outlink
`int`	`getDebugMode()` returns the debug mode of the node
`int`	`getDisplayMask()` returns the displayMask of the node
`java.lang.String[]`	`getDisplayProperties()` gets the display property names of the node
`java.lang.String`	`getLinkName()` returns the name of the uplink
`java.lang.String`	`getLinkName(int i)` returns the name of the i-th outlink
`int`	`getMetaData(int type, int id, long[] data)` copies certain type of MetaData from its id-th instance to the buffer and returns the real id of the instance , or -1 on failure.
`java.lang.String`	`getName()` returns the name of the node
`int`	`getNumberOfOutLinks()` returns the total number of outlinks
`int`	`getNumberOfRules()` returns the total number of RuleSets
`java.lang.String`	`getOperation()` returns the string of the operation
`int`	`getOutLinkBoundary()` returns the lowest id of outlinks for collectibles
`java.lang.String`	`getRuleName(int i)` returns the name of the i-th RuleSet
`int`	`getStatus()` returns the status of the node
`int`	`getXAMode()` returns the transaction mode of the uplink
`int`	`getXAMode(int i)` returns the transaction mode of the i-th outlink
`boolean`	`internalXQSupported()` returns true if the node supports internal XQueues for outlinks
`java.util.Map<java.lang.String,java.lang.String>`	`list(java.lang.String outlinkName, int type)` lists all NEW messages in the given outlink of the node and returns a Map or null if the outlink is not defined.
`java.util.Map<java.lang.String,java.lang.String>`	`listPendings(XQueue uplink, int type)` lists all PROPAGATING or PENDING messages of the node in the uplink and returns a Map or null if the uplink is not for the node.
`void`	`propagate(XQueue in, XQueue[] out)` gets the JMS messages from the input XQueue and processes them one by one.
`int`	`refreshRule(java.lang.String ruleName, XQueue in)` refreshes the external rules and returns the number of rules updated
`int`	`removeRule(java.lang.String ruleName, XQueue in)` removes the rule and returns its id
`int`	`renameRule(java.lang.String oldName, java.lang.String ruleName)` renames the rule and returns its id
`int`	`replaceRule(java.lang.String ruleName, java.util.Map props, XQueue in)` replaces the rule with the given property hash and returns its id
`void`	`resetMetaData(XQueue in, XQueue[] out)` cleans up and resets all MetaData for XQs and messages
`void`	`restore(java.util.Map<java.lang.String,java.lang.Object> chkpt)` restores the state from a checkpointed hashmap
`int`	`rotateRule(java.lang.String ruleName)` moves the rule to the end of list and returns its id
`void`	`setDebugMode(int debug)` sets the debug mode of the node
`void`	`setDisplayMask(int mask)` sets the displayMask of the node
`void`	`setDisplayProperties(java.lang.String[] keys)` sets the display property names of the node
`void`	`setStatus(int status)` sets the status of the node
`java.lang.String`	`show(java.lang.String outlinkName, int id, int type)` browses the message at the id-th cell from the given outlink and returns the detail text in the given format type
`javax.jms.Message`	`takeback(java.lang.String outlinkName, int id)` removes the message at the id-th cell from the given outlink and returns the message upon success
`int`	`updateParameters(java.util.Map props)` updates the parameters of the node and returns number of them changed

- Field Detail
  - MSG_CID
```
static final int MSG_CID
```
    See Also:
    
    Constant Field Values
  - MSG_OID
```
static final int MSG_OID
```
    See Also:
    
    Constant Field Values
  - MSG_BID
```
static final int MSG_BID
```
    See Also:
    
    Constant Field Values
  - MSG_RID
```
static final int MSG_RID
```
    See Also:
    
    Constant Field Values
  - MSG_TID
```
static final int MSG_TID
```
    See Also:
    
    Constant Field Values
  - MSG_TIME
```
static final int MSG_TIME
```
    See Also:
    
    Constant Field Values
  - OUT_NRULE
```
static final int OUT_NRULE
```
    See Also:
    
    Constant Field Values
  - OUT_ORULE
```
static final int OUT_ORULE
```
    See Also:
    
    Constant Field Values
  - OUT_OFFSET
```
static final int OUT_OFFSET
```
    See Also:
    
    Constant Field Values
  - OUT_LENGTH
```
static final int OUT_LENGTH
```
    See Also:
    
    Constant Field Values
  - OUT_CAPACITY
```
static final int OUT_CAPACITY
```
    See Also:
    
    Constant Field Values
  - OUT_SIZE
```
static final int OUT_SIZE
```
    See Also:
    
    Constant Field Values
  - OUT_COUNT
```
static final int OUT_COUNT
```
    See Also:
    
    Constant Field Values
  - OUT_DEQ
```
static final int OUT_DEQ
```
    See Also:
    
    Constant Field Values
  - OUT_STATUS
```
static final int OUT_STATUS
```
    See Also:
    
    Constant Field Values
  - OUT_MODE
```
static final int OUT_MODE
```
    See Also:
    
    Constant Field Values
  - OUT_EXTRA
```
static final int OUT_EXTRA
```
    See Also:
    
    Constant Field Values
  - OUT_TIME
```
static final int OUT_TIME
```
    See Also:
    
    Constant Field Values
  - OUT_QDEPTH
```
static final int OUT_QDEPTH
```
    See Also:
    
    Constant Field Values
  - OUT_QIPPS
```
static final int OUT_QIPPS
```
    See Also:
    
    Constant Field Values
  - OUT_QSTATUS
```
static final int OUT_QSTATUS
```
    See Also:
    
    Constant Field Values
  - OUT_QTIME
```
static final int OUT_QTIME
```
    See Also:
    
    Constant Field Values
  - RULE_OID
```
static final int RULE_OID
```
    See Also:
    
    Constant Field Values
  - RULE_PID
```
static final int RULE_PID
```
    See Also:
    
    Constant Field Values
  - RULE_GID
```
static final int RULE_GID
```
    See Also:
    
    Constant Field Values
  - RULE_PEND
```
static final int RULE_PEND
```
    See Also:
    
    Constant Field Values
  - RULE_SIZE
```
static final int RULE_SIZE
```
    See Also:
    
    Constant Field Values
  - RULE_COUNT
```
static final int RULE_COUNT
```
    See Also:
    
    Constant Field Values
  - RULE_STATUS
```
static final int RULE_STATUS
```
    See Also:
    
    Constant Field Values
  - RULE_TTL
```
static final int RULE_TTL
```
    See Also:
    
    Constant Field Values
  - RULE_MODE
```
static final int RULE_MODE
```
    See Also:
    
    Constant Field Values
  - RULE_OPTION
```
static final int RULE_OPTION
```
    See Also:
    
    Constant Field Values
  - RULE_DMASK
```
static final int RULE_DMASK
```
    See Also:
    
    Constant Field Values
  - RULE_EXTRA
```
static final int RULE_EXTRA
```
    See Also:
    
    Constant Field Values
  - RULE_TIME
```
static final int RULE_TIME
```
    See Also:
    
    Constant Field Values
  - META_MSG
```
static final int META_MSG
```
    See Also:
    
    Constant Field Values
  - META_OUT
```
static final int META_OUT
```
    See Also:
    
    Constant Field Values
  - META_MAP
```
static final int META_MAP
```
    See Also:
    
    Constant Field Values
  - META_RULE
```
static final int META_RULE
```
    See Also:
    
    Constant Field Values
  - META_XQ
```
static final int META_XQ
```
    See Also:
    
    Constant Field Values
  - ASSET_XQ
```
static final int ASSET_XQ
```
    See Also:
    
    Constant Field Values
  - ASSET_URI
```
static final int ASSET_URI
```
    See Also:
    
    Constant Field Values
  - ASSET_THR
```
static final int ASSET_THR
```
    See Also:
    
    Constant Field Values
  - NODE_READY
```
static final int NODE_READY
```
    See Also:
    
    Constant Field Values
  - NODE_RUNNING
```
static final int NODE_RUNNING
```
    See Also:
    
    Constant Field Values
  - NODE_RETRYING
```
static final int NODE_RETRYING
```
    See Also:
    
    Constant Field Values
  - NODE_PAUSE
```
static final int NODE_PAUSE
```
    See Also:
    
    Constant Field Values
  - NODE_STANDBY
```
static final int NODE_STANDBY
```
    See Also:
    
    Constant Field Values
  - NODE_DISABLED
```
static final int NODE_DISABLED
```
    See Also:
    
    Constant Field Values
  - NODE_STOPPED
```
static final int NODE_STOPPED
```
    See Also:
    
    Constant Field Values
  - NODE_CLOSED
```
static final int NODE_CLOSED
```
    See Also:
    
    Constant Field Values
- Method Detail
  - propagate
```
void propagate(XQueue in,
               XQueue[] out)
        throws javax.jms.JMSException
```
    gets the JMS messages from the input XQueue and processes them one by one. Then it propagets them to the output XQueues according certain rulesets.
    
    Throws:
    
    javax.jms.JMSException
  - getOperation
```
java.lang.String getOperation()
```
    returns the string of the operation
  - getName
```
java.lang.String getName()
```
    returns the name of the node
  - getNumberOfOutLinks
```
int getNumberOfOutLinks()
```
    returns the total number of outlinks
  - getOutLinkBoundary
```
int getOutLinkBoundary()
```
    returns the lowest id of outlinks for collectibles
  - getLinkName
```
java.lang.String getLinkName()
```
    returns the name of the uplink
  - getLinkName
```
java.lang.String getLinkName(int i)
```
    returns the name of the i-th outlink
  - getCapacity
```
int getCapacity()
```
    returns the capacity of the uplink
  - getCapacity
```
int getCapacity(int i)
```
    returns the capacity of the i-th outlink
  - getXAMode
```
int getXAMode()
```
    returns the transaction mode of the uplink
  - getXAMode
```
int getXAMode(int i)
```
    returns the transaction mode of the i-th outlink
  - getStatus
```
int getStatus()
```
    returns the status of the node
  - setStatus
```
void setStatus(int status)
```
    sets the status of the node
  - getNumberOfRules
```
int getNumberOfRules()
```
    returns the total number of RuleSets
  - getRuleName
```
java.lang.String getRuleName(int i)
```
    returns the name of the i-th RuleSet
  - getDisplayMask
```
int getDisplayMask()
```
    returns the displayMask of the node
  - setDisplayMask
```
void setDisplayMask(int mask)
```
    sets the displayMask of the node
  - getDebugMode
```
int getDebugMode()
```
    returns the debug mode of the node
  - setDebugMode
```
void setDebugMode(int debug)
```
    sets the debug mode of the node
  - getDisplayProperties
```
java.lang.String[] getDisplayProperties()
```
    gets the display property names of the node
  - setDisplayProperties
```
void setDisplayProperties(java.lang.String[] keys)
```
    sets the display property names of the node
  - updateParameters
```
int updateParameters(java.util.Map props)
```
    updates the parameters of the node and returns number of them changed
  - addRule
```
int addRule(java.util.Map props)
```
    adds a new rule defined by the property hash and returns the rule id
  - removeRule
```
int removeRule(java.lang.String ruleName,
               XQueue in)
```
    removes the rule and returns its id
  - replaceRule
```
int replaceRule(java.lang.String ruleName,
                java.util.Map props,
                XQueue in)
```
    replaces the rule with the given property hash and returns its id
  - renameRule
```
int renameRule(java.lang.String oldName,
               java.lang.String ruleName)
```
    renames the rule and returns its id
  - rotateRule
```
int rotateRule(java.lang.String ruleName)
```
    moves the rule to the end of list and returns its id
  - refreshRule
```
int refreshRule(java.lang.String ruleName,
                XQueue in)
```
    refreshes the external rules and returns the number of rules updated
  - containsRule
```
boolean containsRule(java.lang.String ruleName)
```
    returns true if the rule exists or false otherwise
  - containsXQ
```
boolean containsXQ(java.lang.String outlinkName)
```
    returns true if the node has the outlink
  - internalXQSupported
```
boolean internalXQSupported()
```
    returns true if the node supports internal XQueues for outlinks
  - listPendings
```
java.util.Map<java.lang.String,java.lang.String> listPendings(XQueue uplink,
                                                              int type)
```
    lists all PROPAGATING or PENDING messages of the node in the uplink and returns a Map or null if the uplink is not for the node.
  - list
```
java.util.Map<java.lang.String,java.lang.String> list(java.lang.String outlinkName,
                                                      int type)
```
    lists all NEW messages in the given outlink of the node and returns a Map or null if the outlink is not defined.
  - show
```
java.lang.String show(java.lang.String outlinkName,
                      int id,
                      int type)
```
    browses the message at the id-th cell from the given outlink and returns the detail text in the given format type
  - takeback
```
javax.jms.Message takeback(java.lang.String outlinkName,
                           int id)
```
    removes the message at the id-th cell from the given outlink and returns the message upon success
  - getMetaData
```
int getMetaData(int type,
                int id,
                long[] data)
```
    copies certain type of MetaData from its id-th instance to the buffer and returns the real id of the instance , or -1 on failure. There are four types of MetaData available:
    META_MSG MetaData of outstanding messages in the uplink
    META_OUT MetaData of output links
    META_RULE MetaData of rule sets
    META_XQ MetaData of XQueues
  - resetMetaData
```
void resetMetaData(XQueue in,
                   XQueue[] out)
```
    cleans up and resets all MetaData for XQs and messages
  - checkpoint
```
java.util.Map<java.lang.String,java.lang.Object> checkpoint()
```
    returns the checkpoint hashmap for current state
  - restore
```
void restore(java.util.Map<java.lang.String,java.lang.Object> chkpt)
```
    restores the state from a checkpointed hashmap
  - close
```
void close()
```
    closes all opened resources

Interface MessageNode

Field Summary

Method Summary

Field Detail

MSG_CID

MSG_OID

MSG_BID

MSG_RID

MSG_TID

MSG_TIME

OUT_NRULE

OUT_ORULE

OUT_OFFSET

OUT_LENGTH

OUT_CAPACITY

OUT_SIZE

OUT_COUNT

OUT_DEQ

OUT_STATUS

OUT_MODE

OUT_EXTRA

OUT_TIME

OUT_QDEPTH

OUT_QIPPS

OUT_QSTATUS

OUT_QTIME

RULE_OID

RULE_PID

RULE_GID

RULE_PEND

RULE_SIZE

RULE_COUNT

RULE_STATUS

RULE_TTL

RULE_MODE

RULE_OPTION

RULE_DMASK

RULE_EXTRA

RULE_TIME

META_MSG

META_OUT

META_MAP

META_RULE

META_XQ

ASSET_XQ

ASSET_URI

ASSET_THR

NODE_READY

NODE_RUNNING

NODE_RETRYING

NODE_PAUSE

NODE_STANDBY

NODE_DISABLED

NODE_STOPPED

NODE_CLOSED

Method Detail

propagate

getOperation

getName

getNumberOfOutLinks

getOutLinkBoundary

getLinkName

getLinkName

getCapacity

getCapacity

getXAMode

getXAMode

getStatus

setStatus

getNumberOfRules

getRuleName

getDisplayMask

setDisplayMask

getDebugMode

setDebugMode

getDisplayProperties

setDisplayProperties

updateParameters

addRule

removeRule