mirror of
https://codeberg.org/Mercury-IM/Smack
synced 2025-09-10 18:59:41 +02:00
SMACK-272 Add support for XEP-0060 (pubsub)
git-svn-id: http://svn.igniterealtime.org/svn/repos/smack/trunk@11346 b35dd754-fafc-0310-a699-88a17e54d16e
This commit is contained in:
rcollier
parent
92ba2d7f33
commit
f7a1c750ad
73 changed files with 7214 additions and 0 deletions
309
source/org/jivesoftware/smackx/pubsub/LeafNode.java
Normal file
309
source/org/jivesoftware/smackx/pubsub/LeafNode.java
Normal file
|
|
@ -0,0 +1,309 @@
|
|||
/**
|
||||
* All rights reserved. Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package org.jivesoftware.smackx.pubsub;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.Collection;
|
||||
import java.util.List;
|
||||
|
||||
import org.jivesoftware.smack.XMPPConnection;
|
||||
import org.jivesoftware.smack.XMPPException;
|
||||
import org.jivesoftware.smack.packet.IQ.Type;
|
||||
import org.jivesoftware.smackx.packet.DiscoverItems;
|
||||
import org.jivesoftware.smackx.pubsub.packet.PubSub;
|
||||
import org.jivesoftware.smackx.pubsub.packet.SyncPacketSend;
|
||||
|
||||
/**
|
||||
* The main class for the majority of pubsub functionality. In general
|
||||
* almost all pubsub capabilities are related to the concept of a node.
|
||||
* All items are published to a node, and typically subscribed to by other
|
||||
* users. These users then retrieve events based on this subscription.
|
||||
*
|
||||
* @author Robin Collier
|
||||
*/
|
||||
public class LeafNode extends Node
|
||||
{
|
||||
LeafNode(XMPPConnection connection, String nodeName)
|
||||
{
|
||||
super(connection, nodeName);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get information on the items in the node in standard
|
||||
* {@link DiscoverItems} format.
|
||||
*
|
||||
* @return The item details in {@link DiscoverItems} format
|
||||
*
|
||||
* @throws XMPPException
|
||||
*/
|
||||
public DiscoverItems discoverItems()
|
||||
throws XMPPException
|
||||
{
|
||||
DiscoverItems items = new DiscoverItems();
|
||||
items.setTo(to);
|
||||
items.setNode(getId());
|
||||
return (DiscoverItems)SyncPacketSend.getReply(con, items);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the current items stored in the node.
|
||||
*
|
||||
* @return List of {@link Item} in the node
|
||||
*
|
||||
* @throws XMPPException
|
||||
*/
|
||||
public <T extends Item> List<T> getItems()
|
||||
throws XMPPException
|
||||
{
|
||||
PubSub request = createPubsubPacket(Type.GET, new NodeExtension(PubSubElementType.ITEMS, getId()));
|
||||
|
||||
PubSub result = (PubSub)SyncPacketSend.getReply(con, request);
|
||||
ItemsExtension itemsElem = (ItemsExtension)result.getExtension(PubSubElementType.ITEMS);
|
||||
return (List<T>)itemsElem.getItems();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the items specified from the node. This would typically be
|
||||
* used when the server does not return the payload due to size
|
||||
* constraints. The user would be required to retrieve the payload
|
||||
* after the items have been retrieved via {@link #getItems()} or an
|
||||
* event, that did not include the payload.
|
||||
*
|
||||
* @param ids Item ids of the items to retrieve
|
||||
*
|
||||
* @return The list of {@link Item} with payload
|
||||
*
|
||||
* @throws XMPPException
|
||||
*/
|
||||
public <T extends Item> List<T> getItems(Collection<String> ids)
|
||||
throws XMPPException
|
||||
{
|
||||
List<Item> itemList = new ArrayList<Item>(ids.size());
|
||||
|
||||
for (String id : ids)
|
||||
{
|
||||
itemList.add(new Item(id));
|
||||
}
|
||||
PubSub request = createPubsubPacket(Type.GET, new ItemsExtension(ItemsExtension.ItemsElementType.items, getId(), itemList, null));
|
||||
|
||||
PubSub result = (PubSub)SyncPacketSend.getReply(con, request);
|
||||
ItemsExtension itemsElem = (ItemsExtension)result.getExtension(PubSubElementType.ITEMS);
|
||||
return (List<T>)itemsElem.getItems();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get items persisted on the node, limited to the specified number.
|
||||
*
|
||||
* @param maxItems Maximum number of items to return
|
||||
*
|
||||
* @return List of {@link Item}
|
||||
*
|
||||
* @throws XMPPException
|
||||
*/
|
||||
public <T extends Item> List<T> getItems(int maxItems)
|
||||
throws XMPPException
|
||||
{
|
||||
PubSub request = createPubsubPacket(Type.GET, new ItemsExtension(getId(), Integer.valueOf(maxItems)));
|
||||
|
||||
PubSub result = (PubSub)SyncPacketSend.getReply(con, request);
|
||||
ItemsExtension itemsElem = (ItemsExtension)result.getExtension(PubSubElementType.ITEMS);
|
||||
return (List<T>)itemsElem.getItems();
|
||||
}
|
||||
|
||||
/**
|
||||
* Publishes an event to the node. This is an empty event
|
||||
* with no item.
|
||||
*
|
||||
* This is only acceptable for nodes with {@link ConfigureForm#isPersistItems()}=false
|
||||
* and {@link ConfigureForm#isDeliverPayloads()}=false.
|
||||
*
|
||||
* This is an asynchronous call which returns as soon as the
|
||||
* packet has been sent.
|
||||
*
|
||||
* For synchronous calls use {@link #send() send()}.
|
||||
*/
|
||||
public void publish()
|
||||
{
|
||||
PubSub packet = createPubsubPacket(Type.SET, new NodeExtension(PubSubElementType.PUBLISH, getId()));
|
||||
|
||||
con.sendPacket(packet);
|
||||
}
|
||||
|
||||
/**
|
||||
* Publishes an event to the node. This is a simple item
|
||||
* with no payload.
|
||||
*
|
||||
* If the id is null, an empty item (one without an id) will be sent.
|
||||
* Please note that this is not the same as {@link #send()}, which
|
||||
* publishes an event with NO item.
|
||||
*
|
||||
* This is an asynchronous call which returns as soon as the
|
||||
* packet has been sent.
|
||||
*
|
||||
* For synchronous calls use {@link #send(Item) send(Item))}.
|
||||
*
|
||||
* @param item - The item being sent
|
||||
*/
|
||||
public <T extends Item> void publish(T item)
|
||||
{
|
||||
Collection<T> items = new ArrayList<T>(1);
|
||||
items.add((T)(item == null ? new Item() : item));
|
||||
publish(items);
|
||||
}
|
||||
|
||||
/**
|
||||
* Publishes multiple events to the node. Same rules apply as in {@link #publish(Item)}.
|
||||
*
|
||||
* In addition, if {@link ConfigureForm#isPersistItems()}=false, only the last item in the input
|
||||
* list will get stored on the node, assuming it stores the last sent item.
|
||||
*
|
||||
* This is an asynchronous call which returns as soon as the
|
||||
* packet has been sent.
|
||||
*
|
||||
* For synchronous calls use {@link #send(Collection) send(Collection))}.
|
||||
*
|
||||
* @param items - The collection of items being sent
|
||||
*/
|
||||
public <T extends Item> void publish(Collection<T> items)
|
||||
{
|
||||
PubSub packet = createPubsubPacket(Type.SET, new PublishItem<T>(getId(), items));
|
||||
|
||||
con.sendPacket(packet);
|
||||
}
|
||||
|
||||
/**
|
||||
* Publishes an event to the node. This is an empty event
|
||||
* with no item.
|
||||
*
|
||||
* This is only acceptable for nodes with {@link ConfigureForm#isPersistItems()}=false
|
||||
* and {@link ConfigureForm#isDeliverPayloads()}=false.
|
||||
*
|
||||
* This is a synchronous call which will throw an exception
|
||||
* on failure.
|
||||
*
|
||||
* For asynchronous calls, use {@link #publish() publish()}.
|
||||
*
|
||||
* @throws XMPPException
|
||||
*/
|
||||
public void send()
|
||||
throws XMPPException
|
||||
{
|
||||
PubSub packet = createPubsubPacket(Type.SET, new NodeExtension(PubSubElementType.PUBLISH, getId()));
|
||||
|
||||
SyncPacketSend.getReply(con, packet);
|
||||
}
|
||||
|
||||
/**
|
||||
* Publishes an event to the node. This can be either a simple item
|
||||
* with no payload, or one with it. This is determined by the Node
|
||||
* configuration.
|
||||
*
|
||||
* If the node has <b>deliver_payload=false</b>, the Item must not
|
||||
* have a payload.
|
||||
*
|
||||
* If the id is null, an empty item (one without an id) will be sent.
|
||||
* Please note that this is not the same as {@link #send()}, which
|
||||
* publishes an event with NO item.
|
||||
*
|
||||
* This is a synchronous call which will throw an exception
|
||||
* on failure.
|
||||
*
|
||||
* For asynchronous calls, use {@link #publish(Item) publish(Item)}.
|
||||
*
|
||||
* @param item - The item being sent
|
||||
*
|
||||
* @throws XMPPException
|
||||
*/
|
||||
public <T extends Item> void send(T item)
|
||||
throws XMPPException
|
||||
{
|
||||
Collection<T> items = new ArrayList<T>(1);
|
||||
items.add((item == null ? (T)new Item() : item));
|
||||
send(items);
|
||||
}
|
||||
|
||||
/**
|
||||
* Publishes multiple events to the node. Same rules apply as in {@link #send(Item)}.
|
||||
*
|
||||
* In addition, if {@link ConfigureForm#isPersistItems()}=false, only the last item in the input
|
||||
* list will get stored on the node, assuming it stores the last sent item.
|
||||
*
|
||||
* This is a synchronous call which will throw an exception
|
||||
* on failure.
|
||||
*
|
||||
* For asynchronous calls, use {@link #publish(Collection) publish(Collection))}.
|
||||
*
|
||||
* @param items - The collection of {@link Item} objects being sent
|
||||
*
|
||||
* @throws XMPPException
|
||||
*/
|
||||
public <T extends Item> void send(Collection<T> items)
|
||||
throws XMPPException
|
||||
{
|
||||
PubSub packet = createPubsubPacket(Type.SET, new PublishItem<T>(getId(), items));
|
||||
|
||||
SyncPacketSend.getReply(con, packet);
|
||||
}
|
||||
|
||||
/**
|
||||
* Purges the node of all items.
|
||||
*
|
||||
* <p>Note: Some implementations may keep the last item
|
||||
* sent.
|
||||
*
|
||||
* @throws XMPPException
|
||||
*/
|
||||
public void deleteAllItems()
|
||||
throws XMPPException
|
||||
{
|
||||
PubSub request = createPubsubPacket(Type.SET, new NodeExtension(PubSubElementType.PURGE_OWNER, getId()), PubSubElementType.PURGE_OWNER.getNamespace());
|
||||
|
||||
SyncPacketSend.getReply(con, request);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete the item with the specified id from the node.
|
||||
*
|
||||
* @param itemId The id of the item
|
||||
*
|
||||
* @throws XMPPException
|
||||
*/
|
||||
public void deleteItem(String itemId)
|
||||
throws XMPPException
|
||||
{
|
||||
Collection<String> items = new ArrayList<String>(1);
|
||||
items.add(itemId);
|
||||
deleteItem(items);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete the items with the specified id's from the node.
|
||||
*
|
||||
* @param itemIds The list of id's of items to delete
|
||||
*
|
||||
* @throws XMPPException
|
||||
*/
|
||||
public void deleteItem(Collection<String> itemIds)
|
||||
throws XMPPException
|
||||
{
|
||||
List<Item> items = new ArrayList<Item>(itemIds.size());
|
||||
|
||||
for (String id : itemIds)
|
||||
{
|
||||
items.add(new Item(id));
|
||||
}
|
||||
PubSub request = createPubsubPacket(Type.SET, new ItemsExtension(ItemsExtension.ItemsElementType.retract, getId(), items, null));
|
||||
SyncPacketSend.getReply(con, request);
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue