org.hyperledger.fabric.protos.common

Class ConfigEnvelope

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.hyperledger.fabric.protos.common.ConfigEnvelope

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, ConfigEnvelopeOrBuilder

public final class ConfigEnvelope
extends com.google.protobuf.GeneratedMessageV3
implements ConfigEnvelopeOrBuilder

 ConfigEnvelope is designed to contain _all_ configuration for a chain with no dependency
 on previous configuration transactions.
 It is generated with the following scheme:
   1. Retrieve the existing configuration
   2. Note the config properties (ConfigValue, ConfigPolicy, ConfigGroup) to be modified
   3. Add any intermediate ConfigGroups to the ConfigUpdate.read_set (sparsely)
   4. Add any additional desired dependencies to ConfigUpdate.read_set (sparsely)
   5. Modify the config properties, incrementing each version by 1, set them in the ConfigUpdate.write_set
      Note: any element not modified but specified should already be in the read_set, so may be specified sparsely
   6. Create ConfigUpdate message and marshal it into ConfigUpdateEnvelope.update and encode the required signatures
     a) Each signature is of type ConfigSignature
     b) The ConfigSignature signature is over the concatenation of signature_header and the ConfigUpdate bytes (which includes a ChainHeader)
   5. Submit new Config for ordering in Envelope signed by submitter
     a) The Envelope Payload has data set to the marshaled ConfigEnvelope
     b) The Envelope Payload has a header of type Header.Type.CONFIG_UPDATE
 The configuration manager will verify:
   1. All items in the read_set exist at the read versions
   2. All items in the write_set at a different version than, or not in, the read_set have been appropriately signed according to their mod_policy
   3. The new configuration satisfies the ConfigSchema
 

Protobuf type common.ConfigEnvelope

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigEnvelope.Builder ConfigEnvelope is designed to contain _all_ configuration for a chain with no dependency on previous configuration transactions.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONFIG_FIELD_NUMBER
static int	LAST_UPDATE_FIELD_NUMBER

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Config	getConfig() A marshaled Config structure
ConfigOrBuilder	getConfigOrBuilder() A marshaled Config structure
static ConfigEnvelope	getDefaultInstance()
ConfigEnvelope	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Envelope	getLastUpdate() The last CONFIG_UPDATE message which generated this current configuration
EnvelopeOrBuilder	getLastUpdateOrBuilder() The last CONFIG_UPDATE message which generated this current configuration
com.google.protobuf.Parser<ConfigEnvelope>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasConfig() A marshaled Config structure
int	hashCode()
boolean	hasLastUpdate() The last CONFIG_UPDATE message which generated this current configuration
boolean	isInitialized()
static ConfigEnvelope.Builder	newBuilder()
static ConfigEnvelope.Builder	newBuilder(ConfigEnvelope prototype)
ConfigEnvelope.Builder	newBuilderForType()
static ConfigEnvelope	parseDelimitedFrom(InputStream input)
static ConfigEnvelope	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ConfigEnvelope	parseFrom(byte[] data)
static ConfigEnvelope	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ConfigEnvelope	parseFrom(ByteBuffer data)
static ConfigEnvelope	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ConfigEnvelope	parseFrom(com.google.protobuf.ByteString data)
static ConfigEnvelope	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ConfigEnvelope	parseFrom(com.google.protobuf.CodedInputStream input)
static ConfigEnvelope	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ConfigEnvelope	parseFrom(InputStream input)
static ConfigEnvelope	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ConfigEnvelope>	parser()
ConfigEnvelope.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

CONFIG_FIELD_NUMBER

public static final int CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

LAST_UPDATE_FIELD_NUMBER

public static final int LAST_UPDATE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

hasConfig

public boolean hasConfig()

 A marshaled Config structure
 

.common.Config config = 1 [json_name = "config"];

Specified by:

hasConfig in interface ConfigEnvelopeOrBuilder

Returns:

Whether the config field is set.

getConfig

public Config getConfig()

 A marshaled Config structure
 

.common.Config config = 1 [json_name = "config"];

Specified by:

getConfig in interface ConfigEnvelopeOrBuilder

Returns:

The config.

getConfigOrBuilder

public ConfigOrBuilder getConfigOrBuilder()

 A marshaled Config structure
 

.common.Config config = 1 [json_name = "config"];

Specified by:

getConfigOrBuilder in interface ConfigEnvelopeOrBuilder

hasLastUpdate

public boolean hasLastUpdate()

 The last CONFIG_UPDATE message which generated this current configuration
 

.common.Envelope last_update = 2 [json_name = "lastUpdate"];

Specified by:

hasLastUpdate in interface ConfigEnvelopeOrBuilder

Returns:

Whether the lastUpdate field is set.

getLastUpdate

public Envelope getLastUpdate()

 The last CONFIG_UPDATE message which generated this current configuration
 

.common.Envelope last_update = 2 [json_name = "lastUpdate"];

Specified by:

getLastUpdate in interface ConfigEnvelopeOrBuilder

Returns:

The lastUpdate.

getLastUpdateOrBuilder

public EnvelopeOrBuilder getLastUpdateOrBuilder()

 The last CONFIG_UPDATE message which generated this current configuration
 

.common.Envelope last_update = 2 [json_name = "lastUpdate"];

Specified by:

getLastUpdateOrBuilder in interface ConfigEnvelopeOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static ConfigEnvelope parseFrom(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ConfigEnvelope parseFrom(ByteBuffer data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ConfigEnvelope parseFrom(com.google.protobuf.ByteString data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ConfigEnvelope parseFrom(com.google.protobuf.ByteString data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ConfigEnvelope parseFrom(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ConfigEnvelope parseFrom(byte[] data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ConfigEnvelope parseFrom(InputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static ConfigEnvelope parseFrom(InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static ConfigEnvelope parseDelimitedFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static ConfigEnvelope parseDelimitedFrom(InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseFrom

public static ConfigEnvelope parseFrom(com.google.protobuf.CodedInputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static ConfigEnvelope parseFrom(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

newBuilderForType

public ConfigEnvelope.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ConfigEnvelope.Builder newBuilder()

newBuilder

public static ConfigEnvelope.Builder newBuilder(ConfigEnvelope prototype)

toBuilder

public ConfigEnvelope.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

getDefaultInstance

public static ConfigEnvelope getDefaultInstance()

parser

public static com.google.protobuf.Parser<ConfigEnvelope> parser()

getParserForType

public com.google.protobuf.Parser<ConfigEnvelope> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public ConfigEnvelope getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder