Index

A B C D E F G H I K L M N O P Q R S T U V 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

addOrgs(StateBasedEndorsement.RoleType, String...) - Method in interface org.hyperledger.fabric.shim.ext.sbe.StateBasedEndorsement
Adds the specified orgs to the list of orgs that are required to endorse.
afterTransaction(Context, Object) - Method in interface org.hyperledger.fabric.contract.ContractInterface
Invoked once after each transaction.
ALL - Enum constant in enum class org.hyperledger.fabric.contract.annotation.Serializer.TARGET
Target all elements.
assertAttributeValue(String, String) - Method in class org.hyperledger.fabric.contract.ClientIdentity
assertAttributeValue verifies that the invoking identity has the attribute named `attrName` with a value of `attrValue`.

B

beforeTransaction(Context) - Method in interface org.hyperledger.fabric.contract.ContractInterface
Invoked once before each transaction.
blockUntilShutdown() - Method in interface org.hyperledger.fabric.shim.GrpcServer
Await termination on the main thread since the grpc library uses daemon threads.
blockUntilShutdown() - Method in class org.hyperledger.fabric.shim.NettyGrpcServer
Waits for the server to become terminated.

C

Chaincode - Interface in org.hyperledger.fabric.shim
Defines methods that all chaincodes must implement.
Chaincode.Response - Class in org.hyperledger.fabric.shim
Wrapper around protobuf Response, contains status, message and payload.
Chaincode.Response.Status - Enum Class in org.hyperledger.fabric.shim
Chaincode.Response status enum.
ChaincodeBase - Class in org.hyperledger.fabric.shim
Abstract implementation of Chaincode.
ChaincodeBase() - Constructor for class org.hyperledger.fabric.shim.ChaincodeBase
 
ChaincodeBase.CCState - Enum Class in org.hyperledger.fabric.shim
Chaincode State.
ChaincodeException - Exception Class in org.hyperledger.fabric.shim
Contracts should use ChaincodeException to indicate when an error occurs in Smart Contract logic.
ChaincodeException() - Constructor for exception class org.hyperledger.fabric.shim.ChaincodeException
Constructs a new ChaincodeException with no detail message.
ChaincodeException(String) - Constructor for exception class org.hyperledger.fabric.shim.ChaincodeException
Constructs a new ChaincodeException with the specified detail message.
ChaincodeException(String, byte[]) - Constructor for exception class org.hyperledger.fabric.shim.ChaincodeException
Constructs a new ChaincodeException with the specified detail message and response payload.
ChaincodeException(String, byte[], Throwable) - Constructor for exception class org.hyperledger.fabric.shim.ChaincodeException
Constructs a new ChaincodeException with the specified detail message, response payload and cause.
ChaincodeException(String, String) - Constructor for exception class org.hyperledger.fabric.shim.ChaincodeException
Constructs a new ChaincodeException with the specified detail message and response payload.
ChaincodeException(String, String, Throwable) - Constructor for exception class org.hyperledger.fabric.shim.ChaincodeException
Constructs a new ChaincodeException with the specified detail message, response payload and cause.
ChaincodeException(String, Throwable) - Constructor for exception class org.hyperledger.fabric.shim.ChaincodeException
Constructs a new ChaincodeException with the specified detail message and cause.
ChaincodeException(Throwable) - Constructor for exception class org.hyperledger.fabric.shim.ChaincodeException
Constructs a new ChaincodeException with the specified cause.
ChaincodeServer - Interface in org.hyperledger.fabric.shim
External chaincode server.
ChaincodeServerProperties - Class in org.hyperledger.fabric.shim
 
ChaincodeServerProperties() - Constructor for class org.hyperledger.fabric.shim.ChaincodeServerProperties
Constructor using default configuration.
ChaincodeServerProperties(int, int, int, int, int, int, int, boolean) - Constructor for class org.hyperledger.fabric.shim.ChaincodeServerProperties
Constructor.
ChaincodeStub - Interface in org.hyperledger.fabric.shim
An object which manages the transaction context, provides access to state variables, and supports calls to other chaincode implementations.
ChatChaincodeWithPeer - Class in org.hyperledger.fabric.shim
 
clientIdentity - Variable in class org.hyperledger.fabric.contract.Context
 
ClientIdentity - Class in org.hyperledger.fabric.contract
ClientIdentity represents information about the identity that submitted a transaction.
ClientIdentity(ChaincodeStub) - Constructor for class org.hyperledger.fabric.contract.ClientIdentity
Creates new ClientIdentity helper.
CompositeKey - Class in org.hyperledger.fabric.shim.ledger
 
CompositeKey(String, String...) - Constructor for class org.hyperledger.fabric.shim.ledger.CompositeKey
 
CompositeKey(String, List<String>) - Constructor for class org.hyperledger.fabric.shim.ledger.CompositeKey
 
