A B C D E F G H I L M N O P Q R S T U V W

A

accepts(String, LocationRegistry) - Method in interface brooklyn.location.LocationResolver
whether the spec is something which should be passed to this resolver
AccessController - Interface in brooklyn.management
 
AccessController.Response - Class in brooklyn.management
 
addChild(T) - Method in interface brooklyn.entity.Entity
Add a child Entity, and set this entity as its parent, returning the added child.
addChild(EntitySpec<T>) - Method in interface brooklyn.entity.Entity
Creates an Entity from the given spec and adds it, setting this entity as the parent, returning the added child.
addEnricher(Enricher) - Method in interface brooklyn.entity.Entity
Adds the given enricher to this entity.
addGroup(Group) - Method in interface brooklyn.entity.Entity
Add this entity as a member of the given Group.
addInitializer(EntityInitializer) - Method in class brooklyn.entity.proxying.EntitySpec
 
addInitializer(Class<? extends EntityInitializer>) - Method in class brooklyn.entity.proxying.EntitySpec
The supplied class must have a public no-arg constructor.
addInitializers(Collection<EntityInitializer>) - Method in class brooklyn.entity.proxying.EntitySpec
 
addItem(CatalogItem<?>) - Method in interface brooklyn.catalog.BrooklynCatalog
adds an item to the 'manual' catalog; this does not update the classpath or have a record to the java Class, so callers of this method will typically also need to call BrooklynCatalog.addToClasspath(String) or BrooklynCatalog.addToClasspath(ClassLoader)
addItem(Class<?>) - Method in interface brooklyn.catalog.BrooklynCatalog
creates a catalog item and adds it to the 'manual' catalog, with the corresponding Class definition (loaded by a classloader) registered and available in the classloader.
additionalInterfaces(Class<?>...) - Method in class brooklyn.entity.proxying.EntitySpec
 
additionalInterfaces(Iterable<Class<?>>) - Method in class brooklyn.entity.proxying.EntitySpec
 
