Field Detail

• SECRET_NAMES

  @Deprecated
  public static final java.util.List<java.lang.String> SECRET_NAMES

  Deprecated. since 0.7; instead use Sanitizer.SECRET_NAMES
  Names that, if they appear anywhere in an attribute/config/field indicates that it may be private, so should not be logged etc.

• UNCHANGED

  public static final java.lang.Object UNCHANGED

  Special object used by some setting methods to indicate that a value should be ignored.

  See specific usages of this field to confirm where.

• REMOVE

  public static final java.lang.Object REMOVE

  Special object used by some setting methods to indicate that a value should be removed.

  See specific usages of this field to confirm where.

Constructor Detail

• Entities

  public Entities()

Method Detail

• invokeEffectorList

  public static <T> Task<java.util.List<T>> invokeEffectorList(Entity callingEntity,
                                               java.lang.Iterable<? extends Entity> entitiesToCall,
                                               Effector<T> effector,
                                               java.util.Map<java.lang.String,?> parameters)

  Invokes an Effector on multiple entities, with the named arguments from the parameters Map using the context of the provided Entity.

  Intended for use only from the callingEntity.

  Returns a ParallelTask containing the results from each tasks invocation. Calling get() on this will block until all tasks are complete, and will throw an exception if any task resulted in an error.

  Returns:

  ParallelTask containing results from each invocation

• invokeEffectorListWithMap

  public static <T> Task<java.util.List<T>> invokeEffectorListWithMap(Entity callingEntity,
                                                      java.lang.Iterable<? extends Entity> entitiesToCall,
                                                      Effector<T> effector,
                                                      java.util.Map<java.lang.String,?> parameters)

• invokeEffectorListWithArgs

  public static <T> Task<java.util.List<T>> invokeEffectorListWithArgs(Entity callingEntity,
                                                       java.lang.Iterable<? extends Entity> entitiesToCall,
                                                       Effector<T> effector,
                                                       java.lang.Object... args)

• invokeEffectorList

  public static <T> Task<java.util.List<T>> invokeEffectorList(Entity callingEntity,
                                               java.lang.Iterable<? extends Entity> entitiesToCall,
                                               Effector<T> effector)

• invokeEffector

  public static <T> Task<T> invokeEffector(Entity callingEntity,
                           Entity entityToCall,
                           Effector<T> effector,
                           java.util.Map<java.lang.String,?> parameters)

• invokeEffectorWithArgs

  public static <T> Task<T> invokeEffectorWithArgs(Entity callingEntity,
                                   Entity entityToCall,
                                   Effector<T> effector,
                                   java.lang.Object... args)

• invokeEffector

  public static <T> Task<T> invokeEffector(Entity callingEntity,
                           Entity entityToCall,
                           Effector<T> effector)

• invokeEffector

  public static Task<?> invokeEffector(Entity callingEntity,
                       java.lang.Iterable<? extends Entity> entitiesToCall,
                       Effector<?> effector,
                       java.util.Map<java.lang.String,?> parameters)

  Invokes in parallel if multiple, but otherwise invokes the item directly.

• invokeEffector

  public static Task<?> invokeEffector(Entity callingEntity,
                       java.lang.Iterable<? extends Entity> entitiesToCall,
                       Effector<?> effector)

  Invokes in parallel if multiple, but otherwise invokes the item directly.

• isSecret

  @Deprecated
  public static boolean isSecret(java.lang.String name)

  Deprecated. since 0.7; instead use Sanitizer#IS_SECRET_PREDICATE.apply(Object)

• isTrivial

  public static boolean isTrivial(java.lang.Object v)

• sanitize

  @Deprecated
  public static java.util.Map<java.lang.String,java.lang.Object> sanitize(ConfigBag input)

  Deprecated. since 0.7; instead use Sanitizer.sanitize(ConfigBag)

• sanitize

  @Deprecated
  public static <K> java.util.Map<K,java.lang.Object> sanitize(java.util.Map<K,?> input)

  Deprecated. since 0.7; instead use Sanitizer.sanitize(Map)

• dumpInfo

  public static void dumpInfo(java.lang.Iterable<? extends Entity> entities)

• dumpInfo

  public static void dumpInfo(Entity e)

