[FAB-3222] extract java ChaincodeStub interface

- preparation for further cleanup of API
- also changed getUuid() to getTxId() in this CR

Change-Id: I83f01d7cc0e0b1dcc350e326f1ce06684f3b81b4
Signed-off-by: Luis Sanchez <[email protected]>

Author: Luis Sanchez

core/chaincode/shim/java/src/main/java/org/hyperledger/fabric/shim/ChaincodeStub.java

@@ -1,5 +1,5 @@
 /*
-Copyright DTCC, IBM 2016, 2017 All Rights Reserved.
+Copyright IBM 2017 All Rights Reserved.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -13,80 +13,54 @@
 See the License for the specific language governing permissions and
 limitations under the License.
 */
-
 package org.hyperledger.fabric.shim;
 
 import java.nio.charset.StandardCharsets;
 import java.util.Arrays;
-import java.util.Collections;
 import java.util.List;
 import java.util.stream.Collectors;
 
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
 import org.hyperledger.fabric.protos.peer.ChaincodeEventPackage.ChaincodeEvent;
 import org.hyperledger.fabric.protos.peer.ProposalResponsePackage.Response;
 
 import com.google.protobuf.ByteString;
 
-public class ChaincodeStub {
-
-	private static Log logger = LogFactory.getLog(ChaincodeStub.class);
-
-	private final String uuid;
-	private final Handler handler;
-	private final List<ByteString> args;
-	private ChaincodeEvent event;
-
-	public ChaincodeStub(String uuid, Handler handler, List<ByteString> args) {
-		this.uuid = uuid;
-		this.handler = handler;
-		this.args = Collections.unmodifiableList(args);
-	}
-
-	public List<byte[]> getArgs() {
-		return args.stream().map(x -> x.toByteArray()).collect(Collectors.toList());
-	}
-
-	public List<String> getArgsAsStrings() {
-		return args.stream().map(x -> x.toStringUtf8()).collect(Collectors.toList());
-	}
+public interface ChaincodeStub {
 
 	/**
-	 * Defines the CHAINCODE type event that will be posted to interested
-	 * clients when the chaincode's result is committed to the ledger.
+	 * Returns the arguments corresponding to the call to
+	 * {@link Chaincode#init(ChaincodeStub)} or
+	 * {@link Chaincode#invoke(ChaincodeStub)}.
 	 * 
-	 * @param name
-	 *            Name of event. Cannot be null or empty string.
-	 * @param payload
-	 *            Optional event payload.
+	 * @return a list of arguments
 	 */
-	public void setEvent(String name, byte[] payload) {
-		if(name == null || name.trim().length() == 0) throw new IllegalArgumentException("Event name cannot be null or empty string.");
-		if(payload != null) {
-			this.event = ChaincodeEvent.newBuilder()
-					.setEventName(name)
-					.setPayload(ByteString.copyFrom(payload))
-					.build();
-		} else {
-			this.event = ChaincodeEvent.newBuilder()
-					.setEventName(name)
-					.build();
-		}
-	}
+	List<byte[]> getArgs();
 
-	ChaincodeEvent getEvent() {
-		return event;
-	}
+	/**
+	 * Returns the arguments corresponding to the call to
+	 * {@link Chaincode#init(ChaincodeStub)} or
+	 * {@link Chaincode#invoke(ChaincodeStub)}.
+	 * 
+	 * @return a list of arguments cast to a UTF-8 string
+	 */
+	List<String> getArgsAsStrings();
 
 	/**
-	 * Gets the UUID of this stub
+	 * Returns the transaction id
 	 *
-	 * @return the id used to identify this communication channel
+	 * @return the transaction id
 	 */
-	public String getUuid() {
-		return uuid;
-	}
+	String getTxId();
+
+	/**
+	 * Invoke another chaincode using the same transaction context.
+	 * 
+	 * @param chaincodeName Name of chaincode to be invoked.
+	 * @param args Arguments to pass on to the called chaincode.
+	 * @param channel If not specified, the caller's channel is assumed.  
+	 * @return
+	 */
+	Response invokeChaincode(String chaincodeName, List<byte[]> args, String channel);
 
 	/**
 	 * Get the state of the provided key from the ledger, and returns is as a
@@ -96,9 +70,7 @@ public String getUuid() {
 	 *            the key of the desired state
 	 * @return the String value of the requested state
 	 */
-	public String getState(String key) {
-		return handler.handleGetState(key, uuid).toStringUtf8();
-	}
+	String getState(String key);
 
 	/**
 	 * Puts the given state into a ledger, automatically wrapping it in a
@@ -109,76 +81,15 @@ public String getState(String key) {
 	 * @param value
 	 *            value to be put
 	 */
-	public void putState(String key, String value) {
-		handler.handlePutState(key, ByteString.copyFromUtf8(value), uuid);
-	}
+	void putState(String key, String value);
 
 	/**
 	 * Deletes the state of the given key from the ledger
 	 *
 	 * @param key
 	 *            key of the state to be deleted
 	 */
-	public void delState(String key) {
-		handler.handleDeleteState(key, uuid);
-	}
-	/**
-	 * Given a start key and end key, this method returns a map of items with
-	 * value converted to UTF-8 string.
-	 *
-	 * @param startKey
-	 * @param endKey
-	 * @return
-	 */
-	// TODO: Uncomment and fix range query with new proto type
-	/*
-	public Map<String, String> getStateByRange(String startKey, String endKey) {
-		Map<String, String> retMap = new HashMap<>();
-		for (Map.Entry<String, ByteString> item : getStateByRangeRaw(startKey, endKey).entrySet()) {
-			retMap.put(item.getKey(), item.getValue().toStringUtf8());
-		}
-		return retMap;
-	}
-	*/
-	/**
-	 * This method is same as getStateByRange, except it returns value in
-	 * ByteString, useful in cases where serialized object can be retrieved.
-	 *
-	 * @param startKey
-	 * @param endKey
-	 * @return
-	 */
-	// TODO: Uncomment and fix range query with new proto type
-	/*
-	public Map<String, ByteString> getStateByRangeRaw(String startKey, String endKey) {
-		Map<String, ByteString> map = new HashMap<>();
-		for (ChaincodeShim.QueryStateKeyValue mapping : handler.handleGetStateByRange(startKey, endKey, uuid).getKeysAndValuesList()) {
-			map.put(mapping.getKey(), mapping.getValue());
-		}
-		return map;
-	}
-	*/
-
-	/**
-	 * Given a partial composite key, this method returns a map of items (whose
-	 * key's prefix matches the given partial composite key) with value
-	 * converted to UTF-8 string and this methid should be used only for a
-	 * partial composite key; For a full composite key, an iter with empty
-	 * response would be returned.
-	 * 
-	 * @param startKey
-	 * @param endKey
-	 * @return
-	 */
-
-	// TODO: Uncomment and fix range query with new proto type
-	/*
-	public Map<String, String> getStateByPartialCompositeKey(String objectType, String[] attributes) {
-		String partialCompositeKey = new String();
-		partialCompositeKey = createCompositeKey(objectType, attributes);
-		return getStateByRange(partialCompositeKey + "1", partialCompositeKey + ":");
-	}
-	*/
+	void delState(String key);
 
 	/**
 	 * Given a set of attributes, this method combines these attributes to
@@ -188,33 +99,18 @@ public Map<String, String> getStateByPartialCompositeKey(String objectType, Stri
 	 * @param attributes
 	 * @return
 	 */
-	public String createCompositeKey(String objectType, String[] attributes) {
-		String compositeKey = new String();
-		compositeKey = compositeKey + objectType;
-		for (String attribute : attributes) {
-			compositeKey = compositeKey + attribute.length() + attribute;
-		}
-		return compositeKey;
-	}
+	String createCompositeKey(String objectType, String[] attributes);
 
 	/**
-	 * Invoke another chaincode using the same transaction context.
+	 * Defines the CHAINCODE type event that will be posted to interested
+	 * clients when the chaincode's result is committed to the ledger.
 	 * 
-	 * @param chaincodeName Name of chaincode to be invoked.
-	 * @param args Arguments to pass on to the called chaincode.
-	 * @param channel If not specified, the caller's channel is assumed.  
-	 * @return
+	 * @param name
+	 *            Name of event. Cannot be null or empty string.
+	 * @param payload
+	 *            Optional event payload.
 	 */
-	public Response invokeChaincode(final String chaincodeName, final List<byte[]> args, final String channel) {
-		// internally we handle chaincode name as a composite name
-		final String compositeName;
-		if(channel != null && channel.trim().length() > 0) {
-			compositeName = chaincodeName + "/" + channel;
-		} else {
-			compositeName = chaincodeName;
-		}
-		return handler.handleInvokeChaincode(compositeName, args, this.uuid);
-	}
+	void setEvent(String name, byte[] payload);
 
 	/**
 	 * Invoke another chaincode using the same transaction context.
@@ -223,10 +119,10 @@ public Response invokeChaincode(final String chaincodeName, final List<byte[]> a
 	 * @param args Arguments to pass on to the called chaincode.
 	 * @return
 	 */
-	public Response invokeChaincode(final String chaincodeName, final List<byte[]> args) {
+	default Response invokeChaincode(String chaincodeName, List<byte[]> args) {
 		return invokeChaincode(chaincodeName, args, null);
 	}
-	
+
 	/**
 	 * Invoke another chaincode using the same transaction context.
 	 * 
@@ -238,10 +134,10 @@ public Response invokeChaincode(final String chaincodeName, final List<byte[]> a
 	 * @param channel If not specified, the caller's channel is assumed.  
 	 * @return
 	 */
-	public Response invokeChaincodeWithStringArgs(final String chaincodeName, final List<String> args, final String channel) {
+	default Response invokeChaincodeWithStringArgs(String chaincodeName, List<String> args, String channel) {
 		return invokeChaincode(chaincodeName, args.stream().map(x->x.getBytes(StandardCharsets.UTF_8)).collect(Collectors.toList()), channel);
 	}
-	
+
 	/**
 	 * Invoke another chaincode using the same transaction context.
 	 * 
@@ -253,7 +149,7 @@ public Response invokeChaincodeWithStringArgs(final String chaincodeName, final
 	 * @param args Arguments to pass on to the called chaincode.
 	 * @return
 	 */
-	public Response invokeChaincodeWithStringArgs(final String chaincodeName, final List<String> args) {
+	default Response invokeChaincodeWithStringArgs(String chaincodeName, List<String> args) {
 		return invokeChaincodeWithStringArgs(chaincodeName, args, null);
 	}
 
@@ -268,37 +164,27 @@ public Response invokeChaincodeWithStringArgs(final String chaincodeName, final
 	 * @param args Arguments to pass on to the called chaincode.
 	 * @return
 	 */
-	public Response invokeChaincodeWithStringArgs(final String chaincodeName, final String... args) {
+	default Response invokeChaincodeWithStringArgs(final String chaincodeName, final String... args) {
 		return invokeChaincodeWithStringArgs(chaincodeName, Arrays.asList(args), null);
 	}
 
-	// ------RAW CALLS------
-
 	/**
 	 * @param key
 	 * @return
 	 */
-	public ByteString getRawState(String key) {
-		return handler.handleGetState(key, uuid);
-	}
+	ByteString getRawState(String key);
 
 	/**
 	 * @param key
 	 * @param value
 	 */
-	public void putRawState(String key, ByteString value) {
-		handler.handlePutState(key, value, uuid);
-	}
+	void putRawState(String key, ByteString value);
 
 	/**
-	 *
-	 * @param startKey
-	 * @param endKey
-	 * @param limit
-	 * @return
+	 * Returns the CHAINCODE type event that will be posted to interested
+	 * clients when the chaincode's result is committed to the ledger.
+	 * @return the chaincode event or null
 	 */
-//	public GetStateByRangeResponse getStateByRangeRaw(String startKey, String endKey, int limit) {
-//		return handler.handleGetStateByRange(startKey, endKey, limit, uuid);
-//	}
+	ChaincodeEvent getEvent();
 
-}
+}