Package org.apache.avro.ipc

Class HandshakeRequest

java.lang.Object
org.apache.avro.specific.SpecificRecordBase
org.apache.avro.ipc.HandshakeRequest
All Implemented Interfaces:
Externalizable, Serializable, Comparable<SpecificRecord>, GenericContainer, GenericRecord, IndexedRecord, SpecificRecord
public class HandshakeRequest extends SpecificRecordBase implements SpecificRecord
See Also:

  • Field Details

    • SCHEMA$

      public static final Schema SCHEMA$

  • Constructor Details

    • HandshakeRequest

      public HandshakeRequest()
      Default constructor. Note that this does not initialize fields to their default values from the schema. If that is desired then one should use newBuilder().

    • HandshakeRequest

      public HandshakeRequest(MD5 clientHash, String clientProtocol, MD5 serverHash, Map<String,ByteBuffer> meta)
      All-args constructor.
      Parameters:
      clientHash - The new value for clientHash
      clientProtocol - The new value for clientProtocol
      serverHash - The new value for serverHash
      meta - The new value for meta

  • Method Details

    • getClassSchema

      public static Schema getClassSchema()

    • getEncoder

      public static BinaryMessageEncoder<HandshakeRequest> getEncoder()
      Return the BinaryMessageEncoder instance used by this class.
      Returns:
      the message encoder used by this class

    • getDecoder

      public static BinaryMessageDecoder<HandshakeRequest> getDecoder()
      Return the BinaryMessageDecoder instance used by this class.
      Returns:
      the message decoder used by this class

    • createDecoder

      public static BinaryMessageDecoder<HandshakeRequest> createDecoder(SchemaStore resolver)
      Create a new BinaryMessageDecoder instance for this class that uses the specified SchemaStore.
      Parameters:
      resolver - a SchemaStore used to find schemas by fingerprint
      Returns:
      a BinaryMessageDecoder instance for this class backed by the given SchemaStore

    • toByteBuffer

      public ByteBuffer toByteBuffer() throws IOException
      Serializes this HandshakeRequest to a ByteBuffer.
      Returns:
      a buffer holding the serialized data for this instance
      Throws:
      IOException - if this instance could not be serialized

    • fromByteBuffer

      public static HandshakeRequest fromByteBuffer(ByteBuffer b) throws IOException
      Deserializes a HandshakeRequest from a ByteBuffer.
      Parameters:
      b - a byte buffer holding serialized data for an instance of this class
      Returns:
      a HandshakeRequest instance decoded from the given buffer
      Throws:
      IOException - if the given bytes could not be deserialized into an instance of this class

    • getSpecificData

      public SpecificData getSpecificData()
      Overrides:
      getSpecificData in class SpecificRecordBase

    • getSchema

      public Schema getSchema()
      Description copied from interface: GenericContainer
      The schema of this instance.
      Specified by:
      getSchema in interface GenericContainer

    • get

      public Object get(int field$)
      Description copied from interface: IndexedRecord
      Return the value of a field given its position in the schema.

      This method is not meant to be called by user code, but only by DatumWriter implementations.

      Specified by:
      get in interface IndexedRecord

    • put

      public void put(int field$, Object value$)
      Description copied from interface: IndexedRecord
      Set the value of a field given its position in the schema.

      This method is not meant to be called by user code, but only by DatumReader implementations.

      Specified by:
      put in interface IndexedRecord

    • getClientHash

      public MD5 getClientHash()
      Gets the value of the 'clientHash' field.
      Returns:
      The value of the 'clientHash' field.

    • getOptionalClientHash

      public Optional<MD5> getOptionalClientHash()
      Gets the value of the 'clientHash' field as an Optional<org.apache.avro.ipc.MD5>.
      Returns:
      The value wrapped in an Optional<org.apache.avro.ipc.MD5>.

    • setClientHash

      public void setClientHash(MD5 value)
      Sets the value of the 'clientHash' field.
      Parameters:
      value - the value to set.

    • getClientProtocol

      public String getClientProtocol()
      Gets the value of the 'clientProtocol' field.
      Returns:
      The value of the 'clientProtocol' field.

    • getOptionalClientProtocol

      public Optional<String> getOptionalClientProtocol()
      Gets the value of the 'clientProtocol' field as an Optional<java.lang.String>.
      Returns:
      The value wrapped in an Optional<java.lang.String>.

    • setClientProtocol

      public void setClientProtocol(String value)
      Sets the value of the 'clientProtocol' field.
      Parameters:
      value - the value to set.

    • getServerHash

      public MD5 getServerHash()
      Gets the value of the 'serverHash' field.
      Returns:
      The value of the 'serverHash' field.

    • getOptionalServerHash

      public Optional<MD5> getOptionalServerHash()
      Gets the value of the 'serverHash' field as an Optional<org.apache.avro.ipc.MD5>.
      Returns:
      The value wrapped in an Optional<org.apache.avro.ipc.MD5>.

    • setServerHash

      public void setServerHash(MD5 value)
      Sets the value of the 'serverHash' field.
      Parameters:
      value - the value to set.

    • getMeta

      public Map<String,ByteBuffer> getMeta()
      Gets the value of the 'meta' field.
      Returns:
      The value of the 'meta' field.

    • getOptionalMeta

      public Optional<Map<String,ByteBuffer>> getOptionalMeta()
      Gets the value of the 'meta' field as an Optional<java.util.Map<java.lang.String,java.nio.ByteBuffer>>.
      Returns:
      The value wrapped in an Optional<java.util.Map<java.lang.String,java.nio.ByteBuffer>>.

    • setMeta

      public void setMeta(Map<String,ByteBuffer> value)
      Sets the value of the 'meta' field.
      Parameters:
      value - the value to set.

    • newBuilder

      public static HandshakeRequest.Builder newBuilder()
      Creates a new HandshakeRequest RecordBuilder.
      Returns:
      A new HandshakeRequest RecordBuilder

    • newBuilder

      public static HandshakeRequest.Builder newBuilder(HandshakeRequest.Builder other)
      Creates a new HandshakeRequest RecordBuilder by copying an existing Builder.
      Parameters:
      other - The existing builder to copy.
      Returns:
      A new HandshakeRequest RecordBuilder

    • newBuilder

      public static HandshakeRequest.Builder newBuilder(HandshakeRequest other)
      Creates a new HandshakeRequest RecordBuilder by copying an existing HandshakeRequest instance.
      Parameters:
      other - The existing instance to copy.
      Returns:
      A new HandshakeRequest RecordBuilder

    • writeExternal

      public void writeExternal(ObjectOutput out) throws IOException
      Specified by:
      writeExternal in interface Externalizable
      Overrides:
      writeExternal in class SpecificRecordBase
      Throws:
      IOException

    • readExternal

      public void readExternal(ObjectInput in) throws IOException
      Specified by:
      readExternal in interface Externalizable
      Overrides:
      readExternal in class SpecificRecordBase
      Throws:
      IOException

    • hasCustomCoders

      protected boolean hasCustomCoders()
      Description copied from class: SpecificRecordBase
      Returns true iff an instance supports the MessageEncoder.encode(D) and MessageDecoder.decode(java.io.InputStream) operations. Should only be used by SpecificDatumReader/Writer to selectively use SpecificRecordBase.customEncode(org.apache.avro.io.Encoder) and SpecificRecordBase.customDecode(org.apache.avro.io.ResolvingDecoder) to optimize the (de)serialization of values.
      Overrides:
      hasCustomCoders in class SpecificRecordBase

    • customEncode

      public void customEncode(Encoder out) throws IOException
      Overrides:
      customEncode in class SpecificRecordBase
      Throws:
      IOException

    • customDecode

      public void customDecode(ResolvingDecoder in) throws IOException
      Overrides:
      customDecode in class SpecificRecordBase
      Throws:
      IOException