PrivacyPolicyNegotiationListener.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.security.policynegotiator.requester;

import java.net.URI;
import java.util.List;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.societies.api.identity.Requestor;
import org.societies.api.internal.logging.IPerformanceMessage;
import org.societies.api.internal.logging.PerformanceMessage;
import org.societies.api.internal.privacytrust.privacyprotection.IPrivacyPolicyNegotiationManager;
import org.societies.api.internal.privacytrust.privacyprotection.model.privacypolicy.PPNegotiationEvent;
import org.societies.api.internal.privacytrust.privacyprotection.negotiation.FailedNegotiationEvent;
import org.societies.api.internal.security.policynegotiator.INegotiationCallback;
import org.societies.api.osgi.event.CSSEvent;
import org.societies.api.osgi.event.EventListener;
import org.societies.api.osgi.event.EventTypes;
import org.societies.api.osgi.event.IEventMgr;
import org.societies.api.osgi.event.InternalEvent;
import org.societies.api.privacytrust.privacy.model.privacypolicy.NegotiationStatus;

/**
 * 
 * @author Mitja Vardjan
 *
 */
public class PrivacyPolicyNegotiationListener extends EventListener {

	private static Logger LOG = LoggerFactory.getLogger(PrivacyPolicyNegotiationListener.class);
	private static Logger PERF_LOG = LoggerFactory.getLogger("PerformanceMessage");
	
	INegotiationCallback finalCallback;
	String slaKey;
	List<URI> fileUris;
	int id;
	
	String[] eventTypes;
	IEventMgr eventMgr;
	
	//private long timestamp;
	
	/**
	 * 
	 * @param finalCallback The callback to be invoked when both SLA and privacy
	 * policy negotiations complete.
	 * 
	 * @param slaKey The key to gather SLA from secure storage using
	 * {@link org.societies.api.internal.security.storage.ISecureStorage#getDocument(String)}
	 */
	public PrivacyPolicyNegotiationListener(INegotiationCallback finalCallback, String slaKey,
			List<URI> fileUris, IEventMgr eventMgr, String[] eventTypes, int id) {
		
		this.finalCallback = finalCallback;
		this.slaKey = slaKey;
		this.fileUris = fileUris;
		this.id = id;
		
		this.eventTypes = eventTypes;
		this.eventMgr = eventMgr;
		
		//this.timestamp = System.nanoTime();
	}
	
	@Override
	public void handleInternalEvent(InternalEvent event) {

		String type = event.geteventType();
		
		LOG.info("Internal event received: {}", type);
		LOG.debug("*** event name : " + event.geteventName());
		LOG.debug("*** event source : " + event.geteventSource());

		if (type.equals(EventTypes.PRIVACY_POLICY_NEGOTIATION_EVENT)) {
			
			PPNegotiationEvent payload = (PPNegotiationEvent) event.geteventInfo();
			
			if (isEventForThisNegotiation(payload)) {
				
				NegotiationStatus status = payload.getNegotiationStatus();
				LOG.debug("negotiation status : " + status);

				if (status == NegotiationStatus.SUCCESSFUL) {
					logPerformance(true);
					notifySuccess();
				}
				else if (status == NegotiationStatus.FAILED) {
					logPerformance(false);
					notifyFailure();
				}
			}
		}
		else if (type.equals(EventTypes.FAILED_NEGOTIATION_EVENT)) {
			
			FailedNegotiationEvent payload = (FailedNegotiationEvent) event.geteventInfo();
			
			if (isEventForThisNegotiation(payload)) {

				Requestor requestor = payload.getDetails().getRequestor();
				LOG.debug("negotiation requestor : " + requestor);
				notifyFailure();
			}
		}
		
	}

	@Override
	public void handleExternalEvent(CSSEvent event) {
		LOG.warn("External event received unexpectedly: {}", event.geteventType());    
	}
	
	private boolean isEventForThisNegotiation(Object payload) {

		int id;
		
		if (payload instanceof PPNegotiationEvent) {
			PPNegotiationEvent p = (PPNegotiationEvent) payload;
			id = p.getDetails().getNegotiationID();
		}
		else if (payload instanceof FailedNegotiationEvent) {
			FailedNegotiationEvent p = (FailedNegotiationEvent) payload;
			id = p.getDetails().getNegotiationID();
		}
		else {
			LOG.warn("PPN event payload is of unexpected type: {}", payload.getClass().getName());
			return false;
		}
		
		LOG.debug("Event is for negotiation {}. This listener is waiting " +
				"for negotiation {}", id, this.id);
		
		return id == this.id;
	}
	
	private void notifySuccess() {
		
		eventMgr.unSubscribeInternalEvent(this, eventTypes, null);

		if (finalCallback != null) {
			LOG.debug("invoking final callback");
			finalCallback.onNegotiationComplete(slaKey, fileUris);
			LOG.info("negotiation finished, final callback invoked");
		}
		else {
			LOG.info("negotiation finished, but final callback is null");
		}
	}
	
	private void notifyFailure() {
		LOG.warn("Privacy policy negotiation failed");
		
		eventMgr.unSubscribeInternalEvent(this, eventTypes, null);

		finalCallback.onNegotiationError("");
	}
	
	private void logPerformance(boolean success) {
		
		IPerformanceMessage m = new PerformanceMessage();
		
		// The context under which you are doing the test. E.g. the data set or other boundary conditions.
		m.setTestContext("PolicyNegotiation_SuccessOrFailure");
		
		// The name of the component under test.
		// If you are testing more that one component implicitly or explicitly, then
		// just think of some name that represents the scope of the platform being tested.
		//m.setSourceComponent(this.getClass() + "");
		m.setSourceComponent(IPrivacyPolicyNegotiationManager.class.getName());
		
		// Should tell you something about the nature of the test; it's an index for you to help householding
		m.setOperationType("Privacy policy acceptance");
		
		// The test case name of D82v2 test tables
		m.setD82TestTableName("S70");
		
		m.setPerformanceType(IPerformanceMessage.Quanitative);

		// Should be built like this: "Name=<value>" where name is some name like
		// WHATEVERFUNCTIONALITY.ResponseTime (you choose this), and
		// <value> (without the <>) is a double or integer value - in the form of a String - 
		// that can be read using Double.parseDouble(String), or
		// a String if you cannot log as a quantitative value.
		m.setPerformanceNameValue("Success=" + success);

		PERF_LOG.trace(m.toString());
	}
}