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 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

  @Deprecated
  public static <T,SpecT extends AbstractBrooklynObjectSpec<? extends T,SpecT>> SpecT createCatalogSpec(ManagementContext mgmt,
                                                                                                   CatalogItem<T,SpecT> item)

  Deprecated. 

• createCatalogSpec

  @Deprecated
  public static <T,SpecT extends AbstractBrooklynObjectSpec<? extends T,SpecT>> SpecT createCatalogSpec(ManagementContext mgmt,
                                                                                                   CatalogItem<T,SpecT> item,
                                                                                                   java.util.Set<java.lang.String> encounteredTypes)

  Deprecated. 

• 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

• canPromoteWrappedApplication

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

  Deprecated. since 0.9.0 use canUnwrapApplication(EntitySpec)

• 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

• canPromoteChildrenInWrappedApplication

  @Deprecated
  public static boolean canPromoteChildrenInWrappedApplication(EntitySpec<? extends Application> spec)

  Deprecated. since 0.9.0 use canUnwrapEntity(EntitySpec)

• isWrapperApp

  public static boolean isWrapperApp(EntitySpec<?> spec)