Index

B C D E F G H I M O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

B

BsonPlugin - Class in io.vena.bosk.drivers.mongo

BsonPlugin() - Constructor for class io.vena.bosk.drivers.mongo.BsonPlugin

build(Bosk<RR>, BoskDriver<RR>) - Method in interface io.vena.bosk.drivers.mongo.MongoDriver.MongoDriverFactory

C

close() - Method in class io.vena.bosk.drivers.mongo.MainDriver

close() - Method in interface io.vena.bosk.drivers.mongo.MongoDriver

Frees up resources used by this driver and leaves it unusable.

codecProviderFor(Bosk<R>) - Method in class io.vena.bosk.drivers.mongo.BsonPlugin

Note that the CodecProvider is Class-based, so it has anemic type information for generics due to type erasure.

COLLECTION_NAME - Static variable in class io.vena.bosk.drivers.mongo.MainDriver

CREATE_IF_ABSENT - Enum constant in enum class io.vena.bosk.drivers.mongo.MongoDriverSettings.ManifestMode

If a manifest document doesn't exist, we'll create one.

D

DISCONNECT - Enum constant in enum class io.vena.bosk.drivers.mongo.MongoDriverSettings.InitialDatabaseUnavailableMode

If the database state can't be loaded during BoskDriver.initialRoot(java.lang.reflect.Type), use the downstream driver's initial state and proceed in disconnected mode.

E

EARNEST - Enum constant in enum class io.vena.bosk.drivers.mongo.MongoDriverSettings.OrphanDocumentMode

Unused documents are always deleted before the end of the transaction.

EmptyNode() - Constructor for record class io.vena.bosk.drivers.mongo.Manifest.EmptyNode

Creates an instance of a EmptyNode record class.

equals(Object) - Method in record class io.vena.bosk.drivers.mongo.Manifest.EmptyNode

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class io.vena.bosk.drivers.mongo.Manifest

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class io.vena.bosk.drivers.mongo.PandoFormat

Indicates whether some other object is "equal to" this one.

Experimental() - Constructor for class io.vena.bosk.drivers.mongo.MongoDriverSettings.Experimental

F

factory(MongoClientSettings, MongoDriverSettings, BsonPlugin) - Static method in interface io.vena.bosk.drivers.mongo.MongoDriver

FAIL - Enum constant in enum class io.vena.bosk.drivers.mongo.MongoDriverSettings.InitialDatabaseUnavailableMode

If the database state can't be loaded during BoskDriver.initialRoot(java.lang.reflect.Type), throw an exception.

FailedSessionException - Exception in io.vena.bosk.drivers.mongo

Indicates a call to MongoClient.startSession() threw an exception, leaving us unable to interact with the database.

FailedSessionException(String) - Constructor for exception io.vena.bosk.drivers.mongo.FailedSessionException

FailedSessionException(String, Throwable) - Constructor for exception io.vena.bosk.drivers.mongo.FailedSessionException

FailedSessionException(Throwable) - Constructor for exception io.vena.bosk.drivers.mongo.FailedSessionException

flush() - Method in class io.vena.bosk.drivers.mongo.MainDriver

FormatMisconfigurationException - Exception in io.vena.bosk.drivers.mongo

FormatMisconfigurationException(String) - Constructor for exception io.vena.bosk.drivers.mongo.FormatMisconfigurationException

FormatMisconfigurationException(String, Throwable) - Constructor for exception io.vena.bosk.drivers.mongo.FormatMisconfigurationException

FormatMisconfigurationException(Throwable) - Constructor for exception io.vena.bosk.drivers.mongo.FormatMisconfigurationException

forPando(PandoFormat) - Static method in record class io.vena.bosk.drivers.mongo.Manifest

forSequoia() - Static method in record class io.vena.bosk.drivers.mongo.Manifest

G

getCodec(Type, Class<T>, CodecRegistry, Bosk<R>) - Method in class io.vena.bosk.drivers.mongo.BsonPlugin

