tigase.server.sreceiver
Class StanzaReceiver

java.lang.Object
  tigase.server.AbstractMessageReceiver
      tigase.server.sreceiver.StanzaReceiver

All Implemented Interfaces:

Configurable, XMPPService, MessageReceiver, ServerComponent, StanzaReceiverIfc, StatisticsContainer, VHostListener

public class StanzaReceiver
extends AbstractMessageReceiver
implements Configurable, XMPPService, StanzaReceiverIfc

This is a sibbling of StanzaSender class and offers just an opposite functionaity. It can receive XMPP packets to do something with them. And what to do it depends on the destination address. Destination address points to certain receiver task and this is up to task to decide what to do with the stanza. Task address is just a usuall Jabber ID: task-short-name@srec.tigase.org.

Like public chat rooms in MUC tasks can be preconfigured in the StanzaReceiver configuration or can be created on demand using ad-hoc commands and service-discovery. User can subscribe to some tasks and can add them to the roster just like a normal contacts. This allows to use the functionality from all existing clients without implementing any special protocols or extensions.

Possible tasks are:

• Interests groups - simple stanza (message) distribution to a group of interested ppl. To receive this information user has to subscribe to the task first. It is a bit like a MUC without a chat room or like a mailing list.
• Persistent storage - which is like an archaive of some information for group of ppl.
• Web page publishing - this might be useful for web sites with kind of Short, instant news board where selected users can send information and they are published instantly. (Through the database for example.)
• Forums integration - this might be useful for kind of forums where you can post messages from Web site as well as from your Jabber client.

Task creation parameters:

• Task short name - the nick name of the task which is used to create Jabber ID for the task.
• Task description - description of the task what is the purpose of the task.
• Task type - the server, through ad-hoc commands should present available tasks types which can be created. User can select a task to create. There may be some restrictions on tasks creation like certain types can be created only by server administrator or some tasks types can be created only once on single server and so on.
• Subscrption list - server admin should be able to add list of users who might be interested in subscription to the task. After task is created subscrive presence is sent to these users and they can accept the subscription or not.
• Subscription restrictions - who may subscribe to the task like: public task - anybody can subscribe, local users only - users from the local server (domain) only can subscribe, by regex - regular expresion matching JIDs, moderated subscription - anybody may request subscription but the creator of the task must approve the subscription.
• On line only - the task may distribute packets to online users only.
• Replace sender address - whether sender address should be replaced with task address. This might be useful depending where the responses should go. If the list is kind on announces board like new version release then maybe replies should go to the sender. If this is more like topic discussion group then the reply should go to all subscribers.
• Message type - whether messages should be distributed as a chat, headline or normal.
• Who can post - who can send a message for processing, possible options are: all, subscribed, owner, list

There can be also some per task specific settings...

Created: Wed May 9 08:27:22 2007

Version:

$Rev: 1766 $

Author:

Artur Hefczyc

Field Summary

static java.lang.String	MY_DOMAIN_NAME_PROP_KEY
static java.lang.String	MY_DOMAIN_NAME_PROP_VAL

Fields inherited from class tigase.server.AbstractMessageReceiver

HOUR, MAX_QUEUE_SIZE_PROP_KEY, MAX_QUEUE_SIZE_PROP_VAL, maxQueueSize, MINUTE, SECOND, vHostManager

Fields inherited from interface tigase.conf.Configurable

ADMINS_PROP_KEY, AUTH_REPO_CLASS_PROP_KEY, AUTH_REPO_PARAMS_NODE, AUTH_REPO_URL_PROP_KEY, 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, COMPONENT_ID_PROP_KEY, DEF_BOSH_NAME, DEF_C2S_NAME, DEF_CL_COMP_NAME, DEF_CLUST_CONTR_NAME, DEF_EXT_COMP_NAME, DEF_HOSTNAME_PROP_KEY, 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_CLASS_PROP_VAL, DRUPAL_REPO_URL_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_SM_PLUGINS, GEN_SREC_ADMINS, GEN_SREC_DB, GEN_SREC_DB_URI, GEN_TEST, GEN_TRUSTED, GEN_USER_DB, GEN_USER_DB_URI, GEN_VIRT_HOSTS, HOSTNAMES_PROP_KEY, LIBRESOURCE_REPO_CLASS_PROP_VAL, LIBRESOURCE_REPO_URL_PROP_VAL, MONITORING, MYSQL_REPO_CLASS_PROP_VAL, MYSQL_REPO_URL_PROP_VAL, NULL_ROUTING, 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_POOL_PROP_KEY, SHARED_USER_REPO_PROP_KEY, SM_CLUS_COMP_CLASS_NAME, SM_COMP_CLASS_NAME, SRECV_COMP_CLASS_NAME, SSEND_COMP_CLASS_NAME, STATS_CLASS_NAME, TIGASE_AUTH_REPO_CLASS_PROP_VAL, TIGASE_AUTH_REPO_URL_PROP_VAL, TIGASE_CUSTOM_AUTH_REPO_CLASS_PROP_VAL, TRUSTED_PROP_KEY, USER_REPO_CLASS_PROP_KEY, USER_REPO_PARAMS_NODE, 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

Fields inherited from interface tigase.disco.XMPPService

CMD_FEATURES, DEF_FEATURES, INFO_XMLNS, ITEMS_XMLNS

Constructor Summary

StanzaReceiver()

Method Summary

