[FAB-15634] Annotations for Serializer

Provides the annotation to say what serializer is in use.
Defaults to the current JSON format.

Users can implement their own if they wish.

This brings Java up to the same functional level as Node.

Change-Id: I1d8095cafddf14cd64fc36c67420f1c5246d50cb
Signed-off-by: Matthew B. White <[email protected]>

Author: mbwhite

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/contract/ContractRouter.java

@@ -10,15 +10,18 @@
 import java.util.logging.Logger;
 
 import org.hyperledger.fabric.Logging;
+import org.hyperledger.fabric.contract.annotation.Serializer;
 import org.hyperledger.fabric.contract.execution.ExecutionFactory;
 import org.hyperledger.fabric.contract.execution.ExecutionService;
 import org.hyperledger.fabric.contract.execution.InvocationRequest;
+import org.hyperledger.fabric.contract.execution.SerializerInterface;
 import org.hyperledger.fabric.contract.metadata.MetadataBuilder;
 import org.hyperledger.fabric.contract.routing.ContractDefinition;
 import org.hyperledger.fabric.contract.routing.RoutingRegistry;
 import org.hyperledger.fabric.contract.routing.TxFunction;
 import org.hyperledger.fabric.contract.routing.TypeRegistry;
 import org.hyperledger.fabric.contract.routing.impl.RoutingRegistryImpl;
+import org.hyperledger.fabric.contract.routing.impl.SerializerRegistryImpl;
 import org.hyperledger.fabric.contract.routing.impl.TypeRegistryImpl;
 import org.hyperledger.fabric.metrics.Metrics;
 import org.hyperledger.fabric.shim.ChaincodeBase;
@@ -34,7 +37,11 @@ public class ContractRouter extends ChaincodeBase {
 
     private RoutingRegistry registry;
     private TypeRegistry typeRegistry;
-    private ExecutionService executor;
+
+    // Store instances of SerializerInterfaces - identified by the contract annotation
+    // (default is JSON)
+    public SerializerRegistryImpl serializers;
+
 
     /**
      * Take the arguments from the cli, and initiate processing of cli options and
@@ -55,8 +62,19 @@ public ContractRouter(String[] args) {
         super.validateOptions();
         logger.fine("ContractRouter<init>");
         registry = new RoutingRegistryImpl();
-        typeRegistry = new TypeRegistryImpl();
-        executor = ExecutionFactory.getInstance().createExecutionService(typeRegistry);
+        typeRegistry = TypeRegistry.getRegistry();
+
+        serializers = new SerializerRegistryImpl();
+
+        try {
+            serializers.findAndSetContents();
+        } catch (InstantiationException | IllegalAccessException e) {
+            ContractRuntimeException cre = new ContractRuntimeException("Unable to locate Serializers",e);
+            logger.severe(()-> Logging.formatError(cre));
+            throw new RuntimeException(cre);
+        }
+
+
 
     }
 
@@ -91,6 +109,11 @@ private Response processRequest(ChaincodeStub stub) {
                 InvocationRequest request = ExecutionFactory.getInstance().createRequest(stub);
                 TxFunction txFn = getRouting(request);
 
+                // based on the routing information the serializer can be found
+                // TRANSACTION target as this on the 'inbound' to invoke a tx
+                SerializerInterface si = serializers.getSerializer(txFn.getRouting().getSerializerName(),Serializer.TARGET.TRANSACTION);
+                ExecutionService executor = ExecutionFactory.getInstance().createExecutionService(si);
+
                 logger.info(() -> "Got routing:" + txFn.getRouting());
                 return executor.executeRequest(txFn, request, stub);
             } else {
@@ -137,6 +160,8 @@ public static void main(String[] args) {
         ContractRouter cfc = new ContractRouter(args);
         cfc.findAllContracts();
 
+        logger.fine(cfc.getRoutingRegistry().toString());
+
         // Create the Metadata ahead of time rather than have to produce every
         // time
         MetadataBuilder.initialize(cfc.getRoutingRegistry(), cfc.getTypeRegistry());

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/contract/annotation/Contract.java

@@ -38,4 +38,15 @@
      * @return Name of the contract to be used instead of the Classname
      */
     String name() default "";
+
+    /**
+     * Fully Qualified Classname of the TRANSACTION serializer 
+     * that should be used with this contract.
+     * 
+     * This is the serializer that is used to parse incoming transaction request
+     * parameters and convert the return type
+     */
+    String transactionSerializer() default "org.hyperledger.fabric.contract.execution.JSONTransactionSerializer";
+
+
 }

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/contract/annotation/Serializer.java

