org.hyperledger.fabric.sdk

Class Channel

java.lang.Object

org.hyperledger.fabric.sdk.Channel

All Implemented Interfaces:

Serializable

public class Channel
extends Object
implements Serializable

The class representing a channel with which the client SDK interacts.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Channel.PeerOptions Options for the peer.

Method Summary

Modifier and Type	Method and Description
Channel	addEventHub(EventHub eventHub) Add an Event Hub to this channel.
Channel	addOrderer(Orderer orderer) Add an Orderer to this channel.
Channel	addPeer(Peer peer) Add a peer to the channel
Channel	addPeer(Peer peer, Channel.PeerOptions peerOptions) Add a peer to the channel
byte[]	getChannelConfigurationBytes() Channel Configuration bytes.
Collection<EventHub>	getEventHubs() Get all Event Hubs on this channel.
String	getName() Get the channel name
Collection<Orderer>	getOrderers()
Collection<Peer>	getPeers() Get the peers for this channel.
Collection<Peer>	getPeers(EnumSet<Peer.PeerRole> roles) Get the peers for this channel.
Channel.PeerOptions	getPeersOptions(Peer peer)
byte[]	getUpdateChannelConfigurationSignature(UpdateChannelConfiguration updateChannelConfiguration, User signer) Get signed byes of the update channel.
Channel	initialize() Initialize the Channel.
boolean	isInitialized() Is channel initialized.
boolean	isShutdown() Is the channel shutdown.
Channel	joinPeer(Peer peer) Join the peer to the channel.
Channel	joinPeer(Peer peer, Channel.PeerOptions peerOptions)
BlockInfo	queryBlockByHash(byte[] blockHash) query this channel for a Block by the block hash.
BlockInfo	queryBlockByHash(Peer peer, byte[] blockHash) Query a peer in this channel for a Block by the block hash.
BlockInfo	queryBlockByNumber(long blockNumber) query this channel for a Block by the blockNumber.
BlockInfo	queryBlockByNumber(Peer peer, long blockNumber) query a peer in this channel for a Block by the blockNumber
BlockInfo	queryBlockByTransactionID(Peer peer, String txID) query a peer in this channel for a Block by a TransactionID contained in the block
BlockInfo	queryBlockByTransactionID(String txID) query this channel for a Block by a TransactionID contained in the block The request is sent to a random peer in the channel
BlockchainInfo	queryBlockchainInfo() query this channel for chain information.
BlockchainInfo	queryBlockchainInfo(Peer peer) query for chain information
Collection<ProposalResponse>	queryByChaincode(QueryByChaincodeRequest queryByChaincodeRequest) Send Query proposal
Collection<ProposalResponse>	queryByChaincode(QueryByChaincodeRequest queryByChaincodeRequest, Collection<Peer> peers) Send Query proposal
List<org.hyperledger.fabric.protos.peer.Query.ChaincodeInfo>	queryInstantiatedChaincodes(Peer peer) Query peer for chaincode that has been instantiated
TransactionInfo	queryTransactionByID(Peer peer, String txID) Query for a Fabric Transaction given its transactionID
TransactionInfo	queryTransactionByID(String txID) Query this channel for a Fabric Transaction given its transactionID.
String	registerBlockListener(BlockListener listener) Register a block listener.
String	registerChaincodeEventListener(Pattern chaincodeId, Pattern eventName, ChaincodeEventListener chaincodeEventListener) Register a chaincode event listener.
void	removePeer(Peer peer) Removes the peer connection from the channel.
Collection<ProposalResponse>	sendInstantiationProposal(InstantiateProposalRequest instantiateProposalRequest) Send instantiate request to the channel.
Collection<ProposalResponse>	sendInstantiationProposal(InstantiateProposalRequest instantiateProposalRequest, Collection<Peer> peers) Send instantiate request to the channel.
CompletableFuture<BlockEvent.TransactionEvent>	sendTransaction(Collection<ProposalResponse> proposalResponses) Send transaction to one of the orderers on the channel using the usercontext set on the client.
CompletableFuture<BlockEvent.TransactionEvent>	sendTransaction(Collection<ProposalResponse> proposalResponses, Collection<Orderer> orderers) Send transaction to one of the specified orderers using the usercontext set on the client..
CompletableFuture<BlockEvent.TransactionEvent>	sendTransaction(Collection<ProposalResponse> proposalResponses, Collection<Orderer> orderers, User userContext) Send transaction to one of a specified set of orderers with the specified user context.
CompletableFuture<BlockEvent.TransactionEvent>	sendTransaction(Collection<ProposalResponse> proposalResponses, User userContext) Send transaction to one of the orderers on the channel using a specific user context.
Collection<ProposalResponse>	sendTransactionProposal(TransactionProposalRequest transactionProposalRequest) Send a transaction proposal.
Collection<ProposalResponse>	sendTransactionProposal(TransactionProposalRequest transactionProposalRequest, Collection<Peer> peers) Send a transaction proposal to specific peers.
Collection<ProposalResponse>	sendUpgradeProposal(UpgradeProposalRequest upgradeProposalRequest) Send Upgrade proposal proposal to upgrade chaincode to a new version.
Collection<ProposalResponse>	sendUpgradeProposal(UpgradeProposalRequest upgradeProposalRequest, Collection<Peer> peers) Send Upgrade proposal proposal to upgrade chaincode to a new version.
byte[]	serializeChannel() Serialize channel to a byte array using Java serialization.
void	serializeChannel(File file) Serialize channel to a file using Java serialization.
void	shutdown(boolean force) Shutdown the channel with all resources released.
boolean	unregisterBlockListener(String handle) Unregister a block listener.
boolean	unregisterChaincodeEventListener(String handle) Unregister an existing chaincode event listener.
void	updateChannelConfiguration(UpdateChannelConfiguration updateChannelConfiguration, byte[]... signers) Update channel with specified channel configuration
void	updateChannelConfiguration(UpdateChannelConfiguration updateChannelConfiguration, Orderer orderer, byte[]... signers) Update channel with specified channel configuration