Like codecProviderFor(bosk).get(targetType, registry) except this works more broadly because it can accept a ParameterizedType for generic classes.

H

hashCode() - Method in record class io.vena.bosk.drivers.mongo.Manifest.EmptyNode

Returns a hash code value for this object.

hashCode() - Method in record class io.vena.bosk.drivers.mongo.Manifest

Returns a hash code value for this object.

hashCode() - Method in record class io.vena.bosk.drivers.mongo.PandoFormat

Returns a hash code value for this object.

HASTY - Enum constant in enum class io.vena.bosk.drivers.mongo.MongoDriverSettings.OrphanDocumentMode

Unused documents may be left behind, to be cleaned up later.

I

initialRoot(Type) - Method in class io.vena.bosk.drivers.mongo.MainDriver

InitialRootFailureException - Exception in io.vena.bosk.drivers.mongo

Thrown from BoskDriver.initialRoot(java.lang.reflect.Type) if the initial root can't be loaded from the database and MongoDriverSettings.InitialDatabaseUnavailableMode.FAIL is in effect.

InitialRootFailureException(String) - Constructor for exception io.vena.bosk.drivers.mongo.InitialRootFailureException

InitialRootFailureException(String, Throwable) - Constructor for exception io.vena.bosk.drivers.mongo.InitialRootFailureException

InitialRootFailureException(Throwable) - Constructor for exception io.vena.bosk.drivers.mongo.InitialRootFailureException

io.vena.bosk.drivers.mongo - package io.vena.bosk.drivers.mongo

M

MainDriver<R extends io.vena.bosk.StateTreeNode> - Class in io.vena.bosk.drivers.mongo

This is the driver returned to the user by MongoDriver.factory(com.mongodb.MongoClientSettings, io.vena.bosk.drivers.mongo.MongoDriverSettings, io.vena.bosk.drivers.mongo.BsonPlugin).

MainDriver(Bosk<R>, MongoClientSettings, MongoDriverSettings, BsonPlugin, BoskDriver<R>) - Constructor for class io.vena.bosk.drivers.mongo.MainDriver

Manifest - Record Class in io.vena.bosk.drivers.mongo

Manifest(Integer, Optional<Manifest.EmptyNode>, Optional<PandoFormat>) - Constructor for record class io.vena.bosk.drivers.mongo.Manifest

Creates an instance of a Manifest record class.

MANIFEST_ID - Static variable in class io.vena.bosk.drivers.mongo.MainDriver

Manifest.EmptyNode - Record Class in io.vena.bosk.drivers.mongo

MongoDriver<R extends io.vena.bosk.StateTreeNode> - Interface in io.vena.bosk.drivers.mongo

MongoDriver.MongoDriverFactory<RR extends io.vena.bosk.StateTreeNode> - Interface in io.vena.bosk.drivers.mongo

MongoDriverSettings - Class in io.vena.bosk.drivers.mongo

MongoDriverSettings() - Constructor for class io.vena.bosk.drivers.mongo.MongoDriverSettings

MongoDriverSettings.DatabaseFormat - Interface in io.vena.bosk.drivers.mongo

MongoDriverSettings.Experimental - Class in io.vena.bosk.drivers.mongo

Settings with no guarantee of long-term support.

MongoDriverSettings.InitialDatabaseUnavailableMode - Enum Class in io.vena.bosk.drivers.mongo

MongoDriverSettings.ManifestMode - Enum Class in io.vena.bosk.drivers.mongo

MongoDriverSettings.OrphanDocumentMode - Enum Class in io.vena.bosk.drivers.mongo

MongoDriverSettings.Testing - Class in io.vena.bosk.drivers.mongo

Settings not meant to be used in production.

O

oneBigDocument() - Static method in record class io.vena.bosk.drivers.mongo.PandoFormat

