public final class PubSub
extends java.lang.Object
The implementation of the <pubsub/>
element in the http://jabber.org/protocol/pubsub
namespace.
Child elements are created with a bunch of static factory methods.
Modifier and Type | Class and Description |
---|---|
static class |
PubSub.Default
The
<default/> element. |
static class |
PubSub.Options
The (subscribe)
<options/> element. |
static class |
PubSub.Publish
The
<publish/> element. |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
NAMESPACE
|
Modifier and Type | Method and Description |
---|---|
java.util.List<Affiliation> |
getAffiliations() |
DataForm |
getConfigurationForm() |
PubSub.Default |
getDefault() |
java.util.List<Item> |
getItems() |
java.lang.String |
getNode() |
PubSub.Options |
getOptions() |
PubSub.Publish |
getPublish() |
DataForm |
getPublishOptions() |
Subscription |
getSubscription() |
java.util.List<Subscription> |
getSubscriptions() |
static PubSub |
withAffiliations()
Creates a pubsub element with an
<affiliations/> child element. |
static PubSub |
withAffiliations(java.lang.String node)
Creates a pubsub element with an
<affiliations/> child element and a ‘node’ attribute. |
static PubSub |
withConfigure(java.lang.String node,
DataForm configurationForm)
Creates a pubsub element with an
<configure/> child element and a ‘node’ attribute. |
static PubSub |
withCreate(java.lang.String node)
Creates a pubsub element with an
<create/> child element and a ‘node’ attribute. |
static PubSub |
withCreate(java.lang.String node,
DataForm configurationForm)
Creates a pubsub element with an
<create/> and <configure/> child element. |
static PubSub |
withDefault()
Creates a pubsub element with a
<default/> child element. |
static PubSub |
withDefault(java.lang.String node)
Creates a pubsub element with a
<default/> child element with a ‘node’ attribute. |
static PubSub |
withItems(java.lang.String node)
Creates a pubsub element with an
<items/> child element with a ‘node’ attribute. |
static PubSub |
withItems(java.lang.String node,
int maxItems)
Creates a pubsub element with an
<items/> child element with a ‘node’ and a ‘max_items’ attribute. |
static PubSub |
withItems(java.lang.String node,
java.lang.String... ids)
Creates a pubsub element with an
<items/> child element, containing multiple item elements with an ‘id’ attribute. |
static PubSub |
withOptions(java.lang.String node,
Jid jid,
java.lang.String subid,
DataForm dataForm)
Creates a pubsub element with an
<options/> child element with a ‘node’ and ‘jid’ attribute. |
static PubSub |
withPublish(java.lang.String node,
java.lang.String id,
java.lang.Object item,
DataForm options)
Creates a pubsub element with a
<publish/> child element. |
static PubSub |
withRetract(java.lang.String node,
java.lang.String id,
boolean notify)
Creates a pubsub element with a
<retract/> child element. |
static PubSub |
withSubscribe(java.lang.String node,
Jid jid)
Creates a pubsub element with a
<subscribe/> child element with a ‘node’ and ‘jid’ attribute. |
static PubSub |
withSubscribe(java.lang.String node,
Jid jid,
DataForm dataForm)
Creates a pubsub element with a
<subscribe/> and <options/> child element with a ‘node’ and ‘jid’ attribute. |
static PubSub |
withSubscriptions()
Creates a pubsub element with a
<subscriptions/> child element. |
static PubSub |
withSubscriptions(java.lang.String node)
Creates a pubsub element with a
<subscriptions/> child element with a ‘node’ attribute. |
static PubSub |
withUnsubscribe(java.lang.String node,
Jid jid,
java.lang.String subscriptionId)
Creates a pubsub element with an
<unsubscribe/> child element with a ‘node’ and ‘jid’ attribute. |
public static final java.lang.String NAMESPACE
public static PubSub withAffiliations()
Creates a pubsub element with an <affiliations/>
child element.
Sample:
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
<affiliations/>
</pubsub>
public static PubSub withAffiliations(java.lang.String node)
Creates a pubsub element with an <affiliations/>
child element and a ‘node’ attribute.
Sample:
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
<affiliations node='node6'/>
</pubsub>
node
- The node.public static PubSub withConfigure(java.lang.String node, DataForm configurationForm)
Creates a pubsub element with an <configure/>
child element and a ‘node’ attribute.
Sample:
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
<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='pubsub#tempsub'><value>true</value></field>
</x>
</configure>
</pubsub>
node
- The node.configurationForm
- The configuration form.public static PubSub withCreate(java.lang.String node)
Creates a pubsub element with an <create/>
child element and a ‘node’ attribute.
Sample:
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
<create node='princely_musings'/>
</pubsub>
node
- The node.public static PubSub withCreate(java.lang.String node, DataForm configurationForm)
Creates a pubsub element with an <create/>
and <configure/>
child element.
Sample:
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
<create node='princely_musings'/>
<configure>
<x xmlns='jabber:x:data' type='submit'>
</x>
</configure>
</pubsub>
node
- The node.configurationForm
- The configuration form.public static PubSub withSubscriptions()
Creates a pubsub element with a <subscriptions/>
child element.
Sample:
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
<subscriptions/>
</pubsub>
public static PubSub withSubscriptions(java.lang.String node)
Creates a pubsub element with a <subscriptions/>
child element with a ‘node’ attribute.
Sample:
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
<subscriptions node='princely_musings'/>
</pubsub>
node
- The node.public static PubSub withSubscribe(java.lang.String node, Jid jid)
Creates a pubsub element with a <subscribe/>
child element with a ‘node’ and ‘jid’ attribute.
Sample:
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
<subscribe node='princely_musings' jid='francisco@denmark.lit'/>
</pubsub>
node
- The node.jid
- The JID.public static PubSub withSubscribe(java.lang.String node, Jid jid, DataForm dataForm)
Creates a pubsub element with a <subscribe/>
and <options/>
child element with a ‘node’ and ‘jid’ attribute.
Sample:
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
<subscribe node='princely_musings' jid='francisco@denmark.lit'/>
<options>
<x xmlns='jabber:x:data' type='submit'>
</x>
</options>
</pubsub>
node
- The node.jid
- The JID.dataForm
- The dataForm.public static PubSub withOptions(java.lang.String node, Jid jid, java.lang.String subid, DataForm dataForm)
Creates a pubsub element with an <options/>
child element with a ‘node’ and ‘jid’ attribute.
Sample:
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
<options>
<x xmlns='jabber:x:data' type='submit'>
</x>
</options>
</pubsub>
node
- The node.jid
- The JID.subid
- The subscription id.dataForm
- The data form.public static PubSub withUnsubscribe(java.lang.String node, Jid jid, java.lang.String subscriptionId)
Creates a pubsub element with an <unsubscribe/>
child element with a ‘node’ and ‘jid’ attribute.
Sample:
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
<unsubscribe node='princely_musings' jid='francisco@denmark.lit'/>
</pubsub>
node
- The node.jid
- The JID.subscriptionId
- The subscription id.public static PubSub withDefault()
Creates a pubsub element with a <default/>
child element.
Sample:
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
<default/>
</pubsub>
public static PubSub withDefault(java.lang.String node)
Creates a pubsub element with a <default/>
child element with a ‘node’ attribute.
Sample:
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
<default node='princely_musings'/>
</pubsub>
node
- The node.public static PubSub withItems(java.lang.String node)
Creates a pubsub element with an <items/>
child element with a ‘node’ attribute.
Sample:
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
<items node='princely_musings'/>
</pubsub>
node
- The node.public static PubSub withItems(java.lang.String node, java.lang.String... ids)
Creates a pubsub element with an <items/>
child element, containing multiple item elements with an ‘id’ attribute.
Sample:
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
<items node='princely_musings'>
<item id='368866411b877c30064a5f62b917cffe'/>
<item id='4e30f35051b7b8b42abe083742187228'/>
</items>
</pubsub>
node
- The node.ids
- The ids.public static PubSub withItems(java.lang.String node, int maxItems)
Creates a pubsub element with an <items/>
child element with a ‘node’ and a ‘max_items’ attribute.
Sample:
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
<items node='princely_musings' max_items='2'/>
</pubsub>
node
- The node.maxItems
- The max items.public static PubSub withPublish(java.lang.String node, java.lang.String id, java.lang.Object item, DataForm options)
Creates a pubsub element with a <publish/>
child element.
Sample:
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
<publish node='princely_musings'>
<item id='bnd81g37d61f49fgn581'>
<entry xmlns='http://www.w3.org/2005/Atom'>
...
</pubsub>
node
- The node.id
- The id.item
- The item to publish.options
- The publish options.public static PubSub withRetract(java.lang.String node, java.lang.String id, boolean notify)
Creates a pubsub element with a <retract/>
child element.
Sample:
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
<retract node='princely_musings' notify='true'>
<item id='ae890ac52d0df67ed7cfdf51b644e901'/>
</retract>
</pubsub>
node
- The node.id
- The id.notify
- The notify attribute.public final PubSub.Default getDefault()
public final Subscription getSubscription()
public final PubSub.Options getOptions()
public final java.util.List<Item> getItems()
public final PubSub.Publish getPublish()
public final DataForm getConfigurationForm()
public final java.util.List<Subscription> getSubscriptions()
public final java.util.List<Affiliation> getAffiliations()
public final java.lang.String getNode()
public final DataForm getPublishOptions()
Copyright © 2014–2019 XMPP.rocks. All rights reserved.