addMember(Entity) - Method in interface brooklyn.entity.Group
Adds the given member, returning true if this modifies the set of members (i.e.
addPolicy(Policy) - Method in interface brooklyn.entity.Entity
Adds the given policy to this entity.
AddressableLocation - Interface in brooklyn.location
A location that has an IP address.
addToClasspath(ClassLoader) - Method in interface brooklyn.catalog.BrooklynCatalog
adds a classpath entry which will be used by the 'manual' catalog
addToClasspath(String) - Method in interface brooklyn.catalog.BrooklynCatalog
adds a classpath entry which will be used by the 'manual' catalog
allowed() - Static method in class brooklyn.management.AccessController.Response
 
Application - Interface in brooklyn.entity
An application is the root of the entity hierarchy.
apply(EntityLocal) - Method in interface brooklyn.entity.proxying.EntityInitializer
Applies initialization logic to a just-built entity.
asBoolean() - Method in interface brooklyn.location.PortRange
Note: this method is only here for use with "groovy truth".
asTask() - Method in interface brooklyn.management.TaskAdaptable
 
AttributeSensor<T> - Interface in brooklyn.event
The interface implemented by attribute sensors.

B

blockUntilEnded() - Method in interface brooklyn.management.Task
Causes calling thread to block until the task is ended.
blockUntilEnded(Duration) - Method in interface brooklyn.management.Task
As Task.blockUntilEnded(), but returning after the given timeout; true if the task has ended and false otherwise
blockUntilStarted() - Method in interface brooklyn.management.Task
Causes calling thread to block until the task is started.
brooklyn.catalog - package brooklyn.catalog
 
brooklyn.entity - package brooklyn.entity
 
brooklyn.entity.basic - package brooklyn.entity.basic
 
brooklyn.entity.drivers - package brooklyn.entity.drivers
 
brooklyn.entity.drivers.downloads - package brooklyn.entity.drivers.downloads
 
brooklyn.entity.proxying - package brooklyn.entity.proxying
 
brooklyn.entity.rebind - package brooklyn.entity.rebind
 
brooklyn.entity.trait - package brooklyn.entity.trait
 
brooklyn.event - package brooklyn.event
 
brooklyn.location - package brooklyn.location
 
brooklyn.management - package brooklyn.management
 
brooklyn.mementos - package brooklyn.mementos
 
brooklyn.policy - package brooklyn.policy
 
BrooklynCatalog - Interface in brooklyn.catalog
 
BrooklynMemento - Interface in brooklyn.mementos
Represents an entire persisted Brooklyn management context, with all its entities and locations.
BrooklynMementoPersister - Interface in brooklyn.mementos
Controls the persisting and reading back of mementos.
BrooklynMementoPersister.Delta - Interface in brooklyn.mementos
 
build(DriverDependentEntity<D>, Location) - Method in interface brooklyn.entity.drivers.EntityDriverFactory
Deprecated. Builds a new EntityDriver for the given entity/location.
build(DriverDependentEntity<D>, Location) - Method in interface brooklyn.entity.drivers.EntityDriverManager
Builds a new EntityDriver for the given entity/location.

C

canContinueResolving() - Method in interface brooklyn.entity.drivers.downloads.DownloadResolverManager.DownloadTargets
Indicates whether or not the results of this resolver are the last that should be used.
canManageEntity(Entity) - Method in interface brooklyn.management.AccessController
 
canManageLocation(Location) - Method in interface brooklyn.management.AccessController
 
canMaybeResolve(String) - Method in interface brooklyn.location.LocationRegistry
Returns true/false depending whether spec seems like a valid location, that is it has a chance of being resolved (depending on the spec) but NOT guaranteed; see LocationRegistry.resolveIfPossible(String) which has stronger guarantees
canProvisionLocation(Location) - Method in interface brooklyn.management.AccessController
 
canResolve(String) - Method in interface brooklyn.location.LocationRegistry
Deprecated. since 0.6.0, @see LocationRegistry.resolveIfPossible(String) and #canMaybeResolve(String) as a "true" here does not mean it can actually resolve it
Catalog - Annotation Type in brooklyn.catalog
annotation that can be placed on an Application (template), entity or policy to give metadata for when used in a catalog and to indicate inclusion in annotation-scanned catalogs
CatalogConfig - Annotation Type in brooklyn.catalog
 
CatalogItem<T> - Interface in brooklyn.catalog
 
CatalogItem.CatalogItemType - Enum in brooklyn.catalog
 
ChangeListener - Interface in brooklyn.entity.rebind
Listener to be notified of changes within brooklyn, so that the new state of the entity/location/policy can be persisted.
checkpoint(BrooklynMemento) - Method in interface brooklyn.mementos.BrooklynMementoPersister
 
clearParent() - Method in interface brooklyn.entity.Entity
Clears the parent (i.e.
Configurable - Interface in brooklyn.entity.trait
Something that has mutable config, such as an entity or policy.
configure(Map<?, ?>) - Method in class brooklyn.entity.proxying.EntitySpec
 
configure(CharSequence, Object) - Method in class brooklyn.entity.proxying.EntitySpec
 
configure(ConfigKey<V>, V) - Method in class brooklyn.entity.proxying.EntitySpec
 
configure(ConfigKey<V>, Task<? extends V>) - Method in class brooklyn.entity.proxying.EntitySpec
 
configure(ConfigKey.HasConfigKey<V>, V) - Method in class brooklyn.entity.proxying.EntitySpec
 
configure(ConfigKey.HasConfigKey<V>, Task<? extends V>) - Method in class brooklyn.entity.proxying.EntitySpec
 
configure(Map<?, ?>) - Method in class brooklyn.location.LocationSpec
 
configure(CharSequence, Object) - Method in class brooklyn.location.LocationSpec
 
configure(ConfigKey<V>, V) - Method in class brooklyn.location.LocationSpec
 
configure(ConfigKey<V>, Task<? extends V>) - Method in class brooklyn.location.LocationSpec
 
configure(ConfigKey.HasConfigKey<V>, V) - Method in class brooklyn.location.LocationSpec
 
configure(ConfigKey.HasConfigKey<V>, Task<? extends V>) - Method in class brooklyn.location.LocationSpec
 
configure(Map<?, ?>) - Method in class brooklyn.policy.EnricherSpec
 
configure(CharSequence, Object) - Method in class brooklyn.policy.EnricherSpec
 
configure(ConfigKey<V>, V) - Method in class brooklyn.policy.EnricherSpec
 
configure(ConfigKey<V>, Task<? extends V>) - Method in class brooklyn.policy.EnricherSpec
 
configure(ConfigKey.HasConfigKey<V>, V) - Method in class brooklyn.policy.EnricherSpec
 
configure(ConfigKey.HasConfigKey<V>, Task<? extends V>) - Method in class brooklyn.policy.EnricherSpec
 
configure(Map<?, ?>) - Method in class brooklyn.policy.PolicySpec
 
configure(CharSequence, Object) - Method in class brooklyn.policy.PolicySpec
 
configure(ConfigKey<V>, V) - Method in class brooklyn.policy.PolicySpec
 
configure(ConfigKey<V>, Task<? extends V>) - Method in class brooklyn.policy.PolicySpec
 
configure(ConfigKey.HasConfigKey<V>, V) - Method in class brooklyn.policy.PolicySpec
 
configure(ConfigKey.HasConfigKey<V>, Task<? extends V>) - Method in class brooklyn.policy.PolicySpec
 
configureIfNotNull(ConfigKey<V>, V) - Method in class brooklyn.location.LocationSpec
 
configureIfNotNull(ConfigKey<V>, V) - Method in class brooklyn.policy.EnricherSpec
 
configureIfNotNull(ConfigKey<V>, V) - Method in class brooklyn.policy.PolicySpec
 
containsLocation(Location) - Method in interface brooklyn.location.Location
Answers true if this location equals or is an ancestor of the given location.
create(Class<T>) - Static method in class brooklyn.entity.proxying.EntitySpec
Creates a new EntitySpec instance for an entity of the given type.
create(Class<T>, Class<U>) - Static method in class brooklyn.entity.proxying.EntitySpec
Creates a new EntitySpec instance for an entity of the given type.
create(Map<?, ?>, Class<T>) - Static method in class brooklyn.entity.proxying.EntitySpec
Creates a new EntitySpec instance with the given config, for an entity of the given type.
create(EntitySpec<T>) - Static method in class brooklyn.entity.proxying.EntitySpec
Wraps an entity spec so its configuration can be overridden without modifying the original entity spec.
create(Class<T>) - Static method in class brooklyn.location.LocationSpec
Creates a new LocationSpec instance for a location of the given type.
create(Map<?, ?>, Class<T>) - Static method in class brooklyn.location.LocationSpec
Creates a new LocationSpec instance with the given config, for a location of the given type.
create(Class<T>) - Static method in class brooklyn.policy.EnricherSpec
Creates a new EnricherSpec instance for an enricher of the given type.
create(Map<?, ?>, Class<T>) - Static method in class brooklyn.policy.EnricherSpec
Creates a new EnricherSpec instance with the given config, for an enricher of the given type.
create(Class<T>) - Static method in class brooklyn.policy.PolicySpec
Creates a new PolicySpec instance for a policy of the given type.
create(Map<?, ?>, Class<T>) - Static method in class brooklyn.policy.PolicySpec
Creates a new PolicySpec instance with the given config, for a policy of the given type.
createEntity(EntitySpec<T>) - Method in interface brooklyn.management.EntityManager
Creates a new (unmanaged) entity.
createEntity(Map<?, ?>, Class<T>) - Method in interface brooklyn.management.EntityManager
Convenience (particularly for groovy code) to create an entity.
createLocation(LocationSpec<T>) - Method in interface brooklyn.management.LocationManager
Creates a new location, which is tracked by the management context.
createLocation(Map<?, ?>, Class<T>) - Method in interface brooklyn.management.LocationManager
Convenience (particularly for groovy code) to create a location.

D

delta(BrooklynMementoPersister.Delta) - Method in interface brooklyn.mementos.BrooklynMementoPersister
 
disallowed(String) - Static method in class brooklyn.management.AccessController.Response
 
displayName(String) - Method in class brooklyn.entity.proxying.EntitySpec
 
displayName(String) - Method in class brooklyn.location.LocationSpec
 
displayName(String) - Method in class brooklyn.policy.EnricherSpec
 
displayName(String) - Method in class brooklyn.policy.PolicySpec
 
DownloadResolver - Interface in brooklyn.entity.drivers.downloads
Gives download details for an entity or an entity add-on.
DownloadResolverManager - Interface in brooklyn.entity.drivers.downloads
Used by an EntityDriver to obtain the download locations when installing an entity.
DownloadResolverManager.DownloadRequirement - Interface in brooklyn.entity.drivers.downloads
Gives artifact meta-data for what is required to be downloaded.
DownloadResolverManager.DownloadTargets - Interface in brooklyn.entity.drivers.downloads
Describes the download locations, and their order, to try.
DriverDependentEntity<D extends EntityDriver> - Interface in brooklyn.entity.drivers
An Entity that needs to have a driver.

E

Effector<T> - Interface in brooklyn.entity
An operation of some kind, carried out by an Entity.
emit(Sensor<T>, T) - Method in interface brooklyn.entity.basic.EntityLocal
Emits a SensorEvent event on behalf of this entity (as though produced by this entity).
enricher(Enricher) - Method in class brooklyn.entity.proxying.EntitySpec
adds a policy to the spec
enricher(EnricherSpec<?>) - Method in class brooklyn.entity.proxying.EntitySpec
adds a policy to the spec
Enricher - Interface in brooklyn.policy
Publishes metrics for an entity, e.g.
enrichers(Iterable<? extends Enricher>) - Method in class brooklyn.entity.proxying.EntitySpec
adds the supplied policies to the spec
EnricherSpec<T extends Enricher> - Class in brooklyn.policy
Gives details of an enricher to be created.
EnricherSpec(Class<T>) - Constructor for class brooklyn.policy.EnricherSpec
 
enricherSpecs(Iterable<? extends EnricherSpec<?>>) - Method in class brooklyn.entity.proxying.EntitySpec
adds the supplied policies to the spec
EnricherType - Interface in brooklyn.policy
Gives type information for an Enricher.
entities() - Method in interface brooklyn.mementos.BrooklynMementoPersister.Delta
 
Entity - Interface in brooklyn.entity
The basic interface for a Brooklyn entity.
EntityAdjunct - Interface in brooklyn.policy
EntityAdjuncts are supplementary logic that can be attached to Entities, providing sensor enrichment or enabling policy
EntityDriver - Interface in brooklyn.entity.drivers
The EntityDriver provides an abstraction between the Entity and the environment (the Location it is running in, so that an entity is not tightly coupled to a specific Location.
EntityDriverFactory - Interface in brooklyn.entity.drivers
Deprecated. since 0.5; use EntityDriverManager instead
EntityDriverManager - Interface in brooklyn.entity.drivers
Responsible for creating a driver for a given entity/location.
EntityInitializer - Interface in brooklyn.entity.proxying
 
EntityLocal - Interface in brooklyn.entity.basic
Extended Entity interface for use in places where the caller should have certain privileges, such as setting attribute values, adding policies, etc.
EntityManager - Interface in brooklyn.management
For managing and querying entities.
EntityMemento - Interface in brooklyn.mementos
Represents the state of an entity, so that it can be reconstructed (e.g.
EntitySpec<T extends Entity> - Class in brooklyn.entity.proxying
Gives details of an entity to be created.
EntitySpec(Class<T>) - Constructor for class brooklyn.entity.proxying.EntitySpec
 
EntityStartException - Exception in brooklyn.event
Deprecated. since 0.5, can instead throw any exception; clusters etc should respond accordingly
EntityStartException(String) - Constructor for exception brooklyn.event.EntityStartException
Deprecated.  
EntityStartException(String, Throwable) - Constructor for exception brooklyn.event.EntityStartException
Deprecated.  
EntityType - Interface in brooklyn.entity
Gives type information for an Entity.
EntityTypeRegistry - Interface in brooklyn.entity.proxying
A registry of the entity implementations to be used when creating an entity of a given type.
ExecutionContext - Interface in brooklyn.management
This is a Brooklyn extension to the Java Executor.
ExecutionManager - Interface in brooklyn.management
This class manages the execution of a number of jobs with tags.
extension(Class<E>, E) - Method in class brooklyn.location.LocationSpec
 

F

findLocationProperty(String) - Method in interface brooklyn.location.Location
Deprecated. since 0.5.0, use getConfig

G

get(Duration) - Method in interface brooklyn.management.Task
As Future.get(long, java.util.concurrent.TimeUnit)
getAccessController() - Method in interface brooklyn.management.ManagementContext
For controlling access to operations - can be queried to find if an operation is allowed.
getAdditionalInterfaces() - Method in class brooklyn.entity.proxying.EntitySpec
 
getAddonName() - Method in interface brooklyn.entity.drivers.downloads.DownloadResolverManager.DownloadRequirement
The name of the add-on to be downloaded, or null if it is the main installed.
getAddress() - Method in interface brooklyn.location.AddressableLocation
Return the single most appropriate address for this location.
getAddress() - Method in interface brooklyn.location.MachineLocation
 
getAllConfig() - Method in interface brooklyn.location.Location
Deprecated. since 0.6.0 use {@link #getAllConfig(boolean)
getAllConfig(boolean) - Method in interface brooklyn.location.Location
Returns all config set, either inherited (argument true) or locally-only (argument false)
getAllConfig() - Method in interface brooklyn.policy.Enricher
 
getAllConfig() - Method in interface brooklyn.policy.Policy
 
getApplication() - Method in interface brooklyn.entity.Entity
 
getApplicationId() - Method in interface brooklyn.entity.Entity
 
getApplicationIds() - Method in interface brooklyn.mementos.BrooklynMemento
 
getApplications() - Method in interface brooklyn.management.ManagementContext
All applications under control of this management plane
getArch() - Method in interface brooklyn.location.OsDetails
 
getAttribute(AttributeSensor<T>) - Method in interface brooklyn.entity.Entity
Gets the value of the given attribute on this entity, or null if has not been set.
getAttributes() - Method in interface brooklyn.mementos.EntityMemento
 
getBrooklynVersion() - Method in interface brooklyn.mementos.Memento
The version of brooklyn used when this memento was generated.
getCatalog() - Method in interface brooklyn.management.ManagementContext
Record of configured Brooklyn entities (and templates and policies) which can be loaded
getCatalogItem(String) - Method in interface brooklyn.catalog.BrooklynCatalog
finds the item with the given ID, or null if not found
getCatalogItem(Class<T>, String) - Method in interface brooklyn.catalog.BrooklynCatalog
variant of BrooklynCatalog.getCatalogItem(String) which checks (and casts) type for convenience (returns null if type does not match)
getCatalogItemJavaType() - Method in interface brooklyn.catalog.CatalogItem
 
getCatalogItems() - Method in interface brooklyn.catalog.BrooklynCatalog
returns all items in the catalog
getCatalogItems(Predicate<? super CatalogItem<T>>) - Method in interface brooklyn.catalog.BrooklynCatalog
convenience for filtering items in the catalog; see CatalogPredicates for useful filters
getCatalogItemType() - Method in interface brooklyn.catalog.CatalogItem
 
getChangeListener() - Method in interface brooklyn.entity.rebind.RebindManager
 
getChildLocations() - Method in interface brooklyn.location.Location
Deprecated. since 0.6
getChildren() - Method in interface brooklyn.entity.Entity
Return the entities that are children of (i.e.
getChildren() - Method in interface brooklyn.location.Location
Get the 'children' of this location.
getChildren() - Method in interface brooklyn.management.HasTaskChildren
 
getChildren() - Method in interface brooklyn.mementos.TreeNode
The ids of the children.
getConfig(ConfigKey<T>, T) - Method in interface brooklyn.entity.basic.EntityLocal
Deprecated. in 0.5; use Entity.getConfig(ConfigKey)
getConfig(ConfigKey.HasConfigKey<T>) - Method in interface brooklyn.entity.basic.EntityLocal
 
getConfig(ConfigKey.HasConfigKey<T>, T) - Method in interface brooklyn.entity.basic.EntityLocal
Deprecated. in 0.5; use #getConfig(HasConfigKey)
getConfig(ConfigKey<T>) - Method in interface brooklyn.entity.Entity
Gets the given configuration value for this entity, in the following order of preference: value (including null) explicitly set on the entity value (including null) explicitly set on an ancestor (inherited) a default value (including null) on the best equivalent static key of the same name declared on the entity (where best equivalence is defined as preferring a config key which extends another, as computed in EntityDynamicType.getConfigKeys) a default value (including null) on the key itself null
getConfig(ConfigKey.HasConfigKey<T>) - Method in interface brooklyn.entity.Entity
 
getConfig() - Method in class brooklyn.entity.proxying.EntitySpec
 
getConfig(ConfigKey<T>) - Method in interface brooklyn.location.Location
Returns configuration set at this location or inherited or default
getConfig() - Method in interface brooklyn.location.LocationDefinition
 
getConfig() - Method in class brooklyn.location.LocationSpec
 
getConfig() - Method in interface brooklyn.management.ManagementContext
Returns the ConfigMap (e.g.
getConfig() - Method in interface brooklyn.mementos.EntityMemento
 
getConfig(ConfigKey<T>) - Method in interface brooklyn.policy.Enricher
 
getConfig() - Method in class brooklyn.policy.EnricherSpec
 
getConfig(ConfigKey<T>) - Method in interface brooklyn.policy.Policy
 
getConfig() - Method in class brooklyn.policy.PolicySpec
 
getConfigKey(String) - Method in interface brooklyn.entity.EntityType
The ConfigKey with the given name, or null if not found.
getConfigKey(String) - Method in interface brooklyn.policy.EnricherType
The ConfigKey with the given name, or null if not found.
getConfigKey(String) - Method in interface brooklyn.policy.PolicyType
The ConfigKey with the given name, or null if not found.
getConfigKeys() - Method in interface brooklyn.entity.EntityType
ConfigKeys available on this entity.
getConfigKeys() - Method in interface brooklyn.policy.EnricherType
ConfigKeys available on this policy.
getConfigKeys() - Method in interface brooklyn.policy.PolicyType
ConfigKeys available on this policy.
getCreationTime() - Method in interface brooklyn.entity.Entity
Returns the creation time for this entity, in UTC.
getCurrentSize() - Method in interface brooklyn.entity.Group
 
getCurrentTask() - Method in interface brooklyn.management.ExecutionContext
Deprecated. in 0.5, use Tasks.current()
getCustomField(String) - Method in interface brooklyn.mementos.Memento
A (weakly-typed) property set for this memento.
getCustomFields() - Method in interface brooklyn.mementos.Memento
 
getDefaultValue() - Method in interface brooklyn.entity.ParameterType
 
getDefinedLocation(String) - Method in interface brooklyn.location.LocationRegistry
Deprecated. since 0.6.0; use LocationRegistry.getDefinedLocationById(String) (ID should be explicit because this is usually *not* the method people want)
getDefinedLocationById(String) - Method in interface brooklyn.location.LocationRegistry
returns a LocationDefinition given its ID (usually a random string), or null if none
getDefinedLocationByName(String) - Method in interface brooklyn.location.LocationRegistry
returns a LocationDefinition given its name (e.g.
getDefinedLocations() - Method in interface brooklyn.location.LocationRegistry
map of ID (possibly randomly generated) to the definition (spec, name, id, and props; where spec is the spec as defined, for instance possibly another named:xxx location)
getDescription() - Method in interface brooklyn.catalog.CatalogItem
 
getDescription() - Method in interface brooklyn.entity.Effector
optional description for the effector
getDescription() - Method in interface brooklyn.entity.ParameterType
 
getDescription() - Method in interface brooklyn.event.Sensor
Returns the description of the sensor, for display.
getDescription() - Method in interface brooklyn.management.Task
 
getDisplayName() - Method in interface brooklyn.entity.Entity
A display name; recommended to be a concise single-line description.
getDisplayName() - Method in class brooklyn.entity.proxying.EntitySpec
 
getDisplayName() - Method in interface brooklyn.location.Location
Get the name assigned to this location.
getDisplayName() - Method in class brooklyn.location.LocationSpec
 
getDisplayName() - Method in interface brooklyn.management.Task
 
getDisplayName() - Method in interface brooklyn.mementos.Memento
 
getDisplayName() - Method in class brooklyn.policy.EnricherSpec
 
getDisplayName() - Method in class brooklyn.policy.PolicySpec
 
getDriverInterface() - Method in interface brooklyn.entity.drivers.DriverDependentEntity
 
getEffector(String, Class<?>...) - Method in interface brooklyn.entity.EntityType
 
getEffectors() - Method in interface brooklyn.entity.EntityType
Effectors available on this entity.
getEndTimeUtc() - Method in interface brooklyn.management.Task
if Future.isDone() (for any reason) returns the time when the task ended; guaranteed to be >= Task.getStartTimeUtc() > 0 if ended, or -1 otherwise
getEnrichers() - Method in interface brooklyn.entity.Entity
 
getEnrichers() - Method in class brooklyn.entity.proxying.EntitySpec
 
getEnricherSpecs() - Method in class brooklyn.entity.proxying.EntitySpec
 
getEnricherType() - Method in interface brooklyn.policy.Enricher
Information about the type of this entity; analogous to Java's object.getClass.
getEntities() - Method in interface brooklyn.management.EntityManager
All entities under control of this management plane
getEntities() - Method in interface brooklyn.management.ManagementContext
Deprecated. Use getEntityManager().getEntities() instead; deprecated in 0.5
getEntitiesInApplication(Application) - Method in interface brooklyn.management.EntityManager
All entities managed as part of the given application
getEntity() - Method in interface brooklyn.entity.drivers.EntityDriver
The entity instance that this is a driver for.
getEntity(String) - Method in interface brooklyn.entity.rebind.RebindContext
 
getEntity(String) - Method in interface brooklyn.management.EntityManager
Returns the entity with the given identifier (may be a full instance, or a proxy to one which is remote), or null.
getEntity(String) - Method in interface brooklyn.management.ManagementContext
Deprecated. Use getEntityManager().getEntity(String) instead; deprecated in 0.5
getEntityDownloadsManager() - Method in interface brooklyn.management.ManagementContext
Returns the DownloadResolverManager for resolving things like which URL to download an installer from.
getEntityDriver() - Method in interface brooklyn.entity.drivers.downloads.DownloadResolverManager.DownloadRequirement
The EntityDriver that this download is for.
getEntityDriverFactory() - Method in interface brooklyn.management.ManagementContext
Deprecated. since 0.5; use ManagementContext.getEntityDriverManager()
getEntityDriverManager() - Method in interface brooklyn.management.ManagementContext
Returns the EntityDriverManager entities can use to create drivers.
getEntityIds() - Method in interface brooklyn.mementos.BrooklynMemento
 
getEntityManager() - Method in interface brooklyn.management.ManagementContext
Returns the EntityManager instance for managing/querying entities.
getEntityMemento(String) - Method in interface brooklyn.mementos.BrooklynMemento
 
getEntityMementos() - Method in interface brooklyn.mementos.BrooklynMemento
 
getEntityReferenceAttributes() - Method in interface brooklyn.mementos.EntityMemento
 
getEntityReferenceConfigs() - Method in interface brooklyn.mementos.EntityMemento
 
getEntityType() - Method in interface brooklyn.entity.Entity
Information about the type of this entity; analogous to Java's object.getClass.
getEntityTypeOf(Class<T>) - Method in interface brooklyn.entity.proxying.EntityTypeRegistry
Returns the interface of this entity implementation.
getEntityTypeRegistry() - Method in interface brooklyn.management.EntityManager
Returns the type registry, used to identify the entity implementation when instantiating an entity of a given type.
getExecutionContext() - Method in interface brooklyn.entity.basic.EntityLocal
Deprecated. since 0.5.0; access via EntityInternal#getExecutionContext().
getExecutionContext(Entity) - Method in interface brooklyn.management.ManagementContext
Returns an ExecutionContext instance representing tasks (from the ExecutionManager) associated with this entity, and capable of conveniently running such tasks which will be associated with that entity
getExecutionManager() - Method in interface brooklyn.management.ManagementContext
Returns the ExecutionManager instance for entities and users in this management realm to submit tasks and to observe what tasks are occurring
getExtension(Class<T>) - Method in interface brooklyn.location.Location
Returns an extension of the given type.
getExtensions() - Method in class brooklyn.location.LocationSpec
 
getFallbackLocations() - Method in interface brooklyn.entity.drivers.downloads.DownloadResolverManager.DownloadTargets
Gets the locations to try (in-order), to be used only after all primary locations have been tried.
getFilename() - Method in interface brooklyn.entity.drivers.downloads.DownloadResolver
The name of the artifact.
getFlags() - Method in class brooklyn.entity.proxying.EntitySpec
 
getFlags() - Method in class brooklyn.location.LocationSpec
 
getFlags() - Method in interface brooklyn.mementos.PolicyMemento
 
getFlags() - Method in class brooklyn.policy.EnricherSpec
 
getFlags() - Method in class brooklyn.policy.PolicySpec
 
getGroups() - Method in interface brooklyn.entity.Entity
The Collection of Groups that this entity is a member of.
getIconUrl() - Method in interface brooklyn.catalog.CatalogItem
 
getIconUrl() - Method in interface brooklyn.entity.Entity
A URL pointing to an image which can be used to represent this icon.
getId() - Method in interface brooklyn.catalog.CatalogItem
 
getId() - Method in interface brooklyn.entity.Entity
The unique identifier for this entity.
getId() - Method in interface brooklyn.entity.trait.Identifiable
 
getId() - Method in interface brooklyn.location.Location
A unique id for this location.
getId() - Method in interface brooklyn.location.LocationDefinition
 
getId() - Method in interface brooklyn.management.Task
 
getId() - Method in interface brooklyn.mementos.Memento
 
getId() - Method in interface brooklyn.mementos.TreeNode
The id of this node in the tree.
getId() - Method in interface brooklyn.policy.Enricher
A unique id for this enricher.
getId() - Method in interface brooklyn.policy.EntityAdjunct
A unique id for this adjunct
getId() - Method in interface brooklyn.policy.Policy
A unique id for this policy.
getImplementation() - Method in class brooklyn.entity.proxying.EntitySpec
 
getImplementedBy(Class<T>) - Method in interface brooklyn.entity.proxying.EntityTypeRegistry
Returns the implementation to be used for the given entity type.
getInitializers() - Method in class brooklyn.entity.proxying.EntitySpec
 
getJavaType() - Method in interface brooklyn.catalog.CatalogItem
 
getLocation() - Method in interface brooklyn.entity.drivers.EntityDriver
The location the entity is running in.
getLocation(String) - Method in interface brooklyn.entity.rebind.RebindContext
 
getLocation() - Method in exception brooklyn.location.NoMachinesAvailableException
Deprecated. since 0.5; the catcher can know which location had no machines based on which location they asked for; will remove this so that the exception is definitely serializable.
getLocation(String) - Method in interface brooklyn.management.LocationManager
Returns the location under management (e.g.
getLocationConfig() - Method in interface brooklyn.mementos.LocationMemento
 
getLocationConfigDescription() - Method in interface brooklyn.mementos.LocationMemento
 
getLocationConfigReferenceKeys() - Method in interface brooklyn.mementos.LocationMemento
The keys in LocationMemento.getLocationConfig() that reference other locations.
getLocationConfigUnused() - Method in interface brooklyn.mementos.LocationMemento
 
getLocationIds() - Method in interface brooklyn.mementos.BrooklynMemento
 
getLocationManager() - Method in interface brooklyn.management.ManagementContext
 
getLocationMemento(String) - Method in interface brooklyn.mementos.BrooklynMemento
 
getLocationMementos() - Method in interface brooklyn.mementos.BrooklynMemento
 
getLocationProperty(String) - Method in interface brooklyn.location.Location
Deprecated. since 0.5.0, use `if (hasConfig) { getConfig }` if you really need to preserve "don't look at parents" behaviour
getLocationReferenceAttributes() - Method in interface brooklyn.mementos.EntityMemento
 
getLocationReferenceConfigs() - Method in interface brooklyn.mementos.EntityMemento
 
getLocationRegistry() - Method in interface brooklyn.management.ManagementContext
Record of configured locations and location resolvers
getLocations() - Method in interface brooklyn.entity.Entity
Return all the Locations this entity is deployed to.
getLocations() - Method in interface brooklyn.management.LocationManager
All locations under control of this management plane.
getLocations() - Method in interface brooklyn.mementos.EntityMemento
The ids of the locations for this entity.
getManagementContext() - Method in interface brooklyn.entity.Application
 
getManagementContext() - Method in interface brooklyn.entity.basic.EntityLocal
Deprecated. since 0.5.0; access via EntityInternal#getManagementContext().
getMembers() - Method in interface brooklyn.entity.Group
Return the entities that are members of this group.
getMembers() - Method in interface brooklyn.mementos.EntityMemento
The ids of the member entities, if this is a Group; otherwise empty.
getMemento() - Method in interface brooklyn.entity.rebind.RebindSupport
Creates a memento representing this entity's current state.
getMsg() - Method in class brooklyn.management.AccessController.Response
 
getName() - Method in interface brooklyn.catalog.CatalogItem
 
getName() - Method in interface brooklyn.entity.Effector
human-friendly name of the effector (although frequently this uses java method naming convention)
getName() - Method in interface brooklyn.entity.EntityType
The type name of this entity (normally the fully qualified class name).
getName() - Method in interface brooklyn.entity.ParameterType
 
getName() - Method in interface brooklyn.event.Sensor
Returns the name of the sensor, in a dot-separated namespace.
getName() - Method in interface brooklyn.location.Location
Deprecated. since 0.6
getName() - Method in interface brooklyn.location.LocationDefinition
 
getName() - Method in interface brooklyn.location.OsDetails
 
getName() - Method in interface brooklyn.policy.Enricher
Get the name assigned to this enricher.
getName() - Method in interface brooklyn.policy.EnricherType
The type name of this policy (normally the fully qualified class name).
getName() - Method in interface brooklyn.policy.EntityAdjunct
Get the name assigned to this adjunct
getName() - Method in interface brooklyn.policy.Policy
Get the name assigned to this policy.
getName() - Method in interface brooklyn.policy.PolicyType
The type name of this policy (normally the fully qualified class name).
getNameParts() - Method in interface brooklyn.event.Sensor
Returns the constituent parts of the sensor name as a List.
getOsDetails() - Method in interface brooklyn.location.MachineLocation
 
getParameterClass() - Method in interface brooklyn.entity.ParameterType
 
getParameterClassName() - Method in interface brooklyn.entity.ParameterType
The canonical name of the parameter class; especially useful if the class cannot be resolved after deserialization.
getParameters() - Method in interface brooklyn.entity.Effector
parameters expected by method, including name and type, optional description and default value
getParent() - Method in interface brooklyn.entity.Entity
The parent of this entity, null if no parent.
getParent() - Method in class brooklyn.entity.proxying.EntitySpec
 
getParent() - Method in interface brooklyn.location.Location
Get the 'parent' of this location.
getParent() - Method in class brooklyn.location.LocationSpec
 
getParent() - Method in interface brooklyn.mementos.TreeNode
The id of the parent entity, or null if none.
getParentLocation() - Method in interface brooklyn.location.Location
Deprecated. since 0.6
getPersister() - Method in interface brooklyn.entity.rebind.RebindManager
 
getPolicies() - Method in interface brooklyn.entity.Entity
 
getPolicies() - Method in class brooklyn.entity.proxying.EntitySpec
 
getPolicies() - Method in interface brooklyn.mementos.EntityMemento
The ids of the policies of this entity.
getPolicy(String) - Method in interface brooklyn.entity.rebind.RebindContext
 
getPolicyIds() - Method in interface brooklyn.mementos.BrooklynMemento
 
getPolicyMemento(String) - Method in interface brooklyn.mementos.BrooklynMemento
 
getPolicyMementos() - Method in interface brooklyn.mementos.BrooklynMemento
 
getPolicySpecs() - Method in class brooklyn.entity.proxying.EntitySpec
 
getPolicyType() - Method in interface brooklyn.policy.Policy
Information about the type of this entity; analogous to Java's object.getClass.
getPrefix() - Method in interface brooklyn.location.LocationResolver
the prefix that this resolver will attend to
getPrimaryLocations() - Method in interface brooklyn.entity.drivers.downloads.DownloadResolverManager.DownloadTargets
Gets the locations to try (in-order).
getProperties() - Method in interface brooklyn.entity.drivers.downloads.DownloadResolverManager.DownloadRequirement
Default properties for this download.
getProperties() - Method in interface brooklyn.location.LocationRegistry
 
getProvisioningFlags(Collection<String>) - Method in interface brooklyn.location.MachineProvisioningLocation
Gets flags, suitable as an argument to MachineProvisioningLocation.obtain(Map).
getQueue() - Method in interface brooklyn.management.TaskQueueingContext
returns a list of queued tasks (immutable copy)
getRebindManager() - Method in interface brooklyn.management.ManagementContext
 
getRebindSupport() - Method in interface brooklyn.entity.Entity
 
getRebindSupport() - Method in interface brooklyn.entity.rebind.Rebindable
 
getRebindSupport() - Method in interface brooklyn.location.Location
 
getRebindSupport() - Method in interface brooklyn.policy.Policy
 
getReturnType() - Method in interface brooklyn.entity.Effector
 
getReturnTypeName() - Method in interface brooklyn.entity.Effector
canonical name of return type (in case return type does not resolve after serialization)
getRootClassLoader() - Method in interface brooklyn.catalog.BrooklynCatalog
returns the classloader which should be used to load classes and entities; this includes all the catalog's classloaders in the right order
getSensor(String) - Method in interface brooklyn.entity.EntityType
The Sensor with the given name, or null if not found.
getSensor() - Method in interface brooklyn.event.SensorEvent
The Sensor describing the data.
getSensors() - Method in interface brooklyn.entity.EntityType
Sensors available on this entity.
getShortName() - Method in interface brooklyn.entity.trait.HasShortName
gets a short name, for human-friendly identification e.g.
getSimpleName() - Method in interface brooklyn.entity.EntityType
The simple type name of this entity (normally the unqualified class name).
getSource() - Method in interface brooklyn.event.SensorEvent
The Entity where the data originated.
getSpec() - Method in interface brooklyn.location.LocationDefinition
 
getStartTimeUtc() - Method in interface brooklyn.management.Task
if Task.isBegun() returns the time when the task was starts; guaranteed to be >= Task.getSubmitTimeUtc() > 0 if started, or -1 otherwise
getStatusDetail(boolean) - Method in interface brooklyn.management.Task
Returns detailed status, suitable for a hover.
getStatusSummary() - Method in interface brooklyn.management.Task
 
getSubmittedByTask() - Method in interface brooklyn.management.Task
task which submitted this task, if was submitted by a task
getSubmitTimeUtc() - Method in interface brooklyn.management.Task
if Task.isSubmitted() returns the time when the task was submitted; or -1 otherwise
getSubscriptionContext(Entity) - Method in interface brooklyn.management.ManagementContext
Returns a SubscriptionContext instance representing subscriptions (from the SubscriptionManager) associated with this entity, and capable of conveniently subscribing on behalf of that entity
getSubscriptionManager() - Method in interface brooklyn.management.ManagementContext
Returns the SubscriptionManager instance for entities and users of this management realm to subscribe to sensor events (and, in the case of entities, to emit sensor events)
getSubscriptions() - Method in interface brooklyn.management.SubscriptionContext
Return the subscriptions associated with this context
getSubscriptionsForEntitySensor(Entity, Sensor<?>) - Method in interface brooklyn.management.SubscriptionManager
Return the subscriptions on a given source-sensor pair
getSubscriptionsForSubscriber(Object) - Method in interface brooklyn.management.SubscriptionManager
Return the subscriptions requested by a given subscriber
getTags() - Method in interface brooklyn.management.Task
 
getTargets() - Method in interface brooklyn.entity.drivers.downloads.DownloadResolver
The targets (normally URLs) for downloading the artifact.
getTask(String) - Method in interface brooklyn.management.ExecutionManager
returns the task with the given ID, or null if none
getTask() - Method in interface brooklyn.management.TaskWrapper
 
getTasks() - Method in interface brooklyn.management.ExecutionContext
Get the tasks executed through this context (returning an immutable set).
getTasksWithAllTags(Iterable<?>) - Method in interface brooklyn.management.ExecutionManager
returns all tasks that have all of the given tags (immutable)
getTasksWithAnyTag(Iterable<?>) - Method in interface brooklyn.management.ExecutionManager
returns all tasks that have any of the given tags (immutable)
getTasksWithTag(Object) - Method in interface brooklyn.management.ExecutionManager
returns all tasks with the given tag (immutable)
getTaskTags() - Method in interface brooklyn.management.ExecutionManager
returns all tags known to this manager (immutable)
getThread() - Method in interface brooklyn.management.Task
The thread where the task is running, if it is running.
getTimestamp() - Method in interface brooklyn.event.SensorEvent
The time this data was published, as a UTC time in milliseconds (e.g.
getTopLevelLocationIds() - Method in interface brooklyn.mementos.BrooklynMemento
 
getType() - Method in class brooklyn.entity.proxying.EntitySpec
 
getType() - Method in interface brooklyn.event.Sensor
Returns the Java Class for the sensor data.
getType() - Method in class brooklyn.location.LocationSpec
 
getType() - Method in interface brooklyn.mementos.Memento
 
getType() - Method in class brooklyn.policy.EnricherSpec
 
getType() - Method in class brooklyn.policy.PolicySpec
 
getTypeName() - Method in interface brooklyn.event.Sensor
Returns the type of the sensor data, as a String representation of the class name.
getTypeToken() - Method in interface brooklyn.event.Sensor
Returns the Guava TypeToken (including generics info)
getUnchecked() - Method in interface brooklyn.management.Task
As Future.get(), but propagating checked exceptions as unchecked for convenience.
getUnchecked(Duration) - Method in interface brooklyn.management.Task
As Future.get(), but propagating checked exceptions as unchecked for convenience (including a TimeoutException if the duration expires)
getUnpackedDirectoryName(String) - Method in interface brooklyn.entity.drivers.downloads.DownloadResolver
The name of the directory in the expanded artifact (e.g.
getValue() - Method in interface brooklyn.event.SensorEvent
The value for the Sensor data.
getVersion() - Method in interface brooklyn.location.OsDetails
 
Group - Interface in brooklyn.entity
An Entity that groups together other entities.

H

hasConfig(ConfigKey<?>) - Method in interface brooklyn.location.Location
Deprecated. since 0.6.0 use Location.hasConfig(ConfigKey, boolean)
hasConfig(ConfigKey<?>, boolean) - Method in interface brooklyn.location.Location
True iff the indication config key is set, either inherited (second argument true) or locally-only (second argument false)
hasExtension(Class<?>) - Method in interface brooklyn.location.Location
Whether this location has support for the given extension type.
hasLocationProperty(String) - Method in interface brooklyn.location.Location
Deprecated. since 0.5.0, use hasConfig
hasMember(Entity) - Method in interface brooklyn.entity.Group
 
hasSensor(String) - Method in interface brooklyn.entity.EntityType
 
HasShortName - Interface in brooklyn.entity.trait
 
HasTaskChildren - Interface in brooklyn.management
Interface marks tasks which have explicit children, typically where the task defines the ordering of running those children tasks

I

Identifiable - Interface in brooklyn.entity.trait
 
immutable() - Method in class brooklyn.entity.proxying.EntitySpec
"seals" this spec, preventing any future changes
impl(Class<? extends T>) - Method in class brooklyn.entity.proxying.EntitySpec
 
ImplementedBy - Annotation Type in brooklyn.entity.proxying
A pointer to the default implementation of an entity.
init(ManagementContext) - Method in interface brooklyn.location.LocationResolver
 
invoke(Effector<T>, Map<String, ?>) - Method in interface brooklyn.entity.Entity
Invokes the given effector, with the given parameters to that effector.
is64bit() - Method in interface brooklyn.location.OsDetails
 
isAllowed() - Method in class brooklyn.management.AccessController.Response
 
isBegun() - Method in interface brooklyn.management.Task
Whether task has started running.
isDestroyed() - Method in interface brooklyn.policy.EntityAdjunct
Whether the adjunct is destroyed
isEmpty() - Method in interface brooklyn.location.PortRange
Whether there are any ports in the range.
isError() - Method in interface brooklyn.management.Task
Whether the task threw an error, including cancellation (implies Future.isDone())
isLinux() - Method in interface brooklyn.location.OsDetails
 
isMac() - Method in interface brooklyn.location.OsDetails
 
isManaged(Entity) - Method in interface brooklyn.management.EntityManager
whether the entity is under management by this management context
isManaged(Location) - Method in interface brooklyn.management.LocationManager
whether the location is under management by this management context
isManaged(Entity) - Method in interface brooklyn.management.ManagementContext
Deprecated. Use getEntityManager().isManaged(Entity) instead; deprecated in 0.5
isRunning() - Method in interface brooklyn.management.ManagementContext
Whether this management context is still running, or has been terminated.
isRunning() - Method in interface brooklyn.policy.EntityAdjunct
Whether the adjunct is available
isShutdown() - Method in interface brooklyn.management.ExecutionManager
 
isSubmitted() - Method in interface brooklyn.management.Task
Whether task has been submitted Submitted tasks are normally expected to start running then complete, but unsubmitted tasks are sometimes passed around for someone else to submit them.
isSuspended() - Method in interface brooklyn.policy.Policy
Whether the policy is suspended
isTopLevelApp() - Method in interface brooklyn.mementos.EntityMemento
 
isWindows() - Method in interface brooklyn.location.OsDetails
 

L

last() - Method in interface brooklyn.management.TaskQueueingContext
returns the last task in the queue, or null if none
loadClass(CatalogItem<T>) - Method in interface brooklyn.catalog.BrooklynCatalog
throws exceptions if any problems
loadClass(String) - Method in interface brooklyn.entity.rebind.RebindContext
 
loadClassByType(String, Class<T>) - Method in interface brooklyn.catalog.BrooklynCatalog
 
loadMemento() - Method in interface brooklyn.mementos.BrooklynMementoPersister
 
Location - Interface in brooklyn.location
A location that an entity can be in.
LocationDefinition - Interface in brooklyn.location
Defines a location, where the LocationDefinition.getSpec() is like a serialized representation of the location so that Brooklyn can create a corresponding location.
LocationManager - Interface in brooklyn.management
For managing and querying entities.
LocationMemento - Interface in brooklyn.mementos
Represents the state of an location, so that it can be reconstructed (e.g.
LocationRegistry - Interface in brooklyn.location
The registry of the sorts of locations that brooklyn knows about.
LocationResolver - Interface in brooklyn.location
Provides a way of creating location instances of a particular type.
locations() - Method in interface brooklyn.mementos.BrooklynMementoPersister.Delta
 
LocationSpec<T extends Location> - Class in brooklyn.location
Gives details of a location to be created.
LocationSpec(Class<T>) - Constructor for class brooklyn.location.LocationSpec
 

M

MachineLocation - Interface in brooklyn.location
A location that is a machine.
MachineProvisioningLocation<T extends MachineLocation> - Interface in brooklyn.location
A location that is able to provision new machines within its location.
manage(Entity) - Method in interface brooklyn.management.EntityManager
Begins management for the given entity and its children, recursively.
manage(Location) - Method in interface brooklyn.management.LocationManager
Deprecated. in 0.6.0; use LocationManager.createLocation(LocationSpec) instead.
manage(Entity) - Method in interface brooklyn.management.ManagementContext
Deprecated. Use getEntityManager().manage(Entity) instead; deprecated in 0.5
ManagementContext - Interface in brooklyn.management
This is the entry point for accessing and interacting with a realm of applications and their entities in Brooklyn.
Memento - Interface in brooklyn.mementos
Represents the internal state of something in brooklyn, so that it can be reconstructed (e.g.

N

newDownloader(EntityDriver) - Method in interface brooklyn.entity.drivers.downloads.DownloadResolverManager
For installing the main entity.
newDownloader(EntityDriver, Map<String, ?>) - Method in interface brooklyn.entity.drivers.downloads.DownloadResolverManager
For installing the main entity.
newDownloader(EntityDriver, String, Map<String, ?>) - Method in interface brooklyn.entity.drivers.downloads.DownloadResolverManager
For installing an entity add-on.
newEvent(Entity, T) - Method in interface brooklyn.event.Sensor
Create a new SensorEvent object for a specific Entity and data point.
newInstance(Class<T>) - Static method in class brooklyn.entity.proxying.EntitySpec
 
newLocationFromString(Map, String) - Method in interface brooklyn.location.LocationResolver
Deprecated. since 0.6; use LocationResolver.newLocationFromString(Map, String, LocationRegistry)
newLocationFromString(Map, String, LocationRegistry) - Method in interface brooklyn.location.LocationResolver
Similar to LocationResolver.newLocationFromString(Map, String) but passing in a reference to the registry itself (from which the base properties are discovered) and including flags (e.g.
newSubLocation(Map<?, ?>) - Method in interface brooklyn.location.MachineProvisioningLocation
Creates a new location of the same type, but with additional creation instructions in the form of flags, e.g.
newTask() - Method in interface brooklyn.management.TaskFactory
 
NoMachinesAvailableException - Exception in brooklyn.location
Indicates no machines are available in a given location.
NoMachinesAvailableException() - Constructor for exception brooklyn.location.NoMachinesAvailableException
Deprecated. since 0.5; always include a helpful message!
NoMachinesAvailableException(String) - Constructor for exception brooklyn.location.NoMachinesAvailableException
 
NoMachinesAvailableException(String, Throwable) - Constructor for exception brooklyn.location.NoMachinesAvailableException
 
NoMachinesAvailableException(Throwable) - Constructor for exception brooklyn.location.NoMachinesAvailableException
Deprecated. since 0.5; always include a helpful message!
NoMachinesAvailableException(Location) - Constructor for exception brooklyn.location.NoMachinesAvailableException
Deprecated. since 0.5; don't include Location - just use NoMachinesAvailableException.NoMachinesAvailableException(String)
NoMachinesAvailableException(Location, String) - Constructor for exception brooklyn.location.NoMachinesAvailableException
Deprecated. since 0.5; don't include Location - just use NoMachinesAvailableException.NoMachinesAvailableException(String)
NoMachinesAvailableException(Location, String, Throwable) - Constructor for exception brooklyn.location.NoMachinesAvailableException
Deprecated. since 0.5; don't include Location - just use NoMachinesAvailableException.NoMachinesAvailableException(String, Throwable)
NoMachinesAvailableException(Location, Throwable) - Constructor for exception brooklyn.location.NoMachinesAvailableException
Deprecated. since 0.5; don't include Location - just use NoMachinesAvailableException.NoMachinesAvailableException(String, Throwable)
NOOP - Static variable in interface brooklyn.entity.rebind.ChangeListener
 

O

obtain(Map<?, ?>) - Method in interface brooklyn.location.MachineProvisioningLocation
Obtain a machine in this location.
obtainPort(PortRange) - Method in interface brooklyn.location.PortSupplier
Reserve a port for your application, with a port number in a specific range.
obtainSpecificPort(int) - Method in interface brooklyn.location.PortSupplier
Reserve a specific port for an application.
onChanged(Entity) - Method in interface brooklyn.entity.rebind.ChangeListener
 
onChanged(Location) - Method in interface brooklyn.entity.rebind.ChangeListener
 
onChanged(Policy) - Method in interface brooklyn.entity.rebind.ChangeListener
 
onEvent(SensorEvent<T>) - Method in interface brooklyn.event.SensorEventListener
The SensorEvent handler method.
onManaged(Entity) - Method in interface brooklyn.entity.rebind.ChangeListener
 
onManaged(Location) - Method in interface brooklyn.entity.rebind.ChangeListener
 
onUnmanaged(Entity) - Method in interface brooklyn.entity.rebind.ChangeListener
 
onUnmanaged(Location) - Method in interface brooklyn.entity.rebind.ChangeListener
 
OsDetails - Interface in brooklyn.location
 

P

ParameterType<T> - Interface in brooklyn.entity
Similar to the concepts in the JMX MBeanParameterInfo class.
parent(Entity) - Method in class brooklyn.entity.proxying.EntitySpec
 
parent(Location) - Method in class brooklyn.location.LocationSpec
 
policies(Iterable<? extends Policy>) - Method in class brooklyn.entity.proxying.EntitySpec
adds the supplied policies to the spec
policies() - Method in interface brooklyn.mementos.BrooklynMementoPersister.Delta
 
policy(Policy) - Method in class brooklyn.entity.proxying.EntitySpec
adds a policy to the spec
policy(PolicySpec<?>) - Method in class brooklyn.entity.proxying.EntitySpec
adds a policy to the spec
Policy - Interface in brooklyn.policy
Policies implement actions and thus must be suspendable; policies should continue to evaluate their sensors and indicate their desired planned action even if they aren't invoking them
PolicyMemento - Interface in brooklyn.mementos
Represents the state of an policy, so that it can be reconstructed (e.g.
PolicySpec<T extends Policy> - Class in brooklyn.policy
Gives details of a policy to be created.
PolicySpec(Class<T>) - Constructor for class brooklyn.policy.PolicySpec
 
policySpecs(Iterable<? extends PolicySpec<?>>) - Method in class brooklyn.entity.proxying.EntitySpec
adds the supplied policies to the spec
PolicyType - Interface in brooklyn.policy
Gives type information for a Policy.
PortRange - Interface in brooklyn.location
A range of ports (indicator for Location and other APIs).
PortSupplier - Interface in brooklyn.location
Mixin interface for location which allows it to supply ports from a given range
publish(SensorEvent<T>) - Method in interface brooklyn.management.SubscriptionContext
 
publish(SensorEvent<T>) - Method in interface brooklyn.management.SubscriptionManager
Deliver a SensorEvent to all subscribed listeners.

Q

queue(Task<?>) - Method in interface brooklyn.management.TaskQueueingContext
queues the task for submission as part of this queueing context; should mark it as submitted

R

rebind(BrooklynMemento) - Method in interface brooklyn.entity.rebind.RebindManager
 
rebind(BrooklynMemento, ClassLoader) - Method in interface brooklyn.entity.rebind.RebindManager
 
Rebindable - Interface in brooklyn.entity.rebind
Indicates that this can be recreated, e.g.
RebindContext - Interface in brooklyn.entity.rebind
Gives access to things that are being currently rebinding.
RebindManager - Interface in brooklyn.entity.rebind
Manages the persisting of brooklyn's state, and recreating that state, e.g.
RebindSupport<T extends Memento> - Interface in brooklyn.entity.rebind
Supporter instance for behaviour related to rebinding a given entity/location/policy.
reconstruct(RebindContext, T) - Method in interface brooklyn.entity.rebind.RebindSupport
Reconstructs this entity, given a memento of its state.
registerDriver(Class<D>, Class<? extends Location>, Class<? extends D>) - Method in interface brooklyn.entity.drivers.EntityDriverManager
 
registerFilenameProducer(Function<? super DownloadResolverManager.DownloadRequirement, String>) - Method in interface brooklyn.entity.drivers.downloads.DownloadResolverManager
Registers a producer for generating the expected filename of the download artifact.
registerImplementation(Class<T>, Class<? extends T>) - Method in interface brooklyn.entity.proxying.EntityTypeRegistry
Registers the implementation to use for a given entity type.
registerPrimaryProducer(Function<? super DownloadResolverManager.DownloadRequirement, ? extends DownloadResolverManager.DownloadTargets>) - Method in interface brooklyn.entity.drivers.downloads.DownloadResolverManager
Registers a producer, to be tried before all other producers.
registerProducer(Function<? super DownloadResolverManager.DownloadRequirement, ? extends DownloadResolverManager.DownloadTargets>) - Method in interface brooklyn.entity.drivers.downloads.DownloadResolverManager
Registers a producer, to be tried after all other registered producers have been tried.
release(T) - Method in interface brooklyn.location.MachineProvisioningLocation
Release a previously-obtained machine.
releasePort(int) - Method in interface brooklyn.location.PortSupplier
Release a previously reserved port.
removeAllEnrichers() - Method in interface brooklyn.entity.basic.EntityLocal
Removes all enricher from this entity.
removeAllPolicies() - Method in interface brooklyn.entity.basic.EntityLocal
Removes all policy from this entity.
removeChild(Entity) - Method in interface brooklyn.entity.Entity
Removes the specified child Entity; its parent will be set to null.
removeDefinedLocation(String) - Method in interface brooklyn.location.LocationRegistry
removes the defined location from the registry (applications running there are unaffected)
removedEntityIds() - Method in interface brooklyn.mementos.BrooklynMementoPersister.Delta
 
removedLocationIds() - Method in interface brooklyn.mementos.BrooklynMementoPersister.Delta
 
removedPolicyIds() - Method in interface brooklyn.mementos.BrooklynMementoPersister.Delta
 
removeEnricher(Enricher) - Method in interface brooklyn.entity.Entity
Removes the given enricher from this entity.
removeMember(Entity) - Method in interface brooklyn.entity.Group
Removes the given member, returning true if this modifies the set of members (i.e.
removePolicy(Policy) - Method in interface brooklyn.entity.Entity
Removes the given policy from this entity.
resolve(LocationDefinition) - Method in interface brooklyn.location.LocationRegistry
returns fully populated (config etc) location from the given definition
resolve(String) - Method in interface brooklyn.location.LocationRegistry
See LocationRegistry.resolve(String, Map) (with no options)
resolve(String, Map) - Method in interface brooklyn.location.LocationRegistry
Returns a location created from the given spec, which might correspond to a definition, or created on-the-fly.
resolve(Iterable<?>) - Method in interface brooklyn.location.LocationRegistry
As LocationRegistry.resolve(String) but works with a collection of location specs.
resolveIfPossible(String) - Method in interface brooklyn.location.LocationRegistry
as LocationRegistry.resolve(String) but returning null (never throwing)
resume() - Method in interface brooklyn.policy.Policy
Resume the policy

S

Sensor<T> - Interface in brooklyn.event
The interface implemented by concrete sensors.
SensorEvent<T> - Interface in brooklyn.event
A tuple representing a piece of data from a Sensor on an Entity.
SensorEventListener<T> - Interface in brooklyn.event
A listener for SensorEvents on an Entity.
setAttribute(AttributeSensor<T>, T) - Method in interface brooklyn.entity.basic.EntityLocal
Sets the Sensor data for the given attribute to the specified value.
setConfig(ConfigKey<T>, T) - Method in interface brooklyn.entity.basic.EntityLocal
Must be called before the entity is managed.
setConfig(ConfigKey<T>, Task<T>) - Method in interface brooklyn.entity.basic.EntityLocal
 
setConfig(ConfigKey.HasConfigKey<T>, T) - Method in interface brooklyn.entity.basic.EntityLocal
 
setConfig(ConfigKey.HasConfigKey<T>, Task<T>) - Method in interface brooklyn.entity.basic.EntityLocal
 
setConfig(ConfigKey<T>, T) - Method in interface brooklyn.entity.trait.Configurable
returns the old value, or null if there was not one
setConfig(ConfigKey<T>, T) - Method in interface brooklyn.policy.Enricher
 
setConfig(ConfigKey<T>, T) - Method in interface brooklyn.policy.Policy
 
setDisplayName(String) - Method in interface brooklyn.entity.basic.EntityLocal
Sets the entity's display name.
setParent(Entity) - Method in interface brooklyn.entity.Entity
Sets the parent (i.e.
setParent(Location) - Method in interface brooklyn.location.Location
Set the 'parent' of this location.
setParentLocation(Location) - Method in interface brooklyn.location.Location
Deprecated. since 0.6
setPersister(BrooklynMementoPersister) - Method in interface brooklyn.entity.rebind.RebindManager
 
spec(Class<T>) - Static method in class brooklyn.location.LocationSpec
Deprecated. since 0.6 (added 0.6.0-M1); use LocationSpec.create(Class)
spec(Map<?, ?>, Class<T>) - Static method in class brooklyn.location.LocationSpec
Deprecated. since 0.6 (added 0.6.0-M1); use LocationSpec.create(Map, Class)
stop() - Method in interface brooklyn.entity.rebind.RebindManager
 
stop() - Method in interface brooklyn.mementos.BrooklynMementoPersister
 
submit(Map<?, ?>, Runnable) - Method in interface brooklyn.management.ExecutionContext
See ExecutionManager.submit(Map, TaskAdaptable) for properties that can be passed in.
submit(Map<?, ?>, Callable<T>) - Method in interface brooklyn.management.ExecutionContext
See ExecutionManager.submit(Map, TaskAdaptable) for properties that can be passed in.
submit(TaskAdaptable<T>) - Method in interface brooklyn.management.ExecutionContext
See ExecutionManager.submit(Map, TaskAdaptable).
submit(Map<?, ?>, TaskAdaptable<T>) - Method in interface brooklyn.management.ExecutionContext
See ExecutionManager.submit(Map, TaskAdaptable) for properties that can be passed in.
submit(Runnable) - Method in interface brooklyn.management.ExecutionManager
see #submit(Map, Task)
submit(Callable<T>) - Method in interface brooklyn.management.ExecutionManager
see #submit(Map, Task)
submit(TaskAdaptable<T>) - Method in interface brooklyn.management.ExecutionManager
see #submit(Map, Task)
submit(Map<?, ?>, Runnable) - Method in interface brooklyn.management.ExecutionManager
see #submit(Map, Task)
submit(Map<?, ?>, Callable<T>) - Method in interface brooklyn.management.ExecutionManager
see #submit(Map, Task)
submit(Map<?, ?>, Object) - Method in interface brooklyn.management.ExecutionManager
Deprecated. since 0.5.0 or 0.6.0, while refactoring groovy->java; use strongly typed methods
submit(Map<?, ?>, TaskAdaptable<T>) - Method in interface brooklyn.management.ExecutionManager
Submits the given Task for execution in the context associated with this manager.
subscribe(Entity, Sensor<T>, SensorEventListener<? super T>) - Method in interface brooklyn.entity.basic.EntityLocal
Allow us to subscribe to data from a Sensor on another entity.
subscribe(Map<String, Object>, Entity, Sensor<T>, SensorEventListener<? super T>) - Method in interface brooklyn.management.SubscriptionContext
As SubscriptionManager.subscribe(Map, Entity, Sensor, SensorEventListener) with default subscription parameters for this context
subscribe(Entity, Sensor<T>, SensorEventListener<? super T>) - Method in interface brooklyn.management.SubscriptionContext
 
subscribe(Map<String, Object>, Entity, Sensor<T>, SensorEventListener<? super T>) - Method in interface brooklyn.management.SubscriptionManager
Subscribe to Sensor data changes and events on a given Entity, supplying the SensorEventListener to invoke when they occur.
subscribe(Entity, Sensor<T>, SensorEventListener<? super T>) - Method in interface brooklyn.management.SubscriptionManager
 
subscribeToChildren(Entity, Sensor<T>, SensorEventListener<? super T>) - Method in interface brooklyn.entity.basic.EntityLocal
 
subscribeToChildren(Map<String, Object>, Entity, Sensor<T>, SensorEventListener<? super T>) - Method in interface brooklyn.management.SubscriptionContext
 
subscribeToChildren(Entity, Sensor<T>, SensorEventListener<? super T>) - Method in interface brooklyn.management.SubscriptionContext
 
subscribeToChildren(Map<String, Object>, Entity, Sensor<T>, SensorEventListener<? super T>) - Method in interface brooklyn.management.SubscriptionManager
Subscribe to Sensor data changes and events on all children of a given Entity, supplying the SensorEventListener to invoke when they occur.
subscribeToChildren(Entity, Sensor<T>, SensorEventListener<? super T>) - Method in interface brooklyn.management.SubscriptionManager
 
subscribeToMembers(Group, Sensor<T>, SensorEventListener<? super T>) - Method in interface brooklyn.entity.basic.EntityLocal
 
subscribeToMembers(Map<String, Object>, Group, Sensor<T>, SensorEventListener<? super T>) - Method in interface brooklyn.management.SubscriptionContext
 
subscribeToMembers(Group, Sensor<T>, SensorEventListener<? super T>) - Method in interface brooklyn.management.SubscriptionContext
 
subscribeToMembers(Map<String, Object>, Group, Sensor<T>, SensorEventListener<? super T>) - Method in interface brooklyn.management.SubscriptionManager
Subscribe to Sensor data changes and events on all members of a given Group, supplying the SensorEventListener to invoke when they occur.
subscribeToMembers(Group, Sensor<T>, SensorEventListener<? super T>) - Method in interface brooklyn.management.SubscriptionManager
 
SubscriptionContext - Interface in brooklyn.management
This is the context through which an Entity can manage its subscriptions.
SubscriptionHandle - Interface in brooklyn.management
A "receipt" returned by SubscriptionContext and SubscriptionManager's subscribe() methods.
SubscriptionManager - Interface in brooklyn.management
The management interface for subscriptions.
suspend() - Method in interface brooklyn.policy.Policy
Suspend the policy

T

Task<T> - Interface in brooklyn.management
Represents a unit of work for execution.
TaskAdaptable<T> - Interface in brooklyn.management
marker interface for something which can be adapted to a task
TaskFactory<T extends TaskAdaptable<?>> - Interface in brooklyn.management
Interface for something which can generate tasks (or task wrappers)
TaskQueueingContext - Interface in brooklyn.management
Marks a place where tasks can be added, e.g.
TaskWrapper<T> - Interface in brooklyn.management
Interface for something which is not a task, but which is closely linked to one, ie.
toString() - Method in class brooklyn.entity.proxying.EntitySpec
 
toString() - Method in class brooklyn.location.LocationSpec
 
toString() - Method in class brooklyn.policy.EnricherSpec
 
toString() - Method in class brooklyn.policy.PolicySpec
 
toVerboseString() - Method in interface brooklyn.location.Location
 
toXmlString() - Method in interface brooklyn.catalog.CatalogItem
 
TreeNode - Interface in brooklyn.mementos
A simple tree structure, where a node references a parent and children using their ids.

U

unmanage(Entity) - Method in interface brooklyn.management.EntityManager
Causes the given entity and its children, recursively, to be removed from the management plane (for instance because the entity is no longer relevant)
unmanage(Location) - Method in interface brooklyn.management.LocationManager
Causes the given location and its children, recursively, to be removed from the management plane (for instance because the location is no longer relevant).
unmanage(Entity) - Method in interface brooklyn.management.ManagementContext
Deprecated. Use getEntityManager().unmanage(Entity) instead; deprecated in 0.5
unsubscribe(Entity) - Method in interface brooklyn.entity.basic.EntityLocal
Unsubscribes from the given producer.
unsubscribe(Entity, SubscriptionHandle) - Method in interface brooklyn.entity.basic.EntityLocal
Unsubscribes the given handle.
unsubscribe(SubscriptionHandle) - Method in interface brooklyn.management.SubscriptionContext
 
unsubscribe(SubscriptionHandle) - Method in interface brooklyn.management.SubscriptionManager
Unsubscribe the given subscription id.
unsubscribeAll() - Method in interface brooklyn.management.SubscriptionContext
causes all subscriptions to be deregistered
updateDefinedLocation(LocationDefinition) - Method in interface brooklyn.location.LocationRegistry
adds or updates the given defined location

V

valueOf(String) - Static method in enum brooklyn.catalog.CatalogItem.CatalogItemType
Returns the enum constant of this type with the specified name.
values() - Static method in enum brooklyn.catalog.CatalogItem.CatalogItemType
Returns an array containing the constants of this enum type, in the order they are declared.

W

waitForPendingComplete(long, TimeUnit) - Method in interface brooklyn.entity.rebind.RebindManager
 
waitForWritesCompleted(long, TimeUnit) - Method in interface brooklyn.mementos.BrooklynMementoPersister
 

A B C D E F G H I L M N O P Q R S T U V W

Copyright © 2013. All Rights Reserved.