Package org.hyperledger.fabric.sdk

Class HFClient

java.lang.Object

org.hyperledger.fabric.sdk.HFClient

public class HFClient
extends Object

Method Summary

Modifier and Type	Method	Description
static HFClient	createNewInstance()	createNewInstance create a new instance of the HFClient
Channel	deSerializeChannel(byte[] channelBytes)	Deserialize a channel serialized by Channel.serializeChannel()
Channel	deSerializeChannel(File file)	Deserialize a channel serialized by Channel.serializeChannel()
Channel	getChannel(String name)	getChannel by name
byte[]	getChannelConfigurationSignature(ChannelConfiguration channelConfiguration, User signer)	Get signature for channel configuration
org.hyperledger.fabric.sdk.security.CryptoSuite	getCryptoSuite()
ExecutorService	getExecutorService()
byte[]	getUpdateChannelConfigurationSignature(UpdateChannelConfiguration updateChannelConfiguration, User signer)	Get signature for update channel configuration
User	getUserContext()
Channel	loadChannelFromConfig(String channelName, NetworkConfig networkConfig)	Configures a channel based on information loaded from a Network Config file.
Channel	loadChannelFromConfig(String channelName, NetworkConfig networkConfig, NetworkConfig.NetworkConfigAddPeerHandler networkConfigAddPeerHandler, NetworkConfig.NetworkConfigAddOrdererHandler networkConfigAddOrdererHandler)	Configures a channel based on information loaded from a Network Config file.
Channel	newChannel(String name)	newChannel - already configured channel.
Channel	newChannel(String name, Orderer orderer, ChannelConfiguration channelConfiguration, byte[]... channelConfigurationSignatures)	Create a new channel
InstallProposalRequest	newInstallProposalRequest()	Deprecated. see newLifecycleQueryInstalledChaincodesRequest()
InstantiateProposalRequest	newInstantiationProposalRequest()	Deprecated. See LifecycleCommitChaincodeDefinitionRequest for defining the chaincode and and then TransactionRequest.setInit(boolean) to do the initialization if it's required by the chaincode.
LifecycleApproveChaincodeDefinitionForMyOrgRequest	newLifecycleApproveChaincodeDefinitionForMyOrgRequest()	newLifecycleApproveChaincodeDefinitionForMyOrgRequest get new Install proposal request.
LifecycleCommitChaincodeDefinitionRequest	newLifecycleCommitChaincodeDefinitionRequest()	newLifecycleApproveChaincodeDefinitionForMyOrgRequest get new Install proposal request.
LifecycleInstallChaincodeRequest	newLifecycleInstallChaincodeRequest()	newInstallProposalRequest get new Query Install proposal request.
LifecycleQueryChaincodeDefinitionsRequest	newLifecycleQueryChaincodeDefinitionsRequest()	Create a new QueryChaincodeDefinitions proposal request.
LifecycleQueryInstalledChaincodeRequest	newLifecycleQueryInstalledChaincodeRequest()	Get newLifecycleQueryInstalledChaincodeRequest to find chaincodes installed.
LifecycleQueryInstalledChaincodesRequest	newLifecycleQueryInstalledChaincodesRequest()	LifecycleQueryInstalledChaincodesRequest get new Query Install proposal request.
LifecycleCheckCommitReadinessRequest	newLifecycleSimulateCommitChaincodeDefinitionRequest()	Get a LifecycleSimulateCommitChaincodeDefinitionRequest to find which chaincodes are approved by which organization.
Orderer	newOrderer(String name, String grpcURL)	Create a new urlOrderer.
Orderer	newOrderer(String name, String grpcURL, Properties properties)	Create a new orderer.
Peer	newPeer(String name, String grpcURL)	newPeer create a new peer
Peer	newPeer(String name, String grpcURL, Properties properties)	newPeer create a new peer
QueryLifecycleQueryChaincodeDefinitionRequest	newQueryLifecycleQueryChaincodeDefinitionRequest()	get QueryLifecycleQueryChaincodeDefinitionRequest find which chaincodes are defined.
QueryByChaincodeRequest	newQueryProposalRequest()	newQueryProposalRequest get new query proposal request.
TransactionProposalRequest	newTransactionProposalRequest()	newTransactionProposalRequest get new transaction proposal request.
UpgradeProposalRequest	newUpgradeProposalRequest()	Deprecated. See LifecycleCommitChaincodeDefinitionRequest for defining the chaincode and and then TransactionRequest.setInit(boolean) to do the initialization if it's required by the chaincode.
Set<String>	queryChannels(Peer peer)	Query the joined channels for peers
List<org.hyperledger.fabric.protos.peer.Query.ChaincodeInfo>	queryInstalledChaincodes(Peer peer)	Deprecated. See LifecycleQueryInstalledChaincodesRequest
Collection<ProposalResponse>	sendInstallProposal(InstallProposalRequest installProposalRequest, Collection<Peer> peers)	Deprecated. See LifecycleInstallChaincodeRequest
Collection<LifecycleInstallChaincodeProposalResponse>	sendLifecycleInstallChaincodeRequest(LifecycleInstallChaincodeRequest lifecycleInstallChaincodeRequest, Collection<Peer> peers)	Send install chaincode request proposal to peers.
Collection<LifecycleQueryInstalledChaincodeProposalResponse>	sendLifecycleQueryInstalledChaincode(LifecycleQueryInstalledChaincodeRequest lifecycleQueryInstalledChaincodeRequest, Collection<Peer> peers)	Query installed chaincode on a peer.
Collection<LifecycleQueryInstalledChaincodesProposalResponse>	sendLifecycleQueryInstalledChaincodes(LifecycleQueryInstalledChaincodesRequest lifecycleQueryInstalledChaincodesRequest, Collection<Peer> peers)	Query the peer for installed chaincodes information
void	setCryptoSuite(org.hyperledger.fabric.sdk.security.CryptoSuite cryptoSuite)
void	setExecutorService(ExecutorService executorService)	Set executor service Applications need to set the executor service prior to doing any other operations on the client.
User	setUserContext(User userContext)	Set the User context for this client.

