BrooklynMementoPersisterToObjectStore (Apache Brooklyn)

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

All Implemented Interfaces:

BrooklynMementoPersister
```
public class BrooklynMementoPersisterToObjectStore
extends java.lang.Object
implements BrooklynMementoPersister
```
Implementation of the BrooklynMementoPersister backed by a pluggable PersistenceObjectStore such as a file system or a jclouds object store

Nested Class Summary
- Nested classes/interfaces inherited from interface brooklyn.mementos.BrooklynMementoPersister
  BrooklynMementoPersister.Delta, BrooklynMementoPersister.LookupContext, BrooklynMementoPersister.MutableDelta

Field Summary

Fields
Modifier and Type Field and Description

static ConfigKey<java.lang.Integer> PERSISTER_MAX_SERIALIZATION_ATTEMPTS

static ConfigKey<java.lang.Integer> PERSISTER_MAX_THREAD_POOL_SIZE

Fields
Modifier and Type	Field and Description
`static ConfigKey<java.lang.Integer>`	`PERSISTER_MAX_SERIALIZATION_ATTEMPTS`
`static ConfigKey<java.lang.Integer>`	`PERSISTER_MAX_THREAD_POOL_SIZE`

Constructor Summary

Constructors
Constructor and Description
`BrooklynMementoPersisterToObjectStore(PersistenceObjectStore objectStore, StringConfigMap brooklynProperties, java.lang.ClassLoader classLoader)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`checkpoint(BrooklynMemento newMemento, PersistenceExceptionHandler exceptionHandler)`
`void`	`checkpoint(BrooklynMementoRawData newMemento, PersistenceExceptionHandler exceptionHandler)` See `BrooklynPersistenceUtils` for conveniences for using this method.
`void`	`delta(BrooklynMementoPersister.Delta delta, PersistenceExceptionHandler exceptionHandler)` applies a partial write of state delta
`void`	`disableWriteAccess(boolean graceful)`
`void`	`enableWriteAccess()`
`java.lang.String`	`getBackingStoreDescription()`
`MementoSerializer<java.lang.Object>`	`getMementoSerializer()`
`PersistenceObjectStore`	`getObjectStore()`
`BrooklynMemento`	`loadMemento(BrooklynMementoPersister.LookupContext lookupContext, RebindExceptionHandler exceptionHandler)`
`BrooklynMemento`	`loadMemento(BrooklynMementoRawData mementoData, BrooklynMementoPersister.LookupContext lookupContext, RebindExceptionHandler exceptionHandler)` Retrieves the memento class, containing deserialized objects (but not the `BrooklynObject` class).
`BrooklynMementoManifest`	`loadMementoManifest(BrooklynMementoRawData mementoData, RebindExceptionHandler exceptionHandler)` Loads minimal manifest information (almost entirely not deserialized).
`BrooklynMementoManifest`	`loadMementoManifest(RebindExceptionHandler exceptionHandler)`
`BrooklynMementoRawData`	`loadMementoRawData(RebindExceptionHandler exceptionHandler)` Loads raw data contents of the mementos.
`void`	`queueDelta(BrooklynMementoPersister.Delta delta)` inserts an additional delta to be written on the next delta request
`void`	`stop(boolean graceful)` permanently shuts down all access to the remote store
`void`	`waitForWritesCompleted(Duration timeout)`
`void`	`waitForWritesCompleted(long timeout, java.util.concurrent.TimeUnit unit)`

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

- Field Detail
  - PERSISTER_MAX_THREAD_POOL_SIZE
```
public static final ConfigKey<java.lang.Integer> PERSISTER_MAX_THREAD_POOL_SIZE
```
  - PERSISTER_MAX_SERIALIZATION_ATTEMPTS
```
public static final ConfigKey<java.lang.Integer> PERSISTER_MAX_SERIALIZATION_ATTEMPTS
```
- Constructor Detail
  - BrooklynMementoPersisterToObjectStore
```
public BrooklynMementoPersisterToObjectStore(PersistenceObjectStore objectStore,
                                     StringConfigMap brooklynProperties,
                                     java.lang.ClassLoader classLoader)
```
- Method Detail
  - getMementoSerializer
```
public MementoSerializer<java.lang.Object> getMementoSerializer()
```
  - enableWriteAccess
```
public void enableWriteAccess()
```
    Specified by:
    
    enableWriteAccess in interface BrooklynMementoPersister
  - disableWriteAccess
```
public void disableWriteAccess(boolean graceful)
```
    Specified by:
    
    disableWriteAccess in interface BrooklynMementoPersister
  - stop
```
public void stop(boolean graceful)
```
    Description copied from interface: BrooklynMementoPersister
    
    permanently shuts down all access to the remote store
    
    Specified by:
    
    stop in interface BrooklynMementoPersister
  - getObjectStore
```
public PersistenceObjectStore getObjectStore()
```
  - loadMementoRawData
```
public BrooklynMementoRawData loadMementoRawData(RebindExceptionHandler exceptionHandler)
```
    Description copied from interface: BrooklynMementoPersister
    
    Loads raw data contents of the mementos.
    Some classes (esp deprecated ones) may return null here, meaning that the BrooklynMementoPersister.loadMementoManifest(BrooklynMementoRawData, RebindExceptionHandler) and BrooklynMementoPersister.loadMemento(BrooklynMementoRawData, LookupContext, RebindExceptionHandler) methods will populate the raw data via another source.
    
    Specified by:
    
    loadMementoRawData in interface BrooklynMementoPersister
  - loadMementoManifest
```
public BrooklynMementoManifest loadMementoManifest(RebindExceptionHandler exceptionHandler)
                                            throws java.io.IOException
