MachineLifecycleEffectorTasks (Apache Brooklyn)

java.lang.Object
- org.apache.brooklyn.entity.software.base.lifecycle.MachineLifecycleEffectorTasks

Direct Known Subclasses:

AnsibleLifecycleEffectorTasks, ChefLifecycleEffectorTasks, SaltLifecycleEffectorTasks, SameServerDriverLifecycleEffectorTasks, SoftwareProcessDriverLifecycleEffectorTasks
```
public abstract class MachineLifecycleEffectorTasks
extends java.lang.Object
```
Default skeleton for start/stop/restart tasks on machines.
Knows how to provision machines, making use of ProvidesProvisioningFlags.obtainProvisioningFlags(MachineProvisioningLocation), and provides hooks for injecting behaviour at common places.
Methods are designed for overriding, with the convention that *Async methods should queue (and not block). The following methods are commonly overridden (and you can safely queue tasks, block, or return immediately in them):
- #startProcessesAtMachine(Supplier) (required)
- stopProcessesAtMachine() (required, but can be left blank if you assume the VM will be destroyed)
- preStartCustom(MachineLocation)
- postStartCustom()
- preStopCustom()
- postStopCustom()
Note methods at this level typically look after the Attributes.SERVICE_STATE sensor.
Since:

0.6.0

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MachineLifecycleEffectorTasks.StopMachineDetails<T>

Nested Classes
Modifier and Type	Class and Description
`static class`	`MachineLifecycleEffectorTasks.StopMachineDetails<T>`

Field Summary

Fields
Modifier and Type	Field and Description
`static ConfigKey<java.util.Collection<? extends Location>>`	`LOCATIONS`
`static ConfigKey<java.lang.Boolean>`	`ON_BOX_BASE_DIR_RESOLVED`
`static ConfigKey<Duration>`	`STOP_PROCESS_TIMEOUT`

Constructor Summary

Constructors
Constructor and Description

MachineLifecycleEffectorTasks()

