Index (fabric-chaincode-shim 1.4.0 API)

A C D F G H I K L N O P Q R S T V

A

addOrgs(StateBasedEndorsement.RoleType, String...) - Method in class org.hyperledger.fabric.shim.ext.sbe.impl.StateBasedEndorsementImpl
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.

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 in org.hyperledger.fabric.shim: Chaincode.Response status enum.
ChaincodeStub - Interface in org.hyperledger.fabric.shim
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
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.

D

delOrgs(String...) - Method in class org.hyperledger.fabric.shim.ext.sbe.impl.StateBasedEndorsementImpl
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.

F

forCode(int) - Static method in enum org.hyperledger.fabric.shim.Chaincode.Response.Status
forVal(String) - Static method in enum org.hyperledger.fabric.shim.ext.sbe.StateBasedEndorsement.RoleType

G

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
getBinding() - Method in interface org.hyperledger.fabric.shim.ChaincodeStub: Returns the transaction binding.
getChannelId() - Method in interface org.hyperledger.fabric.shim.ChaincodeStub: Returns the channel id for the current proposal.
getCode() - Method in enum org.hyperledger.fabric.shim.Chaincode.Response.Status
getCreator() - Method in interface org.hyperledger.fabric.shim.ChaincodeStub: Returns the identity of the agent (or user) submitting the transaction.
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.
getInstance() - Static method in class org.hyperledger.fabric.shim.ext.sbe.impl.StateBasedEndorsementFactory
getKey() - Method in interface org.hyperledger.fabric.shim.ledger.KeyValue: Returns the state key.
getMessage() - Method in class org.hyperledger.fabric.shim.Chaincode.Response
getMetadata() - Method in interface org.hyperledger.fabric.shim.ledger.QueryResultsIteratorWithMetadata
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
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, 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.
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.
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.
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.
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.
getSignedProposal() - Method in interface org.hyperledger.fabric.shim.ChaincodeStub: Returns the signed transaction proposal currently being executed.
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
getStatusCode() - Method in class org.hyperledger.fabric.shim.Chaincode.Response
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
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.
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.
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 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.

H

hasStatusForCode(int) - Static method in enum org.hyperledger.fabric.shim.Chaincode.Response.Status

I

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.
invoke(ChaincodeStub) - Method in interface org.hyperledger.fabric.shim.Chaincode: Called for every Invoke transaction.
invokeChaincode(String, List<byte[]>, String) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub: Locally calls the specified chaincode invoke() using the same transaction context.
invokeChaincode(String, List<byte[]>) - 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.
invokeChaincodeWithStringArgs(String, List<String>) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub: Invoke another chaincode using the same transaction context.
invokeChaincodeWithStringArgs(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.

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

listOrgs() - Method in class org.hyperledger.fabric.shim.ext.sbe.impl.StateBasedEndorsementImpl
listOrgs() - Method in interface org.hyperledger.fabric.shim.ext.sbe.StateBasedEndorsement: Returns an array of channel orgs that are required to endorse changes

N

NAMESPACE - Static variable in class org.hyperledger.fabric.shim.ledger.CompositeKey
newStateBasedEndorsement(byte[]) - Method in class org.hyperledger.fabric.shim.ext.sbe.impl.StateBasedEndorsementFactory: Constructs a state-based endorsement policy from a given serialized EP byte array.

O

org.hyperledger.fabric.shim - package org.hyperledger.fabric.shim
org.hyperledger.fabric.shim.ext.sbe - package org.hyperledger.fabric.shim.ext.sbe
org.hyperledger.fabric.shim.ext.sbe.impl - package org.hyperledger.fabric.shim.ext.sbe.impl
org.hyperledger.fabric.shim.ledger - package org.hyperledger.fabric.shim.ledger

P

parseCompositeKey(String) - Static method in class org.hyperledger.fabric.shim.ledger.CompositeKey
policy() - Method in class org.hyperledger.fabric.shim.ext.sbe.impl.StateBasedEndorsementImpl
policy() - Method in interface org.hyperledger.fabric.shim.ext.sbe.StateBasedEndorsement: Returns the endorsement policy as bytes
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

Response(Chaincode.Response.Status, String, byte[]) - Constructor for class org.hyperledger.fabric.shim.Chaincode.Response
Response(int, String, byte[]) - Constructor for class org.hyperledger.fabric.shim.Chaincode.Response

S

setEvent(String, byte[]) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub: Defines the CHAINCODE type event that will be posted to interested clients when the chaincode's result is committed to the ledger.
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.
setStateValidationParameter(String, byte[]) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub: Sets the key-level endorsement policy for key.
splitCompositeKey(String) - Method in interface org.hyperledger.fabric.shim.ChaincodeStub: Parses a composite key CompositeKey from a string.
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 in org.hyperledger.fabric.shim.ext.sbe: RoleType of an endorsement policy's identity
StateBasedEndorsementFactory - Class in org.hyperledger.fabric.shim.ext.sbe.impl: Factory for StateBasedEndorsement objects
StateBasedEndorsementFactory() - Constructor for class org.hyperledger.fabric.shim.ext.sbe.impl.StateBasedEndorsementFactory
StateBasedEndorsementImpl - Class in org.hyperledger.fabric.shim.ext.sbe.impl: Implements StateBasedEndorsement
StateBasedEndorsementUtils - Class in org.hyperledger.fabric.shim.ext.sbe.impl: Utility to create Policies.SignaturePolicy and Policies.SignaturePolicyEnvelope
StateBasedEndorsementUtils() - Constructor for class org.hyperledger.fabric.shim.ext.sbe.impl.StateBasedEndorsementUtils

T

toString() - Method in class org.hyperledger.fabric.shim.ledger.CompositeKey

V

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 org.hyperledger.fabric.shim.Chaincode.Response.Status: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.hyperledger.fabric.shim.ext.sbe.StateBasedEndorsement.RoleType: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.hyperledger.fabric.shim.Chaincode.Response.Status: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.hyperledger.fabric.shim.ext.sbe.StateBasedEndorsement.RoleType: Returns an array containing the constants of this enum type, in the order they are declared.

A C D F G H I K L N O P Q R S T V