Configuration - Search tag in Overview
Section
connect(StreamObserver<ChaincodeMessage>) - Method in class org.hyperledger.fabric.shim.ChatChaincodeWithPeer
Chaincode as a server - peer establishes a connection to the chaincode as a client Currently only supports a stream connection.
connectToPeer() - Method in class org.hyperledger.fabric.shim.ChaincodeBase
 
connectToPeer(StreamObserver<ChaincodeMessage>) - Method in class org.hyperledger.fabric.shim.ChaincodeBase
connect external chaincode to peer for chat.
contact() - Element in annotation interface org.hyperledger.fabric.contract.annotation.Info
Contact object that can be populated with email, name and url fields.
Contact - Annotation Interface in org.hyperledger.fabric.contract.annotation
Class level annotation that identifies this class as being a contact.
Context - Class in org.hyperledger.fabric.contract
This context is available to all 'transaction functions' and provides the transaction context.
Context(ChaincodeStub) - Constructor for class org.hyperledger.fabric.contract.Context
Creates new client identity and sets it as a property of the stub.
Contract - Annotation Interface in org.hyperledger.fabric.contract.annotation
Class level annotation that identifies this class as being a contract.
ContractInterface - Interface in org.hyperledger.fabric.contract
All Contracts should implement this interface, in addition to the Contract annotation.
CORE_CHAINCODE_LOGGING_LEVEL - Static variable in class org.hyperledger.fabric.shim.ChaincodeBase
 
CORE_CHAINCODE_LOGGING_SHIM - Static variable in class org.hyperledger.fabric.shim.ChaincodeBase
 
createCompositeKey(String, String...) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Given a set of attributes, this method combines these attributes to return a composite key.
createContext(ChaincodeStub) - Method in interface org.hyperledger.fabric.contract.ContractInterface
Create context from ChaincodeStub.
CREATED - Enum constant in enum class org.hyperledger.fabric.shim.ChaincodeBase.CCState
 
createInterceptor() - Method in interface org.hyperledger.fabric.traces.TracesProvider
Creates an interceptor of gRPC messages that can be injected in processing incoming messages to extract trace information.
createSpan(ChaincodeStub) - Method in interface org.hyperledger.fabric.traces.TracesProvider
Creates a span with metadata of the current chaincode execution, possibly linked to the execution arguments.

D

DataType - Annotation Interface in org.hyperledger.fabric.contract.annotation
Class level annotation indicating this class represents one of the complex types that can be returned or passed to the transaction functions.
debug(String) - Method in class org.hyperledger.fabric.Logger
 
debug(Supplier<String>) - Method in class org.hyperledger.fabric.Logger
 
Default - Annotation Interface in org.hyperledger.fabric.contract.annotation
Default Contract.
DEFAULT_HOST - Static variable in class org.hyperledger.fabric.shim.ChaincodeBase
 
DEFAULT_MAX_INBOUND_MESSAGE_SIZE - Static variable in class org.hyperledger.fabric.shim.ChaincodeBase
Default to 100MB for maximum inbound grpc message size.
DEFAULT_PORT - Static variable in class org.hyperledger.fabric.shim.ChaincodeBase
 
delOrgs(String...) - Method in interface org.hyperledger.fabric.shim.ext.sbe.StateBasedEndorsement
deletes the specified channel orgs from the existing key-level endorsement policy for this KVS key.
delPrivateData(String, String) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Records the specified key to be deleted in the private writeset of the transaction.
delState(String) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Records the specified key to be deleted in the writeset of the transaction proposal.
description() - Element in annotation interface org.hyperledger.fabric.contract.annotation.Info
 

E

email() - Element in annotation interface org.hyperledger.fabric.contract.annotation.Contact
 
error(String) - Method in class org.hyperledger.fabric.Logger
 
error(Supplier<String>) - Method in class org.hyperledger.fabric.Logger
 
ERROR_THRESHOLD - Enum constant in enum class org.hyperledger.fabric.shim.Chaincode.Response.Status
Minimum threshold for as error status code.
ESTABLISHED - Enum constant in enum class org.hyperledger.fabric.shim.ChaincodeBase.CCState
 
EVALUATE - Enum constant in enum class org.hyperledger.fabric.contract.annotation.Transaction.TYPE
Transaction is evaluated to query information from the ledger.

F

forCode(int) - Static method in enum class org.hyperledger.fabric.shim.Chaincode.Response.Status
Get a status object for a given status code.
formatError(Throwable) - Method in class org.hyperledger.fabric.Logger
 
formatError(Throwable) - Static method in class org.hyperledger.fabric.Logging
Formats a Throwable to a string with details of all the causes.
forVal(String) - Static method in enum class org.hyperledger.fabric.shim.ext.sbe.StateBasedEndorsement.RoleType
 

G

getActiveCount() - Method in interface org.hyperledger.fabric.metrics.TaskMetricsCollector
Currently executing threads.
getArgs() - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Returns the arguments corresponding to the call to Chaincode.init(ChaincodeStub) or Chaincode.invoke(ChaincodeStub), each argument represented as byte array.
getAttributes() - Method in class org.hyperledger.fabric.shim.ledger.CompositeKey
 
