org.hyperledger.fabric.protos.common

Class ChannelHeader

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.hyperledger.fabric.protos.common.ChannelHeader

All Implemented Interfaces:

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

public final class ChannelHeader
extends com.google.protobuf.GeneratedMessageV3
implements ChannelHeaderOrBuilder

 Header is a generic replay prevention and identity message to include in a signed payload
 

Protobuf type common.ChannelHeader

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChannelHeader.Builder Header is a generic replay prevention and identity message to include in a signed payload

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	CHANNEL_ID_FIELD_NUMBER
static int	EPOCH_FIELD_NUMBER
static int	EXTENSION_FIELD_NUMBER
static int	TIMESTAMP_FIELD_NUMBER
static int	TLS_CERT_HASH_FIELD_NUMBER
static int	TX_ID_FIELD_NUMBER
static int	TYPE_FIELD_NUMBER
static int	VERSION_FIELD_NUMBER

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getChannelId() Identifier of the channel this message is bound for
com.google.protobuf.ByteString	getChannelIdBytes() Identifier of the channel this message is bound for
static ChannelHeader	getDefaultInstance()
ChannelHeader	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
long	getEpoch() The epoch in which this header was generated, where epoch is defined based on block height Epoch in which the response has been generated.
com.google.protobuf.ByteString	getExtension() Extension that may be attached based on the header type
com.google.protobuf.Parser<ChannelHeader>	getParserForType()
int	getSerializedSize()
com.google.protobuf.Timestamp	getTimestamp() Timestamp is the local time when the message was created by the sender
com.google.protobuf.TimestampOrBuilder	getTimestampOrBuilder() Timestamp is the local time when the message was created by the sender
com.google.protobuf.ByteString	getTlsCertHash() If mutual TLS is employed, this represents the hash of the client's TLS certificate
String	getTxId() An unique identifier that is used end-to-end.
com.google.protobuf.ByteString	getTxIdBytes() An unique identifier that is used end-to-end.
int	getType() Header types 0-10000 are reserved and defined by HeaderType
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	getVersion() Version indicates message protocol version
int	hashCode()
boolean	hasTimestamp() Timestamp is the local time when the message was created by the sender
boolean	isInitialized()
static ChannelHeader.Builder	newBuilder()
static ChannelHeader.Builder	newBuilder(ChannelHeader prototype)
ChannelHeader.Builder	newBuilderForType()
static ChannelHeader	parseDelimitedFrom(InputStream input)
static ChannelHeader	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ChannelHeader	parseFrom(byte[] data)
static ChannelHeader	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ChannelHeader	parseFrom(ByteBuffer data)
static ChannelHeader	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ChannelHeader	parseFrom(com.google.protobuf.ByteString data)
static ChannelHeader	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ChannelHeader	parseFrom(com.google.protobuf.CodedInputStream input)
static ChannelHeader	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ChannelHeader	parseFrom(InputStream input)
static ChannelHeader	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ChannelHeader>	parser()
ChannelHeader.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

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER

See Also:

Constant Field Values

VERSION_FIELD_NUMBER

public static final int VERSION_FIELD_NUMBER

See Also:

Constant Field Values

TIMESTAMP_FIELD_NUMBER

public static final int TIMESTAMP_FIELD_NUMBER

See Also:

Constant Field Values

CHANNEL_ID_FIELD_NUMBER

public static final int CHANNEL_ID_FIELD_NUMBER

See Also:

Constant Field Values

TX_ID_FIELD_NUMBER

public static final int TX_ID_FIELD_NUMBER

See Also:

Constant Field Values

EPOCH_FIELD_NUMBER

public static final int EPOCH_FIELD_NUMBER

See Also:

Constant Field Values

EXTENSION_FIELD_NUMBER

public static final int EXTENSION_FIELD_NUMBER

See Also:

Constant Field Values

TLS_CERT_HASH_FIELD_NUMBER

public static final int TLS_CERT_HASH_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()

getType

public int getType()

 Header types 0-10000 are reserved and defined by HeaderType
 

int32 type = 1 [json_name = "type"];

Specified by:

getType in interface ChannelHeaderOrBuilder

Returns:

The type.

getVersion

public int getVersion()

 Version indicates message protocol version
 

int32 version = 2 [json_name = "version"];