Methods inherited from class java.lang.Object

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

Method Detail

getEventHubs

public Collection<EventHub> getEventHubs()

Get all Event Hubs on this channel.

Returns:

Event Hubs

updateChannelConfiguration

public void updateChannelConfiguration(UpdateChannelConfiguration updateChannelConfiguration,
                                       byte[]... signers)
                                throws TransactionException,
                                       InvalidArgumentException

Update channel with specified channel configuration

Parameters:

updateChannelConfiguration - Updated Channel configuration

signers - signers

Throws:

TransactionException

InvalidArgumentException

updateChannelConfiguration

public void updateChannelConfiguration(UpdateChannelConfiguration updateChannelConfiguration,
                                       Orderer orderer,
                                       byte[]... signers)
                                throws TransactionException,
                                       InvalidArgumentException

Update channel with specified channel configuration

Parameters:

updateChannelConfiguration - Channel configuration

signers - signers

orderer - The specific orderer to use.

Throws:

TransactionException

InvalidArgumentException

isInitialized

public boolean isInitialized()

Is channel initialized.

Returns:

true if the channel has been initialized.

getName

public String getName()

Get the channel name

Returns:

The name of the channel

addPeer

public Channel addPeer(Peer peer)
                throws InvalidArgumentException

Add a peer to the channel

Parameters:

peer - The Peer to add.

Returns:

Channel The current channel added.

Throws:

InvalidArgumentException

addPeer

public Channel addPeer(Peer peer,
                       Channel.PeerOptions peerOptions)
                throws InvalidArgumentException

Add a peer to the channel

Parameters:

peer - The Peer to add.

peerOptions - see Peer.PeerRole

Returns:

Channel The current channel added.

Throws:

InvalidArgumentException

joinPeer

public Channel joinPeer(Peer peer)
                 throws ProposalException

Join the peer to the channel. The peer is added with all roles see Channel.PeerOptions

Parameters:

peer - the peer to join the channel.

Returns:

Throws:

ProposalException

joinPeer

public Channel joinPeer(Peer peer,
                        Channel.PeerOptions peerOptions)
                 throws ProposalException

Parameters:

peer - the peer to join the channel.

peerOptions - see Channel.PeerOptions

Returns:

Throws:

ProposalException

removePeer

public void removePeer(Peer peer)
                throws InvalidArgumentException

Removes the peer connection from the channel. This does NOT unjoin the peer from from the channel. Fabric does not support that at this time -- maybe some day, but not today

Parameters:

peer -

Throws:

InvalidArgumentException

addOrderer

public Channel addOrderer(Orderer orderer)
                   throws InvalidArgumentException

Add an Orderer to this channel.

Parameters:

orderer - the orderer to add.

Returns:

this channel.

