FAB-5387 Listener for custom chaincode events.

Change-Id: I3082678b840d4149dce6a6b772f2cb1ba23091a9
Signed-off-by: rickr <cr22rc@gmail.com>

src/main/java/org/hyperledger/fabric/sdk/BlockEvent.java

@@ -42,6 +42,12 @@ public EventHub getEventHub() {
     private final EventHub eventHub;
     private final Event event;
 
+    /**
+     * Raw proto buff event.
+     *
+     * @return Return raw protobuf event.
+     */
+
     public Event getEvent() {
         return event;
     }

src/main/java/org/hyperledger/fabric/sdk/BlockInfo.java

@@ -321,6 +321,13 @@ public int getProposalResponseStatus() {
 
             }
 
+            /**
+             * Get read write set for this transaction. Will return null on for Eventhub events.
+             * For eventhub events find the block by block number to get read write set if needed.
+             *
+             * @return Read write set.
+             */
+
             public TxReadWriteSetInfo getTxReadWriteSet() {
 
                 TxReadWriteSet txReadWriteSet = transactionAction.getPayload().getAction().getProposalResponsePayload()
@@ -333,6 +340,19 @@ public TxReadWriteSetInfo getTxReadWriteSet() {
 
             }
 
+            /**
+             * Get chaincode events for this transaction.
+             *
+             * @return A chaincode event if the chaincode set an event otherwise null.
+             */
+
+            public ChaincodeEvent getEvent() {
+
+                return transactionAction.getPayload().getAction().getProposalResponsePayload()
+                        .getExtension().getEvent();
+
+            }
+
         }
 
         public TransactionActionInfo getTransactionActionInfo(int index) {

src/main/java/org/hyperledger/fabric/sdk/ChaincodeActionDeserializer.java

@@ -52,11 +52,19 @@ ChaincodeAction getChaincodeAction() {
 
         }
 
-        //TODO events ?
+        return ret;
 
-        //     ret.getResponse();
+    }
 
-        return ret;
+    ChaincodeEvent getEvent() {
+
+        ChaincodeAction ca = getChaincodeAction();
+        ByteString eventsBytes = ca.getEvents();
+        if (eventsBytes == null || eventsBytes.isEmpty()) {
+            return null;
+        }
+
+        return new ChaincodeEvent(eventsBytes);
 
     }
 

src/main/java/org/hyperledger/fabric/sdk/ChaincodeEvent.java

@@ -0,0 +1,110 @@
+/*
+ *
+ *  Copyright 2016,2017 DTCC, Fujitsu Australia Software Technology, IBM - 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.
+ *  You may obtain a copy of the License at
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ *
+ */
+
+package org.hyperledger.fabric.sdk;
+
+import java.lang.ref.WeakReference;
+
+import com.google.protobuf.ByteString;
+import com.google.protobuf.InvalidProtocolBufferException;
+import org.hyperledger.fabric.protos.peer.ChaincodeEventOuterClass;
+import org.hyperledger.fabric.sdk.exception.InvalidProtocolBufferRuntimeException;
+
+/**
+ * Encapsulates a Chaincode event.
+ */
+public class ChaincodeEvent {
+    private final ByteString byteString;
+    private WeakReference<ChaincodeEventOuterClass.ChaincodeEvent> chaincodeEvent;
+
+    ChaincodeEvent(ByteString byteString) {
+        this.byteString = byteString;
+    }
+
+    ChaincodeEventOuterClass.ChaincodeEvent getChaincodeEvent() {
+        ChaincodeEventOuterClass.ChaincodeEvent ret = null;
+
+        if (chaincodeEvent != null) {
+            ret = chaincodeEvent.get();
+
+        }
+        if (ret == null) {
+
+            try {
+                ret = ChaincodeEventOuterClass.ChaincodeEvent.parseFrom(byteString);
+
+            } catch (InvalidProtocolBufferException e) {
+                throw new InvalidProtocolBufferRuntimeException(e);
+            }
+
+            chaincodeEvent = new WeakReference<>(ret);
+
+        }
+
+        return ret;
+
+    }
+
+    /**
+     * Get Chaincode event's name;
+     *
+     * @return Return name;
+     */
+    public String getEventName() {
+
+        return getChaincodeEvent().getEventName();
+
+    }
+
+    /**
+     * Get Chaincode identifier.
+     *
+     * @return The identifier
+     */
+    public String getChaincodeId() {
+
+        return getChaincodeEvent().getChaincodeId();
+
+    }
+
+    /**
+     * Get transaction id associated with this event.
+     *
+     * @return The transactions id.
+     */
+    public String getTxId() {
+
+        return getChaincodeEvent().getTxId();
+
+    }
+
+    /**
+     * Binary data associated with this event.
+     *
+     * @return binary data set by the chaincode for this event. This may return null.
+     */
+    public byte[] getPayload() {
+
+        ByteString ret = getChaincodeEvent().getPayload();
+        if (null == ret) {
+            return null;
+        }
+
+        return ret.toByteArray();
+
+    }
+
+}

src/main/java/org/hyperledger/fabric/sdk/ChaincodeEventListener.java

@@ -0,0 +1,31 @@
+/*
+ *
+ *  Copyright 2016,2017 DTCC, Fujitsu Australia Software Technology, IBM - 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.
+ *  You may obtain a copy of the License at
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ *
+ */
+
+package org.hyperledger.fabric.sdk;
+
+/**
+ * ChaincodeEventListener  implemented by classes needing to receive chaincode events.
+ */
+public interface ChaincodeEventListener {
+    /**
+     * Receiving a chaincode event. ChaincodeEventListener should not be long lived as they can take up thread resources.
+     *
+     * @param handle         The handle of the chaincode event listener that produced this event.
+     * @param blockEvent     The block event information that contained the chaincode event. See {@link BlockEvent}
+     * @param chaincodeEvent The chaincode event. see {@link ChaincodeEvent}
+     */
+    void received(String handle, BlockEvent blockEvent, ChaincodeEvent chaincodeEvent);
+}