one.microstream.storage.embedded.types.EmbeddedStorageManager.Default

All Implemented Interfaces:: AutoCloseable, PersistenceStoring, Persister, Unpersistable, LazyReferenceManager.Controller, ObjectSwizzling, EmbeddedStorageManager, DatabasePart, StorageActivePart, StorageConnection, StorageController, StorageManager

Enclosing interface:: EmbeddedStorageManager

public static final class EmbeddedStorageManager.Default
extends Object
implements EmbeddedStorageManager, Unpersistable, LazyReferenceManager.Controller

Nested Class Summary

Nested classes/interfaces inherited from interface one.microstream.storage.embedded.types.EmbeddedStorageManager
EmbeddedStorageManager.Default

Method Summary

Modifier and Type	Method	Description
`void`	`checkAcceptingTasks()`
`StorageConfiguration`	`configuration()`	Returns the `StorageConfiguration` used to initialize this `StorageManager` instance.
`StorageConnection`	`createConnection()`	Creates a new `StorageConnection` instance.
`StorageRawFileStatistics`	`createStorageStatistics()`	Creates a `StorageRawFileStatistics` instance, (obviously) containing raw file statistics about every channel in the storage.
`Storer`	`createStorer()`	Creates a new `Storer` instance with default storing behavior.
`Database`	`database()`	Returns the `Database` instance this `StorageManager` is associated with.
`Reference<Object>`	`defaultRoot()`	Deprecated.
`void`	`exportChannels(StorageLiveFileProvider fileProvider, boolean performGarbageCollection)`	Exports the data of all channels in the storage by using the passed `StorageLiveFileProvider` instance. This is basically a simple file copy applied to all files in the storage, however with the guaranteed safety of no other task / access to the storage's files intervening with the ongoing process.
`StorageEntityTypeExportStatistics`	`exportTypes(StorageEntityTypeExportFileProvider exportFileProvider, Predicate<? super StorageEntityTypeHandler> isExportType)`	Exports the entity data of all selected types of all channels into one file per type. The data will be in the native binary format used internally by the storage.
`void`	`importFiles(XGettingEnum<AFile> importFiles)`	Imports all files specified by the passed Enum (ordered set) of `AFile` in order. The files are assumed to be in the native binary format used internally by the storage. All entities contained in the specified files will be imported.
`long`	`initializationTime()`
`boolean`	`isAcceptingTasks()`
`boolean`	`isActive()`	Queries whether the part is actually active right now.
`boolean`	`isRunning()`
`boolean`	`isShuttingDown()`
`boolean`	`isStartingUp()`
`boolean`	`issueCacheCheck(long nanoTimeBudget)`	Issues a storage cache check to be executed, limited to the time budget in nanoseconds specified by the passed `nanoTimeBudget`. When the time budget is used up, the checking logic will keep the current progress and continue there at the next opportunity.
`boolean`	`issueCacheCheck(long nanoTimeBudget, StorageEntityCacheEvaluator entityEvaluator)`	Same as `StorageConnection.issueCacheCheck(long)`, but with using the passed `StorageEntityCacheEvaluator` logic instead of the configured one.
`boolean`	`issueFileCheck(long nanoTimeBudget)`	Issues a storage file check to be executed, limited to the time budget in nanoseconds specified by the passed `nanoTimeBudget`. When the time budget is used up, the checking logic will keep the current progress and continue there at the next opportunity.
`void`	`issueFullBackup(StorageLiveFileProvider targetFileProvider, PersistenceTypeDictionaryExporter typeDictionaryExporter)`	Issues a full backup of the whole storage to be executed.
`void`	`issueFullCacheCheck()`	Issues a full storage cache check to be executed.
`void`	`issueFullCacheCheck(StorageEntityCacheEvaluator entityEvaluator)`	Same as `StorageConnection.issueFullCacheCheck()`, but with using the passed `StorageEntityCacheEvaluator` logic instead of the configured one.
`void`	`issueFullFileCheck()`	Issues a full storage file check to be executed.
`void`	`issueFullGarbageCollection()`	Issues a full garbage collection to be executed.
`boolean`	`issueGarbageCollection(long nanoTimeBudget)`	Issues garbage collection to be executed, limited to the time budget in nanoseconds specified by the passed `nanoTimeBudget`. When the time budget is used up, the garbage collector will keep the current progress and continue there at the next opportunity.
`boolean`	`mayRun()`
`long`	`operationModeTime()`
`PersistenceManager<Binary>`	`persistenceManager()`
`Object`	`root()`	Return the persistent object graph's root object, without specific typing.
`Object`	`setRoot(Object newRoot)`	Sets the passed instance as the new root for the persistent object graph. Note that this will replace the old root instance, potentially resulting in wiping the whole database.
`boolean`	`shutdown()`	Issues a command to shut down all active threads managing the storage.
`EmbeddedStorageManager.Default`	`start()`	"Starts" the storage controlled by this `StorageController` instance, with "starting" meaning: Reading, indexing and potentially caching all the persisted data in the storage. Starting storage managing threads to execute requests like storing, loading and issued utility functions.
`long`	`storeRoot()`	Stores the registered root instance (as returned by `StorageManager.root()`) by using the default storing logic by calling `StorageConnection.createStorer()` to create the `Storer` to be used. Depending on the storer logic, storing the root instance can cause many other object to be stored, as well.
`StorageTypeDictionary`	`typeDictionary()`	Returns the `StorageTypeDictionary` that contains a completely list of types currently known to / handled by the storage represented by this `StorageManager` instance.
`PersistenceRootsView`	`viewRoots()`	Returns a read-only view on all technical root instance registered in this `StorageManager` instance. See the description in `PersistenceRootsView` for details.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface one.microstream.storage.types.StorageConnection

createEagerStorer, createLazyStorer, exportChannels, exportTypes, getObject, issueFullBackup, store, storeAll, storeAll

Methods inherited from interface one.microstream.storage.types.StorageController

close, initializationDuration, isShutdown

Methods inherited from interface one.microstream.storage.types.StorageManager

customRoot, databaseName, storeDefaultRoot

Method Details
- database
  
  public final Database database()
  
  Description copied from interface: StorageManager
  
  Returns the Database instance this StorageManager is associated with. See its description for details.
  
  Specified by:
  
  database in interface StorageManager
  
  Returns:
  
  the associated Database instance.
- root
  
  public final Object root()
  
  Description copied from interface: StorageManager
  Return the persistent object graph's root object, without specific typing.
  If a specifically typed root instance reference is desired, it is preferable to hold a properly typed constant reference to it and let the storage initialization use that instance as the root.
  See the following code snippet on how to do that:
  static final MyAppRoot ROOT = new MyAppRoot(); static final StorageManager STORAGE = EmbeddedStorage.start(ROOT);
  Specified by:
  
  root in interface StorageManager
  
  Returns:
  
  the persistent object graph's root object.
- setRoot
  
  public final Object setRoot(Object newRoot)
  
  Description copied from interface: StorageManager
  
  Sets the passed instance as the new root for the persistent object graph.
  Note that this will replace the old root instance, potentially resulting in wiping the whole database.
  
  Specified by:
  
  setRoot in interface StorageManager
  
  Parameters:
  
  newRoot - the new root instance to be set.
  
  Returns:
  
  the passed newRoot to allow fluent usage of this method.