• dumpInfo

  public static void dumpInfo(Entity e,
              java.io.Writer out)
                       throws java.io.IOException

  Throws:

  java.io.IOException

• dumpInfo

  public static void dumpInfo(Entity e,
              java.lang.String currentIndentation,
              java.lang.String tab)
                       throws java.io.IOException

  Throws:

  java.io.IOException

• dumpInfo

  public static void dumpInfo(Entity e,
              java.io.Writer out,
              java.lang.String currentIndentation,
              java.lang.String tab)
                       throws java.io.IOException

  Throws:

  java.io.IOException

• dumpInfo

  public static void dumpInfo(Location loc)

• dumpInfo

  public static void dumpInfo(Location loc,
              java.io.Writer out)
                       throws java.io.IOException

  Throws:

  java.io.IOException

• dumpInfo

  public static void dumpInfo(Location loc,
              java.lang.String currentIndentation,
              java.lang.String tab)
                       throws java.io.IOException

  Throws:

  java.io.IOException

• dumpInfo

  public static void dumpInfo(Location loc,
              java.io.Writer out,
              java.lang.String currentIndentation,
              java.lang.String tab)
                       throws java.io.IOException

  Throws:

  java.io.IOException

• dumpInfo

  public static void dumpInfo(Enricher enr)

• dumpInfo

  public static void dumpInfo(Enricher enr,
              java.io.Writer out)
                       throws java.io.IOException

  Throws:

  java.io.IOException

• dumpInfo

  public static void dumpInfo(Enricher enr,
              java.lang.String currentIndentation,
              java.lang.String tab)
                       throws java.io.IOException

  Throws:

  java.io.IOException

• dumpInfo

  public static void dumpInfo(Enricher enr,
              java.io.Writer out,
              java.lang.String currentIndentation,
              java.lang.String tab)
                       throws java.io.IOException

  Throws:

  java.io.IOException

• dumpInfo

  public static void dumpInfo(Feed feed,
              java.lang.String currentIndentation,
              java.lang.String tab)
                       throws java.io.IOException

  Throws:

  java.io.IOException

• dumpInfo

  public static void dumpInfo(Feed feed,
              java.io.Writer out,
              java.lang.String currentIndentation,
              java.lang.String tab)
                       throws java.io.IOException

  Throws:

  java.io.IOException

• dumpInfo

  public static void dumpInfo(Policy pol)

• dumpInfo

  public static void dumpInfo(Policy pol,
              java.io.Writer out)
                       throws java.io.IOException

  Throws:

  java.io.IOException

• dumpInfo

  public static void dumpInfo(Policy pol,
              java.lang.String currentIndentation,
              java.lang.String tab)
                       throws java.io.IOException

  Throws:

  java.io.IOException

• dumpInfo

  public static void dumpInfo(Policy pol,
              java.io.Writer out,
              java.lang.String currentIndentation,
              java.lang.String tab)
                       throws java.io.IOException

  Throws:

  java.io.IOException

• sortSensors

  public static java.util.List<Sensor<?>> sortSensors(java.util.Set<Sensor<?>> sensors)

• sortConfigKeys

  public static java.util.List<ConfigKey<?>> sortConfigKeys(java.util.Set<ConfigKey<?>> configs)

• sortMap

  public static <T> java.util.Map<java.lang.String,T> sortMap(java.util.Map<java.lang.String,T> map)

• isAncestor

  public static boolean isAncestor(Entity descendant,
                   Entity potentialAncestor)

  Returns true if the given descendant includes the given ancestor in its chain. Does NOT count a node as its ancestor.

• isDescendant

  public static boolean isDescendant(Entity ancestor,
                     Entity potentialDescendant)

  Checks whether the descendants of the given ancestor contains the given potentialDescendant.

  In this test, unlike in descendants(Entity), an entity is not counted as a descendant. note, it is usually preferred to use isAncestor() and swap the order, it is a cheaper method.

• descendants

  public static java.lang.Iterable<Entity> descendants(Entity root,
                                        matching,
                                       boolean includeSelf)

  Return all descendants of given entity matching the given predicate and optionally the entity itself.

  See Also:

  EntityPredicates} for useful second arguments.

• descendants

  public static java.lang.Iterable<Entity> descendants(Entity root,
                                        matching)

  Returns the entity matching the given predicate

  See Also:

  #descendants(Entity, Predicate, boolean)

