Method Detail

• loadMementoRawData

  BrooklynMementoRawData loadMementoRawData(RebindExceptionHandler exceptionHandler)

  Loads raw data contents of the mementos.

  Some classes (esp deprecated ones) may return null here, meaning that the loadMementoManifest(BrooklynMementoRawData, RebindExceptionHandler) and loadMemento(BrooklynMementoRawData, LookupContext, RebindExceptionHandler) methods will populate the raw data via another source.

• loadMementoManifest

  BrooklynMementoManifest loadMementoManifest(RebindExceptionHandler exceptionHandler)
                                              throws java.io.IOException

  Deprecated. since 0.7.0 use loadMementoManifest(BrooklynMementoRawData, RebindExceptionHandler)

  Throws:

  java.io.IOException

• loadMementoManifest

  BrooklynMementoManifest loadMementoManifest(@Nullable
                                            BrooklynMementoRawData mementoData,
                                            RebindExceptionHandler exceptionHandler)
                                              throws java.io.IOException

  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.

  Throws:

  java.io.IOException

• loadMemento

  BrooklynMemento loadMemento(BrooklynMementoPersister.LookupContext lookupContext,
                            RebindExceptionHandler exceptionHandler)
                              throws java.io.IOException

  Deprecated. since 0.7.0 use #loadMemento(RebindExceptionHandler)

  Throws:

  java.io.IOException

• loadMemento

  BrooklynMemento loadMemento(@Nullable
                            BrooklynMementoRawData mementoData,
                            BrooklynMementoPersister.LookupContext lookupContext,
                            RebindExceptionHandler exceptionHandler)
                              throws java.io.IOException

  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.

  Throws:

  java.io.IOException

• checkpoint

  @Deprecated
  void checkpoint(BrooklynMemento memento,
                           PersistenceExceptionHandler exceptionHandler)

  Deprecated. since 0.7.0, use checkpoint(BrooklynMementoRawData, PersistenceExceptionHandler) and javadoc on implementations of that

• checkpoint

  void checkpoint(BrooklynMementoRawData newMemento,
                PersistenceExceptionHandler exceptionHandler)

  applies a full checkpoint (write) of all state

• delta

  void delta(BrooklynMementoPersister.Delta delta,
           PersistenceExceptionHandler exceptionHandler)

  applies a partial write of state delta

• queueDelta

  @Beta
  void queueDelta(BrooklynMementoPersister.Delta delta)

  inserts an additional delta to be written on the next delta request

• enableWriteAccess

  void enableWriteAccess()

• disableWriteAccess

  void disableWriteAccess(boolean graceful)

• stop

  void stop(boolean graceful)

  permanently shuts down all access to the remote store

• waitForWritesCompleted

  void waitForWritesCompleted(Duration timeout)
                              throws java.lang.InterruptedException,
                                     java.util.concurrent.TimeoutException

  Throws:

  java.lang.InterruptedException

  java.util.concurrent.TimeoutException

• waitForWritesCompleted

  void waitForWritesCompleted(long timeout,
                            java.util.concurrent.TimeUnit unit)
                              throws java.lang.InterruptedException,
                                     java.util.concurrent.TimeoutException

  Deprecated. since 0.7.0; use waitForWritesCompleted(Duration)

  Throws:

  java.lang.InterruptedException

  java.util.concurrent.TimeoutException

• getBackingStoreDescription

  java.lang.String getBackingStoreDescription()