Throws:

InvalidArgumentException

getPeersOptions

public Channel.PeerOptions getPeersOptions(Peer peer)

addEventHub

public Channel addEventHub(EventHub eventHub)
                    throws InvalidArgumentException

Add an Event Hub to this channel.

Parameters:

eventHub -

Returns:

this channel

Throws:

InvalidArgumentException

getPeers

public Collection<Peer> getPeers()

Get the peers for this channel.

Returns:

the peers.

getPeers

public Collection<Peer> getPeers(EnumSet<Peer.PeerRole> roles)

Get the peers for this channel.

Returns:

the peers.

initialize

public Channel initialize()
                   throws InvalidArgumentException,
                          TransactionException

Initialize the Channel. Starts the channel. event hubs will connect.

Returns:

this channel.

Throws:

InvalidArgumentException

TransactionException

isShutdown

public boolean isShutdown()

Is the channel shutdown.

Returns:

return true if the channel is shutdown.

getUpdateChannelConfigurationSignature

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

Get signed byes of the update channel.

Parameters:

updateChannelConfiguration -

signer -

Returns:

Throws:

InvalidArgumentException

getChannelConfigurationBytes

public byte[] getChannelConfigurationBytes()
                                    throws TransactionException

Channel Configuration bytes. Bytes that can be used with configtxlator tool to upgrade the channel. Convert to Json for editing with: <p> curl -v POST --data-binary @fooConfig http://host/protolator/decode/common.Config <p> See http://hyperledger-fabric.readthedocs.io/en/latest/configtxlator.html

Returns:

Channel configuration bytes.

Throws:

TransactionException

getOrderers

public Collection<Orderer> getOrderers()

sendInstantiationProposal

public Collection<ProposalResponse> sendInstantiationProposal(InstantiateProposalRequest instantiateProposalRequest)
                                                       throws InvalidArgumentException,
                                                              ProposalException

Send instantiate request to the channel. Chaincode is created and initialized.

Parameters:

instantiateProposalRequest - send instantiate chaincode proposal request.

Returns:

Collections of proposal responses

Throws:

InvalidArgumentException

ProposalException

sendInstantiationProposal

public Collection<ProposalResponse> sendInstantiationProposal(InstantiateProposalRequest instantiateProposalRequest,
                                                              Collection<Peer> peers)
                                                       throws InvalidArgumentException,
                                                              ProposalException

Send instantiate request to the channel. Chaincode is created and initialized.

Parameters:

instantiateProposalRequest -

peers -

Returns:

responses from peers.

Throws:

InvalidArgumentException

ProposalException

sendUpgradeProposal

public Collection<ProposalResponse> sendUpgradeProposal(UpgradeProposalRequest upgradeProposalRequest)
                                                 throws ProposalException,
                                                        InvalidArgumentException

Send Upgrade proposal proposal to upgrade chaincode to a new version.

Parameters:

upgradeProposalRequest -

Returns:

Collection of proposal responses.

Throws:

ProposalException

InvalidArgumentException

sendUpgradeProposal

public Collection<ProposalResponse> sendUpgradeProposal(UpgradeProposalRequest upgradeProposalRequest,
                                                        Collection<Peer> peers)
                                                 throws InvalidArgumentException,
                                                        ProposalException

Send Upgrade proposal proposal to upgrade chaincode to a new version.

Parameters:

upgradeProposalRequest -

peers - the specific peers to send to.

Returns:

Collection of proposal responses.

Throws:

ProposalException

InvalidArgumentException

queryBlockByHash

public BlockInfo queryBlockByHash(byte[] blockHash)
                           throws InvalidArgumentException,
                                  ProposalException

query this channel for a Block by the block hash. The request is sent to a random peer in the channel.

Parameters:

blockHash - the hash of the Block in the chain

Returns:

the BlockInfo with the given block Hash

Throws:

InvalidArgumentException

ProposalException

queryBlockByHash

public BlockInfo queryBlockByHash(Peer peer,
                                  byte[] blockHash)
                           throws InvalidArgumentException,
                                  ProposalException

Query a peer in this channel for a Block by the block hash.

Parameters:

peer - the Peer to query.

blockHash - the hash of the Block in the chain.

Returns:

the BlockInfo with the given block Hash

Throws:

InvalidArgumentException - if the channel is shutdown or any of the arguments are not valid.

ProposalException - if an error occurred processing the query.

queryBlockByNumber

