RebindManagerImpl (Apache Brooklyn)

java.lang.Object
- brooklyn.entity.rebind.RebindManagerImpl

All Implemented Interfaces:

RebindManager
```
public class RebindManagerImpl
extends java.lang.Object
implements RebindManager
```
Manages the persistence/rebind process.
Lifecycle is to create an instance of this, set it up (e.g. setPeriodicPersistPeriod(Duration), setPersister(BrooklynMementoPersister); however noting that persist period must be set before the persister).
Usually done for you by the conveniences (such as the launcher).

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RebindManagerImpl.RebindTracker
For tracking if rebinding, for AbstractBrooklynObject.isRebinding() etc.
- Nested classes/interfaces inherited from interface brooklyn.entity.rebind.RebindManager
  RebindManager.RebindFailureMode

Nested Classes
Modifier and Type	Class and Description
`static class`	`RebindManagerImpl.RebindTracker` For tracking if rebinding, for `AbstractBrooklynObject.isRebinding()` etc.

Field Summary

Fields
Modifier and Type	Field and Description
`static ConfigKey<RebindManager.RebindFailureMode>`	`ADD_POLICY_FAILURE_MODE`
`static ConfigKey<RebindManager.RebindFailureMode>`	`DANGLING_REFERENCE_FAILURE_MODE`
`static ConfigKey<QuorumCheck>`	`DANGLING_REFERENCES_MIN_REQUIRED_HEALTHY`
`static ConfigKey<RebindManager.RebindFailureMode>`	`LOAD_POLICY_FAILURE_MODE`
`static org.slf4j.Logger`	`LOG`
`static ConfigKey<RebindManager.RebindFailureMode>`	`REBIND_FAILURE_MODE`

Constructor Summary

Constructors
Constructor and Description

RebindManagerImpl(ManagementContextInternal managementContext)

Constructors
Constructor and Description
`RebindManagerImpl(ManagementContextInternal managementContext)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`forcePersistNow()` Forcibly performs persistence, in the foreground
`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()`
`ManagementContextInternal`	`getManagementContext()`
`java.util.Map<java.lang.String,java.lang.Object>`	`getMetrics()` Metrics about rebind, last success, etc.
`BrooklynMementoPersister`	`getPersister()`
`int`	`getReadOnlyRebindCount()`
`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
`boolean`	`isPersistenceRunning()`
`boolean`	`isReadOnlyRunning()`
`java.util.List<Application>`	`rebind()`
`java.util.List<Application>`	`rebind(java.lang.ClassLoader classLoader)`
`java.util.List<Application>`	`rebind(java.lang.ClassLoader classLoader, RebindExceptionHandler exceptionHandler)`
`java.util.List<Application>`	`rebind(java.lang.ClassLoader classLoaderO, RebindExceptionHandler exceptionHandlerO, ManagementNodeState modeO)` Causes this management context to rebind, loading data from the given backing store.
`void`	`rebindPartialActive(CompoundTransformer transformer, java.util.Iterator<BrooklynObject> objectsToRebind)`
`void`	`rebindPartialActive(CompoundTransformer transformer, java.lang.String... objectsToRebindIds)`
`BrooklynMementoRawData`	`retrieveMementoRawData()`
`void`	`setAwaitingInitialRebind(boolean isAwaitingInitialRebind)`
`void`	`setPeriodicPersistPeriod(Duration period)` Must be called before setPerister()
`void`	`setPeriodicPersistPeriod(long periodMillis)` Deprecated. since 0.7.0; use `setPeriodicPersistPeriod(Duration)`
`void`	`setPersister(BrooklynMementoPersister val)`
`void`	`setPersister(BrooklynMementoPersister val, PersistenceExceptionHandler exceptionHandler)`
`void`	`start()` Starts the appropriate background processes, `RebindManager.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, `RebindManager.stopPersistence()` or `RebindManager.stopReadOnly()`, waiting for activity there to cease (interrupting in the case of `RebindManager.stopReadOnly()`).
`void`	`stopPersistence()` Stops the background persistence of state.
`void`	`stopReadOnly()` Stops the background reading (mirroring) of state.
`java.lang.String`	`toString()`
`void`	`waitForPendingComplete(Duration timeout, boolean canTrigger)`

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

- Field Detail
  - DANGLING_REFERENCE_FAILURE_MODE
```
public static final ConfigKey<RebindManager.RebindFailureMode> DANGLING_REFERENCE_FAILURE_MODE
```
  - REBIND_FAILURE_MODE
```
public static final ConfigKey<RebindManager.RebindFailureMode> REBIND_FAILURE_MODE
```
  - ADD_POLICY_FAILURE_MODE
```
public static final ConfigKey<RebindManager.RebindFailureMode> ADD_POLICY_FAILURE_MODE
```
  - LOAD_POLICY_FAILURE_MODE
```
public static final ConfigKey<RebindManager.RebindFailureMode> LOAD_POLICY_FAILURE_MODE
```
  - DANGLING_REFERENCES_MIN_REQUIRED_HEALTHY
```
public static final ConfigKey<QuorumCheck> DANGLING_REFERENCES_MIN_REQUIRED_HEALTHY
```
  - LOG
```
public static final org.slf4j.Logger LOG
```
- Constructor Detail
  - RebindManagerImpl
```
public RebindManagerImpl(ManagementContextInternal managementContext)
```
- Method Detail
  - getManagementContext
```
public ManagementContextInternal getManagementContext()
```
  - setPeriodicPersistPeriod
```
public void setPeriodicPersistPeriod(Duration period)
```
    Must be called before setPerister()
  - setPeriodicPersistPeriod
```
public void setPeriodicPersistPeriod(long periodMillis)
```
    Deprecated. since 0.7.0; use setPeriodicPersistPeriod(Duration)
  - isPersistenceRunning
```
public boolean isPersistenceRunning()
```
  - isReadOnlyRunning
```
public boolean isReadOnlyRunning()
```
  - setPersister
```
public void setPersister(BrooklynMementoPersister val)
```
    Specified by:
    
    setPersister in interface RebindManager
  - setPersister
```
public void setPersister(BrooklynMementoPersister val,
                PersistenceExceptionHandler exceptionHandler)
