org.qbroker.node

Class MonitorNode

java.lang.Object

org.qbroker.node.Node

org.qbroker.node.MonitorNode

All Implemented Interfaces:

MessageNode

public class MonitorNode
extends Node

MonitorNode listens to an input XQ for JMS messages as requests for certain occurrences. If a new request is for a new occurrence, it will create the Monitor object according to the ruleset and the content. Upon success, the incoming message will be routed to the outlink of bypass if the on-wait option is disabled for the ruleset. If it fails to create the object, the message will be routed to the outlink of failure. If there is no ruleset to handle the message, it will be routed to the outlink of nohit. Meanwhile, MonitorNode periodically sends all active occurrences as tasks to the outlink of pool. On the other end of the outlink of pool, a number of instances of MonitorPersister will be listening on the outlink for tasks. They will run each occurrence tasks and updates the results of the tasks. Each task will be collected as the result of the monitor. The result will be evaluated and escalated if it is necessary. The escalation messages will be routed to the outlink of done. If the result matches the predefined patterns or its lifetime ends, MonitorNode will terminate the occurrence and generates a new message as the final escalation. Then the occurrence will be destroyed. The outlink of done can be shared with with other outlinks except for pool.

MonitorNode also contains a number of predefined rulesets. These rulesets categorize messages into non-overlapping groups via the filters. Therefore, each rule defines a unique message group. If a ruleset is not of bypass, it is supposed to define a template to construct properties for new occurrences. It also contains multiple parameters for the node to manage active occurrences. For example, TimeToLive specifies the life time in seconds of the new occurrence. Once the occurrence passes that time span, MonitorNode will escalate the final event and terminates it. Option is another parameter which controls when to deliver the original request. By default, it is zero and there is no wait on the final event. If it is 1, MonitorNode will hold the request and waits until the final event is escalated. Heartbeat determines how often to run the occurrence. The non-bypass rulesets may also have a list of EventPatterns to determine when to escalate the final event for the occurrence and to terminate the request. The total number of active occurrences is stored into the RULE_PEND field. For those messages falling off all defined rulesets, MonitorNode always creates an extra ruleset, nohit, to handle them. Therefore all the nohit messages will be routed to the outlink of nohit.

You are free to choose any names for the five fixed outlinks. But MonitorNode always assumes the first outlink for pool, the second for done, the third for bypass, the fourth for failure and the last for nohit. It is OK for the last four outlinks to share the same name. But the name of the first outlink has to be unique.

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
MonitorNode(java.util.Map props)

Method Summary

Modifier and Type	Method and Description
void	close() It closes all resources and cleans up all list, cache, metadata, etc.
protected void	finalize()
int	getOutLinkBoundary() returns 0 to have the ack propagation skipped on the first outlink
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.
java.util.Map<java.lang.String,java.lang.String>	listPendings(XQueue xq, int type) list all propagating messages and pending jobs
void	propagate(XQueue in, XQueue[] out) picks up a message from input queue and evaluates its content to decide which output queue to propagate
int	removeRule(java.lang.String key, XQueue in) It removes the rule from the ruleList and returns the rule id upon success.
int	replaceRule(java.lang.String key, java.util.Map ph, XQueue in) It replaces the rule with the new rule defined by the property hashmap and returns its id upon success.

Methods inherited from class org.qbroker.node.Node

addRule, callback, checkpoint, collectAll, containsRule, containsXQ, feedback, forcethru, getCapacity, getCapacity, getDebugMode, getDisplayMask, getDisplayProperties, getLinkName, getLinkName, getMetaData, getName, getNumberOfOutLinks, getNumberOfRules, getOperation, getRuleName, getStatus, getXAMode, getXAMode, internalXQSupported, list, passthru, refreshRule, renameRule, 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

MonitorNode

public MonitorNode(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

removeRule

public int removeRule(java.lang.String key,
                      XQueue in)

It removes the rule from the ruleList and returns the rule id upon success. It is not MT-Safe.

Specified by:

removeRule in interface MessageNode

Overrides:

removeRule in class Node

replaceRule

public int replaceRule(java.lang.String key,
                       java.util.Map ph,
                       XQueue in)

It replaces the rule with the new rule defined by the property hashmap and returns its id upon success. It is not MT-Safe.

Specified by:

replaceRule in interface MessageNode

Overrides:

replaceRule in class Node

propagate

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

picks up a message from input queue and evaluates its content to decide which output queue to propagate

Specified by:

propagate in interface MessageNode

Specified by:

propagate in class Node

Throws:

javax.jms.JMSException

listPendings

public java.util.Map<java.lang.String,java.lang.String> listPendings(XQueue xq,
                                                                     int type)

list all propagating messages and pending jobs

Specified by:

listPendings in interface MessageNode

Overrides:

listPendings in class Node

getOutLinkBoundary

public int getOutLinkBoundary()

returns 0 to have the ack propagation skipped on the first outlink

Specified by:

getOutLinkBoundary in interface MessageNode

Overrides:

getOutLinkBoundary in class Node

close

public void close()

Description copied from class: Node

It closes all resources and cleans up all list, cache, metadata, etc. Once it is closed, it can not be used any more.

Specified by:

close in interface MessageNode

Overrides:

close in class Node

finalize

protected void finalize()

Overrides:

finalize in class Node