ContextAware3pService.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., 
 * 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.context.exampleRemote.broker;
import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;
import java.util.concurrent.ExecutionException;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.societies.api.cis.management.ICisOwned;
import org.societies.api.comm.xmpp.interfaces.ICommManager;
import org.societies.api.context.CtxException;
import org.societies.api.context.broker.ICtxBroker;
import org.societies.api.context.event.CtxChangeEvent;
import org.societies.api.context.event.CtxChangeEventListener;
import org.societies.api.context.model.CommunityCtxEntity;
import org.societies.api.context.model.CtxAssociation;
import org.societies.api.context.model.CtxAssociationTypes;
import org.societies.api.context.model.CtxAttribute;
import org.societies.api.context.model.CtxAttributeBond;
import org.societies.api.context.model.CtxAttributeIdentifier;
import org.societies.api.context.model.CtxAttributeTypes;
import org.societies.api.context.model.CtxAttributeValueMetrics;
import org.societies.api.context.model.CtxAttributeValueType;
import org.societies.api.context.model.CtxBond;
import org.societies.api.context.model.CtxBondOriginType;
import org.societies.api.context.model.CtxEntity;
import org.societies.api.context.model.CtxEntityIdentifier;
import org.societies.api.context.model.CtxEntityTypes;
import org.societies.api.context.model.CtxHistoryAttribute;
import org.societies.api.context.model.CtxIdentifier;
import org.societies.api.context.model.CtxModelObject;
import org.societies.api.context.model.CtxModelType;
import org.societies.api.context.model.CtxOriginType;
import org.societies.api.context.model.IndividualCtxEntity;
import org.societies.api.context.model.util.SerialisationHelper;
import org.societies.api.identity.IIdentity;
import org.societies.api.identity.IIdentityManager;
import org.societies.api.identity.INetworkNode;
import org.societies.api.identity.InvalidFormatException;
import org.societies.api.identity.Requestor;
import org.societies.api.identity.RequestorService;
import org.societies.api.schema.servicelifecycle.model.ServiceResourceIdentifier;


/*
import org.societies.privacytrust.privacyprotection.api.IPrivacyPreferenceManager;
import org.societies.privacytrust.privacyprotection.api.model.privacypreference.IPrivacyPreference;
import org.societies.privacytrust.privacyprotection.api.model.privacypreference.PPNPOutcome;
import org.societies.privacytrust.privacyprotection.api.model.privacypreference.PPNPreferenceDetails;
import org.societies.privacytrust.privacyprotection.api.model.privacypreference.PPNPrivacyPreferenceTreeModel;
import org.societies.privacytrust.privacyprotection.api.model.privacypreference.PrivacyPreference;
import org.societies.privacytrust.privacyprotection.api.model.privacypreference.constants.PrivacyOutcomeConstants;
 */
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

/**
 * Describe your class here...
 *
 * @author NikosK
 *
 */
@Service
public class ContextAware3pService implements IContextAware3pService{


	private Logger LOG = LoggerFactory.getLogger(this.getClass());

	//services
	private ICommManager commsMgr;
	private IIdentityManager idMgr;
	private ICtxBroker ctxBroker;
	//private IPrivacyPreferenceManager privPrefMgr;

	// identities
	private RequestorService requestorService;

	private Requestor requestor;
	//private IIdentity userIdentity;
	private IIdentity serviceIdentity;
	private ServiceResourceIdentifier myServiceID;

	@Autowired(required=true)
	public ContextAware3pService( ICtxBroker ctxBroker, ICommManager commsMgr){

		LOG.info("*** ContextAware3pRemoteService started");

		//services
		this.ctxBroker = ctxBroker;
		this.commsMgr = commsMgr;
		this.idMgr = commsMgr.getIdManager();

		LOG.info("ctxBroker: "+this.ctxBroker);
		LOG.info("commsMgr : "+this.commsMgr );
		LOG.info("idMgr : "+this.idMgr );

		this.requestor = getSimpleRequestor();
		//this.requestor = getRequestor();
	}



