org.jivesoftware.smackx.pubsub.ItemsExtension Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of smack Show documentation
Smack is an Open Source XMPP (Jabber) client library for instant messaging and presence. This library provides the client side functionality as specified in the core XMPP specifications as related to the client side of said specifications.
The newest version!
/**
 * 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.List;

import org.jivesoftware.smack.packet.PacketExtension;

/**
 * This class is used to for multiple purposes.  
 * It can represent an event containing a list of items that have been published
 * 
It can represent an event containing a list of retracted (deleted) items.
 * 
It can represent a request to delete a list of items.
 * 
It can represent a request to get existing items.
 * 
 * Please note, this class is used for internal purposes, and is not required for usage of 
 * pubsub functionality.
 * 
 * @author Robin Collier
 */
public class ItemsExtension extends NodeExtension implements EmbeddedPacketExtension
{
	protected ItemsElementType type;
	protected Boolean notify;
	protected List items;

	public enum ItemsElementType
	{
		/** An items element, which has an optional max_items attribute when requesting items */
		items(PubSubElementType.ITEMS, "max_items"),
		
		/** A retract element, which has an optional notify attribute when publishing deletions */
		retract(PubSubElementType.RETRACT, "notify");
		
		private PubSubElementType elem;
		private String att;
		
		private ItemsElementType(PubSubElementType nodeElement, String attribute)
		{
			elem = nodeElement;
			att = attribute;
		}
		
		public PubSubElementType getNodeElement()
		{
			return elem;
		}

		public String getElementAttribute()
		{
			return att;
		}
	}

	/**
	 * Construct an instance with a list representing items that have been published or deleted.
	 * 
	 * 
Valid scenarios are:
	 * 
Request items from node - itemsType = {@link ItemsElementType#items}, items = list of {@link Item} and an
	 * optional value for the max_items attribute.
	 * 
Request to delete items - itemsType = {@link ItemsElementType#retract}, items = list of {@link Item} containing
	 * only id's and an optional value for the notify attribute.
	 * 
Items published event - itemsType = {@link ItemsElementType#items}, items = list of {@link Item} and 
	 * attributeValue = null
	 * 
Items deleted event -  itemsType = {@link ItemsElementType#items}, items = list of {@link RetractItem} and 
	 * attributeValue = null 
	 * 
	 * @param itemsType Type of representation
	 * @param nodeId The node to which the items are being sent or deleted
	 * @param items The list of {@link Item} or {@link RetractItem}
	 * @param attributeValue The value of the max_items  
	 */
	public ItemsExtension(ItemsElementType itemsType, String nodeId, List items)
	{
		super(itemsType.getNodeElement(), nodeId);
		type = itemsType;
		this.items = items;
	}
	
	/**
	 * Construct an instance with a list representing items that have been published or deleted.
	 * 
	 * Valid scenarios are:
	 * 
Request items from node - itemsType = {@link ItemsElementType#items}, items = list of {@link Item} and an
	 * optional value for the max_items attribute.
	 * 
Request to delete items - itemsType = {@link ItemsElementType#retract}, items = list of {@link Item} containing
	 * only id's and an optional value for the notify attribute.
	 * 
Items published event - itemsType = {@link ItemsElementType#items}, items = list of {@link Item} and 
	 * attributeValue = null
	 * Items deleted event -  itemsType = {@link ItemsElementType#items}, items = list of {@link RetractItem} and 
	 * attributeValue = null 
	 * 
	 * @param itemsType Type of representation
	 * @param nodeId The node to which the items are being sent or deleted
	 * @param items The list of {@link Item} or {@link RetractItem}
	 * @param attributeValue The value of the max_items  
	 */
	public ItemsExtension(String nodeId, List items, boolean notify)
	{
		super(ItemsElementType.retract.getNodeElement(), nodeId);
		type = ItemsElementType.retract;
		this.items = items; 
		this.notify = notify;
	}
	
	/**
	 * Get the type of element
	 * 
	 * @return The element type
	 */
	public ItemsElementType getItemsElementType()
	{
		return type;
	}
	
	public List getExtensions()
	{
		return (List)getItems();
	}
	
	/**
	 * Gets the items related to the type of request or event.
	 * 
	 * return List of {@link Item}, {@link RetractItem}, or null
	 */
	public List getItems()
	{
		return items;
	}

	/**
	 * Gets the value of the optional attribute related to the {@link ItemsElementType}.
	 * 
	 * @return The attribute value
	 */
	public boolean getNotify()
	{
		return notify;
	}
	
	@Override
	public String toXML()
	{
		if ((items == null) || (items.size() == 0))
		{
			return super.toXML();
		}
		else
		{
			StringBuilder builder = new StringBuilder("<");
			builder.append(getElementName());
			builder.append(" node='");
			builder.append(getNode());
			
			if (notify != null)
			{
				builder.append("' ");
				builder.append(type.getElementAttribute());
				builder.append("='");
				builder.append(notify.equals(Boolean.TRUE) ? 1 : 0);
				builder.append("'>");
			}
			else
			{
				builder.append("'>");
				for (PacketExtension item : items)
				{
					builder.append(item.toXML());
				}
			}
			
			builder.append("");
			return builder.toString();
		}
	}

	@Override
	public String toString()
	{
		return getClass().getName() + "Content [" + toXML() + "]";
	}

}