Node

java.lang.Object
- org.qbroker.node.Node

All Implemented Interfaces:

MessageNode

Direct Known Subclasses:

ActionNode, AggregateNode, CacheNode, CascadeNode, CollectNode, DeliverNode, DispatchNode, DistinguishNode, DuplicateNode, EventCorrelator, EventDispatcher, EventMonitor, FormatNode, FreeMarkerNode, JobNode, JSONPathNode, JSONTNode, MapReduceNode, MonitorNode, ParserNode, PickupNode, PipeNode, PublishNode, RequestNode, ScreenNode, ScriptNode, SelectNode, ServiceNode, SortNode, SpreadNode, SwitchNode, XPathNode, XSLTNode
```
public abstract class Node
extends java.lang.Object
implements MessageNode
```
Node is an abstract class of MessageNode. It has two abstract methods, propagate() and initRuleset(). Other methods can be overridden if it is necessary.

There are 3 metadata lists for tracking the internal state and the stats of the node. The first one is msgList for the internal state of all the outstanding messages in the uplink of the node. An outstanding message is the message still in process and not committed from the internal queue yet. In most scenarios, if a message is outstanding for a long time, it means the down stream of the message flow gets stuck somehow.

The next list is assetList for all the outlinks. The metadata field of OUT_STATUS is for the status of the outlink. OUT_SIZE is for the number of outstanding messages on the outlink. OUT_COUNT is for the total number of committed messages on the outlink since the reset. OUT_TIME is for the time of the latest change on the metadata of the outlink.

The last one is ruleList for all the rulesets of the node. The metadata field of RULE_STATUS is for the status of the ruleset. RULE_SIZE is for the number of outstanding messages with the ruleset. RULE_COUNT is for the total number of committed messages since the reset. RULE_PEND is for the number of cached or pending messages, depending on the function of the node. RULE_TIME is for the time of the latest change on the metadata.

There is also a configuration list for generating dynamic rulesets. It manages a list of configuration properties for rulesets. So the node is able to download or monitor the properties from certain external data sources.

By default, the interanl XQueue is not supported. In case the node supports dynamic XQueues, please make sure to overwrite the methods of internalXQSupported() and takebackEnabled().

Author:

yannanlu@yahoo.com

Field Summary