```
    Specified by:
    
    setPersister in interface RebindManager
  - getPersister
```
public BrooklynMementoPersister getPersister()
```
    Specified by:
    
    getPersister in interface RebindManager
  - startPersistence
```
public void startPersistence()
```
    Description copied from interface: RebindManager
    
    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.
    
    Specified by:
    
    startPersistence in interface RebindManager
  - stopPersistence
```
public void stopPersistence()
```
    Description copied from interface: RebindManager
    
    Stops the background persistence of state. Waits for any current persistence to complete.
    
    Specified by:
    
    stopPersistence in interface RebindManager
  - startReadOnly
```
public void startReadOnly(ManagementNodeState mode)
```
    Description copied from interface: RebindManager
    
    Perform an initial load of state read-only and starts a background process reading (mirroring) state periodically.
    
    Specified by:
    
    startReadOnly in interface RebindManager
  - stopReadOnly
```
public void stopReadOnly()
```
    Description copied from interface: RebindManager
    
    Stops the background reading (mirroring) of state. Interrupts any current activity and waits for it to cease.
    
    Specified by:
    
    stopReadOnly in interface RebindManager
  - start
```
public void start()
```
    Description copied from interface: RebindManager
    
    Starts the appropriate background processes, RebindManager.startPersistence() if ManagementNodeState.MASTER, #startReadOnly() if ManagementNodeState.HOT_STANDBY or ManagementNodeState.HOT_BACKUP
    
    Specified by:
    
    start in interface RebindManager
  - stop
```
public void stop()
```
    Description copied from interface: RebindManager
    
    Stops the appropriate background processes, RebindManager.stopPersistence() or RebindManager.stopReadOnly(), waiting for activity there to cease (interrupting in the case of RebindManager.stopReadOnly()).
    
    Specified by:
    
    stop in interface RebindManager
  - rebindPartialActive
```
public void rebindPartialActive(CompoundTransformer transformer,
                       java.util.Iterator<BrooklynObject> objectsToRebind)
