Class CryptoResponseContext

  • All Implemented Interfaces:
    java.io.Externalizable , java.io.Serializable , java.lang.Comparable , org.apache.avro.generic.GenericContainer , org.apache.avro.generic.GenericRecord , org.apache.avro.generic.IndexedRecord , org.apache.avro.specific.SpecificRecord

    
    public class CryptoResponseContext
    extends SpecificRecordBase implements SpecificRecord
                        

    Defines over-the-wire response context (mostly copied from the corresponding request context) such as timestamp, requesting component, tenant id, and other.

    • Constructor Detail

      • CryptoResponseContext

        CryptoResponseContext()
        Default constructor.
      • CryptoResponseContext

        CryptoResponseContext(String requestingComponent, Instant requestTimestamp, String requestId, Instant responseTimestamp, String tenantId, KeyValuePairList other)
        All-args constructor.
        Parameters:
        requestingComponent - Name of the component which requested the operation, copied from the corresponding request.
        requestTimestamp - Time ([Instant]) in milliseconds of the request, copied from the corresponding request.
        requestId - Request id which can be used to track the request progress.
        responseTimestamp - Time ([Instant]) in milliseconds of the response.
        tenantId - Tenant id on which behalf the request is made, copied from the corresponding request.
        other - Any other list of context's key-values.
    • Method Detail

      • getRequestingComponent

         String getRequestingComponent()

        Gets the value of the 'requestingComponent' field.

        Returns:

        Name of the component which requested the operation, copied from the corresponding request.

      • setRequestingComponent

         void setRequestingComponent(String value)

        Sets the value of the 'requestingComponent' field. Name of the component which requested the operation, copied from the corresponding request.

        Parameters:
        value - the value to set.
      • getRequestTimestamp

         Instant getRequestTimestamp()

        Gets the value of the 'requestTimestamp' field.

        Returns:

        Time ([Instant]) in milliseconds of the request, copied from the corresponding request.

      • setRequestTimestamp

         void setRequestTimestamp(Instant value)

        Sets the value of the 'requestTimestamp' field. Time ([Instant]) in milliseconds of the request, copied from the corresponding request.

        Parameters:
        value - the value to set.
      • getRequestId

         String getRequestId()

        Gets the value of the 'requestId' field.

        Returns:

        Request id which can be used to track the request progress.

      • setRequestId

         void setRequestId(String value)

        Sets the value of the 'requestId' field. Request id which can be used to track the request progress.

        Parameters:
        value - the value to set.
      • getResponseTimestamp

         Instant getResponseTimestamp()

        Gets the value of the 'responseTimestamp' field.

        Returns:

        Time ([Instant]) in milliseconds of the response.

      • setResponseTimestamp

         void setResponseTimestamp(Instant value)

        Sets the value of the 'responseTimestamp' field. Time ([Instant]) in milliseconds of the response.

        Parameters:
        value - the value to set.
      • getTenantId

         String getTenantId()

        Gets the value of the 'tenantId' field.

        Returns:

        Tenant id on which behalf the request is made, copied from the corresponding request.

      • setTenantId

         void setTenantId(String value)

        Sets the value of the 'tenantId' field. Tenant id on which behalf the request is made, copied from the corresponding request.

        Parameters:
        value - the value to set.
      • getOther

         KeyValuePairList getOther()

        Gets the value of the 'other' field.

        Returns:

        Any other list of context's key-values.

      • setOther

         void setOther(KeyValuePairList value)

        Sets the value of the 'other' field. Any other list of context's key-values.

        Parameters:
        value - the value to set.
      • getEncoder

         static BinaryMessageEncoder<CryptoResponseContext> getEncoder()

        Return the BinaryMessageEncoder instance used by this class.

        Returns:

        the message encoder used by this class

      • getDecoder

         static BinaryMessageDecoder<CryptoResponseContext> getDecoder()

        Return the BinaryMessageDecoder instance used by this class.

        Returns:

        the message decoder used by this class

      • createDecoder

         static BinaryMessageDecoder<CryptoResponseContext> 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

         ByteBuffer toByteBuffer()

        Serializes this CryptoResponseContext to a ByteBuffer.

        Returns:

        a buffer holding the serialized data for this instance

      • fromByteBuffer

         static CryptoResponseContext fromByteBuffer(ByteBuffer b)

        Deserializes a CryptoResponseContext from a ByteBuffer.

        Parameters:
        b - a byte buffer holding serialized data for an instance of this class
        Returns:

        a CryptoResponseContext instance decoded from the given buffer