Specified by:

getVersion in interface ChannelHeaderOrBuilder

Returns:

The version.

hasTimestamp

public boolean hasTimestamp()

 Timestamp is the local time when the message was created
 by the sender
 

.google.protobuf.Timestamp timestamp = 3 [json_name = "timestamp"];

Specified by:

hasTimestamp in interface ChannelHeaderOrBuilder

Returns:

Whether the timestamp field is set.

getTimestamp

public com.google.protobuf.Timestamp getTimestamp()

 Timestamp is the local time when the message was created
 by the sender
 

.google.protobuf.Timestamp timestamp = 3 [json_name = "timestamp"];

Specified by:

getTimestamp in interface ChannelHeaderOrBuilder

Returns:

The timestamp.

getTimestampOrBuilder

public com.google.protobuf.TimestampOrBuilder getTimestampOrBuilder()

 Timestamp is the local time when the message was created
 by the sender
 

.google.protobuf.Timestamp timestamp = 3 [json_name = "timestamp"];

Specified by:

getTimestampOrBuilder in interface ChannelHeaderOrBuilder

getChannelId

public String getChannelId()

 Identifier of the channel this message is bound for
 

string channel_id = 4 [json_name = "channelId"];

Specified by:

getChannelId in interface ChannelHeaderOrBuilder

Returns:

The channelId.

getChannelIdBytes

public com.google.protobuf.ByteString getChannelIdBytes()

 Identifier of the channel this message is bound for
 

string channel_id = 4 [json_name = "channelId"];

Specified by:

getChannelIdBytes in interface ChannelHeaderOrBuilder

Returns:

The bytes for channelId.

getTxId

public String getTxId()

 An unique identifier that is used end-to-end.
  -  set by higher layers such as end user or SDK
  -  passed to the endorser (which will check for uniqueness)
  -  as the header is passed along unchanged, it will be
     be retrieved by the committer (uniqueness check here as well)
  -  to be stored in the ledger
 

string tx_id = 5 [json_name = "txId"];

Specified by:

getTxId in interface ChannelHeaderOrBuilder

Returns:

The txId.

getTxIdBytes

public com.google.protobuf.ByteString getTxIdBytes()

 An unique identifier that is used end-to-end.
  -  set by higher layers such as end user or SDK
  -  passed to the endorser (which will check for uniqueness)
  -  as the header is passed along unchanged, it will be
     be retrieved by the committer (uniqueness check here as well)
  -  to be stored in the ledger
 

string tx_id = 5 [json_name = "txId"];

Specified by:

getTxIdBytes in interface ChannelHeaderOrBuilder

Returns:

The bytes for txId.

getEpoch

public long getEpoch()

 The epoch in which this header was generated, where epoch is defined based on block height
 Epoch in which the response has been generated. This field identifies a
 logical window of time. A proposal response is accepted by a peer only if
 two conditions hold:
 1. the epoch specified in the message is the current epoch
 2. this message has been only seen once during this epoch (i.e. it hasn't
    been replayed)
 

uint64 epoch = 6 [json_name = "epoch"];

Specified by:

getEpoch in interface ChannelHeaderOrBuilder

Returns:

The epoch.

getExtension

public com.google.protobuf.ByteString getExtension()

 Extension that may be attached based on the header type
 

bytes extension = 7 [json_name = "extension"];

Specified by:

getExtension in interface ChannelHeaderOrBuilder

Returns:

The extension.

getTlsCertHash

public com.google.protobuf.ByteString getTlsCertHash()

 If mutual TLS is employed, this represents
 the hash of the client's TLS certificate
 

bytes tls_cert_hash = 8 [json_name = "tlsCertHash"];

Specified by:

getTlsCertHash in interface ChannelHeaderOrBuilder

Returns:

The tlsCertHash.

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 ChannelHeader parseFrom(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ChannelHeader parseFrom(InputStream input)
                               throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static ChannelHeader parseDelimitedFrom(InputStream input)
                                        throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public ChannelHeader.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ChannelHeader.Builder newBuilder()

newBuilder

public static ChannelHeader.Builder newBuilder(ChannelHeader prototype)

toBuilder

public ChannelHeader.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

getDefaultInstance

public static ChannelHeader getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<ChannelHeader> 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 ChannelHeader getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder