FABJ-430 Networkconfig handlers

NetworkConfig does not allow to specify custom PeerOptions

PS
02 Pass in the network config to handlers and provide peers org.

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

Author: cr22rc

README.md

@@ -292,6 +292,12 @@ also has some descriptions on what they do.  Most server timeout request can be
 You only ever *join* a peer belonging to _your own organization_ to a channel once at the beginning. You would only *add* peers
 from other organizations or peers of your own organization you've already *joined* like when recreating the channel SDK object.
 
+
+### Transaction sent to orderer results in future with exception *validation code: xxx* Where can I find what that means?
+
+See Fabric protobuf protos/peer/transaction.proto's [TxValidationCode](https://github.com/hyperledger/fabric/blob/dce0e5d8e7bbce5315d0895e5d1460640700285b/protos/peer/transaction.proto#L115-L143)
+
+
 ### java.security.InvalidKeyException: Illegal key size
 
 If you get this error, this means your JDK does not capable of handling unlimited strength crypto algorithms. To fix this issue, You will need to download the JCE libraries for your version of JDK. Please follow the instructions <a href="http://stackoverflow.com/questions/6481627/java-security-illegal-key-size-or-default-parameters">here</a> to download and install the JCE for your version of the JDK.

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

@@ -151,6 +151,46 @@ public static HFClient createNewInstance() {
         return new HFClient();
     }
 
