Brooklyn

Deprecated API


Interfaces
EntityDriverFactory
      A Factory responsible for creating a driver for a given entity/location.
TaskPreprocessor
      The preprocessor is an internal mechanism to decorate Tasks.
TaskStub
      @deprecated since 0.5; May be deleted (still up for discussion); one can use Task directly
ValueProvider
      TODO javadoc

Classes
AbstractCombiningEnricher
      Convenience base for transforming multiple sensors into a single new sensor.
AbstractPollHelper
      captures common fields and processes for pollers that support sensor adapters
AbstractPushHelper
      Captures common fields and processes for pushers that support sensor adapters.
AbstractSensorAdapter
      Captures common fields and processes for sensor adapters
AbstractSensorEvaluationContext
      provides fields and methods that are brought into scope when executing closures submitted by an entity developer for evaluating a sensor; fields can be made explicit, to be shared among multiple sensors; and specific per-sensor evaluation properties can be passed as "extraProperties" which exist only for that evaluation context duration
CommonCommands
     
deprecated:
since 0.5.0.
ConfigSensorAdapter
      Simple config adapter which, on registration, sets all config-attributes from config values
EffectorUtils
      @deprecated Use brooklyn.management.internal.EffectorUtils; deprecated since 0.5
EffectorWithExplicitImplementation
     
deprecated:
will be deleted in 0.5.
FunctionSensorAdapter
      Entry point for wiring up arbitrary functions to be used as the source for sensors.
HttpPollHelper
      @deprecated See brooklyn.event.feed.http.HttpFeed
HttpResponseContext
      context object for evaluating sensor closures with http data handy
HttpSensorAdapter
      @deprecated See brooklyn.event.feed.http.HttpFeed
JBoss6ServerFactory
      @deprecated since 0.5; instead use new BasicConfigurableEntityFactory(JBoss6ServerImpl.class)
JBoss7ServerFactory
      @deprecated since 0.5; instead use new BasicConfigurableEntityFactory(JBoss7ServerImpl.class)
JmxAttributeAdapter
      Adapter that polls for a JMX attribute.
JmxHelper
      @deprecated Use brooklyn.event.feed.jmx.JmxHelper instead
JmxNotificationAdapter
      Adapter that subscribes to a JMX notification.
JmxNotificationFilters
      @deprecated Use brooklyn.event.feed.jmx.JmxNotificationFilters instead
JmxObjectNameAdapter
      Provides convenient/fluent (and preferred) way to access a JMX object instance.
JmxOperationAdapter
      Adapter that periodically calls a JMX operation.
JmxReachableAdapter
      Adapter that polls for a JMX attribute.
JmxSensorAdapter
      Entry point for wiring up brooklyn attributes to jmx; this doesn't evaluate any sensors directly, but provides support for specific object-name/attribute combos etc.
LanguageUtils
      Useful Groovy utility methods.
Main
      Launches just the brooklyn web-console.
SensorRegistry
      This class manages the periodic polling of a set of sensors, to update the attribute values of a particular Entity.
ShellSensorAdapter
      Like FunctionSensorAdapter but executes a shell command (on the local machine where this instance of brooklyn is running).
SingleThreadedExecution
      Instances of this class ensures that Tasks it is shown execute with in-order single-threaded semantics.
SingleValueResponseContext
      @deprecated See brooklyn.event.feed
SingleWebServerExample
      This example starts one web app on 8080, waits for a keypress, then stops it.
SshPollHelper
      Captures output and exit code for SshSensorAdapter.
SshResultContext
      Context object for evaluating sensor closures with ssh command results.
SshSensorAdapter
      @deprecated See brooklyn.event.feed.ssh.SshFeed
SshShellSensorAdapter
      Like ShellSensorAdapter but executes the shell command remotely.
StringUtils
      Conveniences for manipulating strings.
TomcatServerFactory
      @deprecated since 0.5; instead use new BasicConfigurableEntityFactory(TomcatServerImpl.class)
TrustingSslSocketFactory
      An SSLSocketFactory which trusts all endpoints (ie encryption but no authentication)