Methods inherited from class java.lang.Object

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

Method Details

getExecutorService

public ExecutorService getExecutorService()

getUserContext

public User getUserContext()

getCryptoSuite

public org.hyperledger.fabric.sdk.security.CryptoSuite getCryptoSuite()

setCryptoSuite

public void setCryptoSuite(org.hyperledger.fabric.sdk.security.CryptoSuite cryptoSuite)
                    throws CryptoException,
InvalidArgumentException

Throws:

CryptoException

InvalidArgumentException

setExecutorService

public void setExecutorService(ExecutorService executorService)
                        throws InvalidArgumentException

Set executor service Applications need to set the executor service prior to doing any other operations on the client.

Parameters:

executorService - The executor service the application wants to use.

Throws:

InvalidArgumentException - if executor service has been set already.

createNewInstance

public static HFClient createNewInstance()

createNewInstance create a new instance of the HFClient

Returns:

client

loadChannelFromConfig

public Channel loadChannelFromConfig(String channelName,
 NetworkConfig networkConfig,
 NetworkConfig.NetworkConfigAddPeerHandler networkConfigAddPeerHandler,
 NetworkConfig.NetworkConfigAddOrdererHandler networkConfigAddOrdererHandler)
                              throws InvalidArgumentException,
NetworkConfigurationException

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.

Parameters:

channelName - The name of the channel to be configured

networkConfig - The network configuration to use to configure the channel

networkConfigAddPeerHandler - A handler that will create and add peers to the channel.

networkConfigAddOrdererHandler - A handler that will create orderers and add orderers to the channel.

Returns:

The configured channel, or null if the channel is not defined in the configuration

Throws:

InvalidArgumentException

NetworkConfigurationException

loadChannelFromConfig

public Channel loadChannelFromConfig(String channelName,
 NetworkConfig networkConfig)
                              throws InvalidArgumentException,
NetworkConfigurationException

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.

Parameters:

channelName - The name of the channel to be configured

networkConfig - The network configuration to use to configure the channel

Returns:

The configured channel, or null if the channel is not defined in the configuration

Throws:

InvalidArgumentException

NetworkConfigurationException

newChannel

public Channel newChannel(String name)
                   throws InvalidArgumentException

newChannel - already configured channel.

Parameters:

name -

Returns:

a new channel.

Throws:

InvalidArgumentException

newChannel

public Channel newChannel(String name,
 Orderer orderer,
 ChannelConfiguration channelConfiguration,
 byte[]... channelConfigurationSignatures)
                   throws TransactionException,
InvalidArgumentException

Create a new channel

Parameters:

name - The channel's name

orderer - Orderer to create the channel with.

channelConfiguration - Channel configuration data.

channelConfigurationSignatures - byte arrays containing ConfigSignature's proto serialized. See Channel.getChannelConfigurationSignature(org.hyperledger.fabric.sdk.ChannelConfiguration, org.hyperledger.fabric.sdk.User) on how to create

Returns:

a new channel.

Throws:

TransactionException

InvalidArgumentException

deSerializeChannel

public Channel deSerializeChannel(File file)
                           throws IOException,
ClassNotFoundException,
InvalidArgumentException

Deserialize a channel serialized by Channel.serializeChannel()

Parameters:

file - a file which contains the bytes to be deserialized.

Returns:

A Channel that has not been initialized.

Throws:

IOException

ClassNotFoundException

InvalidArgumentException

deSerializeChannel

public Channel deSerializeChannel(byte[] channelBytes)
                           throws IOException,
ClassNotFoundException,
InvalidArgumentException

Deserialize a channel serialized by Channel.serializeChannel()

Parameters:

channelBytes - bytes to be deserialized.

Returns:

A Channel that has not been initialized.

Throws:

IOException

ClassNotFoundException

InvalidArgumentException

newPeer

public Peer newPeer(String name,
 String grpcURL,
 Properties properties)
             throws InvalidArgumentException

newPeer create a new peer

Parameters:

name - name of peer.

grpcURL - to the peer's location

properties -

Supported properties

• pemFile - File location for x509 pem certificate for SSL.
• pemBytes - byte array for x509 pem certificates for SSL
• trustServerCertificate - boolen(true/false) override CN to match pemFile certificate -- for development only. If the pemFile has the target server's certificate (instead of a CA Root certificate), instruct the TLS client to trust the CN value of the certificate in the pemFile, useful in development to get past default server hostname verification during TLS handshake, when the server host name does not match the certificate.
• clientKeyFile - File location for private key pem for mutual TLS
• clientCertFile - File location for x509 pem certificate for mutual TLS
• clientKeyBytes - Private key pem bytes for mutual TLS
• clientCertBytes - x509 pem certificate bytes for mutual TLS
• hostnameOverride - Specify the certificates CN -- for development only.
• sslProvider - Specify the SSL provider, openSSL or JDK.
• negotiationType - Specify the type of negotiation, TLS or plainText.
• If the pemFile does not represent the server certificate, use this property to specify the URI authority (a.k.a hostname) expected in the target server's certificate. This is required to get past default server hostname verifications during TLS handshake.
• peerEventRegistrationWaitTime - Time in milliseconds to wait for peer eventing service registration.
• org.hyperledger.fabric.sdk.peer.organization_mspid Peer.PEER_ORGANIZATION_MSPID_PROPERTY - Associates peer to an organization by its mspid.
• grpc.NettyChannelBuilderOption.<methodName> where methodName is any method on grpc ManagedChannelBuilder. If more than one argument to the method is needed then the parameters need to be supplied in an array of Objects.

Returns:

Peer

Throws:

InvalidArgumentException

newPeer

public Peer newPeer(String name,
 String grpcURL)
             throws InvalidArgumentException

newPeer create a new peer

Parameters:

name -

grpcURL - to the peer's location

Returns:

Peer

Throws:

InvalidArgumentException

getChannel

public Channel getChannel(String name)

getChannel by name

Parameters:

name - The channel name

Returns:

a channel (or null if the channel does not exist)

newInstallProposalRequest

@Deprecated
public InstallProposalRequest newInstallProposalRequest()

Deprecated.

see newLifecycleQueryInstalledChaincodesRequest()

newInstallProposalRequest get new Install proposal request.

Returns:

InstallProposalRequest

newLifecycleInstallChaincodeRequest

public LifecycleInstallChaincodeRequest newLifecycleInstallChaincodeRequest()

newInstallProposalRequest get new Query Install proposal request.

Returns:

LifecycleInstallChaincodeProposalResponse

newLifecycleQueryInstalledChaincodeRequest

public LifecycleQueryInstalledChaincodeRequest newLifecycleQueryInstalledChaincodeRequest()

Get newLifecycleQueryInstalledChaincodeRequest to find chaincodes installed.

Returns:

LifecycleInstallChaincodeProposalResponse finds chaincodes installed.

newLifecycleQueryInstalledChaincodesRequest

public LifecycleQueryInstalledChaincodesRequest newLifecycleQueryInstalledChaincodesRequest()

LifecycleQueryInstalledChaincodesRequest get new Query Install proposal request.

Returns:

LifecycleQueryInstalledChaincodesRequest

newLifecycleApproveChaincodeDefinitionForMyOrgRequest

public LifecycleApproveChaincodeDefinitionForMyOrgRequest newLifecycleApproveChaincodeDefinitionForMyOrgRequest()

newLifecycleApproveChaincodeDefinitionForMyOrgRequest get new Install proposal request.

