public class HFClient extends Object
Modifier and Type | Method and 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() |
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.
|
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.
|
Collection<ProposalResponse> |
sendInstallProposal(InstallProposalRequest installProposalRequest,
Collection<Peer> peers)
Deprecated.
|
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.
|
public User getUserContext()
public org.hyperledger.fabric.sdk.security.CryptoSuite getCryptoSuite()
public void setCryptoSuite(org.hyperledger.fabric.sdk.security.CryptoSuite cryptoSuite) throws CryptoException, InvalidArgumentException
public void setExecutorService(ExecutorService executorService) throws InvalidArgumentException
executorService
- The executor service the application wants to use.InvalidArgumentException
- if executor service has been set already.public static HFClient createNewInstance()
public Channel loadChannelFromConfig(String channelName, NetworkConfig networkConfig, NetworkConfig.NetworkConfigAddPeerHandler networkConfigAddPeerHandler, NetworkConfig.NetworkConfigAddOrdererHandler networkConfigAddOrdererHandler) throws InvalidArgumentException, NetworkConfigurationException
channelName
- The name of the channel to be configurednetworkConfig
- The network configuration to use to configure the channelnetworkConfigAddPeerHandler
- A handler that will create and add peers to the channel.networkConfigAddOrdererHandler
- A handler that will create orderers and add orderers to the channel.InvalidArgumentException
NetworkConfigurationException
public Channel loadChannelFromConfig(String channelName, NetworkConfig networkConfig) throws InvalidArgumentException, NetworkConfigurationException
channelName
- The name of the channel to be configurednetworkConfig
- The network configuration to use to configure the channelInvalidArgumentException
NetworkConfigurationException
public Channel newChannel(String name) throws InvalidArgumentException
name
- InvalidArgumentException
public Channel newChannel(String name, Orderer orderer, ChannelConfiguration channelConfiguration, byte[]... channelConfigurationSignatures) throws TransactionException, InvalidArgumentException
name
- The channel's nameorderer
- 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 createTransactionException
InvalidArgumentException
public Channel deSerializeChannel(File file) throws IOException, ClassNotFoundException, InvalidArgumentException
Channel.serializeChannel()
file
- a file which contains the bytes to be deserialized.IOException
ClassNotFoundException
InvalidArgumentException
public Channel deSerializeChannel(byte[] channelBytes) throws IOException, ClassNotFoundException, InvalidArgumentException
Channel.serializeChannel()
channelBytes
- bytes to be deserialized.IOException
ClassNotFoundException
InvalidArgumentException
public Peer newPeer(String name, String grpcURL, Properties properties) throws InvalidArgumentException
name
- name of peer.grpcURL
- to the peer's locationproperties
- Supported properties
Peer.PEER_ORGANIZATION_MSPID_PROPERTY
- Associates peer to an organization by its mspid.
InvalidArgumentException
public Peer newPeer(String name, String grpcURL) throws InvalidArgumentException
name
- grpcURL
- to the peer's locationInvalidArgumentException
public Channel getChannel(String name)
name
- The channel name@Deprecated public InstallProposalRequest newInstallProposalRequest()
newLifecycleQueryInstalledChaincodesRequest()
public LifecycleInstallChaincodeRequest newLifecycleInstallChaincodeRequest()
public LifecycleQueryInstalledChaincodeRequest newLifecycleQueryInstalledChaincodeRequest()
LifecycleInstallChaincodeProposalResponse
finds chaincodes installed.public LifecycleQueryInstalledChaincodesRequest newLifecycleQueryInstalledChaincodesRequest()
public LifecycleApproveChaincodeDefinitionForMyOrgRequest newLifecycleApproveChaincodeDefinitionForMyOrgRequest()
public LifecycleCheckCommitReadinessRequest newLifecycleSimulateCommitChaincodeDefinitionRequest()
public LifecycleCommitChaincodeDefinitionRequest newLifecycleCommitChaincodeDefinitionRequest()
public LifecycleQueryChaincodeDefinitionsRequest newLifecycleQueryChaincodeDefinitionsRequest()
public QueryLifecycleQueryChaincodeDefinitionRequest newQueryLifecycleQueryChaincodeDefinitionRequest()
public Collection<LifecycleInstallChaincodeProposalResponse> sendLifecycleInstallChaincodeRequest(LifecycleInstallChaincodeRequest lifecycleInstallChaincodeRequest, Collection<Peer> peers) throws ProposalException, InvalidArgumentException
lifecycleInstallChaincodeRequest
- peers
- Collection of peers to install on.InvalidArgumentException
ProposalException
public Collection<LifecycleQueryInstalledChaincodeProposalResponse> sendLifecycleQueryInstalledChaincode(LifecycleQueryInstalledChaincodeRequest lifecycleQueryInstalledChaincodeRequest, Collection<Peer> peers) throws InvalidArgumentException, ProposalException
lifecycleQueryInstalledChaincodeRequest
- The request LifecycleQueryInstalledChaincodeRequest
peers
- the peer to send the request to.InvalidArgumentException
ProposalException
public Collection<LifecycleQueryInstalledChaincodesProposalResponse> sendLifecycleQueryInstalledChaincodes(LifecycleQueryInstalledChaincodesRequest lifecycleQueryInstalledChaincodesRequest, Collection<Peer> peers) throws InvalidArgumentException, ProposalException
lifecycleQueryInstalledChaincodesRequest
- the request LifecycleQueryInstalledChaincodesRequest
peers
- The peer to query.LifecycleQueryInstalledChaincodesProposalResponse
InvalidArgumentException
ProposalException
@Deprecated public InstantiateProposalRequest newInstantiationProposalRequest()
LifecycleCommitChaincodeDefinitionRequest
for defining the chaincode and
and then TransactionRequest.setInit(boolean)
to do the initialization if it's required by the chaincode.InstantiateProposalRequest
@Deprecated public UpgradeProposalRequest newUpgradeProposalRequest()
LifecycleCommitChaincodeDefinitionRequest
for defining the chaincode and
and then TransactionRequest.setInit(boolean)
to do the initialization if it's required by the chaincode.UpgradeProposalRequest
public TransactionProposalRequest newTransactionProposalRequest()
public QueryByChaincodeRequest newQueryProposalRequest()
public User setUserContext(User userContext)
userContext
- IllegalStateException
- if no crypto suite has been set.NullPointerException
- if the user context is null.IllegalArgumentException
- if the user context is not valid.public Orderer newOrderer(String name, String grpcURL) throws InvalidArgumentException
name
- name of the orderer.grpcURL
- url location of orderer grpc or grpcs protocol.InvalidArgumentException
public Orderer newOrderer(String name, String grpcURL, Properties properties) throws InvalidArgumentException
name
- name of Orderer.grpcURL
- url location of orderer grpc or grpcs protocol.properties
- Supported properties
Orderer.ORDERER_ORGANIZATION_MSPID_PROPERTY
- Associates orderer to an organization by its mspid.
InvalidArgumentException
public Set<String> queryChannels(Peer peer) throws InvalidArgumentException, ProposalException
peer
- the peer to queryInvalidArgumentException
ProposalException
@Deprecated public List<org.hyperledger.fabric.protos.peer.Query.ChaincodeInfo> queryInstalledChaincodes(Peer peer) throws InvalidArgumentException, ProposalException
LifecycleQueryInstalledChaincodesRequest
peer
- The peer to query.Query.ChaincodeInfo
InvalidArgumentException
ProposalException
public byte[] getChannelConfigurationSignature(ChannelConfiguration channelConfiguration, User signer) throws InvalidArgumentException
channelConfiguration
- signer
- InvalidArgumentException
public byte[] getUpdateChannelConfigurationSignature(UpdateChannelConfiguration updateChannelConfiguration, User signer) throws InvalidArgumentException
updateChannelConfiguration
- signer
- InvalidArgumentException
@Deprecated public Collection<ProposalResponse> sendInstallProposal(InstallProposalRequest installProposalRequest, Collection<Peer> peers) throws ProposalException, InvalidArgumentException
LifecycleInstallChaincodeRequest
installProposalRequest
- peers
- Collection of peers to install on.InvalidArgumentException
ProposalException
Copyright © 2022. All rights reserved.