boolean	addOutPacket(Packet packet)
protected void	addTaskInstance(ReceiverTaskIfc task) Describe addTaskInstance method here.
protected void	addTaskInstance(java.lang.String task_type, java.lang.String task_name, java.util.Map<java.lang.String,java.lang.Object> task_params)
java.util.Map<java.lang.String,java.lang.Object>	getDefaults(java.util.Map<java.lang.String,java.lang.Object> params) Returns defualt configuration settings for this object.
java.util.List<tigase.xml.Element>	getDiscoFeatures() Returns features for top level disco info
tigase.xml.Element	getDiscoInfo(java.lang.String node, java.lang.String jid) Describe getDiscoInfo method here.
java.util.List<tigase.xml.Element>	getDiscoItems(java.lang.String node, java.lang.String jid)
void	getStatistics(StatisticsList list)
ReceiverTaskIfc	getTask(java.lang.String jidOrName)
protected java.util.Map<java.lang.String,ReceiverTaskIfc>	getTaskInstances()
protected java.util.Map<java.lang.String,TaskType>	getTaskTypes()
protected boolean	isAdmin(java.lang.String jid)
protected boolean	isAllowedCreate(java.lang.String jid, java.lang.String task_type)
void	processPacket(Packet packet) Describe processPacket method here.
protected void	removeTaskInstance(ReceiverTaskIfc task)
protected void	removeTaskSubscribers(ReceiverTaskIfc task, java.lang.String... subscr)
protected void	saveTaskToRepository(ReceiverTaskIfc task)
void	setProperties(java.util.Map<java.lang.String,java.lang.Object> props) Describe setProperties method here.

Methods inherited from class tigase.server.AbstractMessageReceiver

addOutPacketNB, addOutPackets, addOutPacketWithTimeout, addPacket, addPacketNB, addPackets, addRegexRouting, clearRegexRoutings, everyHour, everyMinute, everySecond, getComponentId, getDefHostName, getMaxQueueSize, getName, getRegexRoutings, getVHostItem, handlesLocalDomains, handlesNameSubdomains, handlesNonLocalDomains, hashCodeForPacket, initializationCompleted, isInRegexRoutings, isLocalDomain, isLocalDomainOrComponent, newPacketId, processingThreads, processPacket, release, removeRegexRouting, setMaxQueueSize, setName, setParent, setVHostManager, start, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface tigase.conf.Configurable

getName

Methods inherited from interface tigase.server.ServerComponent

getComponentId, initializationCompleted, processPacket, release, setName

Methods inherited from interface tigase.server.sreceiver.StanzaReceiverIfc

getDefHostName, getName

Field Detail

MY_DOMAIN_NAME_PROP_KEY

public static final java.lang.String MY_DOMAIN_NAME_PROP_KEY

See Also:

Constant Field Values

MY_DOMAIN_NAME_PROP_VAL

public static final java.lang.String MY_DOMAIN_NAME_PROP_VAL

See Also:

Constant Field Values

Constructor Detail

StanzaReceiver

public StanzaReceiver()

Method Detail

isAllowedCreate

protected boolean isAllowedCreate(java.lang.String jid,
                                  java.lang.String task_type)

addTaskInstance

protected void addTaskInstance(java.lang.String task_type,
                               java.lang.String task_name,
                               java.util.Map<java.lang.String,java.lang.Object> task_params)

addTaskInstance

protected void addTaskInstance(ReceiverTaskIfc task)

Describe addTaskInstance method here.

Parameters:

task - a ReceiverTaskIfc value

removeTaskInstance

protected void removeTaskInstance(ReceiverTaskIfc task)

removeTaskSubscribers

protected void removeTaskSubscribers(ReceiverTaskIfc task,
                                     java.lang.String... subscr)

getTaskTypes

protected java.util.Map<java.lang.String,TaskType> getTaskTypes()

getTaskInstances

protected java.util.Map<java.lang.String,ReceiverTaskIfc> getTaskInstances()

saveTaskToRepository

protected void saveTaskToRepository(ReceiverTaskIfc task)
                             throws TigaseDBException

Throws:

TigaseDBException

setProperties

public void setProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Describe setProperties method here.

Specified by:

setProperties in interface Configurable

Overrides:

setProperties in class AbstractMessageReceiver

Parameters:

props - a Map value

getDefaults

public java.util.Map<java.lang.String,java.lang.Object> getDefaults(java.util.Map<java.lang.String,java.lang.Object> params)

Description copied from class: AbstractMessageReceiver

Returns defualt configuration settings for this object.

Specified by:

getDefaults in interface Configurable

Overrides:

getDefaults in class AbstractMessageReceiver

Returns:

isAdmin

protected boolean isAdmin(java.lang.String jid)

processPacket

public void processPacket(Packet packet)

Describe processPacket method here.

Specified by:

processPacket in class AbstractMessageReceiver

Parameters:

packet - a Packet value

getTask

public ReceiverTaskIfc getTask(java.lang.String jidOrName)

getDiscoInfo

public tigase.xml.Element getDiscoInfo(java.lang.String node,
                                       java.lang.String jid)

Describe getDiscoInfo method here.

Specified by:

getDiscoInfo in interface XMPPService

Parameters:

node - a String value

jid - a String value

Returns:

an Element value

getDiscoFeatures

public java.util.List<tigase.xml.Element> getDiscoFeatures()

Description copied from interface: XMPPService

Returns features for top level disco info

Specified by:

getDiscoFeatures in interface XMPPService

Returns:

getDiscoItems

public java.util.List<tigase.xml.Element> getDiscoItems(java.lang.String node,
                                                        java.lang.String jid)

Specified by:

getDiscoItems in interface XMPPService

addOutPacket

public boolean addOutPacket(Packet packet)

Specified by:

addOutPacket in interface StanzaReceiverIfc

Overrides:

addOutPacket in class AbstractMessageReceiver

getStatistics

public void getStatistics(StatisticsList list)

Specified by:

getStatistics in interface StatisticsContainer

Overrides:

getStatistics in class AbstractMessageReceiver