CommsServer.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 Corp (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.
 */
package org.societies.css.mgmt.comms;

import java.util.Arrays;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map.Entry;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Future;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.societies.api.comm.xmpp.datatypes.Stanza;
import org.societies.api.comm.xmpp.exceptions.CommunicationException;
import org.societies.api.comm.xmpp.exceptions.XMPPError;
import org.societies.api.comm.xmpp.interfaces.ICommManager;
import org.societies.api.comm.xmpp.interfaces.IFeatureServer;
import org.societies.api.css.FriendFilter;
import org.societies.api.internal.css.ICSSInternalManager;
import org.societies.api.schema.css.directory.CssAdvertisementRecord;
import org.societies.api.schema.cssmanagement.CssInterfaceResult;
import org.societies.api.schema.cssmanagement.CssManagerMessageBean;
import org.societies.api.schema.cssmanagement.CssManagerResultActivities;
import org.societies.api.schema.cssmanagement.CssManagerResultBean;
import org.societies.api.schema.cssmanagement.CssRecord;
import org.societies.api.schema.cssmanagement.CssRequest;
import org.societies.api.schema.cssmanagement.CssRequestOrigin;
import org.societies.api.schema.cssmanagement.CssRequestStatusType;
import org.societies.api.schema.cssmanagement.FriendEntry;
import org.societies.utilities.DBC.Dbc;
import org.societies.api.identity.IIdentity;
import org.societies.api.identity.InvalidFormatException;
import org.societies.api.identity.RequestorService;
import org.societies.api.schema.servicelifecycle.model.ServiceResourceIdentifier;
import org.societies.api.schema.activity.MarshaledActivity;

public class CommsServer implements IFeatureServer {
	private ICommManager commManager;
	private ICSSInternalManager cssManager;
	private FriendFilter FriendFilter;
	
	public static final List<String> MESSAGE_BEAN_NAMESPACES = Collections.unmodifiableList(
			  Arrays.asList("http://societies.org/api/schema/cssmanagement"));
	public static final List<String> MESSAGE_BEAN_PACKAGES = Collections.unmodifiableList(
			  Arrays.asList("org.societies.api.schema.cssmanagement"));

	private static Logger LOG = LoggerFactory.getLogger(CommsServer.class);

	/**
	 * Default Constructor
	 */
	public CommsServer() {
	}
	/**
	 * Used by Spring to initialise bean
	 */
	public void initService() {
		try {
			LOG.debug("Initialise with Communication Manager");
			this.commManager.register(this);
		} catch (CommunicationException e) {
			e.printStackTrace();
		}
	}
	
	@Override
	public List<String> getJavaPackages() {
		Dbc.ensure("Message bean Java packages list must have at least one member ", MESSAGE_BEAN_PACKAGES != null && MESSAGE_BEAN_PACKAGES.size() > 0);
		return MESSAGE_BEAN_PACKAGES;
	}

	@Override
	public List<String> getXMLNamespaces() {
		Dbc.ensure("Message bean namespaces list must have at least one member ", MESSAGE_BEAN_NAMESPACES != null && MESSAGE_BEAN_NAMESPACES.size() > 0);
		return MESSAGE_BEAN_NAMESPACES;
	}

	@Override
	public Object getQuery(Stanza stanza, Object payload) throws XMPPError {
		Dbc.require("Message stanza cannot be null", stanza != null);
		Dbc.require("Message payload cannot be null", payload != null);
		
		LOG.debug("CSSManager remote invocation with stanza length: " + stanza.toString().length() +payload.getClass().getName().toString());
		LOG.debug("CSSManager commsServer getQuery called ");
		LOG.debug("CSSManager remote invocation with stanza length: " + stanza.toString().length());
		

		if (payload instanceof CssManagerMessageBean) {
			CssManagerMessageBean bean = (CssManagerMessageBean) payload;

			LOG.debug("CSSManager remote invocation");
			LOG.debug("CSSManager remote invocation on thread" + Thread.currentThread()  + " " + Thread.activeCount());

			Future<CssInterfaceResult> asyncResult = null;
			CssInterfaceResult result = null;
			
			Future<List<CssRequest>> asyncRequestResult = null;
			List<CssRequest> RequestResult = null;
			
			Future<List<CssAdvertisementRecord>> asyncFriendsAdsResult = null;
			List<CssAdvertisementRecord> friendsAdsResult = null;
			
			Future<HashMap<IIdentity, Integer>> asyncFriendsFilterResult = null;
			HashMap<IIdentity, Integer> FriendsFilterResult = null;
			
			Future<HashMap<CssAdvertisementRecord, Integer>> asyncFriendsFilterDetailsResult = null;
			HashMap<CssAdvertisementRecord, Integer> FriendsFilterDetailsResult = null;
		
			LOG.debug("CSSManager remote invocation of method " + bean.getMethod().name());

			switch (bean.getMethod()) {

			case REGISTER_XMPP_SERVER:
				asyncResult = this.cssManager.registerXMPPServer((CssRecord) bean.getProfile());
				break;
			case LOGIN_CSS:
				LOG.debug("Login - Sending stanza with CSS identity: " + bean.getProfile().getCssIdentity());
				asyncResult = this.cssManager.loginCSS((CssRecord) bean.getProfile());
				break;
			case LOGOUT_CSS:
				LOG.debug("Logout - Sending stanza with CSS identity: " + bean.getProfile().getCssIdentity());
				asyncResult = this.cssManager.logoutCSS((CssRecord) bean.getProfile());
				break;
//			case LOGIN_XMPP_SERVER:
//				asyncResult = this.cssManager.loginXMPPServer((CssRecord) bean.getProfile());
//				break;
//			case LOGOUT_XMPP_SERVER:
//				asyncResult = this.cssManager.logoutXMPPServer((CssRecord) bean.getProfile());
//				break;
			case SYNCH_PROFILE:
				asyncResult = this.cssManager.synchProfile((CssRecord) bean.getProfile());
				break;
			case UNREGISTER_CSS:
				asyncResult = this.cssManager.unregisterCSS((CssRecord) bean.getProfile());
				break;
			case UNREGISTER_CSS_NODE:
				asyncResult = this.cssManager.unregisterCSSNode((CssRecord) bean.getProfile());
				break;
			case UNREGISTER_XMPP_SERVER:
				asyncResult = this.cssManager.unregisterXMPPServer((CssRecord) bean.getProfile());
				break;
//			case SET_PRESENCE_STATUS:
//				asyncResult = this.cssManager.setPresenceStatus((CssRecord) bean.getProfile());
//				break;
			case GET_CSS_RECORD:
				asyncResult = this.cssManager.getCssRecord();
				break;
			case REGISTER_CSS:
				asyncResult = this.cssManager.registerCSS((CssRecord) bean.getProfile());
				break;
			case REGISTER_CSS_NODE:
				asyncResult = this.cssManager.registerCSSNode((CssRecord) bean.getProfile());
				break;
			case MODIFY_CSS_RECORD:
				asyncResult = this.cssManager.modifyCssRecord((CssRecord) bean.getProfile());
				break;	
			case GET_CSS_FRIENDS:
				asyncFriendsAdsResult = this.cssManager.getCssFriends();
				break;
			case SUGGESTED_FRIENDS:
				LOG.info("CommsServer calling Suggested_Friends");
				FriendFilter filter = this.cssManager.getFriendfilter();
				if(filter == null){
					filter = new FriendFilter();
					filter.setFilterFlag(0x0000011111);
				}
				LOG.info("CommsServer FriendFilter is: " +FriendFilter);
				//asyncFriendsFilterResult = this.cssManager.getSuggestedFriends(filter);
				asyncFriendsFilterDetailsResult = this.cssManager.getSuggestedFriendsDetails(filter); 
				LOG.info("CommsServer BACK from calling Suggested_Friends");
				break;
			case GET_FRIEND_REQUESTS:
				asyncFriendsAdsResult = this.cssManager.getFriendRequests(); 
				break;
			case FIND_ALL_CSS_REQUESTS:
				asyncRequestResult = this.cssManager.findAllCssRequests(); 
				break;
			case FIND_ALL_CSS_FRIEND_REQUESTS:
				asyncRequestResult = this.cssManager.findAllCssFriendRequests(); 
				break;
			case GET_CSS_ACTIVITIES:
				//TODO: TIMESPAN DEFAULTS TO 1/1/2000 TO NOW - NEED TO ADD TIMESPAN TO XSD
				Date date = new Date();
				long longDate=date.getTime();
				String timespan = "1262304000000 " + longDate;
								
				Future<List<MarshaledActivity>> asyncActivitiesResult = this.cssManager.getActivities(timespan, 20);
				CssManagerResultActivities results = new CssManagerResultActivities();
				try {
					results.setMarshaledActivity(asyncActivitiesResult.get());
				} catch (InterruptedException e1) {
					e1.printStackTrace();
				} catch (ExecutionException e1) {
					e1.printStackTrace();
				}
				return results;
			default:
				LOG.error("Bean method does not exist: " + bean.getMethod());
				break;
			}
			
			CssManagerResultBean resultBean = new CssManagerResultBean();
			try {
				switch (bean.getMethod()) {
				case GET_CSS_FRIENDS:
					friendsAdsResult = asyncFriendsAdsResult.get();
					LOG.debug("Number of actual friends: " + friendsAdsResult.size());
					break;
				case SUGGESTED_FRIENDS:
					FriendsFilterDetailsResult = asyncFriendsFilterDetailsResult.get();
					LOG.debug("Number of suggested friends: " + FriendsFilterDetailsResult.size());
					
					List<FriendEntry> results = new ArrayList<FriendEntry>();
					for(Entry<CssAdvertisementRecord, Integer> entry : FriendsFilterDetailsResult.entrySet()) {
						FriendEntry record = new FriendEntry();
						record.setKey(entry.getKey());
						record.setValue(entry.getValue());
						results.add(record);	
					}
					resultBean.setResultSuggestedFriends(results);
					break;
				case GET_FRIEND_REQUESTS:
					friendsAdsResult = asyncFriendsAdsResult.get();
					LOG.debug("Number of friend requests: " + friendsAdsResult.size());
					break;
				case FIND_ALL_CSS_FRIEND_REQUESTS:
				case FIND_ALL_CSS_REQUESTS:
					RequestResult = asyncRequestResult.get();
					break;
				case GET_CSS_ACTIVITIES:
					break;
				default:
					// Since everything else seems to use this!!
					result = asyncResult.get();
				}
			} catch (InterruptedException e) {
				// TODO Auto-generated catch block
				e.printStackTrace();
			} catch (ExecutionException e) {
				// TODO Auto-generated catch block
				e.printStackTrace();
			} 
			LOG.debug("CSSManager result");
			LOG.debug("CSSManager remote invocation on thread" + Thread.currentThread()  + " " + Thread.activeCount());

			resultBean.setResult(result);
			resultBean.setResultAdvertList(friendsAdsResult);
			resultBean.setResultAdvertList(friendsAdsResult);
			resultBean.setResultCssRequestList(RequestResult);

			Dbc.ensure("CSSManager result bean cannot be null", resultBean != null);
			return resultBean;
		}
		
		Dbc.ensure(this.getClass().getName() + " failure to interpret remote method invocation payload", true);
		return null;

	}


	@Override
	public void receiveMessage(Stanza stanza, Object payload) {
		
		if (payload instanceof CssManagerMessageBean) {
			CssManagerMessageBean bean = (CssManagerMessageBean) payload;
			
			CssRequest request = new CssRequest();
			
			
			
			switch (bean.getMethod())
			{
			case SEND_CSS_FRIEND_REQUEST:
				LOG.debug("Intercepting remote method invocation SEND_CSS_FRIEND_REQUEST");
				ServiceResourceIdentifier myServiceID = new ServiceResourceIdentifier();
				IIdentity receivedID = stanza.getFrom();
				//TODO: REPLACE WITH NEW IDENTITY FUNCTION
				String receivedIDcloud =  receivedID.getIdentifier() + "." + receivedID.getDomain();
				LOG.info("receivedIDcloud result is : " +receivedIDcloud);
				
				RequestorService service = new RequestorService(receivedID, myServiceID);
				
				//SAVE receivedIDcloud TO DATABASE INSTEAD
				request.setCssIdentity(receivedIDcloud);
				LOG.info("UPDATE_CSS_FRIEND_REQUEST COMMSServer StanzagetJid " +stanza.getFrom().getJid());
				//request.setCssIdentity(stanza.getFrom().getJid());
				request.setRequestStatus(CssRequestStatusType.PENDING);
				request.setOrigin(CssRequestOrigin.REMOTE);
				
				//this.cssManager.updateCssRequest(request);
				this.cssManager.sendCSSFriendRequest(receivedID, service);
				
				break;
				
			case SEND_CSS_FRIEND_REQUEST_INTERNAL:
				LOG.debug("Intercepting remote method invocation SEND_CSS_FRIEND_REQUEST_INTERNAL");
				
				String targetcssId = bean.getTargetCssId();
				
								
				LOG.info("SEND_CSS_FRIEND_REQUEST_INTERNAL " +targetcssId);
				
				request.setRequestStatus(bean.getRequestStatus());
				request.setOrigin(CssRequestOrigin.REMOTE);
				request.setRequestStatus(CssRequestStatusType.PENDING);
				request.setCssIdentity(targetcssId);
				
				this.cssManager.sendCssFriendRequest(targetcssId); //updateCssRequest(request);
				break;

			case UPDATE_CSS_FRIEND_REQUEST:
				receivedID = stanza.getFrom();
				//TODO: REPLACE WITH NEW IDENTITY FUNCTION
				receivedIDcloud =  receivedID.getIdentifier() + "." + receivedID.getDomain();
				LOG.info("receivedIDcloud result is : " +receivedIDcloud);
				
				//SAVE receivedIDcloud TO DATABASE INSTEAD
				request.setCssIdentity(receivedIDcloud);
				LOG.info("UPDATE_CSS_FRIEND_REQUEST COMMSServer StanzagetJid " +stanza.getFrom().getJid());
				//request.setCssIdentity(stanza.getFrom().getJid());
				request.setRequestStatus(bean.getRequestStatus());
				request.setOrigin(CssRequestOrigin.REMOTE);
				this.cssManager.handleExternalUpdateRequest(receivedID, bean.getRequestStatus());
				
			break;
			case UPDATE_CSS_REQUEST:
				receivedID = stanza.getFrom();
				//TODO: REPLACE WITH NEW IDENTITY FUNCTION
				receivedIDcloud =  receivedID.getIdentifier() + "." + receivedID.getDomain();
				LOG.info("receivedIDcloud result is : " +receivedIDcloud);
				
				//SAVE receivedIDcloud TO DATABASE INSTEAD
				request.setCssIdentity(receivedIDcloud);
				LOG.info("UPDATE_CSS_REQUEST COMMSServer StanzagetJid " +stanza.getFrom().getJid());
				//request.setCssIdentity(stanza.getFrom().getJid());
				request.setRequestStatus(bean.getRequestStatus());
				request.setOrigin(CssRequestOrigin.REMOTE);
			//	request.setRequestStatus(bean.ge);
				//this.cssManager.updateCssRequest(request);
				this.cssManager.handleExternalFriendRequest(receivedID, bean.getRequestStatus());
			break;
			case ACCEPT_CSS_FRIEND_REQUEST_INTERNAL:
				
				receivedID = stanza.getFrom();				
				targetcssId = bean.getTargetCssId();
				request.setCssIdentity(targetcssId);
				IIdentity targetFriendId = null;
				LOG.info("ACCEPT_CSS_FRIEND_REQUEST_INTERNAL COMMSServer targetcssId " +targetcssId);
				try {
					targetFriendId = this.getCommManager().getIdManager().fromJid(targetcssId);					
					request.setRequestStatus(bean.getRequestStatus());
					request.setOrigin(CssRequestOrigin.REMOTE);
					//this.cssManager.acceptCssFriendRequest(request);
					this.cssManager.handleInternalFriendRequest(targetFriendId, bean.getRequestStatus());
				} catch (InvalidFormatException e) {
					e.printStackTrace();
				}
			break;
			case ACCEPT_CSS_FRIEND_REQUEST:
				receivedID = stanza.getFrom();
				//TODO: REPLACE WITH NEW IDENTITY FUNCTION
				receivedIDcloud =  receivedID.getIdentifier() + "." + receivedID.getDomain();
				LOG.info("receivedIDcloud result is : " +receivedIDcloud);
				
				//SAVE receivedIDcloud TO DATABASE INSTEAD
				request.setCssIdentity(receivedIDcloud);
				LOG.info("ACCEPT_CSS_FRIEND_REQUEST COMMSServer StanzagetJid " +stanza.getFrom().getJid());
				//request.setCssIdentity(stanza.getFrom().getJid());
				request.setRequestStatus(bean.getRequestStatus());
				request.setOrigin(CssRequestOrigin.REMOTE);
				this.cssManager.handleExternalFriendRequest(receivedID, bean.getRequestStatus());
			break;
			case DECLINE_CSS_FRIEND_REQUEST:
				receivedID = stanza.getFrom();
				//TODO: REPLACE WITH NEW IDENTITY FUNCTION
				receivedIDcloud =  receivedID.getIdentifier() + "." + receivedID.getDomain();
				LOG.info("DECLINE_CSS_FRIEND_REQUEST receivedIDcloud result is : " +receivedIDcloud);
				
				//SAVE receivedIDcloud TO DATABASE INSTEAD
				request.setCssIdentity(receivedIDcloud);
				LOG.info("DECLINE_CSS_FRIEND_REQUEST COMMSServer StanzagetJid " +stanza.getFrom().getJid());
				request.setRequestStatus(bean.getRequestStatus());
				request.setOrigin(CssRequestOrigin.REMOTE);
			//	request.setRequestStatus(bean.ge);
				//this.cssManager.declineCssFriendRequest(request);
				this.cssManager.handleExternalFriendRequest(receivedID, bean.getRequestStatus());
			break;
			}
		}
	}

	@Override
	public Object setQuery(Stanza stanza, Object payload) throws XMPPError {
		
		
		// TODO Auto-generated method stub
		return null;
	}
	
	/**
	 * Spring bean injection related method
	 * @return ICommManager
	 */
	public ICommManager getCommManager() {
		Dbc.ensure("Communication Manager cannot be null", this.commManager != null);
		return commManager;
	}
	/**
	 * Spring bean injection related method
	 * @param commManager
	 */
	public void setCommManager(ICommManager commManager) {
		Dbc.require(commManager != null);
		this.commManager = commManager;
	}
	public ICSSInternalManager getCssManager() {
		Dbc.ensure("CSS Manager cannot be null", this.cssManager != null);
		return cssManager;
	}
	public void setCssManager(ICSSInternalManager cssManager) {
		this.cssManager = cssManager;
	}

}