```
  - rebindPartialActive
```
public void rebindPartialActive(CompoundTransformer transformer,
                       java.lang.String... objectsToRebindIds)
```
  - waitForPendingComplete
```
public void waitForPendingComplete(Duration timeout,
                          boolean canTrigger)
                            throws java.lang.InterruptedException,
                                   java.util.concurrent.TimeoutException
```
    Specified by:
    
    waitForPendingComplete in interface RebindManager
    
    Throws:
    
    java.lang.InterruptedException
    
    java.util.concurrent.TimeoutException
  - forcePersistNow
```
public void forcePersistNow()
```
    Description copied from interface: RebindManager
    
    Forcibly performs persistence, in the foreground
    
    Specified by:
    
    forcePersistNow in interface RebindManager
  - forcePersistNow
```
public void forcePersistNow(boolean full,
                   PersistenceExceptionHandler exceptionHandler)
```
    Description copied from interface: RebindManager
    
    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!)
    
    Specified by:
    
    forcePersistNow in interface RebindManager
  - getChangeListener
```
public ChangeListener getChangeListener()
```
    Specified by:
    
    getChangeListener in interface RebindManager
  - rebind
```
public java.util.List<Application> rebind()
```
    Specified by:
    
    rebind in interface RebindManager
  - rebind
```
public java.util.List<Application> rebind(java.lang.ClassLoader classLoader)
```
    Specified by:
    
    rebind in interface RebindManager
  - rebind
```
public java.util.List<Application> rebind(java.lang.ClassLoader classLoader,
                                 RebindExceptionHandler exceptionHandler)
```
    Specified by:
    
    rebind in interface RebindManager
  - rebind
```
public java.util.List<Application> rebind(java.lang.ClassLoader classLoaderO,
                                 RebindExceptionHandler exceptionHandlerO,
                                 ManagementNodeState modeO)
```
    Description copied from interface: RebindManager
    
    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.
    
    Specified by:
    
    rebind in interface RebindManager
  - retrieveMementoRawData
```
public BrooklynMementoRawData retrieveMementoRawData()
```
    Specified by:
    
    retrieveMementoRawData in interface RebindManager
  - isAwaitingInitialRebind
```
public boolean isAwaitingInitialRebind()
```
    Description copied from interface: RebindManager
    
    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
    
    Specified by:
    
    isAwaitingInitialRebind in interface RebindManager
  - setAwaitingInitialRebind
```
public void setAwaitingInitialRebind(boolean isAwaitingInitialRebind)
```
  - getReadOnlyRebindCount
```
public int getReadOnlyRebindCount()
```
  - getMetrics
```
public java.util.Map<java.lang.String,java.lang.Object> getMetrics()
```
    Description copied from interface: RebindManager
    
    Metrics about rebind, last success, etc.
    
    Specified by:
    
    getMetrics in interface RebindManager
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class RebindManagerImpl

Nested Class Summary

Nested classes/interfaces inherited from interface brooklyn.entity.rebind.RebindManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DANGLING_REFERENCE_FAILURE_MODE

REBIND_FAILURE_MODE

ADD_POLICY_FAILURE_MODE

LOAD_POLICY_FAILURE_MODE

DANGLING_REFERENCES_MIN_REQUIRED_HEALTHY

LOG

Constructor Detail

RebindManagerImpl

Method Detail

getManagementContext

setPeriodicPersistPeriod

setPeriodicPersistPeriod

isPersistenceRunning

isReadOnlyRunning

setPersister

setPersister

getPersister

startPersistence

stopPersistence

startReadOnly

stopReadOnly

start

stop

rebindPartialActive

rebindPartialActive

waitForPendingComplete

forcePersistNow

forcePersistNow

getChangeListener

rebind

rebind

rebind

rebind

retrieveMementoRawData

isAwaitingInitialRebind

setAwaitingInitialRebind

getReadOnlyRebindCount

getMetrics

toString