Differs from Sequoia in that (1) the root document has a different ID, rendering the formats incompatible; and (2) Sequoia is designed not to need multi-document transactions.

P

pando() - Method in record class io.vena.bosk.drivers.mongo.Manifest

Returns the value of the pando record component.

PandoFormat - Record Class in io.vena.bosk.drivers.mongo

A scalable format that stores the bosk state in multiple documents, thereby overcoming MongoDB's 16MB document size limit.

PandoFormat(ListValue<String>) - Constructor for record class io.vena.bosk.drivers.mongo.PandoFormat

Creates an instance of a PandoFormat record class.

R

refurbish() - Method in class io.vena.bosk.drivers.mongo.MainDriver

refurbish() - Method in interface io.vena.bosk.drivers.mongo.MongoDriver

Deserializes and re-serializes the entire bosk contents, thus updating the database to match the current serialized format.

S

separateCollections() - Method in record class io.vena.bosk.drivers.mongo.PandoFormat

Returns the value of the separateCollections record component.

sequoia() - Method in record class io.vena.bosk.drivers.mongo.Manifest

Returns the value of the sequoia record component.

SEQUOIA - Static variable in interface io.vena.bosk.drivers.mongo.MongoDriverSettings.DatabaseFormat

Simple format that stores the entire bosk state in a single document, and (except for refirbish) doesn't require any multi-document transactions.

submitConditionalDeletion(Reference<T>, Reference<Identifier>, Identifier) - Method in class io.vena.bosk.drivers.mongo.MainDriver

submitConditionalReplacement(Reference<T>, T, Reference<Identifier>, Identifier) - Method in class io.vena.bosk.drivers.mongo.MainDriver

submitDeletion(Reference<T>) - Method in class io.vena.bosk.drivers.mongo.MainDriver

submitInitialization(Reference<T>, T) - Method in class io.vena.bosk.drivers.mongo.MainDriver

submitReplacement(Reference<T>, T) - Method in class io.vena.bosk.drivers.mongo.MainDriver

T

Testing() - Constructor for class io.vena.bosk.drivers.mongo.MongoDriverSettings.Testing

toString() - Method in record class io.vena.bosk.drivers.mongo.Manifest.EmptyNode

Returns a string representation of this record class.

toString() - Method in record class io.vena.bosk.drivers.mongo.Manifest

Returns a string representation of this record class.

toString() - Method in record class io.vena.bosk.drivers.mongo.PandoFormat

Returns a string representation of this record class.

U

USE_IF_EXISTS - Enum constant in enum class io.vena.bosk.drivers.mongo.MongoDriverSettings.ManifestMode

If a manifest document doesn't exist, we'll assume certain defaults.

V

validate() - Method in class io.vena.bosk.drivers.mongo.MongoDriverSettings

valueOf(String) - Static method in enum class io.vena.bosk.drivers.mongo.MongoDriverSettings.InitialDatabaseUnavailableMode

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class io.vena.bosk.drivers.mongo.MongoDriverSettings.ManifestMode

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class io.vena.bosk.drivers.mongo.MongoDriverSettings.OrphanDocumentMode

Returns the enum constant of this class with the specified name.

values() - Static method in enum class io.vena.bosk.drivers.mongo.MongoDriverSettings.InitialDatabaseUnavailableMode

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class io.vena.bosk.drivers.mongo.MongoDriverSettings.ManifestMode

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class io.vena.bosk.drivers.mongo.MongoDriverSettings.OrphanDocumentMode

Returns an array containing the constants of this enum class, in the order they are declared.

version() - Method in record class io.vena.bosk.drivers.mongo.Manifest

Returns the value of the version record component.

W

withSeparateCollections(String...) - Static method in record class io.vena.bosk.drivers.mongo.PandoFormat

withSeparateCollections(Collection<String>) - Static method in record class io.vena.bosk.drivers.mongo.PandoFormat

B C D E F G H I M O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form