WebClusterDatabaseExample
      Launches a 3-tier app with nginx, clustered jboss, and mysql.
WebClusterDatabaseExampleAlt
      Shows some alternative syntaxes compared with WebClusterDatabaseExample.
WebClusterDatabaseExampleAltJava
      Launches a 3-tier app with nginx, clustered jboss, and mysql.
WebClusterExample
      Launches a clustered and load-balanced set of web servers.
WebClusterExampleAlt
      Launches a clustered and load-balanced set of web servers.

Exceptions
EntityStartException
      Indicate an exception when attempting to start an entity.

Annotation Types
Create
      @deprecated This annotation had no effect; deprecated in brooklyn 0.4.0.
Destroy
      @deprecated This annotation had no effect; deprecated in brooklyn 0.4.0.
Error
      @deprecated This annotation had no effect; deprecated in brooklyn 0.4.0.
PostStart
      @deprecated This annotation had no effect; deprecated in brooklyn 0.4.0.
PreStart
      @deprecated This annotation had no effect; deprecated in brooklyn 0.4.0.
PreStop
      @deprecated This annotation had no effect; deprecated in brooklyn 0.4.0.

Methods
AbstractEntity#hasEverBeenManaged()
      FIXME Temporary workaround for use-case: - the load balancing policy test calls app.managementContext.unmanage(itemToStop) - concurrently, the policy calls an effector on that item: item.move() - The code in AbstractManagementContext.invokeEffectorMethodSync calls manageIfNecessary.
AbstractEntity#onManagementBecomingMaster()
      Invoked by ManagementContext when this entity becomes managed at a particular management node, including the initial management started and subsequent management node master-change for this entity.
AbstractEntity#onManagementNoLongerMaster()
      Invoked by ManagementContext when this entity becomes mastered at a particular management node, including the final management end and subsequent management node master-change for this entity.
AbstractEntity#toStringFieldsToInclude()
      override this, adding to the collection, to supply fields whose value, if not null, should be included in the toString
AbstractSoftwareProcessSshDriver#getDefaultVersion()
     
deprecated:
since 0.4.
AbstractSoftwareProcessSshDriver#getEntityVersionLabel()
      @deprecated since 0.5.0; instead rely on DownloadResolverManager to include local-repo, such as:
AbstractSoftwareProcessSshDriver#getEntityVersionLabel(java.lang.String separator)
      @deprecated since 0.5.0; instead rely on DownloadResolverManager to include local-repo
ApplicationBuilder#createChild(EntitySpec spec)
      @deprecated since 0.5.0-rc.1 (added in 0.5.0-M2); use addChild(EntitySpec), for consistency with AbstractEntity#addChild(EntitySpec)#addChild(EntitySpec).
ApplicationBuilder#createChild(java.util.Map config, java.lang.Class type)
      @deprecated since 0.5.0-rc.1 (added in 0.5.0-M2); use addChild(Map, Class)
ApplicationBuilder#newAppSpec(java.lang.Class type)
      @deprecated since 0.5.0-rc.1 (added in 0.5.0-M2)
BasicConfigKey#resolveValue(java.lang.Object v, java.lang.Class type, ExecutionContext exec)
      attempt to resolve the given value as the given type, waiting on futures, and coercing as allowed by TypeCoercions
BasicExecutionManager#setBlockingDetails(java.lang.String description)
      convenience for setting "blocking details" on any task where the current thread is running; typically invoked prior to a wait, for transparency to a user; then invoked with 'null' just after the wait
BasicExecutionManager#withBlockingDetails(java.lang.String description, java.util.concurrent.Callable code)
      convenience for setting "blocking details" on any task where the current thread is running, while the passed code is executed; often used from groovy as
withBlockingDetails("sleeping 5s") { Thread.sleep(5000);  }
BrooklynLauncher#launch()
      Starts the web server (with web console) and Brooklyn applications, as per the specifications configured.
BrooklynLauncher#manage(AbstractApplication app)
      Launches the web console on port 8081, and a Brooklyn application, with a single command, in such a way that the web console is launched and the application is shutdown on server termination.