Fields
Modifier and Type	Field and Description
`protected AssetList`	`assetList`
`protected int`	`bufferSize`
`protected java.lang.reflect.Method`	`callbackMethod`
`protected int`	`capacity`
`protected XQCallbackWrapper`	`cbw`
`protected CollectibleCells`	`cells`
`protected AssetList`	`cfgList`
`protected int`	`chkptExpiration`
`protected int`	`debug`
`protected static int`	`DEBUG_COLL`
`protected static int`	`DEBUG_DIFF`
`protected static int`	`DEBUG_FBAK`
`protected static int`	`DEBUG_INIT`
`protected static int`	`DEBUG_PASS`
`protected static int`	`DEBUG_PROP`
`protected static int`	`DEBUG_REPT`
`protected static int`	`DEBUG_UPDT`
`protected int`	`displayMask`
`protected java.lang.String[]`	`displayPropertyName`
`protected java.lang.String`	`linkName`
`protected static int`	`LOAD_HIGH`
`protected static int`	`LOAD_LOW`
`protected static int`	`LOAD_MEDIUM`
`protected AssetList`	`msgList`
`protected java.lang.String`	`name`
`protected java.lang.String`	`operation`
`protected static int`	`RESET_ALL`
`protected static int`	`RESET_MAP`
`protected static int`	`RESET_NONE`
`protected static int`	`RESET_SOME`
`protected AssetList`	`ruleList`
`protected int`	`status`
`protected static int`	`TYPE_ACTION`
`protected static int`	`TYPE_AGGREGATE`
`protected static int`	`TYPE_BYPASS`
`protected static int`	`TYPE_CACHE`
`protected static int`	`TYPE_COLLECT`
`protected static int`	`TYPE_DELIVER`
`protected static int`	`TYPE_FORMAT`
`protected static int`	`TYPE_JSONPATH`
`protected static int`	`TYPE_JSONT`
`protected static int`	`TYPE_MAPREDUCE`
`protected static int`	`TYPE_NONE`
`protected static int`	`TYPE_PARSER`
`protected static int`	`TYPE_PICKUP`
`protected static int`	`TYPE_PIPE`
`protected static int`	`TYPE_PUBLISH`
`protected static int`	`TYPE_ROUNDROBIN`
`protected static int`	`TYPE_SCREEN`
`protected static int`	`TYPE_SCRIPT`
`protected static int`	`TYPE_SERVICE`
`protected static int`	`TYPE_SORT`
`protected static int`	`TYPE_SPLIT`
`protected static int`	`TYPE_SPREAD`
`protected static int`	`TYPE_WEIGHTED`
`protected static int`	`TYPE_XPATH`
`protected static int`	`TYPE_XSLT`
`protected long`	`waitTime`
`protected int`	`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

Node(java.util.Map props)

Constructors
Constructor and Description
`Node(java.util.Map props)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`addRule(java.util.Map ph)` It adds a new rule to the ruleList and returns its id upon success.
`void`	`callback(java.lang.String key, java.lang.String id)` It marks the cell in cells with key and id.
`java.util.Map<java.lang.String,java.lang.Object>`	`checkpoint()` It returns the checkpoint map for current state
`void`	`close()` It closes all resources and cleans up all list, cache, metadata, etc.
`protected int`	`collectAll(long currentTime, XQueue in, XQueue out, int oid, long[] outInfo)` It collects all the delivered messages in the given xq and returns the total number of collected upon success.
`boolean`	`containsRule(java.lang.String key)` returns true if the rule exists or false otherwise
`boolean`	`containsXQ(java.lang.String key)` returns true if the node has the outlink
`protected int`	`feedback(XQueue in, long milliSec)` It returns the number of done messages removed from the input XQueue.
`protected void`	`finalize()`
`protected int`	`forcethru(long currentTime, javax.jms.Message msg, XQueue in, int rid, int oid, int cid)` It forces to route the msg to oid without putback.
`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 -1 since there is no outlinks for collectibles by default
`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
`protected abstract java.util.Map`	`initRuleset(long t, java.util.Map ph, long[] ruleInfo)` It initializes a new ruleset with the ruleInfo and returns the rule upon success.
`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 key, int type)` lists all NEW messages in a specific outlink named by the key and returns a Map or null if it is not defined
`java.util.Map<java.lang.String,java.lang.String>`	`listPendings(XQueue xq, int type)` lists all propagating and pending messages of the node in the uplink and returns a Map or null if it is not defined
`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.
`abstract void`	`propagate(XQueue in, XQueue[] out)` It picks up messages from the input XQueue and evaluates their content to decide which output XQueues to propagate.
`int`	`refreshRule(java.lang.String key, XQueue in)` It refrshes the group of dynamic template rules or external rules for a key and returns the number of rules refreshed upon success.
`int`	`removeRule(java.lang.String key, XQueue in)` It removes the rule from the ruleList and returns the rule id upon success.
`int`	`renameRule(java.lang.String oldkey, java.lang.String key)` It renames the rule and returns the rule id.
`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.
`void`	`resetMetaData(XQueue in, XQueue[] out)` It cleans up MetaData for all XQueues and messages.
`void`	`restore(java.util.Map<java.lang.String,java.lang.Object> chkpt)` It restores the state from a checkpointed map
`int`	`rotateRule(java.lang.String key)` It moves the rule to the end of the list and returns the 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 key, 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 key, int id)` removes the message at the id-th cell from the given outlink and returns the message upon success
`protected boolean`	`takebackEnabled()`
`int`	`updateParameters(java.util.Map ph)` It updates the parameters of the node with the given property map.

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

- Field Detail
  - name
```
protected java.lang.String name
```
  - operation
```
protected java.lang.String operation
```
  - linkName
```
protected java.lang.String linkName
```
  - xaMode
```
protected int xaMode
```
  - capacity
```
protected int capacity
```
  - displayMask
```
protected int displayMask
```
  - debug
```
protected int debug
```
  - status
```
protected int status
```
  - bufferSize
```
protected int bufferSize
```
  - chkptExpiration
```
protected int chkptExpiration
```
  - waitTime
```
protected long waitTime
```
  - displayPropertyName
```
protected java.lang.String[] displayPropertyName
```
  - msgList
```
protected AssetList msgList
```
  - assetList
```
protected AssetList assetList
```
  - ruleList
```
protected AssetList ruleList
```
  - cfgList
```
protected AssetList cfgList
```
  - cells
```
protected CollectibleCells cells
```
  - cbw
```
protected XQCallbackWrapper cbw
```
  - callbackMethod
```
protected java.lang.reflect.Method callbackMethod
```
  - DEBUG_INIT
```
protected static final int DEBUG_INIT
```
    See Also:
    
    Constant Field Values
  - DEBUG_REPT
```
protected static final int DEBUG_REPT
```
    See Also:
    
    Constant Field Values
  - DEBUG_PROP
```
protected static final int DEBUG_PROP
```
    See Also:
    
    Constant Field Values
  - DEBUG_UPDT
```
protected static final int DEBUG_UPDT
```
    See Also:
    
    Constant Field Values
  - DEBUG_COLL
```
protected static final int DEBUG_COLL
```
    See Also:
    
    Constant Field Values
  - DEBUG_PASS
```
protected static final int DEBUG_PASS
```
    See Also:
    
    Constant Field Values
  - DEBUG_FBAK
```
protected static final int DEBUG_FBAK
```
    See Also:
    
    Constant Field Values
  - DEBUG_DIFF
```
protected static final int DEBUG_DIFF
```
    See Also:
    
    Constant Field Values
  - TYPE_NONE
```
protected static final int TYPE_NONE
```
    See Also:
    
    Constant Field Values
  - TYPE_ROUNDROBIN
```
protected static final int TYPE_ROUNDROBIN
```
    See Also:
    
    Constant Field Values
  - TYPE_WEIGHTED
```
protected static final int TYPE_WEIGHTED
```
    See Also:
    
    Constant Field Values
  - TYPE_BYPASS
```
protected static final int TYPE_BYPASS
```
    See Also:
    
    Constant Field Values
  - TYPE_SCREEN
```
protected static final int TYPE_SCREEN
```
    See Also:
    
    Constant Field Values
  - TYPE_AGGREGATE
```
protected static final int TYPE_AGGREGATE
```
    See Also:
    
    Constant Field Values
  - TYPE_PARSER
```
protected static final int TYPE_PARSER
```
    See Also:
    
    Constant Field Values
  - TYPE_XSLT
```
protected static final int TYPE_XSLT
```
    See Also:
    
    Constant Field Values
  - TYPE_COLLECT
```
protected static final int TYPE_COLLECT
```
    See Also:
    
    Constant Field Values
  - TYPE_SPLIT
```
protected static final int TYPE_SPLIT
```
    See Also:
    
    Constant Field Values
  - TYPE_FORMAT
```
protected static final int TYPE_FORMAT
```
    See Also:
    
    Constant Field Values
  - TYPE_DELIVER
```
protected static final int TYPE_DELIVER
```
    See Also:
    
    Constant Field Values
  - TYPE_SORT
```
protected static final int TYPE_SORT
```
    See Also:
    
    Constant Field Values
  - TYPE_ACTION
```
protected static final int TYPE_ACTION
```
    See Also:
    
    Constant Field Values
  - TYPE_XPATH
```
protected static final int TYPE_XPATH
```
    See Also:
    
    Constant Field Values
  - TYPE_PICKUP
```
protected static final int TYPE_PICKUP
```
    See Also:
    
    Constant Field Values
  - TYPE_SPREAD
```
protected static final int TYPE_SPREAD
```
    See Also:
    
    Constant Field Values
  - TYPE_CACHE
```
protected static final int TYPE_CACHE
```
    See Also:
    
    Constant Field Values
  - TYPE_PUBLISH
```
protected static final int TYPE_PUBLISH
```
    See Also:
    
    Constant Field Values
  - TYPE_SERVICE
```
protected static final int TYPE_SERVICE
```
    See Also:
    
    Constant Field Values
  - TYPE_PIPE
```
protected static final int TYPE_PIPE
```
    See Also:
    
    Constant Field Values
  - TYPE_JSONPATH
```
protected static final int TYPE_JSONPATH
```
    See Also:
    
    Constant Field Values
  - TYPE_JSONT
```
protected static final int TYPE_JSONT
```
    See Also:
    
    Constant Field Values
  - TYPE_MAPREDUCE
```
protected static final int TYPE_MAPREDUCE
```
    See Also:
    
    Constant Field Values
  - TYPE_SCRIPT
```
protected static final int TYPE_SCRIPT
```
    See Also:
    
    Constant Field Values
  - LOAD_LOW
```
protected static final int LOAD_LOW
```
    See Also:
    
    Constant Field Values
  - LOAD_MEDIUM
```
protected static final int LOAD_MEDIUM
```
    See Also:
    
    Constant Field Values
  - LOAD_HIGH
```
protected static final int LOAD_HIGH
```
    See Also:
    
    Constant Field Values
  - RESET_NONE
```
protected static final int RESET_NONE
```
    See Also:
    
    Constant Field Values
  - RESET_SOME
```
protected static final int RESET_SOME
```
    See Also:
    
    Constant Field Values
  - RESET_ALL
```
protected static final int RESET_ALL
```
    See Also:
    
    Constant Field Values
  - RESET_MAP
```
protected static final int RESET_MAP
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Node
```
public Node(java.util.Map props)
```
- Method Detail
  - initRuleset
