@PublicAPI(stability=PRIVATE)

Package org.opends.server.backends.pluggable.spi

Interfaces and classes required when implementing new storage engines for the pluggable backend.

Interface Summary

Interface	Description
Cursor<K,V>	Sequential cursor extended with navigation methods.
Importer	Allows to run an import.
ReadableTransaction	Represents a readable transaction on a storage engine.
ReadOperation<T>	Function performing a read operation.
SequentialCursor<K,V>	Cursor extended with navigation methods.
Storage	This interface abstracts the underlying storage engine, isolating the pluggable backend generic code from a particular storage engine implementation.
UpdateFunction	Function that computes the new value of a record for a Read-Modify-Write operation inside a transaction.
WriteableTransaction	Represents a writeable transaction on a storage engine.
WriteOperation	Function performing a write operation.

Class Summary

Class	Description
EmptyCursor<K,V>	Implementation of an empty Cursor, for simulating no records to cursor on.
StorageStatus	Represents the current status of a storage with respect to its resources.
StorageUtils	Utility class for implementations of Storage.
TreeName	Represents the name of a tree (key-value store) in a database.

Enum Summary

Enum	Description
AccessMode	Defines access modes of a Storage.
ReadableTransaction.ReadOption	Options applicable to ReadableTransaction.openCursor(TreeName, ReadOption...).
WriteableTransaction.WriteTransactionOption	Options applicable to a WriteableTransaction.

Exception Summary

Exception	Description
ReadOnlyStorageException	Thrown when the server or a tool attempts to access the storage while it is read-only.
StorageInUseException	Runtime exception for storage supporting single access only.
StorageRuntimeException	Runtime exception for problems happening in the storage engine.