Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- acceptCommit(BlockEvent.TransactionEvent) - Method in interface org.hyperledger.fabric.gateway.spi.CommitListener
-
Called to notify the listener that a given peer has processed a transaction.
- acceptDisconnect(PeerDisconnectEvent) - Method in interface org.hyperledger.fabric.gateway.spi.CommitListener
-
Called to notify the listener of a communication failure with a given peer.
- addBlockListener(long, Consumer<BlockEvent>) - Method in interface org.hyperledger.fabric.gateway.Network
-
Add a listener to replay block events from the network.
- addBlockListener(Consumer<BlockEvent>) - Method in interface org.hyperledger.fabric.gateway.Network
-
Add a listener to receive block events from the network.
- addBlockListener(Checkpointer, Consumer<BlockEvent>) - Method in interface org.hyperledger.fabric.gateway.Network
-
Add a listener to receive block events from the network with checkpointing.
- addCommitListener(CommitListener, Collection<Peer>, String) - Method in interface org.hyperledger.fabric.gateway.Network
-
Add a listener to receive transaction commit and peer disconnect events for a set of peers.
- addContractListener(long, Consumer<ContractEvent>) - Method in interface org.hyperledger.fabric.gateway.Contract
-
Add a listener to replay contract events emitted by committed transactions.
- addContractListener(long, Consumer<ContractEvent>, String) - Method in interface org.hyperledger.fabric.gateway.Contract
-
Add a listener to replay contract events emitted by committed transactions.
- addContractListener(long, Consumer<ContractEvent>, Pattern) - Method in interface org.hyperledger.fabric.gateway.Contract
-
Add a listener to replay contract events emitted by committed transactions.
- addContractListener(Consumer<ContractEvent>) - Method in interface org.hyperledger.fabric.gateway.Contract
-
Add a listener to receive all contract events emitted by committed transactions.
- addContractListener(Consumer<ContractEvent>, String) - Method in interface org.hyperledger.fabric.gateway.Contract
-
Add a listener to receive contract events emitted by committed transactions.
- addContractListener(Consumer<ContractEvent>, Pattern) - Method in interface org.hyperledger.fabric.gateway.Contract
-
Add a listener to receive contract events emitted by committed transactions.
- addContractListener(Checkpointer, Consumer<ContractEvent>) - Method in interface org.hyperledger.fabric.gateway.Contract
-
Add a listener to receive all contract events emitted by committed transactions with checkpointing.
- addContractListener(Checkpointer, Consumer<ContractEvent>, String) - Method in interface org.hyperledger.fabric.gateway.Contract
-
Add a listener to receive contract events emitted by committed transactions with checkpointing.
- addContractListener(Checkpointer, Consumer<ContractEvent>, Pattern) - Method in interface org.hyperledger.fabric.gateway.Contract
-
Add a listener to receive contract events emitted by committed transactions with checkpointing.
- addTransactionId(String) - Method in interface org.hyperledger.fabric.gateway.spi.Checkpointer
-
Add a transaction ID for the current block.
C
- cancelListening() - Method in interface org.hyperledger.fabric.gateway.spi.CommitHandler
-
Called to interrupt the waiting state of
CommitHandler.waitForEvents(long, TimeUnit)
before completion. - Checkpointer - Interface in org.hyperledger.fabric.gateway.spi
-
Persists the current block and transactions within that block to enable event listening to be resumed following an application outage.
- close() - Method in interface org.hyperledger.fabric.gateway.Gateway
-
Close the gateway connection and all associated resources, including removing listeners attached to networks and contracts created by the gateway.
- close() - Method in interface org.hyperledger.fabric.gateway.spi.Checkpointer
- commitHandler(CommitHandlerFactory) - Method in interface org.hyperledger.fabric.gateway.Gateway.Builder
-
Optional - Allows an alternative commit handler to be specified.
- CommitHandler - Interface in org.hyperledger.fabric.gateway.spi
-
Class to handle waiting for an appropriate number of successful commit events to be received from peers following submit of a transaction to the orderer.
- CommitHandlerFactory - Interface in org.hyperledger.fabric.gateway.spi
-
Functional interface describing a factory function for constructing
CommitHandler
instances. - CommitListener - Interface in org.hyperledger.fabric.gateway.spi
-
Implemented by listeners for transaction commit events.
- commitTimeout(long, TimeUnit) - Method in interface org.hyperledger.fabric.gateway.Gateway.Builder
-
Optional - Set the default maximum time to wait for commit events to be received from peers after submitting a transaction to the orderer.
- connect() - Method in interface org.hyperledger.fabric.gateway.Gateway.Builder
-
Connects to the gateway using the specified options.
- Contract - Interface in org.hyperledger.fabric.gateway
-
Represents a smart contract instance in a network.
- ContractEvent - Interface in org.hyperledger.fabric.gateway
-
Event emitted by the business logic of a smart contract during execution of a transaction.
- ContractException - Exception in org.hyperledger.fabric.gateway
-
Thrown when an error occurs invoking a smart contract.
- ContractException(String) - Constructor for exception org.hyperledger.fabric.gateway.ContractException
-
Constructs a new exception with the specified detail message.
- ContractException(String, Throwable) - Constructor for exception org.hyperledger.fabric.gateway.ContractException
-
Constructs a new exception with the specified detail message and cause.
- ContractException(String, Collection<ProposalResponse>) - Constructor for exception org.hyperledger.fabric.gateway.ContractException
-
Constructs a new exception with the specified detail message and proposal responses returned from peer invocations.
- create(String, Network) - Method in enum org.hyperledger.fabric.gateway.DefaultCommitHandlers
- create(String, Network) - Method in interface org.hyperledger.fabric.gateway.spi.CommitHandlerFactory
-
Factory function to create a commit handler instance.
- create(Network) - Method in enum org.hyperledger.fabric.gateway.DefaultQueryHandlers
- create(Network) - Method in interface org.hyperledger.fabric.gateway.spi.QueryHandlerFactory
-
Factory function to create a query handler instance.
- createBuilder() - Static method in interface org.hyperledger.fabric.gateway.Gateway
-
Creates a gateway builder which is used to configure the gateway options prior to connecting to the Fabric network.
- createTransaction(String) - Method in interface org.hyperledger.fabric.gateway.Contract
-
Create an object representing a specific invocation of a transaction function implemented by this contract, and provides more control over the transaction invocation.
D
- DefaultCheckpointers - Class in org.hyperledger.fabric.gateway
-
Provides static factory methods used to create instances of default
Checkpointer
implementations. - DefaultCommitHandlers - Enum in org.hyperledger.fabric.gateway
-
Default commit handler implementations.
- DefaultQueryHandlers - Enum in org.hyperledger.fabric.gateway
-
Default query handler implementations.
- discovery(boolean) - Method in interface org.hyperledger.fabric.gateway.Gateway.Builder
-
Optional - Enable or disable service discovery for all transaction submissions for this gateway.
E
- evaluate(String...) - Method in interface org.hyperledger.fabric.gateway.Transaction
-
Evaluate a transaction function and return its results.
- evaluate(Collection<Peer>) - Method in interface org.hyperledger.fabric.gateway.spi.Query
-
Evaluate the query on several peers.
- evaluate(Query) - Method in interface org.hyperledger.fabric.gateway.spi.QueryHandler
-
Called when the result for a given query is required.
- evaluate(Peer) - Method in interface org.hyperledger.fabric.gateway.spi.Query
-
Evaluate the query on a specific peer.
- evaluateTransaction(String, String...) - Method in interface org.hyperledger.fabric.gateway.Contract
-
Evaluate a transaction function and return its results.
F
- file(Path) - Static method in class org.hyperledger.fabric.gateway.DefaultCheckpointers
-
Checkpointer implementation that persists state to a given file.
G
- Gateway - Interface in org.hyperledger.fabric.gateway
-
The Gateway provides the connection point for an application to access the Fabric network as a specific user.
- Gateway.Builder - Interface in org.hyperledger.fabric.gateway
-
The Gateway Builder interface defines the options that can be configured prior to connection.
- GatewayException - Exception in org.hyperledger.fabric.gateway
-
Base class for exceptions thrown by the Gateway SDK or by components of the underlying Fabric.
- GatewayException(String) - Constructor for exception org.hyperledger.fabric.gateway.GatewayException
-
Constructs a new exception with the specified detail message.
- GatewayException(String, Throwable) - Constructor for exception org.hyperledger.fabric.gateway.GatewayException
-
Constructs a new exception with the specified detail message and cause.
- GatewayException(Throwable) - Constructor for exception org.hyperledger.fabric.gateway.GatewayException
-
Constructs a new exception with the specified cause.
- GatewayRuntimeException - Exception in org.hyperledger.fabric.gateway
-
Runtime exception for gateway classes.
- GatewayRuntimeException(String) - Constructor for exception org.hyperledger.fabric.gateway.GatewayRuntimeException
-
Constructs a new exception with the specified detail message.
- GatewayRuntimeException(String, Throwable) - Constructor for exception org.hyperledger.fabric.gateway.GatewayRuntimeException
-
Constructs a new exception with the specified detail message and cause.
- GatewayRuntimeException(Throwable) - Constructor for exception org.hyperledger.fabric.gateway.GatewayRuntimeException
-
Constructs a new exception with the specified cause.
- get(String) - Method in interface org.hyperledger.fabric.gateway.spi.WalletStore
-
Get data from the store.
- get(String) - Method in interface org.hyperledger.fabric.gateway.Wallet
-
Get an identity from the wallet.
- getBlockNumber() - Method in interface org.hyperledger.fabric.gateway.spi.Checkpointer
-
Get the current block number, or
Checkpointer.UNSET_BLOCK_NUMBER
if there is no previously saved state. - getCause() - Method in interface org.hyperledger.fabric.gateway.spi.PeerDisconnectEvent
-
Get any underlying exception describing the reason the peer disconnected.
- getCertificate() - Method in interface org.hyperledger.fabric.gateway.X509Identity
-
Get the certificate for this identity.
- getChaincodeId() - Method in interface org.hyperledger.fabric.gateway.ContractEvent
-
Get the identifier of the chaincode that emitted the event.
- getChannel() - Method in interface org.hyperledger.fabric.gateway.Network
-
Get the low-level chanel object associated with this network.
- getClient() - Method in interface org.hyperledger.fabric.gateway.Gateway
-
Get the Client used by the gateway connection.
- getContract(String) - Method in interface org.hyperledger.fabric.gateway.Network
-
Get an instance of a contract on the current network.
- getContract(String, String) - Method in interface org.hyperledger.fabric.gateway.Network
-
Get an instance of a contract on the current network.
- getGateway() - Method in interface org.hyperledger.fabric.gateway.Network
-
Get a reference to the owning Gateway connection.
- getIdentity() - Method in interface org.hyperledger.fabric.gateway.Gateway
-
Get the identity associated with the gateway connection.
- getMspId() - Method in interface org.hyperledger.fabric.gateway.Identity
-
Member services provider to which this identity is associated.
- getName() - Method in interface org.hyperledger.fabric.gateway.ContractEvent
-
Get the name of the event emitted by the contract.
- getName() - Method in interface org.hyperledger.fabric.gateway.Transaction
-
Get the fully qualified name of the transaction function.
- getNetwork(String) - Method in interface org.hyperledger.fabric.gateway.Gateway
-
Returns an object representing a network.
- getPayload() - Method in interface org.hyperledger.fabric.gateway.ContractEvent
-
Any binary data associated with this event by the chaincode.
- getPeer() - Method in interface org.hyperledger.fabric.gateway.spi.PeerDisconnectEvent
-
Get the peer that has disconnected.
- getPrivateKey() - Method in interface org.hyperledger.fabric.gateway.X509Identity
-
Get the private key for this identity.
- getProposalResponses() - Method in exception org.hyperledger.fabric.gateway.ContractException
-
Get the proposal responses received from peer invocations.
- getTransactionEvent() - Method in interface org.hyperledger.fabric.gateway.ContractEvent
-
Get the transaction event that included this contract event.
- getTransactionId() - Method in interface org.hyperledger.fabric.gateway.Transaction
-
Get the transaction ID that will be used when submitting this transaction.
- getTransactionIds() - Method in interface org.hyperledger.fabric.gateway.spi.Checkpointer
-
Get the transaction IDs processed within the current block.
I
- Identities - Class in org.hyperledger.fabric.gateway
-
This class consists exclusively of static methods used to create and operate on identity information.
- identity(Identity) - Method in interface org.hyperledger.fabric.gateway.Gateway.Builder
-
Specifies the identity that is to be used to connect to the network.
- identity(Wallet, String) - Method in interface org.hyperledger.fabric.gateway.Gateway.Builder
-
Specifies the identity that is to be used to connect to the network.
- Identity - Interface in org.hyperledger.fabric.gateway
-
Common behavior shared by all identity implementations.
L
- list() - Method in interface org.hyperledger.fabric.gateway.spi.WalletStore
-
List the labels for all stored data.
- list() - Method in interface org.hyperledger.fabric.gateway.Wallet
-
Get the labels of all identities in the wallet.
M
- MSPID_SCOPE_ALLFORTX - Enum constant in enum org.hyperledger.fabric.gateway.DefaultCommitHandlers
-
Wait to receive commit events from all currently responding peers in the user's organization after submitting a transaction.
- MSPID_SCOPE_ANYFORTX - Enum constant in enum org.hyperledger.fabric.gateway.DefaultCommitHandlers
-
Wait to receive a commit event from any currently responding peer in the user's organization after submitting a transaction.
- MSPID_SCOPE_ROUND_ROBIN - Enum constant in enum org.hyperledger.fabric.gateway.DefaultQueryHandlers
-
For each subsequent query, the next peer in the list is used.
- MSPID_SCOPE_SINGLE - Enum constant in enum org.hyperledger.fabric.gateway.DefaultQueryHandlers
-
The last peer that provided a successful response is used.
N
- Network - Interface in org.hyperledger.fabric.gateway
-
A Network object represents the set of peers in a Fabric network (channel).
- NETWORK_SCOPE_ALLFORTX - Enum constant in enum org.hyperledger.fabric.gateway.DefaultCommitHandlers
-
Wait to receive commit events from all currently responding peers in the network after submitting a transaction.
- NETWORK_SCOPE_ANYFORTX - Enum constant in enum org.hyperledger.fabric.gateway.DefaultCommitHandlers
-
Wait to receive a commit event from any currently responding peer in the network after submitting a transaction.
- networkConfig(InputStream) - Method in interface org.hyperledger.fabric.gateway.Gateway.Builder
-
Specifies the common connection profile.
- networkConfig(Path) - Method in interface org.hyperledger.fabric.gateway.Gateway.Builder
-
Specifies the path to the common connection profile.
- newCouchDBWallet(URL, String) - Static method in class org.hyperledger.fabric.gateway.Wallets
-
Create a wallet backed by a CouchDB database.
- newFileSystemWallet(Path) - Static method in class org.hyperledger.fabric.gateway.Wallets
-
Create a wallet backed by a directory on the file system.
- newInMemoryWallet() - Static method in class org.hyperledger.fabric.gateway.Wallets
-
Create a wallet backed by an in-memory (non-persistent) store.
- newWallet(WalletStore) - Static method in class org.hyperledger.fabric.gateway.Wallets
-
Create a wallet backed by a custom store implementation.
- newX509Identity(String, X509Certificate, PrivateKey) - Static method in class org.hyperledger.fabric.gateway.Identities
-
Create a new identity using X.509 credentials.
- newX509Identity(String, Enrollment) - Static method in class org.hyperledger.fabric.gateway.Identities
-
Create a new X.509 identity from an enrollment returned from a Certificate Authority.
- NONE - Enum constant in enum org.hyperledger.fabric.gateway.DefaultCommitHandlers
-
Do not wait for any commit events to be received from peers after submitting a transaction.
O
- org.hyperledger.fabric.gateway - package org.hyperledger.fabric.gateway
-
This package provides the set of interfaces that enable a Java application to interact with a Fabric blockchain network.
- org.hyperledger.fabric.gateway.spi - package org.hyperledger.fabric.gateway.spi
-
This package provides the set of interfaces that enable a Java developer to extend the set of built in handlers for controlling gateway strategies.
P
- PeerDisconnectEvent - Interface in org.hyperledger.fabric.gateway.spi
-
Event with information relating to a peer disconnect.
- PREFER_MSPID_SCOPE_ALLFORTX - Enum constant in enum org.hyperledger.fabric.gateway.DefaultCommitHandlers
-
Wait to receive commit events from all currently responding peers in the user's organization after submitting a transaction.
- PREFER_MSPID_SCOPE_ANYFORTX - Enum constant in enum org.hyperledger.fabric.gateway.DefaultCommitHandlers
-
Wait to receive a commit event from any currently responding peer in the user's organization after submitting a transaction.
- PREFER_MSPID_SCOPE_ROUND_ROBIN - Enum constant in enum org.hyperledger.fabric.gateway.DefaultQueryHandlers
-
For each subsequent query, the next peer in the list is used.
- PREFER_MSPID_SCOPE_SINGLE - Enum constant in enum org.hyperledger.fabric.gateway.DefaultQueryHandlers
-
The last peer that provided a successful response is used.
- put(String, InputStream) - Method in interface org.hyperledger.fabric.gateway.spi.WalletStore
-
Put data into the store.
- put(String, Identity) - Method in interface org.hyperledger.fabric.gateway.Wallet
-
Put an identity into the wallet.
Q
- Query - Interface in org.hyperledger.fabric.gateway.spi
-
Defines a query and provides methods to evaluate the query on specific peers.
- queryHandler(QueryHandlerFactory) - Method in interface org.hyperledger.fabric.gateway.Gateway.Builder
-
Optional - Allows an alternative query handler to be specified.
- QueryHandler - Interface in org.hyperledger.fabric.gateway.spi
-
Handler responsible for evaluating a given query against appropriate peers.
- QueryHandlerFactory - Interface in org.hyperledger.fabric.gateway.spi
-
Functional interface describing a factory function for constructing
QueryHandler
instances.
R
- readPrivateKey(Reader) - Static method in class org.hyperledger.fabric.gateway.Identities
-
Read a PEM format private key.
- readPrivateKey(String) - Static method in class org.hyperledger.fabric.gateway.Identities
-
Read a PEM format private key.
- readX509Certificate(Reader) - Static method in class org.hyperledger.fabric.gateway.Identities
-
Read a PEM format X.509 certificate.
- readX509Certificate(String) - Static method in class org.hyperledger.fabric.gateway.Identities
-
Read a PEM format X.509 certificate.
- remove(String) - Method in interface org.hyperledger.fabric.gateway.spi.WalletStore
-
Remove data from the store.
- remove(String) - Method in interface org.hyperledger.fabric.gateway.Wallet
-
Remove an identity from the wallet.
- removeBlockListener(Consumer<BlockEvent>) - Method in interface org.hyperledger.fabric.gateway.Network
-
Removes a previously added block listener.
- removeCommitListener(CommitListener) - Method in interface org.hyperledger.fabric.gateway.Network
-
Removes a previously added transaction commit listener.
- removeContractListener(Consumer<ContractEvent>) - Method in interface org.hyperledger.fabric.gateway.Contract
-
Remove a previously registered contract listener.
S
- setBlockNumber(long) - Method in interface org.hyperledger.fabric.gateway.spi.Checkpointer
-
Set the current block number.
- setCommitHandler(CommitHandlerFactory) - Method in interface org.hyperledger.fabric.gateway.Transaction
-
Set the commit handler to use for this transaction invocation instead of the default handler configured for the gateway.
- setCommitTimeout(long, TimeUnit) - Method in interface org.hyperledger.fabric.gateway.Transaction
-
Set the maximum length of time to wait for commit events to be received after submitting a transaction to the orderer.
- setEndorsingPeers(Collection<Peer>) - Method in interface org.hyperledger.fabric.gateway.Transaction
-
Set the peers that should be used for endorsement of transaction submitted to the ledger using
Transaction.submit(String...)
. - setProposalResponses(Collection<ProposalResponse>) - Method in exception org.hyperledger.fabric.gateway.ContractException
-
Set the proposal responses received from peer invocations.
- setTransient(Map<String, byte[]>) - Method in interface org.hyperledger.fabric.gateway.Transaction
-
Set transient data that will be passed to the transaction function but will not be stored on the ledger.
- startListening() - Method in interface org.hyperledger.fabric.gateway.spi.CommitHandler
-
Called to initiate listening for transaction events.
- submit(String...) - Method in interface org.hyperledger.fabric.gateway.Transaction
-
Submit a transaction to the ledger.
- submitTransaction(String, String...) - Method in interface org.hyperledger.fabric.gateway.Contract
-
Submit a transaction to the ledger.
T
- toPemString(Certificate) - Static method in class org.hyperledger.fabric.gateway.Identities
-
Converts the argument to a PEM format string.
- toPemString(PrivateKey) - Static method in class org.hyperledger.fabric.gateway.Identities
-
Converts the argument to a PKCS #8 PEM format string.
- Transaction - Interface in org.hyperledger.fabric.gateway
-
A Transaction represents a specific invocation of a transaction function, and provides flexibility over how that transaction is invoked.
U
- UNSET_BLOCK_NUMBER - Static variable in interface org.hyperledger.fabric.gateway.spi.Checkpointer
-
Block number indicating no stored value.
V
- valueOf(String) - Static method in enum org.hyperledger.fabric.gateway.DefaultCommitHandlers
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.hyperledger.fabric.gateway.DefaultQueryHandlers
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.hyperledger.fabric.gateway.DefaultCommitHandlers
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.hyperledger.fabric.gateway.DefaultQueryHandlers
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- waitForEvents(long, TimeUnit) - Method in interface org.hyperledger.fabric.gateway.spi.CommitHandler
-
Block until enough transaction commit events have been received to satisfy the event handling strategy.
- Wallet - Interface in org.hyperledger.fabric.gateway
-
A wallet stores identity information used to connect to a Hyperledger Fabric network.
- Wallets - Class in org.hyperledger.fabric.gateway
-
Factory methods for creating wallets to hold identity information, using various backing stores.
- WalletStore - Interface in org.hyperledger.fabric.gateway.spi
-
Interface for store implementations that provide backing storage for identities in a
Wallet
.
X
- X509Identity - Interface in org.hyperledger.fabric.gateway
-
Identity comprising an X.509 certificate and associated private key.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form