```
protected abstract java.util.Map initRuleset(long t,
                                             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.
  - propagate
```
public abstract void propagate(XQueue in,
                               XQueue[] out)
                        throws javax.jms.JMSException
```
    It picks up messages from the input XQueue and evaluates their content to decide which output XQueues to propagate.
    
    Specified by:
    
    propagate in interface MessageNode
    
    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 callbacks and no update on rule stats either. If tid is less than 0, msg will not be put back to uplink in case of failure.
  - forcethru
```
protected int forcethru(long currentTime,
                        javax.jms.Message msg,
                        XQueue in,
                        int rid,
                        int oid,
                        int cid)
```
    It forces to route the msg to oid without putback. It returns 1 upon success, 0 with msg removed from uplink and flushed to the outlink, or -1 with msg dropped.
  - feedback
```
protected int feedback(XQueue in,
                       long milliSec)
```
    It returns the number of done messages removed from the input XQueue. If milliSec is less than 0, there is no wait and it tries to collect all cells. Otherwise, it just tries to collect only one cell.
  - callback
```
public void callback(java.lang.String key,
                     java.lang.String id)
```
    It marks the cell in cells with key and id.
  - collectAll
```
protected int collectAll(long currentTime,
                         XQueue in,
                         XQueue out,
                         int oid,
                         long[] outInfo)