@@ -0,0 +1,28 @@
+/*
+Copyright IBM Corp. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+package org.hyperledger.fabric.contract.annotation;
+
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+/**
+ * Class level annotation that defines the serializer that should be used to
+ * convert objects to and from the wire format.
+ * 
+ * This should annotate a class that implements the Serializer interface
+ */
+@Retention(RUNTIME)
+@Target({ElementType.TYPE,ElementType.TYPE_USE})
+public @interface Serializer {
+    public enum TARGET {
+        TRANSACTION, ALL
+    }
+
+    TARGET target() default Serializer.TARGET.ALL; 
+}

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/contract/annotation/Transaction.java

@@ -23,6 +23,14 @@
 @Retention(RUNTIME)
 @Target(METHOD)
 public @interface Transaction {
+
+    /**
+     * SUBMIT or EVALUATE semantics
+     */
+    public enum TYPE {
+        SUBMIT,EVALUATE
+    }
+
     /**
      * TRUE indicates that this function is intended to be called with the 'submit'
      * semantics
@@ -31,9 +39,17 @@
      * semantics
      *
      * @return boolean, default is true
+     * @deprecated Please use intent
      */
+    @Deprecated
     boolean submit() default true;
 
+    /**
+     * SUBMIT - indicates that this function is intended to be called with the 'submit' semantics
+     * EVALUATE - indicates that this is intended to be called with the 'evaluate' semantics
+     */
+    TYPE intent() default Transaction.TYPE.SUBMIT;
+
     /**
      * The name of the callable transaction if it should be different to the method
      * name.

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/contract/execution/ExecutionFactory.java

@@ -8,7 +8,6 @@
 
 import org.hyperledger.fabric.contract.execution.impl.ContractExecutionService;
 import org.hyperledger.fabric.contract.execution.impl.ContractInvocationRequest;
-import org.hyperledger.fabric.contract.routing.TypeRegistry;
 import org.hyperledger.fabric.shim.ChaincodeStub;
 
 public class ExecutionFactory {
@@ -26,9 +25,10 @@ public InvocationRequest createRequest(ChaincodeStub context) {
         return new ContractInvocationRequest(context);
     }
 
-    public ExecutionService createExecutionService(TypeRegistry typeRegistry) {
+
+    public ExecutionService createExecutionService(SerializerInterface serializers) {
         if (es == null) {
-            es = new ContractExecutionService(typeRegistry);
+            es = new ContractExecutionService(serializers);
         }
         return es;
     }

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/contract/execution/JSONTransactionSerializer.java

@@ -25,20 +25,20 @@
 import org.json.JSONException;
 import org.json.JSONObject;
 
+import org.hyperledger.fabric.contract.annotation.Serializer;
+
 /**
  * Used as a the default serialisation for transmission from SDK to Contract
  */
-public class JSONTransactionSerializer {
+@Serializer() 
+public class JSONTransactionSerializer implements SerializerInterface {
     private static Logger logger = Logger.getLogger(JSONTransactionSerializer.class.getName());
-    private TypeRegistry typeRegistry;
+    private TypeRegistry typeRegistry = TypeRegistry.getRegistry();
 
     /**
-     * Create a new serialiser and maintain a reference to the TypeRegistry
-     *
-     * @param typeRegistry
+     * Create a new serialiser
      */
-    public JSONTransactionSerializer(TypeRegistry typeRegistry) {
-        this.typeRegistry = typeRegistry;
+    public JSONTransactionSerializer() {
     }
 
     /**
@@ -48,6 +48,7 @@ public JSONTransactionSerializer(TypeRegistry typeRegistry) {
      * @param ts
      * @return  Byte buffer
      */
+    @Override
     public byte[] toBuffer(Object value, TypeSchema ts) {
         logger.debug(() -> "Schema to convert is " + ts);
         byte[] buffer = null;
@@ -87,6 +88,7 @@ public byte[] toBuffer(Object value, TypeSchema ts) {
      * @throws InstantiationException
      * @throws IllegalAccessException
      */
+    @Override
     public Object fromBuffer(byte[] buffer, TypeSchema ts) {
         try {
             String stringData = new String(buffer, StandardCharsets.UTF_8);

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/contract/execution/SerializerInterface.java

@@ -0,0 +1,45 @@
+/*
+Copyright IBM Corp. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package org.hyperledger.fabric.contract.execution;
+
+import org.hyperledger.fabric.contract.metadata.TypeSchema;
+import org.hyperledger.fabric.contract.routing.TypeRegistry;
+
+/**
+ * This interface allows contract developers to change the serialization mechanism.
+ * There are two scenaios where instances of DataTypes are serialized. 
+ * 
+ * When the objects are (logically) transferred from the Client application to the Contract resulting
+ * in a transaction function being invoked. Typicaly this is JSON, hence a default JSON parser is provided.
+ * 
+ * The JSONTransactionSerializer can be extended if needed
+ */
+public interface SerializerInterface {
+
+    /**
+     * Convert the value supplied to a byte array, according to the TypeSchema
+     *
+     * @param value
+     * @param ts
+     * @return
+     */
+    byte[] toBuffer(Object value, TypeSchema ts);
+
+    /**
+     * Take the byte buffer and return the object as required
+     *
+     * @param buffer Byte buffer from the wire
+     * @param ts     TypeSchema representing the type
+     *
+     * @return Object created; relies on Java auto-boxing for primitives
+     *
+     * @throws InstantiationException
+     * @throws IllegalAccessException
+     */
+    Object fromBuffer(byte[] buffer, TypeSchema ts);
+
+}

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/contract/execution/impl/ContractExecutionService.java

@@ -18,11 +18,10 @@
 import org.hyperledger.fabric.contract.ContractRuntimeException;
 import org.hyperledger.fabric.contract.execution.ExecutionService;
 import org.hyperledger.fabric.contract.execution.InvocationRequest;
-import org.hyperledger.fabric.contract.execution.JSONTransactionSerializer;
+import org.hyperledger.fabric.contract.execution.SerializerInterface;
 import org.hyperledger.fabric.contract.metadata.TypeSchema;
 import org.hyperledger.fabric.contract.routing.ParameterDefinition;
 import org.hyperledger.fabric.contract.routing.TxFunction;
-import org.hyperledger.fabric.contract.routing.TypeRegistry;
 import org.hyperledger.fabric.shim.Chaincode;
 import org.hyperledger.fabric.shim.ChaincodeException;
 import org.hyperledger.fabric.shim.ChaincodeStub;
@@ -32,12 +31,11 @@ public class ContractExecutionService implements ExecutionService {
 
     private static Logger logger = Logger.getLogger(ContractExecutionService.class.getName());
 
-    private JSONTransactionSerializer serializer;
+    private SerializerInterface serializer;
     Map<String, Object> proxies = new HashMap<>();
 
-    public ContractExecutionService(TypeRegistry typeRegistry) {
-        // FUTURE: Permit this to swapped out as per node.js
-        this.serializer = new JSONTransactionSerializer(typeRegistry);
+    public ContractExecutionService(SerializerInterface serializer) {
+        this.serializer = serializer;
     }
 
     @Override

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/contract/routing/TxFunction.java

@@ -22,6 +22,7 @@ interface Routing {
 
         ContractInterface getContractInstance() throws IllegalAccessException, InstantiationException, InvocationTargetException, NoSuchMethodException;
 
+        String getSerializerName();
     }
 
     boolean isUnknownTx();
@@ -45,4 +46,6 @@ interface Routing {
     void setParameterDefinitions(List<ParameterDefinition> list);
 
     List<ParameterDefinition> getParamsList();
+
+  
 }

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/contract/routing/TypeRegistry.java

@@ -7,8 +7,14 @@
 
 import java.util.Collection;
 
+import org.hyperledger.fabric.contract.routing.impl.TypeRegistryImpl;
+
 public interface TypeRegistry {
 
+	static TypeRegistry getRegistry(){
+		return TypeRegistryImpl.getInstance();
+	}
+
 	void addDataType(DataTypeDefinition dtd);
 
 	void addDataType(Class<?> cl);