All Classes and Interfaces
Class
Description
A class that puts together the api key and value in form of
ApiKeyPermissions
.Singleton used in the RoStore service to control access to the APIKeys.
Defines permissions associated with APIKEY
Class is injected in the REST filters and extract information
about the API key of the current request.
Class is used to access and modify the api keys on the storage.
A representation of the rostore container.
This class is a wrapper around the stream (input or output).
A class to serialize and deserialize java classes to the binary stream.
An object to access and modify the data in the
boundaries of one block.
Information regarding allocation of the blocks with the ro-store components
Materialized object that implements
BlockAllocation
This interface allows to allocate and free blocks.
This interface allows to allocate and free blocks
What rebalance is?
The allocation involves usage of blocks where the catalog is stored.
An instance of this listener can be provided to
BlockAllocator
,
which will be notified if the blocks are freed or allocatedThis is the holder of all block allocator's listeners.
Specifies a set of blocks in the current transaction.
Annotation that can be used on the fields of the java objects
that store a block index.
This is the list of blocks which is used in the sequences
This clas holds all the block sequences in the
Media
object.Annotation that can be used on the fields of the java objects
that store an offset within a block.
A structure that combines both
BlockAllocator
and BlockContainer
.Sequences manage a set of blocks.
A type of the block.
Special kind of listener that can be used to verify the block allocations
This class extends
CatalogBlockOperations
by caching some subset
of the catalog in memory.An entry used to store the elements of catalog.
This is the major class to manage a catalog of blocks.
The exception is thrown by rostore client, in case of any issue in the communication with the remote rostore service.
An interface that marks an entity that holds opened blocks,
which should be closed after its usage.
Marks an entity that holds active blocks, which needs to be committed.
Container class to manage access to the set of keys and their values.
Thrown when the container name is already in use.
This class is created on the container creation event and should be stored in the
container list, so it can be reopened again.
This class is serialized and stored in the media header at the time of
Media
creation.This is the major class to manage the containers on the rostore.
The class contains the properties that steers the list of containers.
Specifies the major container properties, such as the maximum size and maximum TTL of the keys
the container will allow to store, as well as the number of container's shard.
Container Shards ar independent portion of the Container, that have its own
BlockAllocator
and independent set of keys.This is a manager to clean up if needed
This information meant to be serialized and stored to the
Media
so that the shard can be recreated.Encapsulates the operation context on the shard level.
Specify a content-type header for the request to the remote rostore service.
This is a counterpart of
DataWriter
, that allows to read the data from the storage that
has been previously written by the writer.Thrown when data transfer is aborted out of any reason
Represents a combination of the value data and the metadata associated with the entry
Class to write the data to the storage using the provided block allocator.
A default key serializer.
A listener get called when number of entries in the block changes.
Exception is thrown if the value of EOL violates some
validation rules.
Abstract entry that encapsulates operation on the entries with the fixed size.
This is an extension of sequence block that maps the block area as
a set of the fixed-sized entries.
Represents a simple rostore container.
This instance manages a low-level block operation and creates a new
BlockContainer
.This one uses the
ObjectMapper
to serialize / deserialize the content of the storeRepresents an entry with exactly one key.
This is a class to manage keys.
This interface (function) provides a flexible way to define a new expiration policy for the given object
A list of keys loaded by the
KeyBlockOperations
.Interface specifies the logic for key object serialization
Encapsulates access to the container that uses specific serializer / deserializer.
Represents the mapped to the memory the physical block of the storage.
This is a container of all active physical blocks in the ro-store.
Provides serialization / deserialization for mapping of the underlying objects
Class defines the properties of the
BinaryMapper
that specify the length of the fields depending on the storage internal properties.A major class representing the ro-store storage.
This object is stored in the first block of ro-store
Media
.Properties of the media that defines its major parameters.
This one is needed to create MediaProperties.
Provides information about the objects the ro-store
Media
instance is currently keeping in memory.This one uses the native serializer of the ro-store
Exception thrown when an operation on a key can't be executed as requested
A permission
Exception is thrown when the client tries to execute an operation
that it has no sufficient permissions for.
Properties of the data transfer operations
Exception is thrown by
BlockAllocator
when the request has to be rejected because
the size that has to be allocated is greater than the allowed size
of the underlying storage object, e.g.Record describes the payload associated with the key in the storage.
Defines the lengths of the key record components in bytes
Specify behaviour of the system when update or creation of key-value happens.
This is a backbone class that contains all the data needed to execute a
REST request against the remote rostore instance.
Major allocator for the
Media
.A basic class that has the status and can be closed.
The major object to access the remote rostore service.
Properties that define connection to the remote rostore service
Base class for all exceptions generated by the RoStore core
RoStore storage properties.
This class creates
BlockAllocator
that allows to control a set of blocks.Represents a block that is embedded in
BlockSequence
.Used in async stream processing function
The class represents the result of key listing operation.
General functions and constants used in rostore modules.
An entry of the block that validates the index to be valid.
This class refer the sequence of entries of variable size, that are stored in the memory blocks.
Manages several variable-sized entries in one block.
This class is used when the key data exceeds the size of block.
Represents information about the version of the rostore instance.
Exception is thrown on post/put when the version in e input is not as expected by the server.
Versioned object, containing the object itself, and metadata: ttl information and version
Exception thrown when the version of the record in the store is
not the one as requested.
Thrown when the version of the entry is set incorrectly on the entry initialization.