Returns:

LifecycleApproveChaincodeDefinitionForMyOrgRequest

newLifecycleSimulateCommitChaincodeDefinitionRequest

public LifecycleCheckCommitReadinessRequest newLifecycleSimulateCommitChaincodeDefinitionRequest()

Get a LifecycleSimulateCommitChaincodeDefinitionRequest to find which chaincodes are approved by which organization.

Returns:

newLifecycleCommitChaincodeDefinitionRequest

public LifecycleCommitChaincodeDefinitionRequest newLifecycleCommitChaincodeDefinitionRequest()

newLifecycleApproveChaincodeDefinitionForMyOrgRequest get new Install proposal request.

Returns:

LifecycleCommitChaincodeDefinitionRequest

newLifecycleQueryChaincodeDefinitionsRequest

public LifecycleQueryChaincodeDefinitionsRequest newLifecycleQueryChaincodeDefinitionsRequest()

Create a new QueryChaincodeDefinitions proposal request.

Returns:

A proposal request.

newQueryLifecycleQueryChaincodeDefinitionRequest

public QueryLifecycleQueryChaincodeDefinitionRequest newQueryLifecycleQueryChaincodeDefinitionRequest()

get QueryLifecycleQueryChaincodeDefinitionRequest find which chaincodes are defined.

Returns:

QueryLifecycleQueryChaincodeDefinitionRequest

sendLifecycleInstallChaincodeRequest

public Collection<LifecycleInstallChaincodeProposalResponse> sendLifecycleInstallChaincodeRequest(LifecycleInstallChaincodeRequest lifecycleInstallChaincodeRequest,
 Collection<Peer> peers)
                                                                                           throws ProposalException,
InvalidArgumentException

Send install chaincode request proposal to peers.

Parameters:

lifecycleInstallChaincodeRequest -

peers - Collection of peers to install on.

Returns:

responses from peers.

Throws:

InvalidArgumentException

ProposalException

sendLifecycleQueryInstalledChaincode

public Collection<LifecycleQueryInstalledChaincodeProposalResponse> sendLifecycleQueryInstalledChaincode(LifecycleQueryInstalledChaincodeRequest lifecycleQueryInstalledChaincodeRequest,
 Collection<Peer> peers)
                                                                                                  throws InvalidArgumentException,
ProposalException

Query installed chaincode on a peer.

Parameters:

lifecycleQueryInstalledChaincodeRequest - The request LifecycleQueryInstalledChaincodeRequest

peers - the peer to send the request to.

Returns:

LifecycleQueryInstalledChaincodeProposalResponse

Throws:

InvalidArgumentException

ProposalException

sendLifecycleQueryInstalledChaincodes

public Collection<LifecycleQueryInstalledChaincodesProposalResponse> sendLifecycleQueryInstalledChaincodes(LifecycleQueryInstalledChaincodesRequest lifecycleQueryInstalledChaincodesRequest,
 Collection<Peer> peers)
                                                                                                    throws InvalidArgumentException,
ProposalException

Query the peer for installed chaincodes information

Parameters:

lifecycleQueryInstalledChaincodesRequest - the request LifecycleQueryInstalledChaincodesRequest

peers - The peer to query.

Returns:

Collection of ChaincodeInfo on installed chaincode @see LifecycleQueryInstalledChaincodesProposalResponse

Throws:

InvalidArgumentException

ProposalException

newInstantiationProposalRequest

@Deprecated
public InstantiateProposalRequest newInstantiationProposalRequest()

Deprecated.

See LifecycleCommitChaincodeDefinitionRequest for defining the chaincode and and then TransactionRequest.setInit(boolean) to do the initialization if it's required by the chaincode.

newInstantiationProposalRequest get new instantiation proposal request.

Returns:

see InstantiateProposalRequest

newUpgradeProposalRequest

@Deprecated
public UpgradeProposalRequest newUpgradeProposalRequest()

Deprecated.

See LifecycleCommitChaincodeDefinitionRequest for defining the chaincode and and then TransactionRequest.setInit(boolean) to do the initialization if it's required by the chaincode.

Returns:

UpgradeProposalRequest

newTransactionProposalRequest

public TransactionProposalRequest newTransactionProposalRequest()

newTransactionProposalRequest get new transaction proposal request.

Returns:

TransactionProposalRequest

newQueryProposalRequest

public QueryByChaincodeRequest newQueryProposalRequest()

newQueryProposalRequest get new query proposal request.

Returns:

QueryByChaincodeRequest

setUserContext

