Method Detail

• getSummaryName

  java.lang.String getSummaryName()

  human-readable name of this object store

• injectManagementContext

  @Beta
  void injectManagementContext(ManagementContext managementContext)

  Allows a way for an object store to be created ahead of time, and a mgmt context injected. Currently subsequent changes are not permitted.

  A ManagementContext must be supplied via constructor or this method before invoking other methods.

• prepareForSharedUse

  @Beta
  void prepareForSharedUse(PersistMode persistMode,
                              HighAvailabilityMode highAvailabilityMode)

  Prepares the persistence store for read use and non-contentious write use, in particular detecting whether we should clean or register a need for backup etc. Typically called early in the setup lifecycle, after injectManagementContext(ManagementContext), but before prepareForMasterUse().

  See prepareForMasterUse() for discussion of "contentious writes".

• prepareForMasterUse

  @Beta
  void prepareForMasterUse()

  Prepares the persistence store for "contentious writes". These are defined as those writes which might overwrite important information. Implementations usually perform backup/versioning of the store if required.

  Caller must call prepareForSharedUse(PersistMode, HighAvailabilityMode) first (and injectManagementContext(ManagementContext) before that).

  This is typically invoked "at the last moment" e.g. before the any such write, mainly in order to prevent backups being made unnecessarily (e.g. if a node is standby, or if it tries to become master but is not capable), but also to prevent simultaneous backups which can cause problems with some stores (only a mgmt who knows he is the master should invoke this).

• newAccessor

  @Beta
  PersistenceObjectStore.StoreObjectAccessor newAccessor(java.lang.String path)

  For reading/writing data to the item at the given path. Note that the accessor is not generally thread safe, usually does not support blocking, and multiple instances may conflict with each other.

  Clients should wrap in a dedicated StoreObjectAccessorLocking and share if multiple threads may be accessing the store. This method may be changed in future to allow access to a shared locking accessor.

• createSubPath

  void createSubPath(java.lang.String subPath)

  create the directory at the given subPath relative to the base of this store

• listContentsWithSubPath

  java.util.List<java.lang.String> listContentsWithSubPath(java.lang.String subPath)

  Lists the paths of objects contained at the given path, including the subpath. For example, if a file-based ObjectStore is configured to write to file://path/to/root/ then parentSubPath=entities would return the contents of /path/to/root/entities/, such as [entities/e1, entities/e2, entities/e3]. The returned paths values are usable in calls to newAccessor(String).

• deleteCompletely

  void deleteCompletely()

  Entirely delete the contents of this persistence location. Use with care, primarily in tests. This will recursively wipe the indicated location.

• close

  void close()

  Closes all resources used by this ObjectStore. No subsequent calls should be made to the ObjectStore; behaviour of such calls is undefined but likely to throw exceptions.