tigase.server
Class MessageRouter

java.lang.Object
  tigase.server.BasicComponent
      tigase.server.AbstractMessageReceiver
          tigase.server.MessageRouter

All Implemented Interfaces:

Configurable, XMPPService, MessageReceiver, MessageRouterIfc, ServerComponent, StatisticsContainer, VHostListener

public class MessageRouter
extends AbstractMessageReceiver
implements MessageRouterIfc

Class MessageRouter Created: Tue Nov 22 07:07:11 2005

Version:

$Rev: 2996 $

Author:

Artur Hefczyc

Field Summary

Fields inherited from class tigase.server.AbstractMessageReceiver

HOUR, INCOMING_FILTERS_PROP_KEY, INCOMING_FILTERS_PROP_VAL, MAX_QUEUE_SIZE_PROP_KEY, MAX_QUEUE_SIZE_PROP_VAL, maxInQueueSize, maxOutQueueSize, MINUTE, OUTGOING_FILTERS_PROP_KEY, OUTGOING_FILTERS_PROP_VAL, SECOND

Fields inherited from class tigase.server.BasicComponent

admins, ALL_PROP_KEY, COMMAND_PROP_NODE, scriptCommands, SCRIPTS_DIR_PROP_DEF, SCRIPTS_DIR_PROP_KEY, vHostManager

Fields inherited from interface tigase.conf.Configurable

ADMINS_PROP_KEY, AMP_CLASS_NAME, AUTH_DOMAIN_POOL_CLASS, AUTH_REPO_DOMAINS_PROP_KEY, AUTH_REPO_PARAMS_NODE, AUTH_REPO_POOL_CLASS, AUTH_REPO_URL_PROP_KEY, BOSH_CLUST_COMP_CLASS_NAME, BOSH_COMP_CLASS_NAME, C2S_CLUST_COMP_CLASS_NAME, C2S_COMP_CLASS_NAME, CL_COMP_CLASS_NAME, CLUSTER_CONECT, CLUSTER_CONTR_CLASS_NAME, CLUSTER_LISTEN, CLUSTER_MODE, CLUSTER_NODES, CLUSTER_NODES_PROP_KEY, COMP_PROT_CLASS_NAME, COMPONENT_ID_PROP_KEY, DEF_AMP_NAME, DEF_BOSH_NAME, DEF_C2S_NAME, DEF_CL_COMP_NAME, DEF_CLUST_CONTR_NAME, DEF_COMP_PROT_NAME, DEF_EXT_COMP_NAME, DEF_HOSTNAME_PROP_KEY, DEF_MONITOR_NAME, DEF_S2S_NAME, DEF_SM_NAME, DEF_SRECV_NAME, DEF_SSEND_NAME, DEF_STATS_NAME, DEF_VHOST_MAN_NAME, DERBY_REPO_CLASS_PROP_VAL, DERBY_REPO_URL_PROP_VAL, DRUPAL_REPO_URL_PROP_VAL, DRUPALWP_REPO_CLASS_PROP_VAL, DUMMY_REPO_CLASS_PROP_VAL, EXT_COMP_CLASS_NAME, GEN_ADMINS, GEN_AUTH_DB, GEN_AUTH_DB_URI, GEN_COMP_CLASS, GEN_COMP_NAME, GEN_CONF, GEN_CONFIG, GEN_CONFIG_ALL, GEN_CONFIG_COMP, GEN_CONFIG_CS, GEN_CONFIG_DEF, GEN_CONFIG_SM, GEN_DEBUG, GEN_DEBUG_PACKAGES, GEN_EXT_COMP, GEN_MAX_QUEUE_SIZE, GEN_SCRIPT_DIR, GEN_SM_PLUGINS, GEN_SREC_ADMINS, GEN_SREC_DB, GEN_SREC_DB_URI, GEN_TEST, GEN_TRUSTED, GEN_USER_DB, GEN_USER_DB_URI, GEN_USER_DB_URI_PROP_KEY, GEN_VIRT_HOSTS, HOSTNAMES_PROP_KEY, LIBRESOURCE_REPO_CLASS_PROP_VAL, LIBRESOURCE_REPO_URL_PROP_VAL, MONITOR_CLASS_NAME, MONITOR_CLUST_CLASS_NAME, MONITORING, MYSQL_REPO_CLASS_PROP_VAL, MYSQL_REPO_URL_PROP_VAL, PGSQL_REPO_CLASS_PROP_VAL, PGSQL_REPO_URL_PROP_VAL, ROUTER_COMP_CLASS_NAME, S2S_CLUST_COMP_CLASS_NAME, S2S_COMP_CLASS_NAME, SHARED_AUTH_REPO_PARAMS_PROP_KEY, SHARED_AUTH_REPO_PROP_KEY, SHARED_USER_REPO_PARAMS_PROP_KEY, SHARED_USER_REPO_PROP_KEY, SM_CLUST_COMP_CLASS_NAME, SM_COMP_CLASS_NAME, SRECV_COMP_CLASS_NAME, SSEND_COMP_CLASS_NAME, STANZA_WHITE_CHAR_ACK, STANZA_XMPP_ACK, STATS_CLASS_NAME, STRINGPREP_PROCESSOR, TIGASE_AUTH_REPO_CLASS_PROP_VAL, TIGASE_AUTH_REPO_URL_PROP_VAL, TIGASE_CUSTOM_AUTH_REPO_CLASS_PROP_VAL, TRUSTED_PROP_KEY, USER_DOMAIN_POOL_CLASS, USER_REPO_DOMAINS_PROP_KEY, USER_REPO_PARAMS_NODE, USER_REPO_POOL_CLASS, USER_REPO_POOL_SIZE, USER_REPO_POOL_SIZE_PROP_KEY, USER_REPO_URL_PROP_KEY, VHOST_MAN_CLASS_NAME, XML_REPO_CLASS_PROP_VAL, XML_REPO_URL_PROP_VAL, XMPP_STANZA_ACK

