RebindManager (Apache Brooklyn)

All Known Implementing Classes:

RebindManagerImpl
```
public interface RebindManager
```
Manages the persisting of brooklyn's state, and recreating that state, e.g. on brooklyn restart. Users are not expected to implement this class, or to call methods on it directly.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class RebindManager.RebindFailureMode

Nested Classes
Modifier and Type	Interface and Description
`static class`	`RebindManager.RebindFailureMode`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`forcePersistNow()` Deprecated. since 0.7.0; use `forcePersistNow(boolean, PersistenceExceptionHandler)`, default parameter here is false to mean incremental, with null/default exception handler
`void`	`forcePersistNow(boolean full, PersistenceExceptionHandler exceptionHandler)` Forcibly performs persistence, in the foreground, either full (all entities) or incremental; if no exception handler specified, the default one from the persister is used.
`ChangeListener`	`getChangeListener()`
`java.util.Map<java.lang.String,java.lang.Object>`	`getMetrics()` Metrics about rebind, last success, etc.
`BrooklynMementoPersister`	`getPersister()`
`boolean`	`isAwaitingInitialRebind()` Whether the management state has changed to a state where a rebind is needed but we are still awaiting the first run; ie state is master or hot, but list of apps is not yet accurate
`java.util.List<Application>`	`rebind()` Deprecated. since 0.7; use `rebind(ClassLoader, RebindExceptionHandler, ManagementNodeState)`
`java.util.List<Application>`	`rebind(java.lang.ClassLoader classLoader)` Deprecated. since 0.7; use `rebind(ClassLoader, RebindExceptionHandler, ManagementNodeState)`
`java.util.List<Application>`	`rebind(java.lang.ClassLoader classLoader, RebindExceptionHandler exceptionHandler)` Deprecated. since 0.7; use `rebind(ClassLoader, RebindExceptionHandler, ManagementNodeState)`
`java.util.List<Application>`	`rebind(java.lang.ClassLoader classLoader, RebindExceptionHandler exceptionHandler, ManagementNodeState mode)` Causes this management context to rebind, loading data from the given backing store.
`BrooklynMementoRawData`	`retrieveMementoRawData()`
`void`	`setPersister(BrooklynMementoPersister persister)`
`void`	`setPersister(BrooklynMementoPersister persister, PersistenceExceptionHandler exceptionHandler)`
`void`	`start()` Starts the appropriate background processes, `startPersistence()` if `ManagementNodeState.MASTER`, `#startReadOnly()` if `ManagementNodeState.HOT_STANDBY` or `ManagementNodeState.HOT_BACKUP`
`void`	`startPersistence()` Starts the background persisting of state (if persister is set; otherwise will start persisting as soon as persister is set).
`void`	`startReadOnly(ManagementNodeState mode)` Perform an initial load of state read-only and starts a background process reading (mirroring) state periodically.
`void`	`stop()` Stops the appropriate background processes, `stopPersistence()` or `stopReadOnly()`, waiting for activity there to cease (interrupting in the case of `stopReadOnly()`).
`void`	`stopPersistence()` Stops the background persistence of state.
`void`	`stopReadOnly()` Stops the background reading (mirroring) of state.
`void`	`waitForPendingComplete(Duration duration, boolean canTrigger)`

- Method Detail
  - setPersister
```
void setPersister(BrooklynMementoPersister persister)
```
  - setPersister
```
void setPersister(BrooklynMementoPersister persister,
                PersistenceExceptionHandler exceptionHandler)
```
  - getPersister
```
BrooklynMementoPersister getPersister()
```
  - rebind
```
@Deprecated
java.util.List<Application> rebind()
```
    Deprecated. since 0.7; use rebind(ClassLoader, RebindExceptionHandler, ManagementNodeState)
  - rebind
```
@Deprecated
java.util.List<Application> rebind(java.lang.ClassLoader classLoader)
```
    Deprecated. since 0.7; use rebind(ClassLoader, RebindExceptionHandler, ManagementNodeState)
  - rebind
