org.apache.brooklyn.core.mgmt

Class EntityManagementUtils

java.lang.Object

org.apache.brooklyn.core.mgmt.EntityManagementUtils

public class EntityManagementUtils
extends java.lang.Object

Utility methods for working with entities and applications

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EntityManagementUtils.CreationResult<T,U> container for operation which creates something and which wants to return both the items created and any pending create/start task

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigKey<java.lang.Boolean>	WRAPPER_APP_MARKER A marker config value which indicates that an Application entity was created automatically, needed because a plan might give multiple top-level entities or a non-Application top-level entity, in a context where Brooklyn requires an Application at the root.

Constructor Summary

Constructors

Constructor and Description
EntityManagementUtils()

Method Summary

Modifier and Type	Method and Description
static EntityManagementUtils.CreationResult<java.util.List<Entity>,java.util.List<java.lang.String>>	addChildren(Entity parent, java.lang.String yaml, java.lang.Boolean start)
static EntityManagementUtils.CreationResult<java.util.List<Entity>,java.util.List<java.lang.String>>	addChildrenStarting(Entity parent, java.lang.String yaml)
static java.util.List<Entity>	addChildrenUnstarted(Entity parent, java.lang.String yaml) adds entities from the given yaml, under the given parent; but does not start them
static boolean	canUnwrapApplication(EntitySpec<? extends Application> wrapperApplication) As canUnwrapEntity(EntitySpec) but additionally requiring that the wrapped item is an Application, for use when the context requires an Application ie a root of a spec.
static boolean	canUnwrapEntity(EntitySpec<? extends Entity> spec) Returns true if the spec is for a wrapper app with no important settings, wrapping a single child entity.
static EntitySpec<? extends Application>	createEntitySpecForApplication(ManagementContext mgmt, java.lang.String plan)
static EntitySpec<? extends Application>	createEntitySpecForApplication(ManagementContext mgmt, java.lang.String format, java.lang.String plan)
static <T extends Application> EntityManagementUtils.CreationResult<T,java.lang.Void>	createStarting(ManagementContext mgmt, EntitySpec<T> appSpec)
static EntityManagementUtils.CreationResult<? extends Application,java.lang.Void>	createStarting(ManagementContext mgmt, java.lang.String appSpec)
static <T extends Application> T	createUnstarted(ManagementContext mgmt, EntitySpec<T> spec) creates an application from the given app spec, managed by the given management context
static <T extends Application> T	createUnstarted(ManagementContext mgmt, EntitySpec<T> spec, <any> entityId) As createUnstarted(ManagementContext, EntitySpec), but uses the given entity id (if present).
static Application	createUnstarted(ManagementContext mgmt, java.lang.String plan) as createUnstarted(ManagementContext, EntitySpec) but for a string plan (e.g.
static boolean	isWrapperApp(EntitySpec<?> spec)
static EntitySpec<? extends Application>	newWrapperApp()
static <T extends Application> EntityManagementUtils.CreationResult<T,java.lang.Void>	start(T app)
static EntitySpec<? extends Application>	unwrapApplication(EntitySpec<? extends Application> wrapperApplication) Unwraps a wrapped Application if appropriate.
static EntitySpec<? extends Entity>	unwrapEntity(EntitySpec<? extends Entity> wrapperApplication) Unwraps a single Entity if appropriate.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

WRAPPER_APP_MARKER

public static final ConfigKey<java.lang.Boolean> WRAPPER_APP_MARKER

A marker config value which indicates that an Application entity was created automatically, needed because a plan might give multiple top-level entities or a non-Application top-level entity, in a context where Brooklyn requires an Application at the root.

Typically when such a wrapper app wraps another Application (or where we are looking for a single Entity, or a list to add, and they are so wrapped) it will be unwrapped. See newWrapperApp() and unwrapApplication(EntitySpec).

Constructor Detail

EntityManagementUtils

public EntityManagementUtils()

Method Detail

createUnstarted

public static <T extends Application> T createUnstarted(ManagementContext mgmt,
                                                        EntitySpec<T> spec)

creates an application from the given app spec, managed by the given management context

createUnstarted

public static <T extends Application> T createUnstarted(ManagementContext mgmt,
                                                        EntitySpec<T> spec,
                                                        <any> entityId)

As createUnstarted(ManagementContext, EntitySpec), but uses the given entity id (if present).

createUnstarted

public static Application createUnstarted(ManagementContext mgmt,
                                          java.lang.String plan)

as createUnstarted(ManagementContext, EntitySpec) but for a string plan (e.g. camp yaml)

createEntitySpecForApplication

public static EntitySpec<? extends Application> createEntitySpecForApplication(ManagementContext mgmt,
                                                                               java.lang.String plan)

createEntitySpecForApplication

public static EntitySpec<? extends Application> createEntitySpecForApplication(ManagementContext mgmt,
                                                                               java.lang.String format,
                                                                               java.lang.String plan)

createStarting

public static <T extends Application> EntityManagementUtils.CreationResult<T,java.lang.Void> createStarting(ManagementContext mgmt,
                                                                                                            EntitySpec<T> appSpec)

createStarting

public static EntityManagementUtils.CreationResult<? extends Application,java.lang.Void> createStarting(ManagementContext mgmt,
                                                                                                        java.lang.String appSpec)

start

public static <T extends Application> EntityManagementUtils.CreationResult<T,java.lang.Void> start(T app)

addChildren

public static EntityManagementUtils.CreationResult<java.util.List<Entity>,java.util.List<java.lang.String>> addChildren(Entity parent,
                                                                                                                        java.lang.String yaml,
                                                                                                                        java.lang.Boolean start)

addChildrenUnstarted

public static java.util.List<Entity> addChildrenUnstarted(Entity parent,
                                                          java.lang.String yaml)

adds entities from the given yaml, under the given parent; but does not start them

addChildrenStarting

public static EntityManagementUtils.CreationResult<java.util.List<Entity>,java.util.List<java.lang.String>> addChildrenStarting(Entity parent,
                                                                                                                                java.lang.String yaml)

unwrapEntity

public static EntitySpec<? extends Entity> unwrapEntity(EntitySpec<? extends Entity> wrapperApplication)

Unwraps a single Entity if appropriate. See WRAPPER_APP_MARKER. Also see canUnwrapEntity(EntitySpec) to test whether it will unwrap.

unwrapApplication

public static EntitySpec<? extends Application> unwrapApplication(EntitySpec<? extends Application> wrapperApplication)

Unwraps a wrapped Application if appropriate. This is like canUnwrapEntity(EntitySpec) with an additional check that the wrapped child is an Application. See WRAPPER_APP_MARKER for an overview. Also see canUnwrapApplication(EntitySpec) to test whether it will unwrap.

newWrapperApp

public static EntitySpec<? extends Application> newWrapperApp()

canUnwrapApplication

public static boolean canUnwrapApplication(EntitySpec<? extends Application> wrapperApplication)

As canUnwrapEntity(EntitySpec) but additionally requiring that the wrapped item is an Application, for use when the context requires an Application ie a root of a spec.

See Also:

WRAPPER_APP_MARKER

canUnwrapEntity

public static boolean canUnwrapEntity(EntitySpec<? extends Entity> spec)

Returns true if the spec is for a wrapper app with no important settings, wrapping a single child entity. for use when adding from a plan specifying multiple entities but there is nothing significant at the application level, and the context would like to flatten it to remove the wrapper yielding just a single entity. (but note the result is not necessarily an Application; see canUnwrapApplication(EntitySpec) if that is required).

Note callers will normally use one of unwrapEntity(EntitySpec) or unwrapApplication(EntitySpec).

See Also:

for an overview

isWrapperApp

public static boolean isWrapperApp(EntitySpec<?> spec)