```
    It collects all the delivered messages in the given xq and returns the total number of collected upon success. If the uplink is in standby mode, it stops the collections and returns -1 immediatly.
  - updateParameters
```
public int updateParameters(java.util.Map ph)
```
    It updates the parameters of the node with the given property map. Upon success, it returns the number of parameters modified. It is not MT-Safe.
    
    Specified by:
    
    updateParameters in interface MessageNode
  - addRule
```
public int addRule(java.util.Map ph)
```
    It adds a new rule to the ruleList and returns its id upon success. It is not MT-Safe.
    
    Specified by:
    
    addRule in interface MessageNode
  - 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
  - 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
  - renameRule
```
public int renameRule(java.lang.String oldkey,
                      java.lang.String key)
```
    It renames the rule and returns the rule id. It is not MT-Safe.
    
    Specified by:
    
    renameRule in interface MessageNode
  - rotateRule
```
public int rotateRule(java.lang.String key)
```
    It moves the rule to the end of the list and returns the id. It is not MT-Safe.
    
    Specified by:
    
    rotateRule in interface MessageNode
  - refreshRule
```
public int refreshRule(java.lang.String key,
                       XQueue in)
```
    It refrshes the group of dynamic template rules or external rules for a key and returns the number of rules refreshed upon success. It is not MT-Safe.
    
    Specified by:
    
    refreshRule in interface MessageNode
  - containsRule
```
public boolean containsRule(java.lang.String key)
```
    Description copied from interface: MessageNode
    
    returns true if the rule exists or false otherwise
    
    Specified by:
    
    containsRule in interface MessageNode
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: MessageNode
    
    returns the name of the node
    
    Specified by:
    
    getName in interface MessageNode
  - getOperation
```
public java.lang.String getOperation()
```
    Description copied from interface: MessageNode
    
    returns the string of the operation
    
    Specified by:
    
    getOperation in interface MessageNode
  - getLinkName
```
public java.lang.String getLinkName()
```
    Description copied from interface: MessageNode
    
    returns the name of the uplink
    
    Specified by:
    
    getLinkName in interface MessageNode
  - getLinkName
```
public java.lang.String getLinkName(int i)
```
    Description copied from interface: MessageNode
    
    returns the name of the i-th outlink
    
    Specified by:
    
    getLinkName in interface MessageNode
  - getNumberOfOutLinks
```
public int getNumberOfOutLinks()
```
    Description copied from interface: MessageNode
    
    returns the total number of outlinks
    
    Specified by:
    
    getNumberOfOutLinks in interface MessageNode
  - getOutLinkBoundary
```
public int getOutLinkBoundary()
```
    returns -1 since there is no outlinks for collectibles by default
    
    Specified by:
    
    getOutLinkBoundary in interface MessageNode
  - getCapacity
```
public int getCapacity()
```
    Description copied from interface: MessageNode
    
    returns the capacity of the uplink
    
    Specified by:
    
    getCapacity in interface MessageNode
  - getCapacity
```
public int getCapacity(int i)
```
    Description copied from interface: MessageNode
    
    returns the capacity of the i-th outlink
    
    Specified by:
    
    getCapacity in interface MessageNode
  - getXAMode
```
public int getXAMode()
```
    Description copied from interface: MessageNode
    
    returns the transaction mode of the uplink
    
    Specified by:
    
    getXAMode in interface MessageNode
  - getXAMode
```
public int getXAMode(int i)
```
    Description copied from interface: MessageNode
    
    returns the transaction mode of the i-th outlink
    
    Specified by:
    
    getXAMode in interface MessageNode
  - getStatus
```
public int getStatus()
```
    Description copied from interface: MessageNode
    
    returns the status of the node
    
    Specified by:
    
    getStatus in interface MessageNode
  - setStatus
```
public void setStatus(int status)
```
    Description copied from interface: MessageNode
    
    sets the status of the node
    
    Specified by:
    
    setStatus in interface MessageNode
  - getRuleName
```
public java.lang.String getRuleName(int i)
```
    Description copied from interface: MessageNode
    
    returns the name of the i-th RuleSet
    
    Specified by:
    
    getRuleName in interface MessageNode
  - getNumberOfRules
```
public int getNumberOfRules()
```
    Description copied from interface: MessageNode
    
    returns the total number of RuleSets
    
    Specified by:
    
    getNumberOfRules in interface MessageNode
  - getDisplayMask
```
public int getDisplayMask()
```
    Description copied from interface: MessageNode
    
    returns the displayMask of the node
    
    Specified by:
    
    getDisplayMask in interface MessageNode
  - setDisplayMask
```
public void setDisplayMask(int mask)
```
    Description copied from interface: MessageNode
    
    sets the displayMask of the node
    
    Specified by:
    
    setDisplayMask in interface MessageNode
  - getDebugMode
```
public int getDebugMode()
```
    Description copied from interface: MessageNode
    
    returns the debug mode of the node
    
    Specified by:
    
    getDebugMode in interface MessageNode
  - setDebugMode
```
public void setDebugMode(int debug)
```
    Description copied from interface: MessageNode
    
    sets the debug mode of the node
    
    Specified by:
    
    setDebugMode in interface MessageNode
  - getDisplayProperties
```
public java.lang.String[] getDisplayProperties()
```
    Description copied from interface: MessageNode
    
    gets the display property names of the node
    
    Specified by:
    
    getDisplayProperties in interface MessageNode
  - setDisplayProperties
```
public void setDisplayProperties(java.lang.String[] keys)
```
    Description copied from interface: MessageNode
    
    sets the display property names of the node
    
    Specified by:
    
    setDisplayProperties in interface MessageNode
  - getMetaData
```
public int getMetaData(int type,
                       int id,
                       long[] data)
