org.hyperledger.fabric.sdk

Class NetworkConfig

java.lang.Object

org.hyperledger.fabric.sdk.NetworkConfig

public class NetworkConfig
extends Object

Holds details of network and channel configurations typically loaded from an external config file.
Also contains convenience methods for utilizing the config details, including the main HFClient.getChannel(String) method

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NetworkConfig.CAInfo Holds the details of a Certificate Authority
static interface	NetworkConfig.NetworkConfigAddOrdererHandler Interface defining handler for adding orderers.
static interface	NetworkConfig.NetworkConfigAddPeerHandler Interface defining handler for adding peers.
static class	NetworkConfig.OrgInfo Holds details of an Organization
static class	NetworkConfig.UserInfo Holds details of a User

Method Summary

Modifier and Type	Method and Description
static NetworkConfig	fromJsonFile(File configFile) Creates a new NetworkConfig instance configured with details supplied in a JSON file.
static NetworkConfig	fromJsonObject(javax.json.JsonObject jsonConfig) Creates a new NetworkConfig instance configured with details supplied in a JSON object
static NetworkConfig	fromJsonStream(InputStream configStream) Creates a new NetworkConfig instance configured with details supplied in JSON format
static NetworkConfig	fromYamlFile(File configFile) Creates a new NetworkConfig instance configured with details supplied in a YAML file.
static NetworkConfig	fromYamlStream(InputStream configStream) Creates a new NetworkConfig instance configured with details supplied in YAML format
Set<String>	getChannelNames() Get the channel names found.
NetworkConfig.OrgInfo	getClientOrganization()
Collection<String>	getOrdererNames() Names of Orderers found
Properties	getOrdererProperties(String name) Get properties for a specific Orderer.
NetworkConfig.OrgInfo	getOrganizationInfo(String orgName)
NetworkConfig.UserInfo	getPeerAdmin() Returns the admin user associated with the client organization
NetworkConfig.UserInfo	getPeerAdmin(String orgName) Returns the admin user associated with the specified organization
Collection<String>	getPeerNames() Names of Peers found
Map<String,NetworkConfig.OrgInfo>	getPeerOrgInfos(String peerName) Find organizations for a peer.
Properties	getPeerProperties(String name) Get properties for a specific peer.
String	getPeerUrl(String name) Get URL for a specific peer.
void	setOrdererProperties(String name, Properties properties) Set a specific orderer's properties.
void	setPeerProperties(String name, Properties properties) Set a specific peer's properties.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getPeerNames

public Collection<String> getPeerNames()

Names of Peers found

Returns:

Collection of peer names found.

getOrdererNames

public Collection<String> getOrdererNames()

Names of Orderers found

Returns:

Collection of peer names found.

getPeerProperties

public Properties getPeerProperties(String name)

Get properties for a specific peer.

Parameters:

name - Name of peer to get the properties for.

Returns:

The peer's properties.

getOrdererProperties

public Properties getOrdererProperties(String name)

Get properties for a specific Orderer.

Parameters:

name - Name of orderer to get the properties for.

Returns:

The orderer's properties.

setPeerProperties

public void setPeerProperties(String name,
                              Properties properties)

Set a specific peer's properties.

Parameters:

name - The name of the peer's property to set.

properties - The properties to set.

setOrdererProperties

public void setOrdererProperties(String name,
                                 Properties properties)

Set a specific orderer's properties.

Parameters:

name - The name of the orderer's property to set.

properties - The properties to set.

getPeerUrl

public String getPeerUrl(String name)

Get URL for a specific peer.

Parameters:

name - Name of peer to get the URL for.

Returns:

The peer's URL.

fromYamlFile

public static NetworkConfig fromYamlFile(File configFile)
                                  throws IOException,
                                         NetworkConfigurationException

Creates a new NetworkConfig instance configured with details supplied in a YAML file.

Parameters:

configFile - The file containing the network configuration

Returns:

A new NetworkConfig instance

Throws:

IOException - if an error occurs reading the file

NetworkConfigurationException - if the configuration is invalid

fromJsonFile

public static NetworkConfig fromJsonFile(File configFile)
                                  throws IOException,
                                         NetworkConfigurationException

Creates a new NetworkConfig instance configured with details supplied in a JSON file.

Parameters:

configFile - The file containing the network configuration

Returns:

A new NetworkConfig instance

Throws:

IOException - if an error occurs reading the file

NetworkConfigurationException - if the configuration is invalid

fromYamlStream

public static NetworkConfig fromYamlStream(InputStream configStream)
                                    throws NetworkConfigurationException

Creates a new NetworkConfig instance configured with details supplied in YAML format

Parameters:

configStream - A stream opened on a YAML document containing network configuration details

Returns:

A new NetworkConfig instance

Throws:

NetworkConfigurationException - if the configuration is invalid

fromJsonStream

public static NetworkConfig fromJsonStream(InputStream configStream)
                                    throws NetworkConfigurationException

Creates a new NetworkConfig instance configured with details supplied in JSON format

Parameters:

configStream - A stream opened on a JSON document containing network configuration details

Returns:

A new NetworkConfig instance

Throws:

NetworkConfigurationException - if the configuration is invalid

fromJsonObject

public static NetworkConfig fromJsonObject(javax.json.JsonObject jsonConfig)
                                    throws NetworkConfigurationException

Creates a new NetworkConfig instance configured with details supplied in a JSON object

Parameters:

jsonConfig - JSON object containing network configuration details

Returns:

A new NetworkConfig instance

Throws:

NetworkConfigurationException - if the configuration is invalid

getClientOrganization

public NetworkConfig.OrgInfo getClientOrganization()

getOrganizationInfo

public NetworkConfig.OrgInfo getOrganizationInfo(String orgName)

getPeerOrgInfos

public Map<String,NetworkConfig.OrgInfo> getPeerOrgInfos(String peerName)

Find organizations for a peer.

Parameters:

peerName - name of peer

Returns:

returns map of orgName to NetworkConfig.OrgInfo that the peer belongs to.

getPeerAdmin

public NetworkConfig.UserInfo getPeerAdmin()
                                    throws NetworkConfigurationException

Returns the admin user associated with the client organization

Returns:

The admin user details

Throws:

NetworkConfigurationException - if the configuration is invalid

getPeerAdmin

public NetworkConfig.UserInfo getPeerAdmin(String orgName)
                                    throws NetworkConfigurationException

Returns the admin user associated with the specified organization

Parameters:

orgName - The name of the organization

Returns:

The admin user details

Throws:

NetworkConfigurationException - if the configuration is invalid

getChannelNames

public Set<String> getChannelNames()

Get the channel names found.

Returns:

A set of the channel names found in the configuration file or empty set if none found.