IPubsubClient.java

/**
 * Copyright (c) 2011, SOCIETIES Consortium (WATERFORD INSTITUTE OF TECHNOLOGY (TSSG), HERIOT-WATT UNIVERSITY (HWU), SOLUTA.NET 
 * (SN), GERMAN AEROSPACE CENTRE (Deutsches Zentrum fuer Luft- und Raumfahrt e.V.) (DLR), Zavod za varnostne tehnologije
 * informacijske družbe in elektronsko poslovanje (SETCCE), INSTITUTE OF COMMUNICATION AND COMPUTER SYSTEMS (ICCS), LAKE
 * COMMUNICATIONS (LAKE), INTEL PERFORMANCE LEARNING SOLUTIONS LTD (INTEL), PORTUGAL TELECOM INOVAÇÃO, SA (PTIN), IBM ISRAEL
 * SCIENCE AND TECHNOLOGY LTD (IBM), INSTITUT TELECOM (ITSUD), AMITEC DIACHYTI EFYIA PLIROFORIKI KAI EPIKINONIES ETERIA
 * PERIORISMENIS EFTHINIS (AMITEC), TELECOM ITALIA S.p.a.(TI),  TRIALOG (TRIALOG), Stiftelsen SINTEF (SINTEF), NEC EUROPE LTD
 * (NEC))
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following
 * conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
 *    disclaimer in the documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
 * SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/**
 * @author Joao M. Goncalves (PTIN)
 * 
 * This is the interface of the service exposed by this OSGi bundle. It is meant to be used by other bundles to perform some
 * get information on the state of this bundle.
 * This bundle handles the logic described in XEP-SOC1 related to basic community membership management, and a service to
 * get the current community state can be requested.
 * 
 */

package org.societies.android.api.pubsub;

import java.util.List;
import java.util.Map;

import org.societies.android.api.comms.IMethodCallback;
import org.societies.android.api.comms.xmpp.CommunicationException;
import org.societies.android.api.comms.xmpp.XMPPError;
import org.societies.api.identity.IIdentity;
import org.w3c.dom.Element;

/**
 * The PubsubClient interface class.
 */
public interface IPubsubClient {
	
	/**
	 * Add the list of classes that will be used as payloads for pubsub events.
	 * 
	 * @param classList
	 * @throws ClassNotFoundException
	 */
	public void addSimpleClasses(List<String> classList) throws ClassNotFoundException;
	
	/**
	 * Disco items.
	 *
	 * @param pubsubService the pubsub service
	 * @param node the node
	 * @return the list
	 * @throws XMPPError the XMPP error
	 * @throws CommunicationException the communication exception
	 */
	public List<String> discoItems(IIdentity pubsubService, String node, IMethodCallback callback) throws XMPPError, CommunicationException;
	// TODO remove subId from interface - it's not interesting for the API users, only for the client implementation
	// TODO disco info nodes
	// TODO reception of notifications from a 3rd party subscription

	/**
	 * Subscribe to a pubsub node and provide the subscriber callback object.
	 *
	 * @param pubsubService Identity of the pubsub service
	 * @param node Pubsub event node
	 * @return the subscription
	 * @throws XMPPError the XMPP error
	 * @throws CommunicationException the communication exception
	 */
	public boolean subscriberSubscribe(IIdentity pubsubService, String node, IMethodCallback callback) throws XMPPError, CommunicationException;

	/**
	 * Unsubscribe from an pubsub node of this identity.
	 *
	 * @param pubsubService Identity of the pubsub service
	 * @param node Pubsub event node
	 * @throws XMPPError the XMPP error
	 * @throws CommunicationException the communication exception
	 */
	public boolean subscriberUnsubscribe(IIdentity pubsubService, String node, IMethodCallback callback) throws XMPPError, CommunicationException;

	/**
	 * Retrieve the last event that was published to this node.
	 *
	 * @param pubsubService Identity of the pubsub service
	 * @param node Pubsub event node
	 * @param subId the sub id
	 * @return the list
	 * @throws XMPPError the XMPP error
	 * @throws CommunicationException the communication exception
	 */
	public List<Element> subscriberRetrieveLast(IIdentity pubsubService, String node, String subId, IMethodCallback callback) throws XMPPError, CommunicationException;
	
