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, but brooklyn requires an Application at the root.

  Typically when such a wrapper app wraps another Application (or when we are adding to an existing entity and it wraps multiple Entity instances) 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 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)

• createCatalogSpec

  public static AbstractBrooklynObjectSpec<?,?> createCatalogSpec(ManagementContext mgmt,
                                                  CatalogItem<?,?> item)

• 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(EntityLocal parent,
                                                                                                          java.lang.String yaml,
                                                                                                          java.lang.Boolean start)

• addChildrenUnstarted

  public static java.util.List<Entity> addChildrenUnstarted(EntityLocal 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(EntityLocal parent,
                                                                                                                  java.lang.String yaml)

• unwrapApplication

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

  if an application should be unwrapped, it does so, returning the child; otherwise returns the argument passed in. use canPromoteWrappedApplication(EntitySpec) to test whether it will unwrap.

• mergeWrapperParentSpecToChildEntity

  @Beta
  public static void mergeWrapperParentSpecToChildEntity(EntitySpec<? extends Application> wrapperParent,
                                              EntitySpec<?> wrappedChild)

  Modifies the child so it includes the inessential setup of its parent, for use when unwrapping specific children, but a name or other item may have been set on the parent. See WRAPPER_APP_MARKER.

• newWrapperApp

  public static EntitySpec<? extends Application> newWrapperApp()

• canPromoteWrappedApplication

  public static boolean canPromoteWrappedApplication(EntitySpec<? extends Application> app)

  returns true if the spec is for an empty-ish wrapper app contianing an application, for use when adding from a plan specifying an application which was wrapped because it had to be.

  See Also:

  WRAPPER_APP_MARKER

• canPromoteChildrenInWrappedApplication

  public static boolean canPromoteChildrenInWrappedApplication(EntitySpec<?> spec)

  returns true if the spec is for an empty-ish wrapper app, for use when adding from a plan specifying multiple entities but nothing significant at the application level.

  See Also:

  WRAPPER_APP_MARKER

• isWrapperApp

  public static boolean isWrapperApp(EntitySpec<?> spec)