```
@Deprecated
java.util.List<Application> rebind(java.lang.ClassLoader classLoader,
                                            RebindExceptionHandler exceptionHandler)
```
    Deprecated. since 0.7; use rebind(ClassLoader, RebindExceptionHandler, ManagementNodeState)
  - rebind
```
java.util.List<Application> rebind(java.lang.ClassLoader classLoader,
                                 RebindExceptionHandler exceptionHandler,
                                 ManagementNodeState mode)
```
    Causes this management context to rebind, loading data from the given backing store. use wisely, as this can cause local entities to be completely lost, or will throw in many other situations. in general it may be invoked for a new node becoming ManagementNodeState.MASTER or periodically for a node in ManagementNodeState.HOT_STANDBY or ManagementNodeState.HOT_BACKUP.
  - retrieveMementoRawData
```
BrooklynMementoRawData retrieveMementoRawData()
```
  - getChangeListener
```
ChangeListener getChangeListener()
```
  - startPersistence
```
void startPersistence()
```
    Starts the background persisting of state (if persister is set; otherwise will start persisting as soon as persister is set). Until this is called, no data will be persisted although entities can be rebinded.
  - stopPersistence
```
void stopPersistence()
```
    Stops the background persistence of state. Waits for any current persistence to complete.
  - startReadOnly
```
void startReadOnly(ManagementNodeState mode)
```
    Perform an initial load of state read-only and starts a background process reading (mirroring) state periodically.
  - stopReadOnly
```
void stopReadOnly()
```
    Stops the background reading (mirroring) of state. Interrupts any current activity and waits for it to cease.
  - start
```
void start()
```
    Starts the appropriate background processes, startPersistence() if ManagementNodeState.MASTER, #startReadOnly() if ManagementNodeState.HOT_STANDBY or ManagementNodeState.HOT_BACKUP
  - stop
```
void stop()
```
    Stops the appropriate background processes, stopPersistence() or stopReadOnly(), waiting for activity there to cease (interrupting in the case of stopReadOnly()).
  - waitForPendingComplete
```
void waitForPendingComplete(Duration duration,
                          boolean canTrigger)
                            throws java.lang.InterruptedException,
                                   java.util.concurrent.TimeoutException
```
    Throws:
    
    java.lang.InterruptedException
    
    java.util.concurrent.TimeoutException
  - forcePersistNow
```
void forcePersistNow()
```
    Deprecated. since 0.7.0; use forcePersistNow(boolean, PersistenceExceptionHandler), default parameter here is false to mean incremental, with null/default exception handler
    
    Forcibly performs persistence, in the foreground
  - forcePersistNow
```
void forcePersistNow(boolean full,
                   @Nullable
                   PersistenceExceptionHandler exceptionHandler)
```
    Forcibly performs persistence, in the foreground, either full (all entities) or incremental; if no exception handler specified, the default one from the persister is used.
    Note that full persistence does *not* delete items; incremental should normally be sufficient. (A clear then full persistence would have the same effect, but that is risky in a production setting if the process fails after the clear!)
  - isAwaitingInitialRebind
```
boolean isAwaitingInitialRebind()
```
    Whether the management state has changed to a state where a rebind is needed but we are still awaiting the first run; ie state is master or hot, but list of apps is not yet accurate
  - getMetrics
```
java.util.Map<java.lang.String,java.lang.Object> getMetrics()
```
    Metrics about rebind, last success, etc.

Interface RebindManager

Nested Class Summary

Method Summary

Method Detail

setPersister

setPersister

getPersister

rebind

rebind

rebind

rebind

retrieveMementoRawData

getChangeListener

startPersistence

stopPersistence

startReadOnly

stopReadOnly

start

stop

waitForPendingComplete

forcePersistNow

forcePersistNow

isAwaitingInitialRebind

getMetrics