+    /**
+     * Configures a channel based on information loaded from a Network Config file.
+     * Note that it is up to the caller to initialize the returned channel.
+     *
+     * @param channelName                    The name of the channel to be configured
+     * @param networkConfig                  The network configuration to use to configure the channel
+     * @param networkConfigAddPeerHandler    A handler that will create and add peers to the channel.
+     * @param networkConfigAddOrdererHandler A handler that will create orderers and add orderers to the channel.
+     * @return The configured channel, or null if the channel is not defined in the configuration
+     * @throws InvalidArgumentException
+     */
+    public Channel loadChannelFromConfig(String channelName, NetworkConfig networkConfig,
+                                         NetworkConfig.NetworkConfigAddPeerHandler networkConfigAddPeerHandler,
+                                         NetworkConfig.NetworkConfigAddOrdererHandler networkConfigAddOrdererHandler) throws InvalidArgumentException, NetworkConfigurationException {
+        clientCheck();
+
+        // Sanity checks
+        if (channelName == null || channelName.isEmpty()) {
+            throw new InvalidArgumentException("channelName must be specified");
+        }
+
+        if (networkConfig == null) {
+            throw new InvalidArgumentException("networkConfig must be specified");
+        }
+
+        if (null == networkConfigAddPeerHandler) {
+            throw new InvalidArgumentException("networkConfigAddPeerHandler is null.");
+        }
+
+        if (null == networkConfigAddOrdererHandler) {
+            throw new InvalidArgumentException("networkConfigAddOrdererHandler is null.");
+        }
+
+        if (channels.containsKey(channelName)) {
+            throw new InvalidArgumentException(format("Channel with name %s already exists", channelName));
+        }
+
+        return networkConfig.loadChannel(this, channelName, networkConfigAddPeerHandler, networkConfigAddOrdererHandler);
+    }
+
     /**
      * Configures a channel based on information loaded from a Network Config file.
      * Note that it is up to the caller to initialize the returned channel.

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

@@ -24,7 +24,6 @@
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
-import java.util.EnumSet;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.LinkedList;
@@ -54,6 +53,7 @@
 import org.hyperledger.fabric.sdk.Peer.PeerRole;
 import org.hyperledger.fabric.sdk.exception.InvalidArgumentException;
 import org.hyperledger.fabric.sdk.exception.NetworkConfigurationException;
+import org.hyperledger.fabric.sdk.helper.Utils;
 import org.hyperledger.fabric.sdk.identity.X509Enrollment;
 import org.hyperledger.fabric.sdk.security.CryptoSuite;
 import org.yaml.snakeyaml.Yaml;
@@ -166,8 +166,6 @@ public Properties getOrdererProperties(String name) throws InvalidArgumentExcept
 
     }
 
-
-
     /**
      * Set a specific peer's properties.
      *
@@ -381,6 +379,33 @@ public Collection<OrgInfo> getOrganizationInfos() {
         return Collections.unmodifiableCollection(organizations.values());
     }
 
+    /**
+     * Find organizations for a peer.
+     *
+     * @param peerName name of peer
+     * @return returns map of orgName to {@link OrgInfo} that the peer belongs to.
+     * @throws InvalidArgumentException
+     */
+    public Map<String, OrgInfo> getPeerOrgInfos(final String peerName) throws InvalidArgumentException {
+        if (Utils.isNullOrEmpty(peerName)) {
+            throw new InvalidArgumentException("peerName can not be null or empty.");
+        }
+
+        if (organizations == null || organizations.isEmpty()) {
+            return new HashMap<>();
+        }
+
+        Map<String, OrgInfo> ret = new HashMap<>(16);
+        organizations.forEach((name, orgInfo) -> {
+
+            if (orgInfo.getPeerNames().contains(peerName)) {
+                ret.put(name, orgInfo);
+            }
+        });
+
+        return ret;
+    }
+
     /**
      * Returns the admin user associated with the client organization
      *
@@ -417,6 +442,17 @@ public UserInfo getPeerAdmin(String orgName) throws NetworkConfigurationExceptio
      * @return A configured Channel instance
      */
     Channel loadChannel(HFClient client, String channelName) throws NetworkConfigurationException {
+        return loadChannel(client, channelName, networkConfigAddPeerHandlerDefault, networkConfigAddOrdererHandlerDefault);
+    }
+
+    /**
+     * Returns a channel configured using the details in the Network Configuration file
+     *
+     * @param client      The associated client
+     * @param channelName The name of the channel
+     * @return A configured Channel instance
+     */
+    Channel loadChannel(HFClient client, String channelName, NetworkConfigAddPeerHandler networkConfigAddPeerHandler, NetworkConfigAddOrdererHandler networkConfigAddOrdererHandler) throws NetworkConfigurationException {
 
         if (logger.isTraceEnabled()) {
             logger.trace(format("NetworkConfig.loadChannel: %s", channelName));
@@ -435,7 +471,7 @@ Channel loadChannel(HFClient client, String channelName) throws NetworkConfigura
                     // Note that by rights this should never happen as HFClient.loadChannelFromConfig should have already checked for this!
                     throw new NetworkConfigurationException(format("Channel %s is already configured in the client!", channelName));
                 }
-                channel = reconstructChannel(client, channelName, jsonChannel);
+                channel = reconstructChannel(client, channelName, jsonChannel, networkConfigAddPeerHandler, networkConfigAddOrdererHandler);
             } else {
 
                 final Set<String> channelNames = getChannelNames();
@@ -502,10 +538,8 @@ private void createAllPeers() throws NetworkConfigurationException {
             throw new NetworkConfigurationException("INTERNAL ERROR: peers has already been initialized!");
         }
 
-
         peers = new HashMap<>();
 
-
         // peers is a JSON object containing a nested object for each peer
         JsonObject jsonPeers = getJsonObject(jsonConfig, "peers");
 
@@ -584,7 +618,7 @@ private void createAllOrganizations(Map<String, JsonObject> foundCertificateAuth
     }
 
     // Reconstructs an existing channel
-    private Channel reconstructChannel(HFClient client, String channelName, JsonObject jsonChannel) throws NetworkConfigurationException {
+    private Channel reconstructChannel(HFClient client, String channelName, JsonObject jsonChannel, NetworkConfigAddPeerHandler networkConfigAddPeerHandler, NetworkConfigAddOrdererHandler networkConfigAddOrdererHandler) throws NetworkConfigurationException {
 
         Channel channel = null;
 
@@ -593,19 +627,26 @@ private Channel reconstructChannel(HFClient client, String channelName, JsonObje
 
             // orderers is an array of orderer name strings
             JsonArray ordererNames = getJsonValueAsArray(jsonChannel.get("orderers"));
-            boolean foundOrderer = false;
 
             //out("Orderer names: " + (ordererNames == null ? "null" : ordererNames.toString()));
             if (ordererNames != null) {
                 for (JsonValue jsonVal : ordererNames) {
 
                     String ordererName = getJsonValueAsString(jsonVal);
-                    Orderer orderer = getOrderer(client, ordererName);
-                    if (orderer == null) {
+
+                    // Orderer orderer = getOrderer(client, ordererName);
+                    Node node = orderers.get(ordererName);
+                    if (null == node) {
                         throw new NetworkConfigurationException(format("Error constructing channel %s. Orderer %s not defined in configuration", channelName, ordererName));
                     }
-                    channel.addOrderer(orderer);
-                    foundOrderer = true;
+
+                    logger.debug(format("Channel %s, adding orderer %s, url: %s", channel.getName(), ordererName, node.url));
+                    Properties nodeProps = node.properties;
+                    if (null != nodeProps) {
+                        nodeProps = (Properties) nodeProps.clone();
+                    }
+
+                    networkConfigAddOrdererHandler.addOrderer(this, client, channel, ordererName, node.url, nodeProps, node.jsonObject);
                 }
             }
 
@@ -628,8 +669,8 @@ private Channel reconstructChannel(HFClient client, String channelName, JsonObje
                         throw new NetworkConfigurationException(format("Error constructing channel %s. Invalid peer entry: %s", channelName, peerName));
                     }
 
-                    Peer peer = getPeer(client, peerName);
-                    if (peer == null) {
+                    Node node = peers.get(peerName);
+                    if (node == null) {
                         throw new NetworkConfigurationException(format("Error constructing channel %s. Peer %s not defined in configuration", channelName, peerName));
                     }
 
@@ -640,13 +681,15 @@ private Channel reconstructChannel(HFClient client, String channelName, JsonObje
                         setPeerRole(channelName, peerOptions, jsonPeer, peerRole);
                     }
 
-                    foundPeer = true;
+                    logger.debug(format("Channel %s, adding peer %s, url: %s", channel.getName(), peerName, node.url));
 
-                    if (peerOptions.peerRoles == null) { // means no roles were found but there is an event hub so define all roles but eventing.
-                        peerOptions.setPeerRoles(EnumSet.of(PeerRole.ENDORSING_PEER, PeerRole.CHAINCODE_QUERY, PeerRole.LEDGER_QUERY));
+                    Properties nodeProps = node.properties;
+                    if (null != nodeProps) {
+                        nodeProps = (Properties) nodeProps.clone();
                     }
+                    networkConfigAddPeerHandler.addPeer(this, client, channel, peerName, node.url, nodeProps, peerOptions, node.jsonObject);
 
-                    channel.addPeer(peer, peerOptions);
+                    foundPeer = true;
 
                 }
 
@@ -664,6 +707,62 @@ private Channel reconstructChannel(HFClient client, String channelName, JsonObje
         return channel;
     }
 
+    /**
+     * Interface defining handler for adding peers.
+     */
+
+    public interface NetworkConfigAddPeerHandler {
+
+        /**
+         * @param networkConfig  The network configuration.
+         * @param client         The client to be used to create the peer.
+         * @param channel        The channel the peer is to be added.
+         * @param peerName       The peer's name.
+         * @param peerURL        The peers's url
+         * @param peerProperties properties that were found in the networkconfig
+         * @param peerOptions    options when adding peer to the channel.
+         * @param jsonPeer       json peer was created
+         * @throws NetworkConfigurationException
+         */
+        void addPeer(NetworkConfig networkConfig, HFClient client, Channel channel, String peerName, String peerURL, Properties peerProperties, PeerOptions peerOptions, JsonObject jsonPeer) throws NetworkConfigurationException;
+    }
+
+    private static final NetworkConfigAddPeerHandler networkConfigAddPeerHandlerDefault = (networkConfig, client, channel, peerName, peerURL, peerProperties, peerOptions, jsonPeer) -> {
+        try {
+            Peer peer = client.newPeer(peerName, peerURL, peerProperties);
+            channel.addPeer(peer, peerOptions);
+        } catch (Exception e) {
+            throw new NetworkConfigurationException(format("Error on creating channel %s peer %s", channel.getName(), peerName), e);
+        }
+    };
+
+    /**
+     * Interface defining handler for adding orderers.
+     */
+    public interface NetworkConfigAddOrdererHandler {
+
+        /**
+         * @param networkConfig     The network configuration.
+         * @param client            The client to be used to create the orderer.
+         * @param channel           The channel the orderer is to be added.
+         * @param ordererName       The orderer's name.
+         * @param ordererURL        The orderers's url
+         * @param ordererProperties properties that were found in the networkconfig
+         * @param jsonOrderer       json orderer was created
+         * @throws NetworkConfigurationException
+         */
+        void addOrderer(NetworkConfig networkConfig, HFClient client, Channel channel, String ordererName, String ordererURL, Properties ordererProperties, JsonObject jsonOrderer) throws NetworkConfigurationException;
+    }
+
+    private static final NetworkConfigAddOrdererHandler networkConfigAddOrdererHandlerDefault = (networkConfig, client, channel, ordererName, ordererURL, ordererProperties, jsonOrderer) -> {
+        try {
+            Orderer orderer = client.newOrderer(ordererName, ordererURL, ordererProperties);
+            channel.addOrderer(orderer);
+        } catch (Exception e) {
+            throw new NetworkConfigurationException(format("Error on creating channel %s orderer %s", channel.getName(), ordererName), e);
+        }
+    };
+
     private static void setPeerRole(String channelName, PeerOptions peerOptions, JsonObject jsonPeer, PeerRole role) throws NetworkConfigurationException {
         String propName = roleNameRemap(role);
         JsonValue val = jsonPeer.get(propName);
@@ -732,7 +831,7 @@ private Node createNode(String nodeName, JsonObject jsonNode, String urlPropName
         // Extract the pem details
         getTLSCerts(nodeName, jsonNode, props);
 
-        return new Node(nodeName, url, props);
+        return new Node(nodeName, url, props, jsonNode);
     }
 
     private void getTLSCerts(String nodeName, JsonObject jsonOrderer, Properties props) {
@@ -1036,12 +1135,14 @@ private class Node {
 
         private final String name;
         private final String url;
+        public JsonObject jsonObject;
         private Properties properties;
 
-        Node(String name, String url, Properties properties) {
+        private Node(String name, String url, Properties properties, JsonObject jsonObject) {
             this.url = url;
             this.name = name;
             this.properties = properties;
+            this.jsonObject = jsonObject;
         }
 
         private String getName() {
@@ -1179,11 +1280,11 @@ public String getMspId() {
         }
 
         public List<String> getPeerNames() {
-            return peerNames;
+            return new LinkedList<>(peerNames);
         }
 
         public List<CAInfo> getCertificateAuthorities() {
-            return certificateAuthorities;
+            return new LinkedList<>(certificateAuthorities);
         }
 
         /**