getAttributeValue(String) - Method in class org.hyperledger.fabric.contract.ClientIdentity
getAttributeValue returns the value of the client's attribute named `attrName`.
getBinding() - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Returns the transaction binding.
getChaincodeConfig() - Method in class org.hyperledger.fabric.shim.ChaincodeBase
Obtains configuration specifically for running the chaincode and settable on a per chaincode basis rather than taking properties from the Peers' configuration.
getChaincodeServerConfig() - Method in class org.hyperledger.fabric.shim.ChaincodeBase
The properties for starting as chaincode-as-a-service.
getChannelId() - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Returns the channel id for the current proposal.
getClientIdentity() - Method in class org.hyperledger.fabric.contract.Context
 
getCode() - Method in enum class org.hyperledger.fabric.shim.Chaincode.Response.Status
Get the status code associated with this status object.
getCorePoolSize() - Method in interface org.hyperledger.fabric.metrics.TaskMetricsCollector
Gets the core (minimum) pool size.
getCreator() - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Returns the identity of the agent (or user) submitting the transaction.
getCurrentQueueCount() - Method in interface org.hyperledger.fabric.metrics.TaskMetricsCollector
Currently waiting tasks; should not be a higher number.
getCurrentTaskCount() - Method in interface org.hyperledger.fabric.metrics.TaskMetricsCollector
Currently executing tasks.
getEvent() - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Returns the CHAINCODE type event that will be posted to interested clients when the chaincode's result is committed to the ledger.
getFunction() - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
A convenience method that returns the first argument of the chaincode invocation for use as a function name.
getHistoryForKey(String) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Returns a history of key values across time.
getId() - Method in class org.hyperledger.fabric.contract.ClientIdentity
getId returns the ID associated with the invoking identity.
getKeepAliveTimeMinutes() - Method in class org.hyperledger.fabric.shim.ChaincodeServerProperties
The delay before the server sends a keep-alive.
getKeepAliveTimeoutSeconds() - Method in class org.hyperledger.fabric.shim.ChaincodeServerProperties
The timeout for a keep-alive ping requests.
getKey() - Method in interface org.hyperledger.fabric.shim.ledger.KeyValue
Returns the state key.
getKeyCertChainFile() - Method in class org.hyperledger.fabric.shim.ChaincodeServerProperties
Server keychain file name.
getKeyFile() - Method in class org.hyperledger.fabric.shim.ChaincodeServerProperties
Server key file name.
getKeyPassword() - Method in class org.hyperledger.fabric.shim.ChaincodeServerProperties
Password used to access the server key.
getLargestPoolSize() - Method in interface org.hyperledger.fabric.metrics.TaskMetricsCollector
Gets the largest pool size so far.
getLogger(Class<?>) - Static method in class org.hyperledger.fabric.Logger
 
getLogger(String) - Static method in class org.hyperledger.fabric.Logger
 
getMaxConnectionAgeSeconds() - Method in class org.hyperledger.fabric.shim.ChaincodeServerProperties
The maximum connection age.
getMaximumPoolSize() - Method in interface org.hyperledger.fabric.metrics.TaskMetricsCollector
Gets the upper limit pool size.
getMaxInboundMessageSize() - Method in class org.hyperledger.fabric.shim.ChaincodeServerProperties
The maximum message size allowed to be received by the server.
getMaxInboundMetadataSize() - Method in class org.hyperledger.fabric.shim.ChaincodeServerProperties
The maximum size of metadata allowed to be received.
getMessage() - Method in class org.hyperledger.fabric.shim.Chaincode.Response
Get the response message.
getMetadata() - Method in interface org.hyperledger.fabric.shim.ledger.QueryResultsIteratorWithMetadata
 
getMspId() - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Get the MSPID of the peer that started this chaincode.
getMSPID() - Method in class org.hyperledger.fabric.contract.ClientIdentity
getMSPID returns the MSP ID of the invoking identity.
getObjectType() - Method in class org.hyperledger.fabric.shim.ledger.CompositeKey
 
