it.agilelab.darwin.manager

AvroSchemaManager

abstract class AvroSchemaManager extends Logging

The main entry point of the Darwin library. An instance of AvroSchemaManager should ALWAYS be obtained through the AvroSchemaManagerFactory. The manager is responsible for schemas registration, retrieval and updates.

Linear Supertypes
Logging, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. AvroSchemaManager
  2. Logging
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AvroSchemaManager(connector: Connector, endianness: ByteOrder)

    connector

    the connector used to retrieve and persist schemas

    endianness

    the endianness that will be used to persist and parse fingerprint bytes, it won't affect how avro payload is written, that is up to the darwin user

Abstract Value Members

  1. abstract def getAll: Seq[(Long, Schema)]

    Retrieves all registered schemas

    Retrieves all registered schemas

    returns

    A Sequence of (ID, Schema)

  2. abstract def getSchema(id: Long): Option[Schema]

    Extracts the Schema from its ID.

    Extracts the Schema from its ID.

    id

    a Long representing an ID

    returns

    the Schema associated to the input ID

  3. abstract def registerAll(schemas: Seq[Schema]): Seq[(Long, Schema)]

    Checks if all the input Schema elements are already in the cache.

    Checks if all the input Schema elements are already in the cache. Then, it performs an insert on the storage for all the elements not found on the cache, and then returns each input schema paired with its ID.

    schemas

    all the Schema that should be registered

    returns

    a sequence of pairs of the input schemas associated with their IDs

  4. abstract def reload(): AvroSchemaManager

    Reloads all the schemas from the previously configured storage.

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  10. def extractSchema(array: Array[Byte]): Either[Exception, Schema]

    Extracts the schema from the avro single-object encoded in the input array.

    Extracts the schema from the avro single-object encoded in the input array.

    array

    avro single-object encoded array

    returns

    the schema ID extracted from the input data

  11. def extractSchema(inputStream: InputStream): Either[Array[Byte], Schema]

    Extracts the schema from the avro single-object encoded at the head of this input stream.

    Extracts the schema from the avro single-object encoded at the head of this input stream. The input stream will have 10 bytes consumed if the first two bytes correspond to the single object encoded header, or zero bytes consumed if the InputStream supports marking; if it doesn't, the first bytes (up to 2) will be consumed and returned in the Left part of the Either

    inputStream

    avro single-object encoded input stream

    returns

    the schema ID extracted from the input data

  12. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. def generateAvroSingleObjectEncoded(byteStream: OutputStream, schemaId: Long)(avroWriter: (OutputStream) ⇒ OutputStream): OutputStream

    Writes to the given OutputStream the Single Object Encoding header then calls the avroWriter function to possibly add data to the stream and finally returns the OutputStream

    Writes to the given OutputStream the Single Object Encoding header then calls the avroWriter function to possibly add data to the stream and finally returns the OutputStream

    byteStream

    the stream to write to

    schemaId

    id of the schema used to encode the payload

    avroWriter

    function that will be called to add user generated avro to the stream

    returns

    the input OutputStream

  14. def generateAvroSingleObjectEncoded(byteStream: OutputStream, avroValue: Array[Byte], schemaId: Long): OutputStream

    Writes to the given OutputStream the Single Object Encoding header then the avroValue and returns the OutputStream

    Writes to the given OutputStream the Single Object Encoding header then the avroValue and returns the OutputStream

    byteStream

    the stream to write to

    avroValue

    the value to be written to the stream

    schemaId

    id of the schema used to encode the payload

    returns

    the input OutputStream

  15. def generateAvroSingleObjectEncoded(avroPayload: Array[Byte], schema: Schema): Array[Byte]

    Create an array that creates a Single-Object encoded byte array.

    Create an array that creates a Single-Object encoded byte array. By specifications the encoded array is obtained concatenating the V1_HEADER, the schema id and the avro-encoded payload.

    avroPayload

    avro-serialized payload

    schema

    the schema used to encode the payload

    returns

    a Single-Object encoded byte array

  16. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  17. def getEndianness(): ByteOrder

    returns

    the configured endianness of this AvroSchemaManager instance

  18. def getId(schema: Schema): Long

    Extracts the ID from a Schema.

    Extracts the ID from a Schema.

    schema

    a Schema with unknown ID

    returns

    the ID associated with the input schema

  19. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  21. def log: Logger

    Definition Classes
    Logging
  22. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  23. final def notify(): Unit

    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  25. def registerAll(schemas: Iterable[Schema]): Iterable[IdSchemaPair]

    JAVA API: Checks if all the input Schema elements are already in the cache.

    JAVA API: Checks if all the input Schema elements are already in the cache. Then, it performs an insert on the storage for all the elements not found on the cache, and then returns each input schema paired with its ID.

    schemas

    all the Schema that should be registered

    returns

    a sequence of pairs of the input schemas associated with their IDs

  26. def retrieveSchemaAndAvroPayload(avroSingleObjectEncoded: ByteBuffer): Schema

    Extracts the Schema from the ByteBuffer after the method call the ByteBuffer position will be right after the header.

    Extracts the Schema from the ByteBuffer after the method call the ByteBuffer position will be right after the header.

    avroSingleObjectEncoded

    a ByteBuffer of a Single-Object encoded payload

    returns

    the avro Schema

  27. def retrieveSchemaAndAvroPayload(avroSingleObjectEncoded: Array[Byte]): (Schema, Array[Byte])

    Extracts a Tuple2 that contains the Schema and the Avro-encoded payload

    Extracts a Tuple2 that contains the Schema and the Avro-encoded payload

    avroSingleObjectEncoded

    a byte array of a Single-Object encoded payload

    returns

    a pair containing the Schema and the payload of the input array

  28. def retrieveSchemaAndPayload(avroSingleObjectEncoded: Array[Byte]): SchemaPayloadPair

    Extracts a SchemaPayloadPair that contains the Schema and the Avro-encoded payload

    Extracts a SchemaPayloadPair that contains the Schema and the Avro-encoded payload

    avroSingleObjectEncoded

    a byte array of a Single-Object encoded payload

    returns

    a SchemaPayloadPair containing the Schema and the payload of the input array

  29. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  30. def toString(): String

    Definition Classes
    AnyRef → Any
  31. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. def writeHeaderToStream(byteStream: OutputStream, schemaId: Long): OutputStream

    Writes to the given OutputStream the Single Object Encoding header and returns the OutputStream

    Writes to the given OutputStream the Single Object Encoding header and returns the OutputStream

    returns

    the input OutputStream

Inherited from Logging

Inherited from AnyRef

Inherited from Any

Ungrouped