• descendants

  public static java.lang.Iterable<Entity> descendants(Entity root)

  Returns the entity, its children, and all its children, and so on.

  See Also:

  #descendants(Entity, Predicate, boolean)

• ancestors

  public static java.lang.Iterable<Entity> ancestors(Entity root)

  Returns the entity, its parent, its parent, and so on.

• invokeStopOnShutdown

  public static void invokeStopOnShutdown(Entity entity)

  Registers a BrooklynShutdownHooks.invokeStopOnShutdown(Entity) to shutdown this entity when the JVM exits. (Convenience method located in this class for easy access.)

• start

  public static void start(Entity e,
           java.util.Collection<? extends Location> locations)

  convenience for starting an entity, esp a new Startable instance which has been created dynamically (after the application is started)

• destroy

  public static void destroy(Entity e)

  Attempts to stop, destroy, and unmanage the given entity.

  Actual actions performed will depend on the entity type and its current state.

• destroyCatching

  public static void destroyCatching(Entity entity)

  Same as destroy(Entity) but catching all errors.

• destroy

  public static void destroy(Location loc)

  Destroys the given location.

• destroyCatching

  public static void destroyCatching(Location loc)

  Same as destroy(Location) but catching all errors.

• destroyAll

  public static void destroyAll(ManagementContext mgmt)

  Stops, destroys, and unmanages all apps in the given context, and then terminates the management context. Apps will be stopped+destroyed+unmanaged concurrently, waiting for all to complete.

• destroyAllCatching

  public static void destroyAllCatching(ManagementContext mgmt)

  Same as destroyAll(ManagementContext) but catching all errors

• isManaged

  public static boolean isManaged(Entity e)

• isNoLongerManaged

  public static boolean isNoLongerManaged(Entity e)

• isReadOnly

  public static java.lang.Boolean isReadOnly(Entity e)

  as EntityManagerInternal#isReadOnly(Entity)

• deproxy

  public static AbstractEntity deproxy(Entity e)

  Unwraps a proxy to retrieve the real item, if available.

  Only intended for use in tests and occasional internal usage, e.g. persistence. For normal operations, callers should ensure the method is available on an interface and accessed via the proxy.

• proxy

  public static <T extends Entity> T proxy(T e)

  Returns the proxy form (if available) of the entity. If already a proxy, returns unmodified. If null is passed in, then null is returned. For legacy entities (that did not use EntitySpec or YAML for creation), the proxy may not be avilable; in which case the concrete class passed in will be returned.

• manage

  @Deprecated
  public static boolean manage(Entity e)

  Deprecated. since 0.9.0; entities are automatically managed when created via Entity.addChild(EntitySpec), or with EntityManager.createEntity(EntitySpec) (it is strongly encouraged to include the parent if using the latter for anything but a top-level app).
  Brings this entity under management only if its ancestor is managed.

  Returns true if successful, otherwise returns false in the expectation that the ancestor will become managed, or throws exception if it has no parent or a non-application root.

  Throws:

  java.lang.IllegalStateException - if e is an Application.

  See Also:

  startManagement(Entity)

• startManagement

  @Deprecated
  public static ManagementContext startManagement(Entity e)

  Deprecated. since 0.9.0; entities are automatically managed when created via Entity.addChild(EntitySpec), or with EntityManager.createEntity(EntitySpec).
  Brings this entity under management, creating a local management context if necessary, assuming root is an application.

  Returns existing management context if there is one (non-deployment) or a new local management context if not, or throws an exception if root is not an application. Callers are recommended to use manage(Entity) instead unless they know a plain-vanilla non-root management context is sufficient e.g. in tests.

  NOTE This method may change, but is provided as a stop-gap to prevent ad-hoc things being done in the code which are even more likely to break!

• startManagement

  @Deprecated
  public static ManagementContext startManagement(Application app,
                                             ManagementContext mgmt)

  Deprecated. since 0.9.0; entities are automatically managed when created with EntityManager.createEntity(EntitySpec). For top-level apps, use code like managementContext.getEntityManager().createEntity(EntitySpec.create(...)).
  Starts managing the given (unmanaged) app, using the given management context.

  See Also:

  startManagement(Entity)

