tigase.pubsub

Class PubSubComponent

java.lang.Object

tigase.server.BasicComponent

tigase.server.AbstractMessageReceiver

tigase.component2.AbstractComponent<PubSubConfig>

tigase.pubsub.PubSubComponent

All Implemented Interfaces:

tigase.cluster.api.ClusteredComponentIfc, tigase.conf.Configurable, tigase.disco.XMPPService, tigase.server.DisableDisco, tigase.server.MessageReceiver, tigase.server.ServerComponent, tigase.stats.StatisticsContainer, tigase.stats.StatisticsContainerIfc, tigase.vhosts.VHostListener

public class PubSubComponent
extends AbstractComponent<PubSubConfig>
implements tigase.conf.Configurable, tigase.server.DisableDisco

Class description

Version:

5.1.0, 2010.11.02 at 01:05:02 MDT

Author:

Artur Hefczyc

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADMINS_KEY Field description
protected CapsModule	capsModule
static String	DEFAULT_LEAF_NODE_CONFIG_KEY Field description
protected LeafNodeConfig	defaultNodeConfig Field description
static String	DELAYED_ROOT_COLLECTION_LOADING_KEY
protected Integer	maxRepositoryCacheSize Field description
protected PendingSubscriptionModule	pendingSubscriptionModule
protected PresenceCollectorModule	presenceCollectorModule
protected PresenceNotifierModule	presenceNotifierModule
protected PublishItemModule	publishNodeModule
protected static String	PUBSUB_REPO_CLASS_PROP_KEY Field description
protected static String	PUBSUB_REPO_POOL_SIZE_PROP_KEY Field description
protected static String	PUBSUB_REPO_URL_PROP_KEY Field description
protected IPubSubRepository	pubsubRepository Field description
protected tigase.db.UserRepository	userRepository Field description

Fields inherited from class tigase.component2.AbstractComponent

componentConfig, eventBus, log, modulesManager

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, maxQueueSize, MINUTE, OUTGOING_FILTERS_PROP_KEY, OUTGOING_FILTERS_PROP_VAL, PACKET_DELIVERY_RETRY_COUNT_PROP_KEY, SCHEDULER_THREADS_PROP_KEY, SECOND

Fields inherited from class tigase.server.BasicComponent

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

Fields inherited from interface tigase.conf.Configurable

ADMINS_PROP_KEY, AMP_CLASS_NAME, AMP_CLUST_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_EVENTBUS_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, DEF_WS2S_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, EVENTBUS_CLASS_NAME, 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, VHOST_MAN_CLUST_CLASS_NAME, WS2S_CLASS_NAME, WS2S_CLUST_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

Constructors

Constructor and Description
PubSubComponent() Constructs ...

Method Summary

Modifier and Type	Method and Description
protected boolean	checkPubSubServiceJid(tigase.server.Packet packet) Method checks if packet is sent to pubsub@xxx and if so then it returns error as we no longer allow usage of pubsub@xxx address as pubsub service jid since we added support to use PEP and we have multiple domains support with separated nodes.
protected PubSubConfig	createComponentConfigInstance(AbstractComponent<?> abstractComponent) Method description
protected PubSubDAO	createDAO(Map<String,Object> props) Method description
protected IPubSubRepository	createPubSubRepository(PubSubDAO directRepository)
void	everyHour()
void	everyMinute()
void	everySecond()
Map<String,Object>	getDefaults(Map<String,Object> params) Method description
String	getDiscoDescription()
static Map<String,Object>	getProperties(String key, Map<String,Object> props) Method description
void	getStatistics(tigase.stats.StatisticsList list)
int	hashCodeForPacket(tigase.server.Packet packet)
protected void	init() Method description
void	initBindings(Bindings binds) Method description
void	initialize(String[] admins, PubSubDAO pubSubDAO, IPubSubRepository createPubSubRepository, LeafNodeConfig defaultNodeConfig, boolean delayedRootCollectionLoading) Method description
boolean	isDiscoNonAdmin() Is this component discoverable by disco#items for domain by non admin users
boolean	isSubdomain() Method description
void	onChangeDefaultNodeConfig() Method description
int	processingInThreads() Method description
int	processingOutThreads() Method description
void	processPacket(tigase.server.Packet packet) Method description
protected boolean	processScriptCommand(tigase.server.Packet pc, Queue<tigase.server.Packet> results)
void	setProperties(Map<String,Object> props) Method description
void	start()
void	stop()

Methods inherited from class tigase.component2.AbstractComponent

getEventBus, getWriter, isRegistered, processCommandPacket, processStanzaPacket, registerModule, registerModule, sendException, updateServiceEntity

Methods inherited from class tigase.server.AbstractMessageReceiver

addOutPacket, addOutPacketNB, addOutPackets, addOutPacketWithTimeout, addPacket, addPacketNB, addPackets, addRegexRouting, addTimerTask, addTimerTask, addTimerTask, addTimerTask, addTimerTask, addTimerTaskWithTimeout, addTimerTaskWithTimeout, clearRegexRoutings, getMaxQueueSize, getRegexRoutings, isInRegexRoutings, newPacketId, processingThreads, processOutPacket, processPacket, release, removeRegexRouting, schedulerThreads, setMaxQueueSize, setName, setParent

Methods inherited from class tigase.server.BasicComponent

addComponentDomain, canCallCommand, checkCommandAcl, getComponentId, getComponentInfo, getDefHostName, getDefVHostItem, getDiscoCategory, getDiscoCategoryType, getDiscoFeatures, getDiscoFeatures, getDiscoInfo, getDiscoInfo, getDiscoItems, getDiscoItems, getName, getNodesConnected, getNodesConnectedWithLocal, getScriptCommands, getScriptItems, getServiceEntity, getVHostItem, handlesLocalDomains, handlesNameSubdomains, handlesNonLocalDomains, initializationCompleted, isAdmin, isInitializationComplete, isLocalDomain, isLocalDomainOrComponent, isNonAdminCommands, isTrusted, isTrusted, nodeConnected, nodeDisconnected, onNodeConnected, onNodeDisconnected, removeComponentDomain, removeServiceDiscoveryItem, setClusterController, 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.ServerComponent

getComponentId, getComponentInfo, getName, initializationCompleted, isInitializationComplete, processPacket, release, setName

Methods inherited from interface tigase.disco.XMPPService

getDiscoFeatures, getDiscoInfo, getDiscoItems

Methods inherited from interface tigase.stats.StatisticsContainerIfc

getName

Methods inherited from interface tigase.server.MessageReceiver

getDefHostName

Field Detail

ADMINS_KEY

public static final String ADMINS_KEY

Field description

See Also:

Constant Field Values

DEFAULT_LEAF_NODE_CONFIG_KEY

public static final String DEFAULT_LEAF_NODE_CONFIG_KEY

Field description

See Also:

Constant Field Values

DELAYED_ROOT_COLLECTION_LOADING_KEY

public static final String DELAYED_ROOT_COLLECTION_LOADING_KEY

See Also:

Constant Field Values

PUBSUB_REPO_CLASS_PROP_KEY

protected static final String PUBSUB_REPO_CLASS_PROP_KEY

Field description

See Also:

Constant Field Values

PUBSUB_REPO_POOL_SIZE_PROP_KEY

protected static final String PUBSUB_REPO_POOL_SIZE_PROP_KEY

Field description

See Also:

Constant Field Values

PUBSUB_REPO_URL_PROP_KEY

protected static final String PUBSUB_REPO_URL_PROP_KEY

Field description

See Also:

Constant Field Values

capsModule

protected CapsModule capsModule

defaultNodeConfig

protected LeafNodeConfig defaultNodeConfig

Field description

maxRepositoryCacheSize

protected Integer maxRepositoryCacheSize

Field description

pendingSubscriptionModule

protected PendingSubscriptionModule pendingSubscriptionModule

presenceCollectorModule

protected PresenceCollectorModule presenceCollectorModule

presenceNotifierModule

protected PresenceNotifierModule presenceNotifierModule

publishNodeModule

protected PublishItemModule publishNodeModule

pubsubRepository

protected IPubSubRepository pubsubRepository

Field description

userRepository

protected tigase.db.UserRepository userRepository

Field description

Constructor Detail

PubSubComponent

public PubSubComponent()

Constructs ...

Method Detail

getProperties

public static Map<String,Object> getProperties(String key,
                                               Map<String,Object> props)

Method description

Parameters:

key - is a String

props - is a Map

Returns:

a value of Map

createComponentConfigInstance

protected PubSubConfig createComponentConfigInstance(AbstractComponent<?> abstractComponent)

Method description

Specified by:

createComponentConfigInstance in class AbstractComponent<PubSubConfig>

Parameters:

abstractComponent - is a AbstractComponent

Returns:

a value of PubSubConfig

createDAO

protected PubSubDAO createDAO(Map<String,Object> props)
                       throws RepositoryException

Method description

Parameters:

props - is a Map

Returns:

a value of PubSubDAO

Throws:

RepositoryException

createPubSubRepository

protected IPubSubRepository createPubSubRepository(PubSubDAO directRepository)

getDefaults

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

Method description

Specified by:

getDefaults in interface tigase.conf.Configurable

Overrides:

getDefaults in class AbstractComponent<PubSubConfig>

Parameters:

params -

Returns:

getDiscoDescription

public String getDiscoDescription()

Overrides:

getDiscoDescription in class tigase.server.BasicComponent

getStatistics

public void getStatistics(tigase.stats.StatisticsList list)

Specified by:

getStatistics in interface tigase.stats.StatisticsContainerIfc

Overrides:

getStatistics in class AbstractComponent<PubSubConfig>

everyHour

public void everyHour()

Overrides:

everyHour in class AbstractComponent<PubSubConfig>

everyMinute

public void everyMinute()

Overrides:

everyMinute in class AbstractComponent<PubSubConfig>

everySecond

public void everySecond()

Overrides:

everySecond in class AbstractComponent<PubSubConfig>

hashCodeForPacket

public int hashCodeForPacket(tigase.server.Packet packet)

Overrides:

hashCodeForPacket in class tigase.server.AbstractMessageReceiver

init

protected void init()

Method description

initBindings

public void initBindings(Bindings binds)

Method description

Overrides:

initBindings in class tigase.server.BasicComponent

Parameters:

binds - is a Bindings

initialize

public void initialize(String[] admins,
                       PubSubDAO pubSubDAO,
                       IPubSubRepository createPubSubRepository,
                       LeafNodeConfig defaultNodeConfig,
                       boolean delayedRootCollectionLoading)
                throws tigase.db.UserNotFoundException,
                       tigase.db.TigaseDBException,
                       RepositoryException

Method description

Parameters:

admins -

pubSubDAO -

createPubSubRepository -

defaultNodeConfig -

Throws:

RepositoryException

tigase.db.TigaseDBException

tigase.db.UserNotFoundException

isDiscoNonAdmin

public boolean isDiscoNonAdmin()

Description copied from class: AbstractComponent

Is this component discoverable by disco#items for domain by non admin users

Specified by:

isDiscoNonAdmin in class AbstractComponent<PubSubConfig>

Returns:

true - if yes

isSubdomain

public boolean isSubdomain()

Method description

Overrides:

isSubdomain in class tigase.server.BasicComponent

Returns:

onChangeDefaultNodeConfig

public void onChangeDefaultNodeConfig()

Method description

processingInThreads

public int processingInThreads()

Method description

Overrides:

processingInThreads in class tigase.server.AbstractMessageReceiver

Returns:

a value of int

processingOutThreads

public int processingOutThreads()

Method description

Overrides:

processingOutThreads in class tigase.server.AbstractMessageReceiver

Returns:

a value of int

processPacket

public void processPacket(tigase.server.Packet packet)

Description copied from class: AbstractComponent

Method description

Overrides:

processPacket in class AbstractComponent<PubSubConfig>

setProperties

public void setProperties(Map<String,Object> props)
                   throws tigase.conf.ConfigurationException

Method description

Specified by:

setProperties in interface tigase.conf.Configurable

Overrides:

setProperties in class AbstractComponent<PubSubConfig>

Parameters:

props -

Throws:

tigase.conf.ConfigurationException

start

public void start()

Specified by:

start in interface tigase.server.MessageReceiver

Overrides:

start in class tigase.server.AbstractMessageReceiver

stop

public void stop()

Overrides:

stop in class tigase.server.AbstractMessageReceiver

processScriptCommand

protected boolean processScriptCommand(tigase.server.Packet pc,
                                       Queue<tigase.server.Packet> results)

Overrides:

processScriptCommand in class tigase.server.BasicComponent

checkPubSubServiceJid

protected boolean checkPubSubServiceJid(tigase.server.Packet packet)

Method checks if packet is sent to pubsub@xxx and if so then it returns error as we no longer allow usage of pubsub@xxx address as pubsub service jid since we added support to use PEP and we have multiple domains support with separated nodes.

Parameters:

packet -

Returns:

true - if packet service jid is ok and should be processed