public User setUserContext(User userContext)

Set the User context for this client.

Parameters:

userContext -

Returns:

the old user context. Maybe null if never set!

Throws:

IllegalStateException - if no crypto suite has been set.

NullPointerException - if the user context is null.

IllegalArgumentException - if the user context is not valid.

newOrderer

public Orderer newOrderer(String name,
 String grpcURL)
                   throws InvalidArgumentException

Create a new urlOrderer.

Parameters:

name - name of the orderer.

grpcURL - url location of orderer grpc or grpcs protocol.

Returns:

a new Orderer.

Throws:

InvalidArgumentException

newOrderer

public Orderer newOrderer(String name,
 String grpcURL,
 Properties properties)
                   throws InvalidArgumentException

Create a new orderer.

Parameters:

name - name of Orderer.

grpcURL - url location of orderer grpc or grpcs protocol.

properties -

Supported properties

• pemFile - File location for x509 pem certificate for SSL.
• pemBytes - byte array for x509 pem certificates for SSL
• trustServerCertificate - boolean(true/false) override CN to match pemFile certificate -- for development only. If the pemFile has the target server's certificate (instead of a CA Root certificate), instruct the TLS client to trust the CN value of the certificate in the pemFile, useful in development to get past default server hostname verification during TLS handshake, when the server host name does not match the certificate.
• clientKeyFile - File location for private key pem for mutual TLS
• clientCertFile - File location for x509 pem certificate for mutual TLS
• clientKeyBytes - Private key pem bytes for mutual TLS
• clientCertBytes - x509 pem certificate bytes for mutual TLS
• sslProvider - Specify the SSL provider, openSSL or JDK.
• negotiationType - Specify the type of negotiation, TLS or plainText.
• hostnameOverride - Specify the certificates CN -- for development only. If the pemFile does not represent the server certificate, use this property to specify the URI authority (a.k.a hostname) expected in the target server's certificate. This is required to get past default server hostname verifications during TLS handshake.
• org.hyperledger.fabric.sdk.orderer.organization_mspid Orderer.ORDERER_ORGANIZATION_MSPID_PROPERTY - Associates orderer to an organization by its mspid.
• grpc.NettyChannelBuilderOption.<methodName> where methodName is any method on grpc ManagedChannelBuilder. If more than one argument to the method is needed then the parameters need to be supplied in an array of Objects.
• ordererWaitTimeMilliSecs Time to wait in milliseconds for the Orderer to accept requests before timing out. The default is two seconds.

Returns:

The orderer.

Throws:

InvalidArgumentException

queryChannels

public Set<String> queryChannels(Peer peer)
                          throws InvalidArgumentException,
ProposalException

Query the joined channels for peers

Parameters:

peer - the peer to query

Returns:

A set of strings with the names of the channels the peer has joined.

Throws:

InvalidArgumentException

ProposalException

queryInstalledChaincodes

@Deprecated
public List<org.hyperledger.fabric.protos.peer.Query.ChaincodeInfo> queryInstalledChaincodes(Peer peer)
                                                                                      throws InvalidArgumentException,
ProposalException

Deprecated.

See LifecycleQueryInstalledChaincodesRequest

Query the peer for installed chaincode information

Parameters:

peer - The peer to query.

Returns:

List of ChaincodeInfo on installed chaincode @see Query.ChaincodeInfo

Throws:

InvalidArgumentException

ProposalException

getChannelConfigurationSignature

public byte[] getChannelConfigurationSignature(ChannelConfiguration channelConfiguration,
 User signer)
                                        throws InvalidArgumentException

Get signature for channel configuration

Parameters:

channelConfiguration -

signer -

Returns:

byte array with the signature

Throws:

InvalidArgumentException

getUpdateChannelConfigurationSignature

public byte[] getUpdateChannelConfigurationSignature(UpdateChannelConfiguration updateChannelConfiguration,
 User signer)
                                              throws InvalidArgumentException

Get signature for update channel configuration

Parameters:

updateChannelConfiguration -

signer -

Returns:

byte array with the signature

Throws:

InvalidArgumentException

sendInstallProposal

@Deprecated
public Collection<ProposalResponse> sendInstallProposal(InstallProposalRequest installProposalRequest,
 Collection<Peer> peers)
                                                 throws ProposalException,
InvalidArgumentException

Deprecated.

See LifecycleInstallChaincodeRequest

Send install chaincode request proposal to peers.

Parameters:

installProposalRequest -

peers - Collection of peers to install on.

Returns:

responses from peers.

Throws:

InvalidArgumentException

ProposalException