Occupant Use Case
To log in to PubSub Node user must send presence to PubSub component with additional information about node:
<presence
from='hag66@shakespeare.lit/pda'
id='n13mt3l'
to='pubsub.shakespeare.lit'>
<pubsub xmlns='tigase:pubsub:1' node='princely_musings'/>
</presence>Component will publish this information in node:
<message from='pubsub.shakespeare.lit' to='francisco@denmark.lit' id='foo'>
<event xmlns='http://jabber.org/protocol/pubsub#event'>
<items node='princely_musings'>
<item>
<presence xmlns='tigase:pubsub:1' node='princely_musings' jid='hag66@shakespeare.lit/pda' type='available'/>
</item>
</items>
</event>
</message>
<message from='pubsub.shakespeare.lit' to='bernardo@denmark.lit' id='bar'>
<event xmlns='http://jabber.org/protocol/pubsub#event'>
<items node='princely_musings'>
<item>
<presence xmlns='tigase:pubsub:1' node='princely_musings' jid='hag66@shakespeare.lit/pda' type='available'/>
</item>
</items>
</event>
</message>And then will send notification with presences of all occupants to new occupant.
To logout from single node, user must send presence stanza with type unavailable:
<presence
from='hag66@shakespeare.lit/pda'
type='unavailable'
to='pubsub.shakespeare.lit'>
<pubsub xmlns='tigase:pubsub:1' node='princely_musings'/>
</presence>Component will send events to all occupants as described:
<message from='pubsub.shakespeare.lit' to='francisco@denmark.lit' id='foo'>
<event xmlns='http://jabber.org/protocol/pubsub#event'>
<items node='princely_musings'>
<item>
<presence xmlns='tigase:pubsub:1' node='princely_musings' jid='hag66@shakespeare.lit/pda' type='unavailable'/>
</item>
</items>
</event>
</message>If component receives presence stanza with type unavailable without specified node, then component will log out user from all nodes he logged before and publish events.
To retrieve list of node subscribers, node configuration option tigase#allow_view_subscribers must be set to true:
<iq type='set'
from='hamlet@denmark.lit/elsinore'
to='pubsub.shakespeare.lit'
id='config2'>
<pubsub xmlns='http://jabber.org/protocol/pubsub#owner'>
<configure node='princely_musings'>
<x xmlns='jabber:x:data' type='submit'>
<field var='FORM_TYPE' type='hidden'>
<value>http://jabber.org/protocol/pubsub#node_config</value>
</field>
<field var='tigase#allow_view_subscribers'><value>1</value></field>
</x>
</configure>
</pubsub>
</iq>When option is enabled, each subscriber may get list of subscribers the same way as owner.
<iq type='get'
from='hamlet@denmark.lit/elsinore'
to='pubsub.shakespeare.lit'
id='subman1'>
<pubsub xmlns='http://jabber.org/protocol/pubsub#owner'>
<subscriptions node='princely_musings'/>
</pubsub>
</iq>There is extension to filter returned list:
<iq type='get'
from='hamlet@denmark.lit/elsinore'
to='pubsub.shakespeare.lit'
id='subman1'>
<pubsub xmlns='http://jabber.org/protocol/pubsub#owner'>
<subscriptions node='princely_musings'>
<filter xmlns='tigase:pubsub:1'>
<jid contains='@denmark.lit' />
</filter>
</subscriptions>
</pubsub>
</iq>In this example will be returned all subscriptions of users from domain "denmark.lit". == Offline Message Sink :author: Bartosz Malkowski :version: v2.0 November 2016. Reformatted for v8.0.0.
Messages sent to offline users is published in pubsub node, from where that message is sent to all the node subscribers as a pubsub notification.
<message from='pubsub.coffeebean.local' to='bard@shakespeare.lit' id='foo'>
<event xmlns='http://jabber.org/protocol/pubsub#event'>
<items node='message_sink'>
<item id='ae890ac52d0df67ed7cfdf51b644e901'>
<message type="chat" xmlns="jabber:client" id="x2ps6u0004"
to="userB_h6x1bt0002@coffeebean.local"
from="userA_uyhx8p0001@coffeebean.local/1149352695-tigase-20">
<body>Hello</body>
</message>
</item>
</items>
</event>
</message>The pubsub node must be created and configured beforehand:
<iq type='set'
to='pubsub.coffeebean.local'
id='create1'>
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
<create node='message_sink'/>
</pubsub>
</iq>After that is done, you need to add SessionManager as a publisher:
<iq type='set'
to='pubsub.coffeebean.local'
id='ent2'>
<pubsub xmlns='http://jabber.org/protocol/pubsub#owner'>
<affiliations node='message_sink'>
<affiliation jid='sess-man@coffeebean.local' affiliation='publisher'/>
</affiliations>
</pubsub>
</iq>Finally, the 'msgoffline' offline messages processor must be configured as well
Because these sinks use a standard pubsub component, administration of the sink node is identical to any other pubsub node. XEP-0060 defines standard pubsub usage and management.
<iq type='set'
to='pubsub.coffeebean.local'
id='subman2'>
<pubsub xmlns='http://jabber.org/protocol/pubsub#owner'>
<subscriptions node='message_sink'>
<subscription jid='bard@shakespeare.lit' subscription='subscribed'/>
</subscriptions>
</pubsub>
</iq>