```
    Description copied from interface: MessageNode
    
    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
    
    Specified by:
    
    getMetaData in interface MessageNode
  - resetMetaData
```
public void resetMetaData(XQueue in,
                          XQueue[] out)
```
    It cleans up MetaData for all XQueues and messages.
    
    Specified by:
    
    resetMetaData in interface MessageNode
  - checkpoint
```
public java.util.Map<java.lang.String,java.lang.Object> checkpoint()
```
    It returns the checkpoint map for current state
    
    Specified by:
    
    checkpoint in interface MessageNode
  - restore
```
public void restore(java.util.Map<java.lang.String,java.lang.Object> chkpt)
```
    It restores the state from a checkpointed map
    
    Specified by:
    
    restore in interface MessageNode
  - containsXQ
```
public boolean containsXQ(java.lang.String key)
```
    Description copied from interface: MessageNode
    
    returns true if the node has the outlink
    
    Specified by:
    
    containsXQ in interface MessageNode
  - internalXQSupported
```
public boolean internalXQSupported()
```
    Description copied from interface: MessageNode
    
    returns true if the node supports internal XQueues for outlinks
    
    Specified by:
    
    internalXQSupported in interface MessageNode
  - takebackEnabled
```
protected boolean takebackEnabled()
```
  - takeback
```
public javax.jms.Message takeback(java.lang.String key,
                                  int id)
```
    Description copied from interface: MessageNode
    
    removes the message at the id-th cell from the given outlink and returns the message upon success
    
    Specified by:
    
    takeback in interface MessageNode
  - close
```
public void close()
```
    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
  - show
```
public java.lang.String show(java.lang.String key,
                             int id,
                             int type)
```
    Description copied from interface: MessageNode
    
    browses the message at the id-th cell from the given outlink and returns the detail text in the given format type
    
    Specified by:
    
    show in interface MessageNode
  - list
```
public java.util.Map<java.lang.String,java.lang.String> list(java.lang.String key,
                                                             int type)
```
    lists all NEW messages in a specific outlink named by the key and returns a Map or null if it is not defined
    
    Specified by:
    
    list in interface MessageNode
  - listPendings
```
public java.util.Map<java.lang.String,java.lang.String> listPendings(XQueue xq,
                                                                     int type)
```
    lists all propagating and pending messages of the node in the uplink and returns a Map or null if it is not defined
    
    Specified by:
    
    listPendings in interface MessageNode
  - finalize
```
protected void finalize()
```
    Overrides:
    
    finalize in class java.lang.Object

Class Node

Field Summary

Fields inherited from interface org.qbroker.node.MessageNode

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

operation

linkName

xaMode

capacity

displayMask

debug

status

bufferSize

chkptExpiration

waitTime

displayPropertyName

msgList

assetList

ruleList

cfgList

cells

cbw

callbackMethod

DEBUG_INIT

DEBUG_REPT

DEBUG_PROP

DEBUG_UPDT

DEBUG_COLL

DEBUG_PASS

DEBUG_FBAK

DEBUG_DIFF

TYPE_NONE

TYPE_ROUNDROBIN

TYPE_WEIGHTED

TYPE_BYPASS

TYPE_SCREEN

TYPE_AGGREGATE

TYPE_PARSER

TYPE_XSLT

TYPE_COLLECT

TYPE_SPLIT

TYPE_FORMAT

TYPE_DELIVER

TYPE_SORT

TYPE_ACTION

TYPE_XPATH

TYPE_PICKUP

TYPE_SPREAD

TYPE_CACHE

TYPE_PUBLISH

TYPE_SERVICE

TYPE_PIPE

TYPE_JSONPATH

TYPE_JSONT

TYPE_MAPREDUCE

TYPE_SCRIPT

LOAD_LOW

LOAD_MEDIUM

LOAD_HIGH

RESET_NONE

RESET_SOME

RESET_ALL

RESET_MAP

Constructor Detail

Node

Method Detail

initRuleset

propagate

passthru

forcethru

feedback

callback

collectAll

updateParameters

addRule

removeRule

replaceRule