```
    Specified by:
    
    loadMementoManifest in interface BrooklynMementoPersister
    
    Throws:
    
    java.io.IOException
  - loadMementoManifest
```
public BrooklynMementoManifest loadMementoManifest(BrooklynMementoRawData mementoData,
                                          RebindExceptionHandler exceptionHandler)
                                            throws java.io.IOException
```
    Description copied from interface: BrooklynMementoPersister
    
    Loads minimal manifest information (almost entirely *not* deserialized). Implementations should load the raw data if BrooklynMementoRawData is not supplied, but callers are encouraged to supply that for optimal performance.
    
    Specified by:
    
    loadMementoManifest in interface BrooklynMementoPersister
    
    Throws:
    
    java.io.IOException
  - loadMemento
```
public BrooklynMemento loadMemento(BrooklynMementoPersister.LookupContext lookupContext,
                          RebindExceptionHandler exceptionHandler)
                            throws java.io.IOException
```
    Specified by:
    
    loadMemento in interface BrooklynMementoPersister
    
    Throws:
    
    java.io.IOException
  - loadMemento
```
public BrooklynMemento loadMemento(BrooklynMementoRawData mementoData,
                          BrooklynMementoPersister.LookupContext lookupContext,
                          RebindExceptionHandler exceptionHandler)
                            throws java.io.IOException
```
    Description copied from interface: BrooklynMementoPersister
    
    Retrieves the memento class, containing deserialized objects (but not the BrooklynObject class). Implementations should load the raw data if BrooklynMementoRawData is not supplied, but callers are encouraged to supply that for optimal performance.
    Note that this method is *not* thread safe.
    
    Specified by:
    
    loadMemento in interface BrooklynMementoPersister
    
    Throws:
    
    java.io.IOException
  - checkpoint
```
@Beta
public void checkpoint(BrooklynMementoRawData newMemento,
                   PersistenceExceptionHandler exceptionHandler)
```
    See BrooklynPersistenceUtils for conveniences for using this method.
    
    Specified by:
    
    checkpoint in interface BrooklynMementoPersister
  - checkpoint
```
public void checkpoint(BrooklynMemento newMemento,
              PersistenceExceptionHandler exceptionHandler)
```
    Specified by:
    
    checkpoint in interface BrooklynMementoPersister
  - delta
```
public void delta(BrooklynMementoPersister.Delta delta,
         PersistenceExceptionHandler exceptionHandler)
```
    Description copied from interface: BrooklynMementoPersister
    
    applies a partial write of state delta
    
    Specified by:
    
    delta in interface BrooklynMementoPersister
  - queueDelta
```
public void queueDelta(BrooklynMementoPersister.Delta delta)
```
    Description copied from interface: BrooklynMementoPersister
    
    inserts an additional delta to be written on the next delta request
    
    Specified by:
    
    queueDelta in interface BrooklynMementoPersister
  - waitForWritesCompleted
```
public void waitForWritesCompleted(long timeout,
                          java.util.concurrent.TimeUnit unit)
                            throws java.lang.InterruptedException,
                                   java.util.concurrent.TimeoutException
```
    Specified by:
    
    waitForWritesCompleted in interface BrooklynMementoPersister
    
    Throws:
    
    java.lang.InterruptedException
    
    java.util.concurrent.TimeoutException
  - waitForWritesCompleted
```
public void waitForWritesCompleted(Duration timeout)
                            throws java.lang.InterruptedException,
                                   java.util.concurrent.TimeoutException
```
    Specified by:
    
    waitForWritesCompleted in interface BrooklynMementoPersister
    
    Throws:
    
    java.lang.InterruptedException
    
    java.util.concurrent.TimeoutException
  - getBackingStoreDescription
```
public java.lang.String getBackingStoreDescription()
```
    Specified by:
    
    getBackingStoreDescription in interface BrooklynMementoPersister

Class BrooklynMementoPersisterToObjectStore

Nested Class Summary

Nested classes/interfaces inherited from interface brooklyn.mementos.BrooklynMementoPersister

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PERSISTER_MAX_THREAD_POOL_SIZE

PERSISTER_MAX_SERIALIZATION_ATTEMPTS

Constructor Detail

BrooklynMementoPersisterToObjectStore

Method Detail

getMementoSerializer

enableWriteAccess

disableWriteAccess

stop

getObjectStore

loadMementoRawData

loadMementoManifest

loadMementoManifest

loadMemento

loadMemento

checkpoint

checkpoint

delta

queueDelta

waitForWritesCompleted

waitForWritesCompleted

getBackingStoreDescription