public BlockInfo queryBlockByNumber(long blockNumber)
                             throws InvalidArgumentException,
                                    ProposalException

query this channel for a Block by the blockNumber. The request is sent to a random peer in the channel.

Parameters:

blockNumber - index of the Block in the chain

Returns:

the BlockInfo with the given blockNumber

Throws:

InvalidArgumentException

ProposalException

queryBlockByNumber

public BlockInfo queryBlockByNumber(Peer peer,
                                    long blockNumber)
                             throws InvalidArgumentException,
                                    ProposalException

query a peer in this channel for a Block by the blockNumber

Parameters:

peer - the peer to send the request to

blockNumber - index of the Block in the chain

Returns:

the BlockInfo with the given blockNumber

Throws:

InvalidArgumentException

ProposalException

queryBlockByTransactionID

public BlockInfo queryBlockByTransactionID(String txID)
                                    throws InvalidArgumentException,
                                           ProposalException

query this channel for a Block by a TransactionID contained in the block The request is sent to a random peer in the channel

Parameters:

txID - the transactionID to query on

Returns:

the BlockInfo for the Block containing the transaction

Throws:

InvalidArgumentException

ProposalException

queryBlockByTransactionID

public BlockInfo queryBlockByTransactionID(Peer peer,
                                           String txID)
                                    throws InvalidArgumentException,
                                           ProposalException

query a peer in this channel for a Block by a TransactionID contained in the block

Parameters:

peer - the peer to send the request to

txID - the transactionID to query on

Returns:

the BlockInfo for the Block containing the transaction

Throws:

InvalidArgumentException

ProposalException

queryBlockchainInfo

public BlockchainInfo queryBlockchainInfo()
                                   throws ProposalException,
                                          InvalidArgumentException

query this channel for chain information. The request is sent to a random peer in the channel

Returns:

a BlockchainInfo object containing the chain info requested

Throws:

InvalidArgumentException

ProposalException

queryBlockchainInfo

public BlockchainInfo queryBlockchainInfo(Peer peer)
                                   throws ProposalException,
                                          InvalidArgumentException

query for chain information

Parameters:

peer - The peer to send the request to

Returns:

a BlockchainInfo object containing the chain info requested

Throws:

InvalidArgumentException

ProposalException

queryTransactionByID

public TransactionInfo queryTransactionByID(String txID)
                                     throws ProposalException,
                                            InvalidArgumentException

Query this channel for a Fabric Transaction given its transactionID. The request is sent to a random peer in the channel.

Parameters:

txID - the ID of the transaction

Returns:

a TransactionInfo

Throws:

ProposalException

InvalidArgumentException

queryTransactionByID

public TransactionInfo queryTransactionByID(Peer peer,
                                            String txID)
                                     throws ProposalException,
                                            InvalidArgumentException

Query for a Fabric Transaction given its transactionID

Parameters:

txID - the ID of the transaction

peer - the peer to send the request to

Returns:

a TransactionInfo

Throws:

ProposalException

InvalidArgumentException

queryInstantiatedChaincodes

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

Query peer for chaincode that has been instantiated

Parameters:

peer - The peer to query.

Returns:

A list of ChaincodeInfo @see Query.ChaincodeInfo

Throws:

InvalidArgumentException

ProposalException

sendTransactionProposal

public Collection<ProposalResponse> sendTransactionProposal(TransactionProposalRequest transactionProposalRequest)
                                                     throws ProposalException,
                                                            InvalidArgumentException

Send a transaction proposal.

Parameters:

transactionProposalRequest - The transaction proposal to be sent to all the peers.

Returns:

responses from peers.

Throws:

InvalidArgumentException

ProposalException

sendTransactionProposal

public Collection<ProposalResponse> sendTransactionProposal(TransactionProposalRequest transactionProposalRequest,
                                                            Collection<Peer> peers)
                                                     throws ProposalException,
                                                            InvalidArgumentException

Send a transaction proposal to specific peers.

Parameters:

transactionProposalRequest - The transaction proposal to be sent to the peers.

peers -

Returns:

responses from peers.

Throws:

InvalidArgumentException

ProposalException

queryByChaincode

public Collection<ProposalResponse> queryByChaincode(QueryByChaincodeRequest queryByChaincodeRequest)
                                              throws InvalidArgumentException,
                                                     ProposalException

Send Query proposal

Parameters:

queryByChaincodeRequest -

Returns:

