org.qbroker.node

Class DuplicateNode

java.lang.Object

org.qbroker.node.Node

org.qbroker.node.DuplicateNode

All Implemented Interfaces:

MessageNode

public class DuplicateNode
extends Node

DuplicateNode duplicates incoming JMS messages to various selected destinations. It has two types of outlinks, primary as of the first outlink and non-primary as of rest of outlinks. All the incoming messages always go out thru the primary outlink. Their duplicates will be routed to their selected non-primay outlinks.

DuplicateNode may also contain a number of predefined rulesets. These rulesets categorize messages into non-overlapping groups. Therefore, each rule defines a unique message group. If a ruleset has the preferredOutLink defined and it is same as the primary (the first) outlink, DuplicateNode will route the messages of the group to the primay outlink without any duplicate actions as a bypass. Any other bypass will be forced to the primary outlink since the messages going out of non-primary outlinks are not collectible. Otherwise, the original message will be duplicated into copies for delivery. The total number of duplicated messages are tracked by RULE_PEND of their rulesets.

A ruleset may define a list of the outlinks as the selected non-primary outlinks for the duplicated messages. If any selected outlink is either the primary or not existing, DuplicateNode will ignore it with a warning. If the selected outlinks are not defined or empty, DuplicateNode will assign the default list that contains all non-primary outlinks. But if PreferredOutLink is defined in the ruleset, the ruleset will be treated as a bypass ruleset. For those messages falling off all defined rulesets, DuplicateNode always creates an extra ruleset, nohit, to handle them. Nohit ruleset is always a bypass rule to the primay outlink.

NB. There is a transaction control on the primary (first) outlink. The XAMode can be defined on the node level or on the rule level. The XAMode on the rule level will overwrite the one on the node level. If the XAMode of the node is on, all non-primary outlinks will wait for the transaction completed on the primary outlink before their propagation unless it is set off on certain rules. Therefore, it is possible to loss messages on the non-primary outlinks, since secondary outlinks have no transaction support. However, if the XAMode of the node is off, all the non-primary outlinks will propagate with no wait. Therefore, there is a chance that the messages either double fed or lost on non-primary outlinks.

Author:

yannanlu@yahoo.com

Field Summary

Fields inherited from class org.qbroker.node.Node

assetList, bufferSize, callbackMethod, capacity, cbw, cells, cfgList, chkptExpiration, debug, DEBUG_COLL, DEBUG_DIFF, DEBUG_FBAK, DEBUG_INIT, DEBUG_PASS, DEBUG_PROP, DEBUG_REPT, DEBUG_UPDT, displayMask, displayPropertyName, linkName, LOAD_HIGH, LOAD_LOW, LOAD_MEDIUM, msgList, name, operation, RESET_ALL, RESET_MAP, RESET_NONE, RESET_SOME, ruleList, status, TYPE_ACTION, TYPE_AGGREGATE, TYPE_BYPASS, TYPE_CACHE, TYPE_COLLECT, TYPE_DELIVER, TYPE_FORMAT, TYPE_JSONPATH, TYPE_JSONT, TYPE_MAPREDUCE, TYPE_NONE, TYPE_PARSER, TYPE_PICKUP, TYPE_PIPE, TYPE_PUBLISH, TYPE_ROUNDROBIN, TYPE_SCREEN, TYPE_SCRIPT, TYPE_SERVICE, TYPE_SORT, TYPE_SPLIT, TYPE_SPREAD, TYPE_WEIGHTED, TYPE_XPATH, TYPE_XSLT, waitTime, xaMode

Fields inherited from interface org.qbroker.node.MessageNode

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

Constructor Summary

Constructors

Constructor and Description
DuplicateNode(java.util.Map props)

Method Summary

Modifier and Type	Method and Description
protected int	feedback(XQueue in, long milliSec) It returns the number of done messages removed from in.
protected java.util.Map<java.lang.String,java.lang.Object>	initRuleset(long tm, java.util.Map ph, long[] ruleInfo) It initializes a new ruleset with the ruleInfo and returns the rule upon success.
protected int	passthru(long currentTime, javax.jms.Message msg, XQueue in, int rid, int oid, int cid, int tid) It passes the message from the input XQueue over to an output XQueue and returns 1 upon success or 0 otherwise.
void	propagate(XQueue in, XQueue[] out) picks up a message from input queue and duplicate it to all output XQ

Methods inherited from class org.qbroker.node.Node

addRule, callback, checkpoint, close, collectAll, containsRule, containsXQ, finalize, forcethru, getCapacity, getCapacity, getDebugMode, getDisplayMask, getDisplayProperties, getLinkName, getLinkName, getMetaData, getName, getNumberOfOutLinks, getNumberOfRules, getOperation, getOutLinkBoundary, getRuleName, getStatus, getXAMode, getXAMode, internalXQSupported, list, listPendings, refreshRule, removeRule, renameRule, replaceRule, resetMetaData, restore, rotateRule, setDebugMode, setDisplayMask, setDisplayProperties, setStatus, show, takeback, takebackEnabled, updateParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

DuplicateNode

public DuplicateNode(java.util.Map props)

Method Detail

initRuleset

protected java.util.Map<java.lang.String,java.lang.Object> initRuleset(long tm,
                                                                       java.util.Map ph,
                                                                       long[] ruleInfo)

It initializes a new ruleset with the ruleInfo and returns the rule upon success. Otherwise, it throws an exception or returns null.

Specified by:

initRuleset in class Node

propagate

public void propagate(XQueue in,
                      XQueue[] out)
               throws javax.jms.JMSException

picks up a message from input queue and duplicate it to all output XQ

Specified by:

propagate in interface MessageNode

Specified by:

propagate in class Node

Throws:

javax.jms.JMSException

passthru

protected int passthru(long currentTime,
                       javax.jms.Message msg,
                       XQueue in,
                       int rid,
                       int oid,
                       int cid,
                       int tid)

It passes the message from the input XQueue over to an output XQueue and returns 1 upon success or 0 otherwise. In case of cid is less than 0, the message has nothing to do with the input XQueue. Nothing will be added to msgList for tracking. No update on stats of ruleset either. If tid is 1, it will cache the duplicated msg into msgList for later retrieval.

Overrides:

passthru in class Node

feedback

protected int feedback(XQueue in,
                       long milliSec)

It returns the number of done messages removed from in. If milliSec is less than 0, there is no wait and it tries to collect all cells. Otherwise, it just tries to collect the first collectible cell. If ruleInfo[RULE_MODE] is 1, it will retrieve the duplicated msg from msgList and copies it to their destinations.

Overrides:

feedback in class Node