Constructors
Constructor and Description
`MachineLifecycleEffectorTasks()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`attachLifecycleEffectors(Entity entity)` Attaches lifecycle effectors (start, restart, stop) to the given entity post-creation.
`static boolean`	`canStop(SoftwareProcess.StopSoftwareParameters.StopMode stopMode, Entity entity)`
`static SoftwareProcess.StopSoftwareParameters.StopMode`	`getStopMachineMode(ConfigBag parameters)`
`Effector<java.lang.Void>`	`newRestartEffector()`
`EffectorBody<java.lang.Void>`	`newRestartEffectorTask()` Calls `restart(ConfigBag)`.
`Effector<java.lang.Void>`	`newStartEffector()` Return an effector suitable for setting in a `public static final` or attaching dynamically.
`EffectorBody<java.lang.Void>`	`newStartEffectorTask()` Returns the `EffectorBody` which supplies the implementation for the start effector.
`Effector<java.lang.Void>`	`newStopEffector()`
`EffectorBody<java.lang.Void>`	`newStopEffectorTask()` Calls `stop(ConfigBag)`.
`Effector<java.lang.Void>`	`newSuspendEffector()`
`EffectorBody<java.lang.Void>`	`newSuspendEffectorTask()` Calls `suspend(ConfigBag)`.
`static java.lang.String`	`resolveOnBoxDir(EntityInternal entity, MachineLocation machine)` Resolves the on-box dir.
`void`	`restart(ConfigBag parameters)` Default restart implementation for an entity.
`void`	`start(java.util.Collection<? extends Location> locations)` runs the tasks needed to start, wrapped by setting `Attributes.SERVICE_STATE_EXPECTED` appropriately
`void`	`stop(ConfigBag parameters)` Default stop implementation for an entity.
`void`	`suspend(ConfigBag parameters)` As `stop(org.apache.brooklyn.util.core.config.ConfigBag)` but calling `suspendAnyProvisionedMachines()` rather than `stopAnyProvisionedMachines()`.

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

- Field Detail
  - ON_BOX_BASE_DIR_RESOLVED
```
public static final ConfigKey<java.lang.Boolean> ON_BOX_BASE_DIR_RESOLVED
```
  - LOCATIONS
```
public static final ConfigKey<java.util.Collection<? extends Location>> LOCATIONS
```
  - STOP_PROCESS_TIMEOUT
```
public static final ConfigKey<Duration> STOP_PROCESS_TIMEOUT
```
- Constructor Detail
  - MachineLifecycleEffectorTasks
```
public MachineLifecycleEffectorTasks()
```
- Method Detail
  - attachLifecycleEffectors
```
public void attachLifecycleEffectors(Entity entity)
```
    Attaches lifecycle effectors (start, restart, stop) to the given entity post-creation.
  - newStartEffector
```
public Effector<java.lang.Void> newStartEffector()
```
    Return an effector suitable for setting in a public static final or attaching dynamically.
    The effector overrides the corresponding effector from Startable with the behaviour in this lifecycle class instance.
  - newRestartEffector
```
public Effector<java.lang.Void> newRestartEffector()
```
    See Also:
    #newStartEffector()}
  - newStopEffector
```
public Effector<java.lang.Void> newStopEffector()
```
    See Also:
    #newStartEffector()}
  - newSuspendEffector
```
public Effector<java.lang.Void> newSuspendEffector()
```
    See Also:
    #newStartEffector()}
  - newStartEffectorTask
```
public EffectorBody<java.lang.Void> newStartEffectorTask()
```
    Returns the EffectorBody which supplies the implementation for the start effector.
    Calls start(Collection) in this class.
  - newRestartEffectorTask
```
public EffectorBody<java.lang.Void> newRestartEffectorTask()
```
    Calls restart(ConfigBag).
    
    See Also:
    #newStartEffectorTask()}
  - newStopEffectorTask
```
public EffectorBody<java.lang.Void> newStopEffectorTask()
```
    Calls stop(ConfigBag).
    
    See Also:
    #newStartEffectorTask()}
  - newSuspendEffectorTask
```
public EffectorBody<java.lang.Void> newSuspendEffectorTask()
```
    Calls suspend(ConfigBag).
    
    See Also:
    #newStartEffectorTask()}
  - start
```
public void start(java.util.Collection<? extends Location> locations)
```
    runs the tasks needed to start, wrapped by setting Attributes.SERVICE_STATE_EXPECTED appropriately
  - resolveOnBoxDir
```
public static java.lang.String resolveOnBoxDir(EntityInternal entity,
                               MachineLocation machine)
```
    Resolves the on-box dir.
    Initialize and pre-create the right onbox working dir, if an ssh machine location. Logs a warning if not.
  - restart
```
public void restart(ConfigBag parameters)
```
    Default restart implementation for an entity.
    Stops processes if possible, then starts the entity again.
  - stop
```
public void stop(ConfigBag parameters)
```
    Default stop implementation for an entity.
    Aborts if already stopped, otherwise sets state Lifecycle.STOPPING then invokes preStopCustom(), stopProcessesAtMachine(), then finally stopAnyProvisionedMachines() and sets state Lifecycle.STOPPED. If no errors were encountered call postStopCustom() at the end.
  - suspend
```
public void suspend(ConfigBag parameters)
```
    As stop(org.apache.brooklyn.util.core.config.ConfigBag) but calling suspendAnyProvisionedMachines() rather than stopAnyProvisionedMachines().
  - getStopMachineMode
```
public static SoftwareProcess.StopSoftwareParameters.StopMode getStopMachineMode(ConfigBag parameters)
```
  - canStop
```
public static boolean canStop(SoftwareProcess.StopSoftwareParameters.StopMode stopMode,
              Entity entity)
```

Class MachineLifecycleEffectorTasks

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ON_BOX_BASE_DIR_RESOLVED

LOCATIONS

STOP_PROCESS_TIMEOUT

Constructor Detail

MachineLifecycleEffectorTasks

Method Detail

attachLifecycleEffectors

newStartEffector

newRestartEffector

newStopEffector

newSuspendEffector

newStartEffectorTask

newRestartEffectorTask

newStopEffectorTask

newSuspendEffectorTask

start

resolveOnBoxDir

restart

stop

suspend

getStopMachineMode

canStop