	/**
	 * Subscriber retrieve specific.
	 *
	 * @param pubsubService the pubsub service
	 * @param node the node
	 * @param subId the sub id
	 * @param itemIdList the item id list
	 * @return the list
	 * @throws XMPPError the XMPP error
	 * @throws CommunicationException the communication exception
	 */
	public List<Element> subscriberRetrieveSpecific(IIdentity pubsubService, String node, String subId, List<String> itemIdList, IMethodCallback callback) throws XMPPError, CommunicationException;
	
	/**
	 * Publishes an event for this identity, on this node of unique itemID and content of item.
	 *
	 * @param pubsubService Identity of the pubsub service
	 * @param node Pubsub event node
	 * @param itemId unique id for this publish event
	 * @param item Payload object for this event. Must map to the JaxbMapping provided earlier
	 * @return the string
	 * @throws XMPPError the XMPP error
	 * @throws CommunicationException the communication exception
	 */
	public String publisherPublish(IIdentity pubsubService, String node, String itemId, Object item, IMethodCallback callback) throws XMPPError, CommunicationException;

	/**
	 * Remove an event for this node of provided itemID.
	 *
	 * @param pubsubService Identity of the pubsub service
	 * @param node Pubsub event node
	 * @param itemId unique id of the published event
	 * @throws XMPPError the XMPP error
	 * @throws CommunicationException the communication exception
	 */
	public void publisherDelete(IIdentity pubsubService, String node, String itemId, IMethodCallback callback) throws XMPPError, CommunicationException;
	
	/**
	 * Creates a pubsub node for this identity using the provided node name ("topic").
	 *
	 * @param pubsubService Identity of the pubsub service
	 * @param node Pubsub event node
	 * @throws XMPPError the XMPP error
	 * @throws CommunicationException the communication exception
	 */
	public void ownerCreate(IIdentity pubsubService, String node, IMethodCallback callback) throws XMPPError, CommunicationException;
	
	/**
	 * Deletes the pubsub node for this identity and node name.
	 *
	 * @param pubsubService Identity of the pubsub service
	 * @param node Pubsub event node
	 * @throws XMPPError the XMPP error
	 * @throws CommunicationException the communication exception
	 */
	public void ownerDelete(IIdentity pubsubService, String node, IMethodCallback callback) throws XMPPError, CommunicationException;
	
	/**
	 * Deletes all the published events for this identity on this node.
	 *
	 * @param pubsubService Identity of the pubsub service
	 * @param node Pubsub event node
	 * @throws XMPPError the XMPP error
	 * @throws CommunicationException the communication exception
	 */
	public void ownerPurgeItems(IIdentity pubsubService, String node, IMethodCallback callback) throws XMPPError, CommunicationException;
	
	/**
	 * Returns the list of identities of users who are subscribed to this pubsub node.
	 *
	 * @param pubsubService Identity of the pubsub service
	 * @param node Pubsub event node
	 * @param callback
	 * @return the map
	 * @throws XMPPError the XMPP error
	 * @throws CommunicationException the communication exception
	 */
	public Map<IIdentity, SubscriptionState> ownerGetSubscriptions(IIdentity pubsubService, String node, IMethodCallback callback) throws XMPPError, CommunicationException;
	
	/**
	 * Owner get affiliations.
	 *
	 * @param pubsubService the pubsub service
	 * @param node the node
	 * @return the map
	 * @param callback
	 * @throws XMPPError the XMPP error
	 * @throws CommunicationException the communication exception
	 */
	public Map<IIdentity, Affiliation> ownerGetAffiliations(IIdentity pubsubService, String node, IMethodCallback callback) throws XMPPError, CommunicationException;
	
	/**
	 * Owner set subscriptions.
	 *
	 * @param pubsubService the pubsub service
	 * @param node the node
	 * @param subscriptions the subscriptions
	 * @param callback
	 * @throws XMPPError the XMPP error
	 * @throws CommunicationException the communication exception
	 */
	public void ownerSetSubscriptions(IIdentity pubsubService, String node, Map<IIdentity, SubscriptionState> subscriptions, IMethodCallback callback) throws XMPPError, CommunicationException;
	
	/**
	 * Owner set affiliations.
	 *
	 * @param pubsubService the pubsub service
	 * @param node the node
	 * @param affiliations the affiliations
	 * @param callback
	 * @throws XMPPError the XMPP error
	 * @throws CommunicationException the communication exception
	 */
	public void ownerSetAffiliations(IIdentity pubsubService, String node, Map<IIdentity, Affiliation> affiliations, IMethodCallback callback) throws XMPPError, CommunicationException;
}