Fields inherited from interface tigase.disco.XMPPService

CMD_FEATURES, DEF_FEATURES, INFO_XMLNS, ITEMS_XMLNS

Constructor Summary

MessageRouter()

Method Summary

void	addComponent(ServerComponent component) Method description
void	addRegistrator(ComponentRegistrator registr) Method description
void	addRouter(MessageReceiver receiver) Method description
Map<String,Object>	getDefaults(Map<String,Object> params) Method description
tigase.xml.Element	getDiscoInfo(String node, tigase.xmpp.JID jid, tigase.xmpp.JID from) Method description
protected Integer	getMaxQueueSize(int def)
void	getStatistics(StatisticsList list) Method description
int	hashCodeForPacket(Packet packet) This method decides how incoming packets are distributed among processing threads.
int	processingInThreads() Method description
int	processingOutThreads() Method description
void	processPacket(Packet packet) Method description
void	processPacketMR(Packet packet, Queue<Packet> results) Method description
void	setConfig(ConfiguratorAbstract config) Method description
void	setProperties(Map<String,Object> props) Method description

Methods inherited from class tigase.server.AbstractMessageReceiver

addOutPacket, addOutPacketNB, addOutPackets, addOutPacketWithTimeout, addPacket, addPacketNB, addPackets, addRegexRouting, addTimerTask, addTimerTask, clearRegexRoutings, everyHour, everyMinute, everySecond, getRegexRoutings, isInRegexRoutings, newPacketId, processingThreads, processOutPacket, processPacket, release, removeRegexRouting, setMaxQueueSize, setName, setParent, start, stop

Methods inherited from class tigase.server.BasicComponent

addComponentDomain, canCallCommand, checkCommandAcl, getComponentId, getDefHostName, getDiscoCategory, getDiscoCategoryType, getDiscoDescription, getDiscoFeatures, getDiscoFeatures, getDiscoInfo, getDiscoItems, getDiscoItems, getName, getScriptItems, getVHostItem, handlesLocalDomains, handlesNameSubdomains, handlesNonLocalDomains, initBindings, initializationCompleted, isAdmin, isLocalDomain, isLocalDomainOrComponent, processScriptCommand, removeComponentDomain, removeServiceDiscoveryItem, setVHostManager, updateServiceDiscoveryItem, updateServiceDiscoveryItem, updateServiceDiscoveryItem

Methods inherited from class java.lang.Object

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

Methods inherited from interface tigase.server.MessageRouterIfc

start

Methods inherited from interface tigase.server.ServerComponent

getComponentId, getName, initializationCompleted, processPacket, release, setName

Methods inherited from interface tigase.server.MessageReceiver

getDefHostName

Constructor Detail

MessageRouter

public MessageRouter()

Method Detail

addComponent

public void addComponent(ServerComponent component)

Method description

Parameters:

component -

addRegistrator

public void addRegistrator(ComponentRegistrator registr)

Method description

Parameters:

registr -

addRouter

public void addRouter(MessageReceiver receiver)

Method description

Parameters:

receiver -

getDefaults

public Map<String,Object> getDefaults(Map<String,Object> params)

Method description

Specified by:

getDefaults in interface Configurable

Overrides:

getDefaults in class AbstractMessageReceiver

Parameters:

params -

Returns:

getDiscoInfo

public tigase.xml.Element getDiscoInfo(String node,
                                       tigase.xmpp.JID jid,
                                       tigase.xmpp.JID from)

Method description

Specified by:

getDiscoInfo in interface XMPPService

Overrides:

getDiscoInfo in class BasicComponent

Parameters:

node -

jid -

from -

Returns:

getStatistics

public void getStatistics(StatisticsList list)

Method description

Specified by:

getStatistics in interface StatisticsContainer

Overrides:

getStatistics in class AbstractMessageReceiver

Parameters:

list -

processPacket

public void processPacket(Packet packet)

Method description

Specified by:

processPacket in class AbstractMessageReceiver

Parameters:

packet -

processPacketMR

public void processPacketMR(Packet packet,
                            Queue<Packet> results)

Method description

Parameters:

packet -

results -

processingInThreads

public int processingInThreads()

Method description

Overrides:

processingInThreads in class AbstractMessageReceiver

Returns:

processingOutThreads

public int processingOutThreads()

Method description

Overrides:

processingOutThreads in class AbstractMessageReceiver

Returns:

setConfig

public void setConfig(ConfiguratorAbstract config)

Method description

Specified by:

setConfig in interface MessageRouterIfc

Parameters:

config -

setProperties

public void setProperties(Map<String,Object> props)

Method description

Specified by:

setProperties in interface Configurable

Overrides:

setProperties in class AbstractMessageReceiver

Parameters:

props -

getMaxQueueSize

protected Integer getMaxQueueSize(int def)

Overrides:

getMaxQueueSize in class AbstractMessageReceiver

hashCodeForPacket

public int hashCodeForPacket(Packet packet)

Description copied from class: AbstractMessageReceiver

This method decides how incoming packets are distributed among processing threads. Different components needs different distribution to efficient use all threads and avoid packets re-ordering.

If there are N processing threads, packets are distributed among threads using following code:

 int threadNo = Math.abs(hashCodeForPacket(packet) % N);
 

For a PubSub component, for example, a better packets distribution would be based on the PubSub channel name, for SM a better distribution is based on the destination address, etc....

Overrides:

hashCodeForPacket in class AbstractMessageReceiver

Parameters:

packet - is a Packet which needs to be processed by some thread.

Returns:

a hash code generated for the input thread.