getParameters() - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
A convenience method that returns all except the first argument of the chaincode invocation for use as the parameters to the function returned by #ChaincodeStub.getFunction().
getPayload() - Method in class org.hyperledger.fabric.shim.Chaincode.Response
Get the response payload.
getPayload() - Method in exception class org.hyperledger.fabric.shim.ChaincodeException
Returns the response payload or null if there is no response.
getPermitKeepAliveTimeMinutes() - Method in class org.hyperledger.fabric.shim.ChaincodeServerProperties
The most aggressive keep-alive time clients are permitted to configure.
getPermitKeepAliveWithoutCalls() - Method in class org.hyperledger.fabric.shim.ChaincodeServerProperties
Whether clients are allowed to send keep-alive HTTP/2 PINGs even if there are no outstanding RPCs on the connection.
getPoolSize() - Method in interface org.hyperledger.fabric.metrics.TaskMetricsCollector
Gets the current size of the pool.
getPrivateData(String, String) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Returns the value of the specified key from the specified collection.
getPrivateDataByPartialCompositeKey(String, String) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Returns all existing keys, and their values, that are prefixed by the specified partial CompositeKey in a given private collection.
getPrivateDataByPartialCompositeKey(String, String, String...) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Returns all existing keys, and their values, that are prefixed by the specified partial CompositeKey in a given private collection.
getPrivateDataByPartialCompositeKey(String, CompositeKey) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Returns all existing keys, and their values, that are prefixed by the specified partial CompositeKey in a given private collection.
getPrivateDataByRange(String, String, String) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Returns all existing keys, and their values, that are lexicographically between startkey (inclusive) and the endKey (exclusive) in a given private collection.
getPrivateDataHash(String, String) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
 
getPrivateDataQueryResult(String, String) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Perform a rich query against a given private collection.
getPrivateDataUTF8(String, String) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Returns the byte array value specified by the key and decoded as a UTF-8 encoded string, from the sidedb collection.
getPrivateDataValidationParameter(String, String) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Retrieves the key-level endorsement policy for the private data specified by key.
getProvider() - Static method in class org.hyperledger.fabric.metrics.Metrics
 
getProvider() - Static method in class org.hyperledger.fabric.traces.Traces
 
getQueryResult(String) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Performs a "rich" query against a state database.
getQueryResultWithPagination(String, int, String) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Performs a "rich" query against a state database.
getServerAddress() - Method in class org.hyperledger.fabric.shim.ChaincodeServerProperties
Get the server socket address.
getSignedProposal() - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Returns the signed transaction proposal currently being executed.
getState() - Method in class org.hyperledger.fabric.shim.ChaincodeBase
 
getState(String) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Returns the value of the specified key from the ledger.
getStateByPartialCompositeKey(String) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Returns all existing keys, and their values, that are prefixed by the specified partial CompositeKey.
getStateByPartialCompositeKey(String, String...) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Returns all existing keys, and their values, that are prefixed by the specified partial CompositeKey.
getStateByPartialCompositeKey(CompositeKey) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Returns all existing keys, and their values, that are prefixed by the specified partial CompositeKey.
getStateByPartialCompositeKeyWithPagination(CompositeKey, int, String) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Queries the state in the ledger based on a given partial composite key.
getStateByRange(String, String) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Returns all existing keys, and their values, that are lexicographically between startkey (inclusive) and the endKey (exclusive).
getStateByRangeWithPagination(String, String, int, String) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Returns a range iterator over a set of keys in the ledger.
getStateValidationParameter(String) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
retrieves the key-level endorsement policy for key.
getStatus() - Method in class org.hyperledger.fabric.shim.Chaincode.Response
Get the response status.
getStatusCode() - Method in class org.hyperledger.fabric.shim.Chaincode.Response
Get the response status code.
getStringArgs() - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Returns the arguments corresponding to the call to Chaincode.init(ChaincodeStub) or Chaincode.invoke(ChaincodeStub), cast to UTF-8 string.
getStringPayload() - Method in class org.hyperledger.fabric.shim.Chaincode.Response
Get the response payload as a UTF-8 string.
getStringState(String) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Returns the byte array value specified by the key and decoded as a UTF-8 encoded string, from the ledger.
getStringValue() - Method in interface org.hyperledger.fabric.shim.ledger.KeyModification
Returns the key's value at the time returned by KeyModification.getTimestamp(), decoded as a UTF-8 string.
getStringValue() - Method in interface org.hyperledger.fabric.shim.ledger.KeyValue
Returns the state value, decoded as a UTF-8 string.
getStub() - Method in class org.hyperledger.fabric.contract.Context
 
getTimestamp() - Method in interface org.hyperledger.fabric.shim.ledger.KeyModification
Returns the timestamp of the key modification entry.
getTransient() - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Returns the transient map associated with the current transaction.
getTrustCertCollectionFile() - Method in class org.hyperledger.fabric.shim.ChaincodeServerProperties
Server trust certificate collection file name.
getTxId() - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Returns the transaction id for the current chaincode invocation request.
getTxId() - Method in interface org.hyperledger.fabric.shim.ledger.KeyModification
Returns the transaction id.
getTxTimestamp() - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Returns the timestamp when the transaction was created.
getVal() - Method in enum class org.hyperledger.fabric.shim.ext.sbe.StateBasedEndorsement.RoleType
 
