org.apache.brooklyn.entity.software.base

Enum SoftwareProcess.ChildStartableMode

java.lang.Object

java.lang.Enum<SoftwareProcess.ChildStartableMode>

org.apache.brooklyn.entity.software.base.SoftwareProcess.ChildStartableMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SoftwareProcess.ChildStartableMode>

Enclosing interface:

SoftwareProcess

public static enum SoftwareProcess.ChildStartableMode
extends java.lang.Enum<SoftwareProcess.ChildStartableMode>

Controls the behavior when starting (stop, restart) Startable children as part of the start (stop, restart) effector on this entity

(NB: restarts are currently not propagated to children in the default SoftwareProcess due to the various semantics which may be desired; this may change, but if entities have specific requirements for restart, developers should either subclass the SoftwareProcessDriverLifecycleEffectorTasks and/or lean on sensors from the parent

Enum Constant Summary

Enum Constants

Enum Constant and Description
BACKGROUND start Startable children concurrent with *driver* start (stop, restart), but in background, ie disassociated from the effector task at this entity (so that this entity can complete start/stop independent of children)
BACKGROUND_LATE as BACKGROUND but isLate
FOREGROUND start (stop) Startable children concurrent with *driver* start (stop), in foreground, so invoking entity will wait for children to complete.
FOREGROUND_LATE as FOREGROUND but isLate
NONE do nothing with Startable children

Field Summary

Fields

Modifier and Type	Field and Description
boolean	isBackground whether starting (stopping, restarting) children is backgrounded, so parent should not wait on them
boolean	isDisabled whether starting (stopping, restarting) children is disabled
boolean	isLate whether starting (stopping, restarting) children should be nested, so start occurs after the driver is started, and stop before the driver is stopped (if false the children operations are concurrent with the parent), (with restart always being done in parallel though this behaviour may change)

Method Summary

Modifier and Type	Method and Description
static SoftwareProcess.ChildStartableMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SoftwareProcess.ChildStartableMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final SoftwareProcess.ChildStartableMode NONE

do nothing with Startable children

FOREGROUND

public static final SoftwareProcess.ChildStartableMode FOREGROUND

start (stop) Startable children concurrent with *driver* start (stop), in foreground, so invoking entity will wait for children to complete.

if the child requires the parent to reach a particular state before acting, when running in foreground the parent should communicate its state using sensors which the child listens for. note that often sensors at the parent are not activated until it is started, so the usual sensors connected at an entity may not be available when running in this mode

FOREGROUND_LATE

public static final SoftwareProcess.ChildStartableMode FOREGROUND_LATE

as FOREGROUND but isLate

BACKGROUND

public static final SoftwareProcess.ChildStartableMode BACKGROUND

start Startable children concurrent with *driver* start (stop, restart), but in background, ie disassociated from the effector task at this entity (so that this entity can complete start/stop independent of children)

BACKGROUND_LATE

public static final SoftwareProcess.ChildStartableMode BACKGROUND_LATE

as BACKGROUND but isLate

Field Detail

isDisabled

public final boolean isDisabled

whether starting (stopping, restarting) children is disabled

isBackground

public final boolean isBackground

whether starting (stopping, restarting) children is backgrounded, so parent should not wait on them

isLate

public final boolean isLate

whether starting (stopping, restarting) children should be nested, so start occurs after the driver is started, and stop before the driver is stopped (if false the children operations are concurrent with the parent), (with restart always being done in parallel though this behaviour may change)

Method Detail

values

public static SoftwareProcess.ChildStartableMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SoftwareProcess.ChildStartableMode c : SoftwareProcess.ChildStartableMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SoftwareProcess.ChildStartableMode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null