• startManagement

  @Deprecated
  public static ManagementContext startManagement(Application app,
                                             BrooklynProperties props)

  Deprecated. since 0.9.0; entities are automatically managed when created via Entity.addChild(EntitySpec), or with EntityManager.createEntity(EntitySpec). For top-level apps, use code like managementContext.getEntityManager().createEntity(EntitySpec.create(...)).
  Starts managing the given (unmanaged) app, setting the given brooklyn properties on the new management context.

  See Also:

  startManagement(Entity)

• newManagementContext

  public static ManagementContext newManagementContext()

• newManagementContext

  public static ManagementContext newManagementContext(BrooklynProperties props)

• newManagementContext

  public static ManagementContext newManagementContext(java.util.Map<?,?> props)

• getManagementContext

  public static ManagementContext getManagementContext(Entity entity)

• unmanage

  public static void unmanage(Entity entity)

• newDownloader

  public static DownloadResolver newDownloader(EntityDriver driver)

• newDownloader

  public static DownloadResolver newDownloader(EntityDriver driver,
                               java.util.Map<java.lang.String,?> properties)

• newDownloader

  public static DownloadResolver newDownloader(EntityDriver driver,
                               java.lang.String addon)

• newDownloader

  public static DownloadResolver newDownloader(EntityDriver driver,
                               java.lang.String addon,
                               java.util.Map<java.lang.String,?> properties)

• attributeSupplier

  public static <T>  attributeSupplier(Entity entity,
                            AttributeSensor<T> sensor)

• attributeSupplier

  public static <T>  attributeSupplier(EntityAndAttribute<T> tuple)

• attributeSupplierWhenReady

  public static <T>  attributeSupplierWhenReady(EntityAndAttribute<T> tuple)

• attributeSupplierWhenReady

  public static <T>  attributeSupplierWhenReady(Entity entity,
                                     AttributeSensor<T> sensor)

• manage

  @Deprecated
  public static void manage(Location loc,
                       ManagementContext managementContext)

  Deprecated. in 0.6.0; use LocationManager.createLocation(LocationSpec) instead

  Since:

  0.6.0 Added only for backwards compatibility, where locations are being created directly.

• getRequiredUrlConfig

  public static java.lang.String getRequiredUrlConfig(Entity entity,
                                      ConfigKey<java.lang.String> urlKey)

  Fails-fast if value of the given key is null or unresolveable.

• getRequiredUrlConfig

  public static java.lang.String getRequiredUrlConfig(Entity entity,
                                      ConfigKey.HasConfigKey<java.lang.String> urlKey)

  See Also:

  getRequiredUrlConfig(Entity, ConfigKey)

• checkRequiredUrl

  public static java.lang.String checkRequiredUrl(Entity entity,
                                  java.lang.String url)

  Fails-fast if value of the given URL is null or unresolveable.

• submit

  public static <T extends TaskAdaptable<?>> T submit(Entity entity,
                                      TaskFactory<T> taskFactory)

  Submits a TaskFactory to construct its task at the entity (in a precursor task) and then to submit it.

  Important if task construction relies on an entity being in scope (in tags, via BrooklynTaskTags)

• submit

  public static <T extends TaskAdaptable<?>> T submit(Entity entity,
                                      T task)

  Submits a task to run at the entity.

  Returns:

  the task passed in, for fluency

• warnOnIgnoringConfig

  public static void warnOnIgnoringConfig(Entity entity,
                          ConfigKey<?> key)

  Logs a warning if an entity has a value for a config key.

• waitForServiceUp

  public static void waitForServiceUp(Entity entity,
                      Duration timeout)

  Waits until Startable.SERVICE_UP returns true.

• waitForServiceUp

  public static void waitForServiceUp(Entity entity,
                      long duration,
                      java.util.concurrent.TimeUnit units)

• waitForServiceUp

  public static void waitForServiceUp(Entity entity)

• shell

  public static ProcessTaskWrapper<java.lang.Integer> shell(ManagementContext mgmt,
                                            java.lang.String command)

  Convenience for creating and submitted a given shell command against the given mgmt context, primarily intended for use in the groovy GUI console.

• catalogItemScopeRoot

  public static Entity catalogItemScopeRoot(Entity entity)

• getAllInheritedLocations

  public static java.util.Set<Location> getAllInheritedLocations(Entity entity)