FileBasedObjectStore (Apache Brooklyn)

java.lang.Object
- brooklyn.entity.rebind.persister.FileBasedObjectStore

All Implemented Interfaces:: PersistenceObjectStore

public class FileBasedObjectStore
extends java.lang.Object
implements PersistenceObjectStore

Nested Class Summary
- Nested classes/interfaces inherited from interface brooklyn.entity.rebind.persister.PersistenceObjectStore
  PersistenceObjectStore.StoreObjectAccessor, PersistenceObjectStore.StoreObjectAccessorWithLock

Constructor Summary

Constructors
Constructor and Description

FileBasedObjectStore(java.io.File basedir)

Constructors
Constructor and Description
`FileBasedObjectStore(java.io.File basedir)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()` Closes all resources used by this ObjectStore.
`void`	`createSubPath(java.lang.String subPath)` create the directory at the given subPath relative to the base of this store
`void`	`deleteCompletely()` Entirely delete the contents of this persistence location.
`static void`	`deleteCompletely(java.io.File d)`
`java.io.File`	`getBaseDir()`
`java.lang.String`	`getSummaryName()` human-readable name of this object store
`void`	`injectManagementContext(ManagementContext mgmt)` Allows a way for an object store to be created ahead of time, and a mgmt context injected.
`java.util.List<java.lang.String>`	`listContentsWithSubPath(java.lang.String parentSubPath)` Lists the paths of objects contained at the given path, including the subpath.
`PersistenceObjectStore.StoreObjectAccessor`	`newAccessor(java.lang.String path)` For reading/writing data to the item at the given path.
`void`	`prepareForMasterUse()` Prepares the persistence store for "contentious writes".
`void`	`prepareForSharedUse(PersistMode persistMode, HighAvailabilityMode haMode)` 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.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FileBasedObjectStore
```
public FileBasedObjectStore(java.io.File basedir)
```
    Parameters:
    basedir -
- Method Detail
  - getSummaryName
```
public java.lang.String getSummaryName()
```
    Description copied from interface: PersistenceObjectStore
    
    human-readable name of this object store
    
    Specified by:
    
    getSummaryName in interface PersistenceObjectStore
  - getBaseDir
```
public java.io.File getBaseDir()
```
  - prepareForMasterUse
```
public void prepareForMasterUse()
```
    Description copied from interface: PersistenceObjectStore
    
    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 PersistenceObjectStore.prepareForSharedUse(PersistMode, HighAvailabilityMode) first (and PersistenceObjectStore.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).
    
    Specified by:
    
    prepareForMasterUse in interface PersistenceObjectStore
  - createSubPath
```
public void createSubPath(java.lang.String subPath)
```
    Description copied from interface: PersistenceObjectStore
    
    create the directory at the given subPath relative to the base of this store
    
    Specified by:
    
    createSubPath in interface PersistenceObjectStore
  - newAccessor
```
public PersistenceObjectStore.StoreObjectAccessor newAccessor(java.lang.String path)
```
    Description copied from interface: PersistenceObjectStore
    
    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.
    
    Specified by:
    
    newAccessor in interface PersistenceObjectStore
  - listContentsWithSubPath
```
public java.util.List<java.lang.String> listContentsWithSubPath(java.lang.String parentSubPath)
```
    Description copied from interface: PersistenceObjectStore
    
    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 PersistenceObjectStore.newAccessor(String).
    
    Specified by:
    
    listContentsWithSubPath in interface PersistenceObjectStore
  - close
```
public void close()
```
    Description copied from interface: PersistenceObjectStore
    
    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.
    
    Specified by:
    
    close in interface PersistenceObjectStore
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - injectManagementContext
```
public void injectManagementContext(ManagementContext mgmt)
```
    Description copied from interface: PersistenceObjectStore
    
    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.
    
    Specified by:
    
    injectManagementContext in interface PersistenceObjectStore
  - prepareForSharedUse
```
public void prepareForSharedUse(@Nullable
                       PersistMode persistMode,
                       HighAvailabilityMode haMode)
```
    Description copied from interface: PersistenceObjectStore
    
    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 PersistenceObjectStore.injectManagementContext(ManagementContext), but before PersistenceObjectStore.prepareForMasterUse().
    See PersistenceObjectStore.prepareForMasterUse() for discussion of "contentious writes".
    
    Specified by:
    
    prepareForSharedUse in interface PersistenceObjectStore
  - deleteCompletely
```
public void deleteCompletely()
```
    Description copied from interface: PersistenceObjectStore
    
    Entirely delete the contents of this persistence location. Use with care, primarily in tests. This will recursively wipe the indicated location.
    
    Specified by:
    
    deleteCompletely in interface PersistenceObjectStore
  - deleteCompletely
```
public static void deleteCompletely(java.io.File d)
```

Class FileBasedObjectStore

Nested Class Summary

Nested classes/interfaces inherited from interface brooklyn.entity.rebind.persister.PersistenceObjectStore

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FileBasedObjectStore

Method Detail

getSummaryName

getBaseDir

prepareForMasterUse

createSubPath

newAccessor

listContentsWithSubPath

close

toString

injectManagementContext

prepareForSharedUse

deleteCompletely

deleteCompletely