- storeRoot
  
  public long storeRoot()
  
  Description copied from interface: StorageManager
  
  Stores the registered root instance (as returned by StorageManager.root()) by using the default storing logic by calling StorageConnection.createStorer() to create the Storer to be used.
  Depending on the storer logic, storing the root instance can cause many other object to be stored, as well. For example for the default behavior (as implemented in StorageConnection.createLazyStorer(), all recursively referenced instances that are not yet known to the persistent context (i.e. have an associated objectId registered in the context's PersistenceObjectRegistry) are stored as well.
  
  Specified by:
  
  storeRoot in interface StorageManager
  
  Returns:
  
  the root instance's objectId.
- viewRoots
  
  public final PersistenceRootsView viewRoots()
  
  Description copied from interface: StorageManager
  
  Returns a read-only view on all technical root instance registered in this StorageManager instance.
  See the description in PersistenceRootsView for details.
  
  Specified by:
  
  viewRoots in interface StorageManager
  
  Returns:
  
  a new PersistenceRootsView instance allowing to iterate all technical root instances.
- persistenceManager
  
  public PersistenceManager<Binary> persistenceManager()
  
  Specified by:
  
  persistenceManager in interface StorageConnection
  
  Returns:
  
  the PersistenceManager used by this StorageConnection.
- createStorer
  
  public final Storer createStorer()
  
  Description copied from interface: StorageConnection
  
  Creates a new Storer instance with default storing behavior. The default is lazy storing. See Persister.createLazyStorer().
  
  Specified by:
  
  createStorer in interface Persister
  
  Specified by:
  
  createStorer in interface StorageConnection
  
  Returns:
  
  the newly created Storer instance.
- mayRun
  
  public boolean mayRun()
  
  Specified by:
  
  mayRun in interface LazyReferenceManager.Controller
- start
  
  public final EmbeddedStorageManager.Default start()
  
  Description copied from interface: StorageManager
  "Starts" the storage controlled by this StorageController instance, with "starting" meaning:
  
  Reading, indexing and potentially caching all the persisted data in the storage.
  
  Starting storage managing threads to execute requests like storing, loading and issued utility functions.
  Specified by:
  
  start in interface EmbeddedStorageManager
  
  Specified by:
  
  start in interface StorageController
  
  Specified by:
  
  start in interface StorageManager
  
  Returns:
  
  this to allow writing of fluent code.
- shutdown
  
  public final boolean shutdown()
  
  Description copied from interface: StorageManager
  
  Issues a command to shut down all active threads managing the storage.
  
  Specified by:
  
  shutdown in interface StorageController
  
  Specified by:
  
  shutdown in interface StorageManager
  
  Returns:
  
  true after a successful shutdown or false if an internal InterruptedException happened.
- isAcceptingTasks
  
  public final boolean isAcceptingTasks()
  
  Specified by:
  
  isAcceptingTasks in interface StorageController
- isRunning
  
  public final boolean isRunning()
  
  Specified by:
  
  isRunning in interface StorageController
- isActive
  
  public final boolean isActive()
  
  Description copied from interface: StorageActivePart
  
  Queries whether the part is actually active right now. This might return true even despite some "running" flag being set to false because there might be one last loop cycle execution before checking the "running" flag again.
  
  Specified by:
  
  isActive in interface StorageActivePart
  
  Returns:
  
  if the part is actually active right now.
- isStartingUp
  
  public final boolean isStartingUp()
  
  Specified by:
  
  isStartingUp in interface StorageController
- isShuttingDown
  
  public final boolean isShuttingDown()
  
  Specified by:
  
  isShuttingDown in interface StorageController
- checkAcceptingTasks
  
  public final void checkAcceptingTasks()
  
  Specified by:
  
  checkAcceptingTasks in interface StorageController
- configuration
  
  public final StorageConfiguration configuration()
  
  Description copied from interface: StorageManager
  
  Returns the StorageConfiguration used to initialize this StorageManager instance.
  
  Specified by:
  
  configuration in interface StorageManager
  
  Returns:
  
  the used configuration.
- typeDictionary
  
  public final StorageTypeDictionary typeDictionary()
  
  Description copied from interface: StorageManager
  
  Returns the StorageTypeDictionary that contains a completely list of types currently known to / handled by the storage represented by this StorageManager instance. This list grows dynamically as so far unknown types are discovered, analyzed, mapped and added on the fly by a store.
  
  Specified by:
  
  typeDictionary in interface StorageManager
  
  Returns:
  
  thr current StorageTypeDictionary.
- createConnection
  
  public final StorageConnection createConnection()
  
  Description copied from interface: StorageManager
  
  Creates a new StorageConnection instance. See the type description for details.
  Not that while it makes sense on an architectural level to have a connecting mechanism between application logic and storage level, there is currently no need to create additional connections beyond the intrinsic one held inside a StorageManager instance. Just use it instead.
  
  Specified by:
  
  createConnection in interface StorageManager
  
  Returns:
  
  a new StorageConnection instance.
- initializationTime
  
  public final long initializationTime()
  
  Specified by:
  
  initializationTime in interface StorageController
- operationModeTime
  
  public final long operationModeTime()
  
  Specified by:
  
  operationModeTime in interface StorageController
- issueFullGarbageCollection
  
  public final void issueFullGarbageCollection()
  
  Description copied from interface: StorageConnection
  
  Issues a full garbage collection to be executed. Depending on the size of the database, the available cache, used hardware, etc., this can take any amount of time.
  Garbage collection marks all persisted objects/records that are reachable from the root (mark phase) and once that is completed, all non-marked records are determined to be effectively unreachable and are thus deleted. This common mechanism in graph-organised data completely removes the need for any explicit deleting.
  Note that the garbage collection on the storage level has nothing to do with the JVM's Garbage Collector on the heap level. While the technical principle is the same, both GCs are separate from each other and do not have anything to do with each other.
  
  Specified by:
  
  issueFullGarbageCollection in interface StorageConnection
  
  See Also:
  
  StorageConnection.issueGarbageCollection(long)
- issueGarbageCollection
  
  public final boolean issueGarbageCollection(long nanoTimeBudget)
  
  Description copied from interface: StorageConnection
  
  Issues garbage collection to be executed, limited to the time budget in nanoseconds specified by the passed nanoTimeBudget.
  When the time budget is used up, the garbage collector will keep the current progress and continue there at the next opportunity. The same progress marker is used by the implicit housekeeping, so both mechanisms will continue on the same progress.
  If no store has occured since the last completed garbage sweep, this method will have no effect and return immediately.
  
  Specified by:
  
  issueGarbageCollection in interface StorageConnection
  
  Parameters:
  
  nanoTimeBudget - the time budget in nanoseconds to be used to perform garbage collection.
  
  Returns:
  
  whether the returned call has completed garbage collection.
  
  See Also:
  
  StorageConnection.issueFullGarbageCollection()
- issueFullFileCheck
  
  public final void issueFullFileCheck()
  
  Description copied from interface: StorageConnection
  
  Issues a full storage file check to be executed. Depending on the size of the database, the available cache, used hardware, etc., this can take any amount of time.
  File checking evaluates every storage data file about being either too small, too big or having too many logical "gaps" in it (created by storing newer versions of an object or by garbage collection). If one of those checks applies, the remaining live data in the file is moved to the current head file and once that is done, the source file (now consisting of 100% logical "gaps", making it effectively superfluous) is then deleted.
  The exact logic is defined by StorageConfiguration.dataFileEvaluator()
  
  Specified by:
  
  issueFullFileCheck in interface StorageConnection
  
  See Also:
  
  StorageConnection.issueFileCheck(long)
- issueFileCheck
  
  public final boolean issueFileCheck(long nanoTimeBudget)
  
  Description copied from interface: StorageConnection
  
  Issues a storage file check to be executed, limited to the time budget in nanoseconds specified by the passed nanoTimeBudget.
  When the time budget is used up, the checking logic will keep the current progress and continue there at the next opportunity. The same progress marker is used by the implicit housekeeping, so both mechanisms will continue on the same progress.
  If no store has occured since the last completed check, this method will have no effect and return immediately.
  
  Specified by:
  
  issueFileCheck in interface StorageConnection
  
  Parameters:
  
  nanoTimeBudget - the time budget in nanoseconds to be used to perform file checking.
  
  Returns:
  
  whether the returned call has completed file checking.
- issueFullCacheCheck
  
  public final void issueFullCacheCheck()
  
  Description copied from interface: StorageConnection
  
  Issues a full storage cache check to be executed. Depending on the size of the database, the available cache, used hardware, etc., this can take any amount of time.
  Cache checking evaluates every cache entity data about being worth to be kept in cache according to the configured StorageEntityCacheEvaluator logic. If deemed unworthy, its data will be cleared from the cache and has to be loaded from the persistent form on the next reading access.
  The check will run until the used cache size is 0 or every entity is checked at least once.
  
  Specified by:
  
  issueFullCacheCheck in interface StorageConnection
  
  See Also:
  
  StorageConnection.issueFullCacheCheck(StorageEntityCacheEvaluator), StorageConnection.issueCacheCheck(long), StorageConnection.issueCacheCheck(long, StorageEntityCacheEvaluator)
- issueFullCacheCheck
  
  public final void issueFullCacheCheck(StorageEntityCacheEvaluator entityEvaluator)
  
  Description copied from interface: StorageConnection
  
  Same as StorageConnection.issueFullCacheCheck(), but with using the passed StorageEntityCacheEvaluator logic instead of the configured one.
  
  Specified by:
  
  issueFullCacheCheck in interface StorageConnection
  
  Parameters:
  
  entityEvaluator - the entity cache evaluation logic to be used for the call.
  
  See Also:
  
  StorageConnection.issueFullCacheCheck(), StorageConnection.issueCacheCheck(long), StorageConnection.issueCacheCheck(long, StorageEntityCacheEvaluator)
- issueCacheCheck
  
  public final boolean issueCacheCheck(long nanoTimeBudget)
  
  Description copied from interface: StorageConnection
  
  Issues a storage cache check to be executed, limited to the time budget in nanoseconds specified by the passed nanoTimeBudget.
  When the time budget is used up, the checking logic will keep the current progress and continue there at the next opportunity. The same progress marker is used by the implicit housekeeping, so both mechanisms will continue on the same progress.
  If the used cache size is 0, this method will have no effect and return immediately.
  
  Specified by:
  
  issueCacheCheck in interface StorageConnection
  
  Parameters:
  
  nanoTimeBudget - the time budget in nanoseconds to be used to perform cache checking.
  
  Returns:
  
  whether the used cache size is 0 or became 0 via the performed check.
  
  See Also:
  
  StorageConnection.issueFullCacheCheck(), StorageConnection.issueFullCacheCheck(StorageEntityCacheEvaluator), StorageConnection.issueCacheCheck(long, StorageEntityCacheEvaluator)
- issueCacheCheck
  
  public final boolean issueCacheCheck(long nanoTimeBudget, StorageEntityCacheEvaluator entityEvaluator)
  
  Description copied from interface: StorageConnection
  
  Same as StorageConnection.issueCacheCheck(long), but with using the passed StorageEntityCacheEvaluator logic instead of the configured one.
  
  Specified by:
  
  issueCacheCheck in interface StorageConnection
  
  entityEvaluator - the entity cache evaluation logic to be used for the call.
  
  See Also:
  
  StorageConnection.issueFullCacheCheck(), StorageConnection.issueFullCacheCheck(StorageEntityCacheEvaluator), StorageConnection.issueCacheCheck(long)
- issueFullBackup
  
  public final void issueFullBackup(StorageLiveFileProvider targetFileProvider, PersistenceTypeDictionaryExporter typeDictionaryExporter)
  
  Description copied from interface: StorageConnection
  
  Issues a full backup of the whole storage to be executed. Keep in mind that this could result in a very long running operation, depending on the storage size.
  Although the full backup may be a valid solution in some circumstances, the incremental backup should be preferred, since it is by far more efficient.
  
  Specified by:
  
  issueFullBackup in interface StorageConnection
  
  Parameters:
  
  targetFileProvider - file provider for backup files
- createStorageStatistics
  
  public final StorageRawFileStatistics createStorageStatistics()
  
  Description copied from interface: StorageConnection
  
  Creates a StorageRawFileStatistics instance, (obviously) containing raw file statistics about every channel in the storage.
  
  Specified by:
  
  createStorageStatistics in interface StorageConnection
  
  Returns:
  
  a StorageRawFileStatistics instance based on the current state.
- exportChannels
  
  public final void exportChannels(StorageLiveFileProvider fileProvider, boolean performGarbageCollection)
  
  Description copied from interface: StorageConnection
  
  Exports the data of all channels in the storage by using the passed StorageLiveFileProvider instance.
  This is basically a simple file copy applied to all files in the storage, however with the guaranteed safety of no other task / access to the storage's files intervening with the ongoing process. This is useful to safely create a complete copy of the storage, e.g. a full backup.
  
  Specified by:
  
  exportChannels in interface StorageConnection
  
  Parameters:
  
  fileProvider - the StorageLiveFileProvider logic to be used for the export.
  
  performGarbageCollection - whether a StorageConnection.issueFullGarbageCollection() shall be issued before performing the export.
- exportTypes
  
  public final StorageEntityTypeExportStatistics exportTypes(StorageEntityTypeExportFileProvider exportFileProvider, Predicate<? super StorageEntityTypeHandler> isExportType)
  
  Description copied from interface: StorageConnection
  
  Exports the entity data of all selected types of all channels into one file per type.
  The data will be in the native binary format used internally by the storage. Converters can be used to transform the data into a different, for example human readable, form like CSV.
  This is useful to extract the data contained in the storage in a structured way, for example to migrate it into another storage system or to analyze it, like converting it into human readable form.
  
  Specified by:
  
  exportTypes in interface StorageConnection
  
  Parameters:
  
  exportFileProvider - the StorageEntityTypeExportFileProvider logic to be used.
  
  isExportType - a Predicate selecting which type's entity data to be exported.
  
  Returns:
  
  a StorageEntityTypeExportStatistics information instance about the completed export.
  
  See Also:
  
  StorageConnection.exportTypes(StorageEntityTypeExportFileProvider)
- importFiles
  
  public final void importFiles(XGettingEnum<AFile> importFiles)
  
  Description copied from interface: StorageConnection
  
  Imports all files specified by the passed Enum (ordered set) of AFile in order.
  The files are assumed to be in the native binary format used internally by the storage.
  All entities contained in the specified files will be imported. If they already exist in the storage (identified by their ObjectId), their current data will be replaced by the imported data.
  Note that importing data that is not reachable from any root entity will have no effect and will eventually be deleted by the garbage collector.
  
  Specified by:
  
  importFiles in interface StorageConnection
  
  Parameters:
  
  importFiles - the files whose native binary content shall be imported.
- defaultRoot
  
  @Deprecated public final Reference<Object> defaultRoot()
  
  Deprecated.
  
  Description copied from interface: StorageManager
  
  This method is deprecated due to simplified root handling and will be removed in a future version.
  It is advised to use StorageManager.root() and StorageManager.setRoot(Object) instead.
  
  Specified by:
  
  defaultRoot in interface StorageManager
  
  Returns:
  
  a mutable Reference to the root object.

Class EmbeddedStorageManager.Default

Nested Class Summary

Nested classes/interfaces inherited from interface one.microstream.storage.embedded.types.EmbeddedStorageManager

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface one.microstream.storage.types.StorageConnection

Methods inherited from interface one.microstream.storage.types.StorageController

Methods inherited from interface one.microstream.storage.types.StorageManager

Method Details