BrooklynLauncher#manage(AbstractApplication app, int port)
      Launches the web console on the given port, and a Brooklyn application, with a single command, in such a way that the web console is launched and the application is shutdown on server termination.
BrooklynLauncher#manage(AbstractApplication app, int port, boolean shutdownApp, boolean startWebConsole)
      Launches the web console on the given port, and a Brooklyn application, with a single command.
BrooklynLauncher#management(ManagementContext context)
      Specifies the management context this launcher should use.
BrooklynLauncher#managing(Application app)
      Specifies that the launcher should manage the given Brooklyn application.
BrooklynLauncher#managing(ApplicationBuilder app)
      Specifies that the launcher should build and manage the given Brooklyn application.
BrooklynLauncher#newLauncher()
      Creates a configurable (fluent API) launcher for use starting the web console and Brooklyn applications.
BrooklynLauncher#setAttribute(java.lang.String field, java.lang.Object value)
      Specifies an attribute passed to deployed webapps (in addition to BrooklynServiceAttributes#BROOKLYN_MANAGEMENT_CONTEXT#BROOKLYN_MANAGEMENT_CONTEXT
CommonCommands#downloadUrlAs(java.lang.String url, java.lang.String entityVersionPath, java.lang.String pathlessFilenameToSaveAs)
      @see downloadUrlAs(Map, String, String, String)
CommonCommands#downloadUrlAs(java.util.Map flags, java.lang.String url, java.lang.String entityVersionPath, java.lang.String pathlessFilenameToSaveAs)
      /** Returns command for downloading from a url and saving to a file; currently using curl.
Entity#addOwnedChild(Entity child)
      @deprecated since 0.5; see addChild(Entity)
Entity#clearOwner()
      @deprecated since 0.5; see clearParent()
Entity#getOwnedChildren()
      @deprecated since 0.5; see getChildren()
Entity#getOwner()
      @deprecated since 0.5; see getParent()
Entity#removeOwnedChild(Entity child)
      @deprecated since 0.5; see removeChild(Entity)
Entity#setOwner(Entity group)
      @deprecated since 0.5; see setOwner(Entity)
EntityInternal#setAttribute(AttributeSensorAndConfigKey configuredSensor)
      sets the value of the given attribute sensor from the config key value herein, if the config key resolves to a non-null value as a sensor
EntityLocal#getConfig(ConfigKey key, java.lang.Object defaultValue)
      sets the value of the given attribute sensor from the config key value herein, // * if the config key resolves to a non-null value as a sensor // * // * @deprecated since 0.5; use setAttribute(AttributeSensor, Object), such as // *
//     * T val = getConfig(KEY.getConfigKey());
//     * if (val !
            
EntityLocal#getConfig(HasConfigKey key, java.lang.Object defaultValue)
      @deprecated in 0.5; use getConfig(HasConfigKey)
EntityLocal#getExecutionContext()
      @return The task execution context for the entity, or null if it is not yet managed.
EntityLocal#getManagementContext()
      @return The management context for the entity, or null if it is not yet managed.
ExecutionContext#getCurrentTask()
      Returns the current Task being executed by this context, or null if not currently executing a task.
ExecutionManager#submit(java.util.Map flags, java.lang.Object c)
      @see submit(Map, Task)
JBoss7SshDriver#getManagementPort()
      @deprecated since 0.5; use getManagementHttpPort() instead
LanguageUtils#addToMapOfLists(java.util.Map map, java.lang.Object key, java.lang.Object valueInCollection)
      as addToMapOfSets(Map, Object, Object) but for java.util.ArrayList
LanguageUtils#addToMapOfSets(java.util.Map map, java.lang.Object key, java.lang.Object valueInCollection)
      Adds the given value to a collection in the map under the key.
LanguageUtils#newUid()
      @deprecated use Identifiers.makeRandomId(8)
LanguageUtils#removeFromMapOfCollections(java.util.Map map, java.lang.Object key, java.lang.Object valueInCollection)
      Removes the given value from a collection in the map under the key.
Location#findLocationProperty(java.lang.String key)
      // * Returns the location properties of this immediate location (i.e. not including those from the parent hierarchy). // * @deprecated since 0.5.0, use getAllConfig //
Location#getLocationProperty(java.lang.String key)
      Returns the value of the property identified by the specified key.
Location#hasLocationProperty(java.lang.String key)
      Returns true iff this location contains a property with the specified key.
ManagementContext#getEntities()
      All entities under control of this management plane
ManagementContext#getEntity(java.lang.String id)
      Returns the entity with the given identifier (may be a full instance, or a proxy to one which is remote)
ManagementContext#getEntityDriverFactory()
      @deprecated since 0.5; use getEntityDriverManager()
ManagementContext#isManaged(Entity entity)
      Whether the entity is under management by this management context
ManagementContext#manage(Entity e)
      Manage an entity.
ManagementContext#unmanage(Entity e)
      Unmanage an entity.
NoMachinesAvailableException#getLocation()
      @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.
SensorRegistry#activateAdapters()
      @deprecated activated automatically, as soon as constructed.
SensorRegistry#addSensor(AttributeSensor sensor, ValueProvider provider)
      @deprecated in 0.4. use new SensorAdapter model.
SensorRegistry#addSensor(AttributeSensor sensor, ValueProvider provider, long period)
      @deprecated in 0.4. use new SensorAdapter model.
SensorRegistry#removeSensor(AttributeSensor sensor)
      @deprecated in 0.4. use new SensorAdapter model.
SensorRegistry#update(Sensor sensor)
      @deprecated in 0.4. use new SensorAdapter model.
SensorRegistry#updateAll()
      @deprecated in 0.4. use new SensorAdapter model.
SshMachineLocation#exec(java.util.List commands)
      Convenience for running commands using ssh {@literal exec} mode.
SshMachineLocation#run(java.util.List commands)
     
deprecated:
in 1.4.1,
@see execCommand and execScript
SshTool#createFile(java.util.Map props, java.lang.String pathAndFileOnRemoteServer, java.io.InputStream input, long size)
      @deprecated since 0.5; See copyToServer(Map, InputStream, String)
SshTool#createFile(java.util.Map props, java.lang.String pathAndFileOnRemoteServer, java.lang.String contents)
      @deprecated since 0.5; See copyToServer(Map, byte[], String)
SshTool#createFile(java.util.Map props, java.lang.String pathAndFileOnRemoteServer, byte[] contents)
      @deprecated since 0.5; See copyToServer(Map, byte[], String)
SshTool#transferFileFrom(java.util.Map props, java.lang.String pathAndFileOnRemoteServer, java.lang.String pathAndFileOnLocalServer)
      @deprecated since 0.5; See copyFromServer(Map, InputStream, String)
SshTool#transferFileTo(java.util.Map props, java.io.InputStream input, java.lang.String pathAndFileOnRemoteServer)
      @deprecated since 0.5; See copyToServer(Map, InputStream, String)
TestUtils#assertAttributeContinually(Entity entity, AttributeSensor attribute, java.lang.Object expected)
      @deprecated since 0.5; use EntityTestUtils#assertAttributeEqualsContinually(Entity, AttributeSensor, Object)#assertAttributeEqualsContinually(Entity, AttributeSensor, Object)
TestUtils#assertAttributeEventually(Entity entity, AttributeSensor attribute, java.lang.Object expected)
      @deprecated since 0.5; use EntityTestUtils#assertAttributeEqualsEventually(Entity, AttributeSensor, Object)#assertAttributeEqualsEventually(Entity, AttributeSensor, Object)
TestUtils#assertContinually(java.util.Map flags = [:], Supplier supplier, Predicate predicate)
      @deprecated since 0.5; use Asserts#continually(Map, Supplier, Predicate)#continually(Map, Supplier, Predicate)
TestUtils#assertContinually(java.util.Map flags = [:], Supplier supplier, Predicate predicate, java.lang.String errMsg, long durationMs)
      @deprecated since 0.5; use Asserts#continually(Map, Supplier, Predicate, String)#continually(Map, Supplier, Predicate, String)
TestUtils#assertContinually(java.util.Map flags = [:], Supplier supplier, Predicate predicate, java.lang.String errMsg)
      @deprecated since 0.5; use Asserts#continually(Map, Supplier, Predicate, String)#continually(Map, Supplier, Predicate, String)
TestUtils#assertContinuallyFromJava(java.util.Map flags = [:], Supplier supplier, Predicate predicate)
      @deprecated since 0.5; use Asserts#continually(Map, Supplier, Predicate)#continually(Map, Supplier, Predicate)
TestUtils#assertEventually(java.util.Map flags = [:], Supplier supplier, Predicate predicate)
      @deprecated since 0.5; use Asserts#eventually(Map, Supplier, Predicate)#eventually(Map, Supplier, Predicate)
TestUtils#assertEventually(java.util.Map flags = [:], Supplier supplier, Predicate predicate, java.lang.String errMsg)
      @deprecated since 0.5; use Asserts#eventually(Map, Supplier, Predicate, String)#eventually(Map, Supplier, Predicate, String)
TestUtils#assertEventually(java.util.Map flags = [:], java.util.concurrent.Callable c)
      @deprecated since 0.5; use Asserts.succeedsEventually
TestUtils#assertEventually(java.util.Map flags = [:], java.lang.Runnable c)
      @deprecated since 0.5; use Asserts#succeedsEventually(Map, Runnable)#succeedsEventually(Map, Runnable)
TestUtils#assertFails(java.lang.Runnable c)
      @deprecated since 0.5; use Asserts#assertFails(Runnable)#assertFails(Runnable)
TestUtils#assertFailsWith(java.lang.Runnable c, groovy.lang.Closure exceptionChecker)
      @deprecated since 0.5; use Asserts#assertFailsWith(Closure)#assertFailsWith(Closure)
TestUtils#assertFailsWith(java.lang.Runnable c, java.lang.Class validException, java.lang.Class otherValidExceptions)
      @deprecated since 0.5; use Asserts.assertFailsWith
TestUtils#assertFailsWith(java.lang.Runnable c, Predicate exceptionChecker)
      @deprecated since 0.5; use Asserts#assertFailsWith(Runnable, Predicate)#assertFailsWith(Runnable, Predicate)
TestUtils#assertNonEmpty(java.lang.Iterable c)
      @deprecated since 0.5; use assertFalse(Iterables.isEmpty(c))
TestUtils#assertSize(java.lang.Iterable c, int expectedSize)
      @deprecated since 0.5; use assertEquals(Iterables.size(c), expectedSize)
TestUtils#assertSucceedsContinually(java.util.Map flags = [:], java.lang.Runnable job)
      @deprecated since 0.5; use Asserts#succeedsContinually(Map, Runnable)#succeedsContinually(Map, Runnable)
TestUtils#assertSucceedsContinually(java.util.Map flags = [:], java.util.concurrent.Callable job)
      @deprecated since 0.5; use Asserts#succeedsContinually(Map, Callable)#succeedsContinually(Map, Callable)
TestUtils#assertUrlStatusCodeEventually(java.lang.String url, int expected)
      @deprecated since 0.5; use HttpTestUtils#assertHttpStatusCodeEquals(String, int)#assertHttpStatusCodeEquals(String, int)
TestUtils#connectToURL(java.lang.String url)
      Connects to the given url and returns the connection.
TestUtils#executeUntilSucceeds(java.util.Map flags = [:], groovy.lang.Closure c)
      @deprecated since 0.5; use Asserts#succeedsEventually(Map, Callable)#succeedsEventually(Map, Callable)
TestUtils#executeUntilSucceeds(java.util.Map flags = [:], java.util.concurrent.Callable c)
      @deprecated since 0.5; use Asserts#succeedsEventually(Map, Callable)#succeedsEventually(Map, Callable)
TestUtils#executeUntilSucceeds(java.util.Map flags = [:], java.lang.Runnable r)
      @deprecated since 0.5; use Asserts#succeedsEventually(Map, Runnable)#succeedsEventually(Map, Runnable)
TestUtils#executeUntilSucceedsElseShutdown(java.util.Map flags = [:], Entity entity, groovy.lang.Closure c)
      @deprecated since 0.5; use Asserts#succeedsEventually(Map, Callable)#succeedsEventually(Map, Callable), and tear-down with AfterMethod.
TestUtils#executeUntilSucceedsWithFinallyBlock(java.util.Map flags = [:], groovy.lang.Closure c, groovy.lang.Closure finallyBlock = {})
      @deprecated since 0.5; use Asserts#succeedsEventually(Map, Callable)#succeedsEventually(Map, Callable), and tear-down with AfterMethod.
TestUtils#executeUntilSucceedsWithFinallyBlock(java.util.Map flags = [:], java.util.concurrent.Callable c, groovy.lang.Closure finallyBlock = {})
      Convenience method for cases where we need to test until something is true.
TestUtils#executeUntilSucceedsWithFinallyBlockInternal(java.util.Map flags = [:], java.util.concurrent.Callable c, groovy.lang.Closure finallyBlock = {})
      the "real" implementation, renamed to allow multiple entry points (depending whether closure cast to callable)
TestUtils#executeUntilSucceedsWithShutdown(java.util.Map flags = [:], Entity entity, groovy.lang.Closure c)
      convenience for entities to ensure they shutdown afterwards.
TestUtils#getResource(java.lang.String path, java.lang.ClassLoader loader)
      @deprecated since 0.5; use ResourceUtils
TestUtils#isPortInUse(int port, long retryAfterMillis = 0)
      True if two attempts to connect to the port succeed.
TestUtils#toTimeDuration(java.lang.Object duration)
      @deprecated since 0.5; use long and java.util.concurrent.TimeUnit
TestUtils#toTimeDuration(java.lang.Object duration, groovy.time.TimeDuration defaultVal)
      @deprecated since 0.5; use long and java.util.concurrent.TimeUnit
TestUtils#urlRespondsStatusCode(java.lang.String url)
      Connects to the given HTTP URL and asserts that the response had status code 200.
TestUtils#urlRespondsWithStatusCode200(java.lang.String url)
      Connects to the given HTTP URL and asserts that the response had status code 200.

Constructors
AbstractApplication#AbstractApplication(java.util.Map properties, Entity parent)
      Constructor for when application is nested inside another application
AbstractEntity#AbstractEntity(java.util.Map flags)
      @deprecated since 0.5; instead use no-arg constructor with EntityManager().createEntity(spec)
AbstractEntity#AbstractEntity(Entity parent)
      @deprecated since 0.5; instead use no-arg constructor with EntityManager().createEntity(spec)
AbstractEntity#AbstractEntity(java.util.Map flags, Entity parent)
      @deprecated since 0.5; instead use no-arg constructor with EntityManager().createEntity(spec)
MovableElasticWebAppClusterImpl#MovableElasticWebAppClusterImpl(java.util.Map flags, Entity parent)
      @deprecated since 0.5; use EntityManager#createEntity(EntitySpec) or {@link ApplicationBuilder#addChild(EntitySpec)#createEntity(EntitySpec) or {@link ApplicationBuilder
NoMachinesAvailableException#NoMachinesAvailableException(Location location)
      @deprecated since 0.5; don't include Location - just use NoMachinesAvailableException(String)
NoMachinesAvailableException#NoMachinesAvailableException(Location location, java.lang.String s)
      @deprecated since 0.5; don't include Location - just use NoMachinesAvailableException(String)
NoMachinesAvailableException#NoMachinesAvailableException(Location location, java.lang.String s, java.lang.Throwable throwable)
      @deprecated since 0.5; don't include Location - just use NoMachinesAvailableException(String, Throwable)
NoMachinesAvailableException#NoMachinesAvailableException(Location location, java.lang.Throwable throwable)
      @deprecated since 0.5; don't include Location - just use NoMachinesAvailableException(String, Throwable)


Brooklyn Multi-Cloud Application Management Platform
brooklyncentral.github.com. Apache License. © 2012.