	@Override
	public CtxAttribute  retrieveCtxObject(CtxIdentifier ctxID){

		CtxAttribute result = null;
		try {
			result = (CtxAttribute) this.ctxBroker.retrieve(requestor, ctxID).get();
		} catch (CtxException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} catch (InterruptedException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} catch (ExecutionException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}

		return result;
	}


	@Override
	public List<CtxIdentifier> lookupRemoteCtxAttribute(String targetID, String type){

		List<CtxIdentifier> results = new ArrayList<CtxIdentifier>(); 
		try {
			//List<CtxIdentifier> attridList = this.ctxBroker.lookup(requestorService, targetId, CtxModelType.ATTRIBUTE, CtxAttributeTypes.BOOKS).get();

			//create identities
			INetworkNode cssNodeId = this.commsMgr.getIdManager().getThisNetworkNode();
			final String cssOwnerStr = cssNodeId.getBareJid();
			IIdentity localID = this.commsMgr.getIdManager().fromJid(cssOwnerStr);	
			requestor = new Requestor(localID);
			LOG.info("simple requestor "+ requestor.getRequestorId().getJid());

			IIdentity targetId = this.commsMgr.getIdManager().fromJid(targetID); 
			LOG.info("targetId "+ targetId.getJid());

			// lookup attribute
			results = this.ctxBroker.lookup(requestor, targetId, CtxModelType.ATTRIBUTE, type).get();


		} catch (CtxException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} catch (InterruptedException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} catch (ExecutionException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} catch (InvalidFormatException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
		return results;
	}


	@Override
	public List<CtxAttribute> lookupRemoteLocalCtxAttribute(String targetID, String attrType){
		//?
		List<CtxAttribute> results = null; 

		try {

			IIdentity targetId = this.commsMgr.getIdManager().fromJid(targetID);
			LOG.info("targetId "+ targetId.getJid());

			// create remote entity
			CtxEntity remoteEntity = this.ctxBroker.createEntity(requestor, targetId, "human").get();
			LOG.info("remote entity"+ remoteEntity.getId().toString());
			CtxEntityIdentifier entID = remoteEntity.getId();
			LOG.info("remote entity owner "+ entID.getOwnerId());

			// create remote attribute
			CtxAttribute remoteAttribute = this.ctxBroker.createAttribute(requestor, entID, attrType).get();
			CtxIdentifier attrID = remoteAttribute.getId();
			LOG.info("remoteAttribute"+ attrID.toString());


			//retrieve remote attribute ??
			LOG.info("retrieve remoteAttribute"+ attrID.toString());
			attrID.setOwnerId("john.societies.local");
			LOG.info("remote attribute owner changed : "+ attrID.getOwnerId());


			CtxAttribute remoteAttributeRetrieved = (CtxAttribute) this.ctxBroker.retrieve(requestor, attrID).get();
			LOG.info("retrieval result Attribute 1 "+ remoteAttributeRetrieved);
			LOG.info("retrieval result Attribute 2 "+ remoteAttributeRetrieved.getId().toString());

			// update attribute
			remoteAttributeRetrieved.getId().setOwnerId("jane.societies.local");
			remoteAttributeRetrieved.setStringValue("TarasBoulba");
			CtxAttribute remoteUpdatedAttr = (CtxAttribute) this.ctxBroker.update(requestor, remoteAttributeRetrieved).get();
			LOG.info("update result Attribute valye should be:  'taras Boulba' and is :"+remoteUpdatedAttr.getId());
			LOG.info("update result Attribute valye should be:  'taras Boulba' and is :"+remoteUpdatedAttr.getStringValue()); 

			// lookup attribute
			//List<CtxIdentifier> attridList = this.ctxBroker.lookup(simpleRequestor, targetId, CtxModelType.ATTRIBUTE, CtxAttributeTypes.BOOKS).get();
			//LOG.info("remote lookup results size "+ attridList.size());

			//for(CtxIdentifier id : attridList ){
			//		LOG.info("remote lookup results id "+ id);
			//}



		} catch (CtxException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} catch (InterruptedException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} catch (ExecutionException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} catch (InvalidFormatException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
		return results;
	}

	@Override
	public CtxAttribute createRemoteCtxAttribute(CtxEntityIdentifier remoteCtxEntityId, String type) {

		CtxAttribute remoteAttribute = null;

		// create remote attribute
		try {
			remoteAttribute = this.ctxBroker.createAttribute(requestor, remoteCtxEntityId, type).get();

		} catch (InterruptedException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} catch (ExecutionException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} catch (CtxException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
		LOG.info("remoteAttribute"+ remoteAttribute);

		return remoteAttribute;
	}




	@Override
	public CtxEntity createRemoteCtxEntity(String targetIDstring, String type) {

		IIdentity targetId;
		CtxEntity remoteEntity = null;

		try {
			targetId = this.commsMgr.getIdManager().fromJid(targetIDstring);
			//LOG.info("targetId "+ targetId.getJid());
			// create remote entity
			remoteEntity = this.ctxBroker.createEntity(requestor, targetId, type).get();
			//LOG.info("remote entity"+ remoteEntity);
		} catch (InvalidFormatException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} catch (InterruptedException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} catch (ExecutionException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} catch (CtxException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} 

		return remoteEntity;
	}




	@Override
	public CtxModelObject updateCtxModelObject(CtxModelObject obj) {

		CtxModelObject updatedObj = null;
		try {
			updatedObj = this.ctxBroker.update(requestor, obj).get();
		} catch (InterruptedException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} catch (ExecutionException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} catch (CtxException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}

		return updatedObj;
	}


	@Override
	public void registerForContextUpdates(CtxIdentifier ctxID, CtxChangeEventListener listener){
		try {
			LOG.info("register for changes for "+ctxID.toString());
			this.ctxBroker.registerForChanges(requestor, listener, ctxID);
			LOG.info("registered");
		} catch (CtxException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}	
	}

	@Override
	public IndividualCtxEntity retrieveRemoteIndiEntity(String targetIDstring) {


		IIdentity targetId;
		IndividualCtxEntity indiEntResult = null;

		try {
			targetId = this.commsMgr.getIdManager().fromJid(targetIDstring);

			CtxEntityIdentifier remoteEntityID = this.ctxBroker.retrieveIndividualEntityId(requestor, targetId).get();


			/*
			CtxAttribute attrName = this.ctxBroker.createAttribute(requestor, remoteEntityID, CtxAttributeTypes.NAME).get();
			attrName.setStringValue("Aris");

			CtxAttribute attrNameUpdated = (CtxAttribute) this.ctxBroker.update(requestor, attrName).get();

			LOG.info("verify that remote ctx attribute name updated   "+attrNameUpdated.getStringValue());

			// retrieve remote attribute object belonging to individual entity id
			List<CtxIdentifier> resultsAttrIDs = this.ctxBroker.lookup(requestor, targetId, CtxModelType.ATTRIBUTE, CtxAttributeTypes.NAME).get();

			CtxAttributeIdentifier attrIndiEntID = null; 

			for( CtxIdentifier ctxID: resultsAttrIDs ){
				CtxAttributeIdentifier attrID = (CtxAttributeIdentifier) ctxID; 
				CtxEntityIdentifier entID =  attrID.getScope();
				//attribute id found
				if(entID.equals(remoteEntityID)) attrIndiEntID = attrID;  
			}

			CtxAttribute attrNameRemote = (CtxAttribute) this.ctxBroker.retrieve(requestor, attrIndiEntID).get();

			LOG.info("retrieve remote ctxAttribute id   "+attrNameRemote.getId());
			LOG.info("retrieve remote ctxAttribute value   "+attrNameRemote.getStringValue());
			 */

			indiEntResult = (IndividualCtxEntity) this.ctxBroker.retrieve(requestor, remoteEntityID).get();


		} catch (InvalidFormatException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} catch (InterruptedException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} catch (ExecutionException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} catch (CtxException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}

		return indiEntResult;
	}


	@Override
	public CtxAssociation createRemoteCtxAssociation(String targetIDstring , String type) {

		IIdentity targetId;
		CtxAssociation remoteAssoc = null;

		try {
			targetId = this.commsMgr.getIdManager().fromJid(targetIDstring);
			LOG.info("create remote Association:  targetId "+ targetId.getJid());

			// create remote association
			remoteAssoc = this.ctxBroker.createAssociation(requestor, targetId, type).get();

			LOG.info("remote association:"+ remoteAssoc);
		} catch (InvalidFormatException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} catch (InterruptedException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} catch (ExecutionException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} catch (CtxException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} 

		return remoteAssoc;
	}



	public String estimateCommunityCtx(){

		String result  = "";

		//retrieve community entity

		// retrieve cis

		System.out.println(" retrieveCommunityEntity ");
		IndividualCtxEntity individualEntity;
		CommunityCtxEntity community = null;

		INetworkNode cssNodeId = this.commsMgr.getIdManager().getThisNetworkNode();
		final String cssOwnerStr = cssNodeId.getBareJid();

		try {
			IIdentity cssOwnerId = this.commsMgr.getIdManager().fromJid(cssOwnerStr);

			LOG.info( "cssOwnerId "+ cssOwnerId.getBareJid());

			CtxEntityIdentifier entID  = this.ctxBroker.retrieveIndividualEntityId(requestor,cssOwnerId).get();
			individualEntity =  (IndividualCtxEntity) this.ctxBroker.retrieve(requestor, entID).get();

			Set<CtxEntityIdentifier> communitiesEntIdSet = individualEntity.getCommunities();

			for(CtxEntityIdentifier commEntID : communitiesEntIdSet){
				CommunityCtxEntity communityEntTemp = (CommunityCtxEntity) this.ctxBroker.retrieve(requestor,commEntID).get();

				LOG.info("community: "+ communityEntTemp.toString());
				if( communityEntTemp.getMembers().size()>1 ) {
					community = communityEntTemp;

					Set<CtxBond> bondSet = this.ctxBroker.retrieveBonds(requestor, community.getId()).get();

					for(CtxBond bond : bondSet){
						LOG.info("bond : "+ bond);	
					}							
				}
			}		

			if(community != null){
				for( CtxEntityIdentifier membEntId : community.getMembers()){
					LOG.info("membEntId : "+ membEntId);	
				} 				

				CtxAttribute commLoc = this.ctxBroker.createAttribute(requestor, community.getId(), CtxAttributeTypes.LOCATION_SYMBOLIC).get();
				LOG.info("commLoc : "+ commLoc.getId());
				CtxAttribute commLocRetrieved = (CtxAttribute) this.ctxBroker.retrieve(requestor, commLoc.getId()).get();
			
				LOG.info("commLocRetrieved : "+ commLocRetrieved.getId());
			
			}		
			
			
			
		} catch (InterruptedException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} catch (ExecutionException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} catch (CtxException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} catch (InvalidFormatException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}

		return result;
	}




	private Requestor getRequestor(){

		Requestor requestor = null;

		INetworkNode cssNodeId = this.commsMgr.getIdManager().getThisNetworkNode();

		try {
			this.serviceIdentity = this.idMgr.fromJid(cssNodeId.getBareJid());
		} catch (InvalidFormatException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}

		myServiceID = new ServiceResourceIdentifier();
		myServiceID.setServiceInstanceIdentifier("css://john@societies.org/ContextAware3pService");
		try {
			myServiceID.setIdentifier(new URI("css://john@societies.org/ContextAware3pService"));
		} catch (URISyntaxException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
		requestorService = new RequestorService(serviceIdentity, myServiceID);

		return requestor;
	}

	private Requestor getSimpleRequestor(){

		Requestor requestor = null;

		INetworkNode cssNodeId = this.commsMgr.getIdManager().getThisNetworkNode();
		IIdentity localID;
		try {
			localID = this.commsMgr.getIdManager().fromJid(cssNodeId.getBareJid());
			requestor = new Requestor(localID);
			LOG.info("simple requestor "+ requestor.getRequestorId().getJid());
		} catch (InvalidFormatException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}	

		return requestor;
	}


}