ITrustClient.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.android.api.privacytrust.trust;

import java.io.Serializable;

import org.societies.android.api.privacytrust.trust.model.ADate;
import org.societies.android.api.privacytrust.trust.model.ATrustEvidenceType;
import org.societies.android.api.privacytrust.trust.model.ATrustedEntityId;
import org.societies.api.privacytrust.trust.TrustException;

/**
 * Describe your class here...
 *
 * @author <a href="mailto:nicolas.liampotis@cn.ntua.gr">Nicolas Liampotis</a> (ICCS)
 * @since 0.5
 */
public interface ITrustClient {
	
	public static final String INTENT_RETURN_VALUE_KEY = 
			"org.societies.android.api.privacytrust.trust.ReturnValue";
    public static final String INTENT_RETURN_STATUS_KEY = 
    		"org.societies.android.api.privacytrust.trust.ReturnStatus";
    
    public static final String RETRIEVE_TRUST_VALUE = 
    		"org.societies.android.api.privacytrust.trust.RETRIEVE_TRUST_VALUE";
    public static final String ADD_TRUST_EVIDENCE = 
    		"org.societies.android.api.privacytrust.trust.ADD_TRUST_EVIDENCE";

    String methodsArray [] = {
    		"retrieveTrust(String client, org.societies.android.api.privacytrust.trust.model.ATrustedEntityId trustorId, org.societies.android.api.privacytrust.trust.model.ATrustedEntityId trusteeId)",
            "addTrustEvidence(String client, org.societies.android.api.privacytrust.trust.model.ATrustedEntityId subjectId, org.societies.android.api.privacytrust.trust.model.ATrustedEntityId objectId, org.societies.android.api.privacytrust.trust.model.ATrustEvidenceType type, org.societies.android.api.privacytrust.trust.model.ADate timestamp, Serializable info"
            };

	/**
	 * Retrieves the trust value which the specified trustor has assigned to the
	 * supplied trustee. The method returns <code>null</code> if no trust value
	 * has been assigned to the specified trustee by the given trustor.
	 * 
	 * @param client
	 *            TODO
	 * @param trustorId
	 *            the identifier of the entity which has assigned the trust
	 *            value to retrieve.
	 * @param trusteeId
	 *            the identifier of the entity whose trust value to retrieve.
	 * @throws TrustException if the trust value cannot be retrieved.
	 * @throws NullPointerException if any of the specified parameters is
	 *         <code>null</code>
	 * @since 0.5
	 */
	public void retrieveTrust(final String client, 
			final ATrustedEntityId trustorId, final ATrustedEntityId trusteeId)
					throws TrustException;
	
	/**
	 * Adds the specified piece of trust evidence. The
	 * {@link ATrustedEntityId ATrustedEntityIds} of the subject and the object
	 * this piece of evidence refers to, its type, as well as, the time the
	 * evidence was recorded are also supplied. Finally, depending on the
	 * evidence type, the method allows specifying supplementary information.
	 * 
	 * @param client
	 *            TODO
	 * @param subjectId
	 *            the {@link ATrustedEntityId} of the subject the piece of
	 *            evidence refers to.
	 * @param objectId
	 *            the {@link ATrustedEntityId} of the object the piece of
	 *            evidence refers to.
	 * @param type
	 *            the type of the evidence to be added.
	 * @param timestamp
	 *            the time the evidence was recorded.
	 * @param info
	 *            supplementary information if applicable; <code>null</code>
	 *            otherwise.
	 * @throws TrustException
	 *            if the specified piece of direct trust evidence cannot be 
	 *            added.
	 * @throws NullPointerException
	 *            if any of the specified subjectId, objectId, type or 
	 *            timestamp parameter is <code>null</code>.
	 * @since 0.5
	 */
	public void addTrustEvidence(final String client, 
			final ATrustedEntityId subjectId, final ATrustedEntityId objectId,
			final ATrustEvidenceType type, final ADate timestamp, 
			final Serializable info) throws TrustException;
}