getValue() - Method in interface org.hyperledger.fabric.shim.ledger.KeyModification
Returns the key's value at the time returned by KeyModification.getTimestamp().
getValue() - Method in interface org.hyperledger.fabric.shim.ledger.KeyValue
Returns the state value.
getX509Certificate() - Method in class org.hyperledger.fabric.contract.ClientIdentity
getX509Certificate returns the X509 certificate associated with the invoking identity, or null if it was not identified by an X509 certificate, for instance if the MSP is implemented with an alternative to PKI such as [Identity Mixer](https://jira.hyperledger.org/browse/FAB-5673).
GrpcServer - Interface in org.hyperledger.fabric.shim
Common interface for grpc server.

H

hasStatusForCode(int) - Static method in enum class org.hyperledger.fabric.shim.Chaincode.Response.Status
Whether a status exists for a given status code.

I

info() - Element in annotation interface org.hyperledger.fabric.contract.annotation.Contract
The Info object can be supplied to provide additional information about the contract.
Info - Annotation Interface in org.hyperledger.fabric.contract.annotation
Info Details
init(ChaincodeStub) - Method in interface org.hyperledger.fabric.shim.Chaincode
Called during an instantiate transaction after the container has been established, allowing the chaincode to initialize its internal data.
init(ChaincodeStub) - Method in class org.hyperledger.fabric.shim.ChaincodeBase
 
initialize(Properties) - Static method in class org.hyperledger.fabric.metrics.Metrics
 
initialize(Properties) - Method in interface org.hyperledger.fabric.metrics.MetricsProvider
Initialize method that is called immediately after creation.
initialize(Properties) - Static method in class org.hyperledger.fabric.traces.Traces
 
initialize(Properties) - Method in interface org.hyperledger.fabric.traces.TracesProvider
Initialize method that is called immediately after creation.
initializeLogging() - Method in class org.hyperledger.fabric.shim.ChaincodeBase
 
intent() - Element in annotation interface org.hyperledger.fabric.contract.annotation.Transaction
What are submit semantics for this transaction.
INTERNAL_SERVER_ERROR - Enum constant in enum class org.hyperledger.fabric.shim.Chaincode.Response.Status
Server-side error status.
invoke(ChaincodeStub) - Method in interface org.hyperledger.fabric.shim.Chaincode
Called for every Invoke transaction.
invoke(ChaincodeStub) - Method in class org.hyperledger.fabric.shim.ChaincodeBase
 
invokeChaincode(String, List<byte[]>) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Invoke another chaincode using the same transaction context.
invokeChaincode(String, List<byte[]>, String) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Locally calls the specified chaincode invoke() using the same transaction context.
invokeChaincodeWithStringArgs(String, String...) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Invoke another chaincode using the same transaction context.
invokeChaincodeWithStringArgs(String, List<String>) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Invoke another chaincode using the same transaction context.
invokeChaincodeWithStringArgs(String, List<String>, String) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Invoke another chaincode using the same transaction context.
isDeleted() - Method in interface org.hyperledger.fabric.shim.ledger.KeyModification
Returns the deletion marker.
isPermitKeepAliveWithoutCalls() - Method in class org.hyperledger.fabric.shim.ChaincodeServerProperties
Whether clients are allowed to send keep-alive HTTP/2 PINGs even if there are no outstanding RPCs on the connection.
isServer() - Method in class org.hyperledger.fabric.shim.ChaincodeBase
Use the CHAINCODE_SERVER_ADDRESS as the key to swap mode.
isTlsEnabled() - Method in class org.hyperledger.fabric.shim.ChaincodeServerProperties
Whether TLS is enabled for the server.

K

KeyModification - Interface in org.hyperledger.fabric.shim.ledger
QueryResult for history query.
KeyValue - Interface in org.hyperledger.fabric.shim.ledger
Query Result associating a state key with a value.

L

license() - Element in annotation interface org.hyperledger.fabric.contract.annotation.Info
License object that can be populated to include name and url.
License - Annotation Interface in org.hyperledger.fabric.contract.annotation
Class level annotation that identifies this class as being a license object.
listOrgs() - Method in interface org.hyperledger.fabric.shim.ext.sbe.StateBasedEndorsement
Returns an array of channel orgs that are required to endorse changes.
Logger - Class in org.hyperledger.fabric
Logger class to use throughout the Contract Implementation.
Logger(String) - Constructor for class org.hyperledger.fabric.Logger
 
Logging - Class in org.hyperledger.fabric
Assistance class to use when logging.

M

Metrics - Class in org.hyperledger.fabric.metrics
Metrics Interface.
MetricsProvider - Interface in org.hyperledger.fabric.metrics
Interface to be implemented to send metrics on the chaincode to the 'backend-of-choice'.

N

name() - Element in annotation interface org.hyperledger.fabric.contract.annotation.Contact
 
name() - Element in annotation interface org.hyperledger.fabric.contract.annotation.Contract
Contract name.
name() - Element in annotation interface org.hyperledger.fabric.contract.annotation.License
 
name() - Element in annotation interface org.hyperledger.fabric.contract.annotation.Transaction
The name of the callable transaction if it should be different to the method name.
namespace() - Element in annotation interface org.hyperledger.fabric.contract.annotation.DataType
Namespace of the type.
NAMESPACE - Static variable in class org.hyperledger.fabric.shim.ledger.CompositeKey
 
NettyChaincodeServer - Class in org.hyperledger.fabric.shim
 
NettyChaincodeServer(ChaincodeBase, ChaincodeServerProperties) - Constructor for class org.hyperledger.fabric.shim.NettyChaincodeServer
configure and init server.
NettyGrpcServer - Class in org.hyperledger.fabric.shim
implementation grpc server with NettyGrpcServer.
NettyGrpcServer(ChaincodeBase, ChaincodeServerProperties) - Constructor for class org.hyperledger.fabric.shim.NettyGrpcServer
init netty grpc server.
newChannelBuilder() - Method in class org.hyperledger.fabric.shim.ChaincodeBase
create NettyChannel for host:port with tls if tlsEnabled.
newErrorResponse() - Static method in class org.hyperledger.fabric.shim.ChaincodeBase
Deprecated.
newErrorResponse() - Static method in class org.hyperledger.fabric.shim.ResponseUtils
 
newErrorResponse(byte[]) - Static method in class org.hyperledger.fabric.shim.ChaincodeBase
Deprecated.
newErrorResponse(byte[]) - Static method in class org.hyperledger.fabric.shim.ResponseUtils
 
newErrorResponse(String) - Static method in class org.hyperledger.fabric.shim.ChaincodeBase
Deprecated.
newErrorResponse(String) - Static method in class org.hyperledger.fabric.shim.ResponseUtils
 
newErrorResponse(String, byte[]) - Static method in class org.hyperledger.fabric.shim.ChaincodeBase
Deprecated.
newErrorResponse(String, byte[]) - Static method in class org.hyperledger.fabric.shim.ResponseUtils
 
newErrorResponse(Throwable) - Static method in class org.hyperledger.fabric.shim.ChaincodeBase
Deprecated.
newErrorResponse(Throwable) - Static method in class org.hyperledger.fabric.shim.ResponseUtils
 
newSuccessResponse() - Static method in class org.hyperledger.fabric.shim.ChaincodeBase
Deprecated.
newSuccessResponse() - Static method in class org.hyperledger.fabric.shim.ResponseUtils
 
newSuccessResponse(byte[]) - Static method in class org.hyperledger.fabric.shim.ChaincodeBase
Deprecated.
newSuccessResponse(byte[]) - Static method in class org.hyperledger.fabric.shim.ResponseUtils
 
newSuccessResponse(String) - Static method in class org.hyperledger.fabric.shim.ChaincodeBase
Deprecated.
newSuccessResponse(String) - Static method in class org.hyperledger.fabric.shim.ResponseUtils
 
newSuccessResponse(String, byte[]) - Static method in class org.hyperledger.fabric.shim.ChaincodeBase
Deprecated.
newSuccessResponse(String, byte[]) - Static method in class org.hyperledger.fabric.shim.ResponseUtils
 

O

Open Telemetry - Search tag in Overview
Section
org.hyperledger.fabric - package org.hyperledger.fabric
Provides logging classes.
org.hyperledger.fabric.contract - package org.hyperledger.fabric.contract
Provides interfaces and classes to support the contract programming model.
org.hyperledger.fabric.contract.annotation - package org.hyperledger.fabric.contract.annotation
Provides annotations required for Contract implementations.
org.hyperledger.fabric.metrics - package org.hyperledger.fabric.metrics
Provides interfaces and classes to support collection of metrics.
org.hyperledger.fabric.shim - package org.hyperledger.fabric.shim
Provides interfaces and classes required for chaincode development and state variable access.
org.hyperledger.fabric.shim.ext.sbe - package org.hyperledger.fabric.shim.ext.sbe
Provides an interface for creating and modifying state-based endorsement policies.
org.hyperledger.fabric.shim.ledger - package org.hyperledger.fabric.shim.ledger
Provides interfaces and classes for querying state variables.
org.hyperledger.fabric.traces - package org.hyperledger.fabric.traces
Supports collection of traces

P

parseCompositeKey(String) - Static method in class org.hyperledger.fabric.shim.ledger.CompositeKey
 
PERFLOGGER - Static variable in class org.hyperledger.fabric.Logging
Name of the Performance logger.
policy() - Method in interface org.hyperledger.fabric.shim.ext.sbe.StateBasedEndorsement
Get the endorsement policy as bytes.
processCommandLineOptions(String[]) - Method in class org.hyperledger.fabric.shim.ChaincodeBase
 
processEnvironmentOptions() - Method in class org.hyperledger.fabric.shim.ChaincodeBase
set fields from env.
Property - Annotation Interface in org.hyperledger.fabric.contract.annotation
Field and parameter level annotation defining a property of the class.
purgePrivateData(String, String) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Reqauests purging of the specified key to be from the private data stores.
putPrivateData(String, String, byte[]) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Puts the specified key and value into the transaction's private writeset.
putPrivateData(String, String, String) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Writes the specified value and key into the sidedb collection value converted to byte array.
putState(String, byte[]) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Puts the specified key and value into the transaction's writeset as a data-write proposal.
putStringState(String, String) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Writes the specified value and key into the ledger.

Q

QueryResultsIterator<T> - Interface in org.hyperledger.fabric.shim.ledger
QueryResultsIterator allows a chaincode to iterate over a set of key/value pairs returned by range, execute and history queries.
QueryResultsIteratorWithMetadata<T> - Interface in org.hyperledger.fabric.shim.ledger
QueryResultsIteratorWithMetadata allows a chaincode to iterate over a set of key/value pairs returned by range, execute and history queries.

R

READY - Enum constant in enum class org.hyperledger.fabric.shim.ChaincodeBase.CCState
 
Response(int, String, byte[]) - Constructor for class org.hyperledger.fabric.shim.Chaincode.Response
Constructor.
Response(Chaincode.Response.Status, String, byte[]) - Constructor for class org.hyperledger.fabric.shim.Chaincode.Response
Constructor.
ResponseUtils - Class in org.hyperledger.fabric.shim
 
RoleTypeMember - Enum constant in enum class org.hyperledger.fabric.shim.ext.sbe.StateBasedEndorsement.RoleType
RoleTypeMember identifies an org's member identity.
RoleTypePeer - Enum constant in enum class org.hyperledger.fabric.shim.ext.sbe.StateBasedEndorsement.RoleType
RoleTypePeer identifies an org's peer identity.

S

schema() - Element in annotation interface org.hyperledger.fabric.contract.annotation.Property
Allows each property to be defined a detail set of rules to determine the valid types of this data.
Serializer - Annotation Interface in org.hyperledger.fabric.contract.annotation
Class level annotation that defines the serializer that should be used to convert objects to and from the wire format.
Serializer.TARGET - Enum Class in org.hyperledger.fabric.contract.annotation
What is this serializer able to target?
setEvent(String, byte[]) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Allows the chaincode to propose an event on the transaction proposal response.
setKeepAliveTimeMinutes(int) - Method in class org.hyperledger.fabric.shim.ChaincodeServerProperties
Set the delay before the server sends a keep-alive.
setKeepAliveTimeoutSeconds(int) - Method in class org.hyperledger.fabric.shim.ChaincodeServerProperties
Set the timeout for keep-alive ping requests.
setKeyCertChainFile(String) - Method in class org.hyperledger.fabric.shim.ChaincodeServerProperties
Set the server keychain file name.
setKeyFile(String) - Method in class org.hyperledger.fabric.shim.ChaincodeServerProperties
Set the server key file name.
setKeyPassword(String) - Method in class org.hyperledger.fabric.shim.ChaincodeServerProperties
Set the password used to access the server key.
setLogLevel(String) - Static method in class org.hyperledger.fabric.Logging
Sets the log level to the the.
setMaxConnectionAgeSeconds(int) - Method in class org.hyperledger.fabric.shim.ChaincodeServerProperties
Specify a maximum connection age.
setMaxInboundMessageSize(int) - Method in class org.hyperledger.fabric.shim.ChaincodeServerProperties
Sets the maximum message size allowed to be received by the server.
setMaxInboundMetadataSize(int) - Method in class org.hyperledger.fabric.shim.ChaincodeServerProperties
Sets the maximum metadata size allowed to be received by the server.
setPermitKeepAliveTimeMinutes(int) - Method in class org.hyperledger.fabric.shim.ChaincodeServerProperties
Specify the most aggressive keep-alive time clients are permitted to configure.
setPermitKeepAliveWithoutCalls(boolean) - Method in class org.hyperledger.fabric.shim.ChaincodeServerProperties
Specify whether clients are allowed to send keep-alive HTTP/2 PINGs even if there are no outstanding RPCs on the connection.
setPrivateDataValidationParameter(String, String, byte[]) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Sets the key-level endorsement policy for the private data specified by key.
setServerAddress(SocketAddress) - Method in class org.hyperledger.fabric.shim.ChaincodeServerProperties
Set the server socket address.
setState(ChaincodeBase.CCState) - Method in class org.hyperledger.fabric.shim.ChaincodeBase
 
setStateValidationParameter(String, byte[]) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Sets the key-level endorsement policy for key.
setTaskMetricsCollector(TaskMetricsCollector) - Method in interface org.hyperledger.fabric.metrics.MetricsProvider
Pass a reference to this task service for information gathering.
setTlsEnabled(boolean) - Method in class org.hyperledger.fabric.shim.ChaincodeServerProperties
Set whether TLS is enabled for the server.
setTrustCertCollectionFile(String) - Method in class org.hyperledger.fabric.shim.ChaincodeServerProperties
Set the server trust certificate collection file name.
splitCompositeKey(String) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub
Parses a composite key CompositeKey from a string.
start() - Method in interface org.hyperledger.fabric.shim.ChaincodeServer
run external chaincode server.
start() - Method in interface org.hyperledger.fabric.shim.GrpcServer
start grpc server.
start() - Method in class org.hyperledger.fabric.shim.NettyChaincodeServer
run external chaincode server.
start() - Method in class org.hyperledger.fabric.shim.NettyGrpcServer
start grpc server.
start(String[]) - Method in class org.hyperledger.fabric.shim.ChaincodeBase
Start chaincode.
StateBasedEndorsement - Interface in org.hyperledger.fabric.shim.ext.sbe
StateBasedEndorsement provides a set of convenience methods to create and modify a state-based endorsement policy.
StateBasedEndorsement.RoleType - Enum Class in org.hyperledger.fabric.shim.ext.sbe
RoleType of an endorsement policy's identity.
stop() - Method in interface org.hyperledger.fabric.shim.ChaincodeServer
shutdown now grpc server.
stop() - Method in interface org.hyperledger.fabric.shim.GrpcServer
shutdown now grpc server.
stop() - Method in class org.hyperledger.fabric.shim.NettyChaincodeServer
shutdown now grpc server.
stop() - Method in class org.hyperledger.fabric.shim.NettyGrpcServer
shutdown now grpc server.
stub - Variable in class org.hyperledger.fabric.contract.Context
 
submit() - Element in annotation interface org.hyperledger.fabric.contract.annotation.Transaction
Deprecated.
Please use intent
SUBMIT - Enum constant in enum class org.hyperledger.fabric.contract.annotation.Transaction.TYPE
Transaction is used to submit updates to the ledger.
SUCCESS - Enum constant in enum class org.hyperledger.fabric.shim.Chaincode.Response.Status
Successful response status.

T

target() - Element in annotation interface org.hyperledger.fabric.contract.annotation.Serializer
 
TaskMetricsCollector - Interface in org.hyperledger.fabric.metrics
Collect metrics relating to the task execution.
termsOfService() - Element in annotation interface org.hyperledger.fabric.contract.annotation.Info
 
title() - Element in annotation interface org.hyperledger.fabric.contract.annotation.Info
 
toJsonString(ChaincodeMessage) - Static method in class org.hyperledger.fabric.shim.ChaincodeBase
Debug Message.
toString() - Method in class org.hyperledger.fabric.shim.ledger.CompositeKey
 
Traces - Class in org.hyperledger.fabric.traces
Traces Interface.
TracesProvider - Interface in org.hyperledger.fabric.traces
Interface to be implemented to send traces on the chaincode to the 'backend-of-choice'.
Transaction - Annotation Interface in org.hyperledger.fabric.contract.annotation
Method level annotation indicating the method to be a callable transaction function.
TRANSACTION - Enum constant in enum class org.hyperledger.fabric.contract.annotation.Serializer.TARGET
Target transaction functions.
Transaction.TYPE - Enum Class in org.hyperledger.fabric.contract.annotation
The intended invocation style for a transaction function.
transactionSerializer() - Element in annotation interface org.hyperledger.fabric.contract.annotation.Contract
Transaction Serializer Classname.

U

unknownTransaction(Context) - Method in interface org.hyperledger.fabric.contract.ContractInterface
Invoked for any transaction that does not exist.
url() - Element in annotation interface org.hyperledger.fabric.contract.annotation.Contact
 
url() - Element in annotation interface org.hyperledger.fabric.contract.annotation.License
 

V

validate() - Method in class org.hyperledger.fabric.shim.ChaincodeServerProperties
Check that all the server property values are valid.
validateOptions() - Method in class org.hyperledger.fabric.shim.ChaincodeBase
Validate init parameters from env chaincode base.
validateSimpleKeys(String...) - Static method in class org.hyperledger.fabric.shim.ledger.CompositeKey
To ensure that simple keys do not go into composite key namespace, we validate simple key to check whether the key starts with 0x00 (which is the namespace for compositeKey).
valueOf(String) - Static method in enum class org.hyperledger.fabric.contract.annotation.Serializer.TARGET
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.hyperledger.fabric.contract.annotation.Transaction.TYPE
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.hyperledger.fabric.shim.Chaincode.Response.Status
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.hyperledger.fabric.shim.ChaincodeBase.CCState
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.hyperledger.fabric.shim.ext.sbe.StateBasedEndorsement.RoleType
Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.hyperledger.fabric.contract.annotation.Serializer.TARGET
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.hyperledger.fabric.contract.annotation.Transaction.TYPE
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.hyperledger.fabric.shim.Chaincode.Response.Status
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.hyperledger.fabric.shim.ChaincodeBase.CCState
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.hyperledger.fabric.shim.ext.sbe.StateBasedEndorsement.RoleType
Returns an array containing the constants of this enum class, in the order they are declared.
version() - Element in annotation interface org.hyperledger.fabric.contract.annotation.Info
 
A B C D E F G H I K L M N O P Q R S T U V 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form