Collection proposal responses.

Throws:

InvalidArgumentException

ProposalException

queryByChaincode

public Collection<ProposalResponse> queryByChaincode(QueryByChaincodeRequest queryByChaincodeRequest,
                                                     Collection<Peer> peers)
                                              throws InvalidArgumentException,
                                                     ProposalException

Send Query proposal

Parameters:

queryByChaincodeRequest -

peers -

Returns:

responses from peers.

Throws:

InvalidArgumentException

ProposalException

sendTransaction

public CompletableFuture<BlockEvent.TransactionEvent> sendTransaction(Collection<ProposalResponse> proposalResponses,
                                                                      User userContext)

Send transaction to one of the orderers on the channel using a specific user context.

Parameters:

proposalResponses - The proposal responses to be sent to the orderer.

userContext - The usercontext used for signing transaction.

Returns:

a future allowing access to the result of the transaction invocation once complete.

sendTransaction

public CompletableFuture<BlockEvent.TransactionEvent> sendTransaction(Collection<ProposalResponse> proposalResponses)

Send transaction to one of the orderers on the channel using the usercontext set on the client.

Parameters:

proposalResponses - .

Returns:

a future allowing access to the result of the transaction invocation once complete.

sendTransaction

public CompletableFuture<BlockEvent.TransactionEvent> sendTransaction(Collection<ProposalResponse> proposalResponses,
                                                                      Collection<Orderer> orderers)

Send transaction to one of the specified orderers using the usercontext set on the client..

Parameters:

proposalResponses - The proposal responses to be sent to the orderer

orderers - The orderers to send the transaction to.

Returns:

a future allowing access to the result of the transaction invocation once complete.

sendTransaction

public CompletableFuture<BlockEvent.TransactionEvent> sendTransaction(Collection<ProposalResponse> proposalResponses,
                                                                      Collection<Orderer> orderers,
                                                                      User userContext)

Send transaction to one of a specified set of orderers with the specified user context. IF there are no event hubs or eventing peers this future returns immediately completed indicating that orderer has accepted the transaction only.

Parameters:

proposalResponses -

orderers -

Returns:

Future allowing access to the result of the transaction invocation.

registerBlockListener

public String registerBlockListener(BlockListener listener)
                             throws InvalidArgumentException

Register a block listener.

Parameters:

listener - function with single argument with type BlockEvent

Returns:

The handle of the registered block listener.

Throws:

InvalidArgumentException - if the channel is shutdown.

unregisterBlockListener

public boolean unregisterBlockListener(String handle)
                                throws InvalidArgumentException

Unregister a block listener.

Parameters:

handle - of Block listener to remove.

Returns:

false if not found.

Throws:

InvalidArgumentException - if the channel is shutdown or invalid arguments.

registerChaincodeEventListener

public String registerChaincodeEventListener(Pattern chaincodeId,
                                             Pattern eventName,
                                             ChaincodeEventListener chaincodeEventListener)
                                      throws InvalidArgumentException

Register a chaincode event listener. Both chaincodeId pattern AND eventName pattern must match to invoke the chaincodeEventListener

Parameters:

chaincodeId - Java pattern for chaincode identifier also know as chaincode name. If ma

eventName - Java pattern to match the event name.

chaincodeEventListener - The listener to be invoked if both chaincodeId and eventName pattern matches.

Returns:

Handle to be used to unregister the event listener unregisterChaincodeEventListener(String)

Throws:

InvalidArgumentException

unregisterChaincodeEventListener

public boolean unregisterChaincodeEventListener(String handle)
                                         throws InvalidArgumentException

Unregister an existing chaincode event listener.

Parameters:

handle - Chaincode event listener handle to be unregistered.

Returns:

True if the chaincode handler was found and removed.

Throws:

InvalidArgumentException

shutdown

public void shutdown(boolean force)

Shutdown the channel with all resources released.

Parameters:

force - force immediate shutdown.

serializeChannel

public void serializeChannel(File file)
                      throws IOException,
                             InvalidArgumentException

Serialize channel to a file using Java serialization. Deserialized channel will NOT be in an initialized state.

Parameters:

file - file

Throws:

IOException

InvalidArgumentException

serializeChannel

public byte[] serializeChannel()
                        throws IOException,
                               InvalidArgumentException

Serialize channel to a byte array using Java serialization. Deserialized channel will NOT be in an initialized state.

Throws:

InvalidArgumentException

IOException