Overview  Package   Class  Deprecated  Index  Help 
Brooklyn
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | METHOD DETAIL: FIELD | METHOD

brooklyn.entity.basic
[Java] Interface EntityInternal

brooklyn.entity.Entity
  brooklyn.entity.rebind.Rebindable
      brooklyn.entity.basic.EntityInternal
All Superinterfaces:
Entity, Rebindable
@Beta
public interface EntityInternal
extends Entity

Extended Entity interface with additional functionality that is purely-internal (i.e. intended for the brooklyn framework only).

Method Summary
void addLocations(java.util.Collection locations)

EntityInternal configure(java.util.Map flags)

Must be called before the entity is started.
void destroy()

Should be invoked at end-of-life to clean up the item.
java.util.Map getAllAttributes()

java.util.Map getAllConfig()

@return a read-only copy of all the config key/value pairs on this entity.
EntityConfigMap getConfigMap()

ExecutionContext getExecutionContext()

Returns the task execution context for the entity.

ManagementContext getManagementContext()

Returns the management context for the entity.

EntityManagementSupport getManagementSupport()

@return Routings for accessing and inspecting the management context of the entity
SubscriptionContext getSubscriptionContext()

void refreshInheritedConfig()

void removeLocations(java.util.Collection locations)

java.lang.Object 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
java.lang.Object setAttributeWithoutPublishing(AttributeSensor sensor, java.lang.Object val)

Like setAttribute(brooklyn.event.AttributeSensor, java.lang.Object), except does not publish an attribute-change event.
 
Methods inherited from interface Entity
addChild, addChild, addEnricher, addGroup, addOwnedChild, addPolicy, clearOwner, clearParent, getApplication, getApplicationId, getAttribute, getChildren, getConfig, getDisplayName, getEnrichers, getEntityType, getGroups, getId, getLocations, getOwnedChildren, getOwner, getParent, getPolicies, getRebindSupport, invoke, removeChild, removeEnricher, removeOwnedChild, removePolicy, setOwner, setParent
 
Methods inherited from interface Rebindable
getRebindSupport
 

Method Detail

addLocations

public void addLocations(java.util.Collection locations)

configure

@Beta // for internal use only
public EntityInternal configure(java.util.Map flags)
Must be called before the entity is started.
Returns:
this entity (i.e. itself)

destroy

@Beta
public void destroy()
Should be invoked at end-of-life to clean up the item.

getAllAttributes

@Beta
public java.util.Map getAllAttributes()

getAllConfig

@Beta
public java.util.Map getAllConfig()
Returns:
a read-only copy of all the config key/value pairs on this entity.

getConfigMap

public EntityConfigMap getConfigMap()

getExecutionContext

public ExecutionContext getExecutionContext()
Returns the task execution context for the entity. If the entity is not yet managed, some operations on the management context will fail. Do not cache this object; instead call getExecutionContext() each time you need to use it.

getManagementContext

public ManagementContext getManagementContext()
Returns the management context for the entity. If the entity is not yet managed, some operations on the management context will fail. Do not cache this object; instead call getManagementContext() each time you need to use it.

getManagementSupport

public EntityManagementSupport getManagementSupport()
Returns:
Routings for accessing and inspecting the management context of the entity

getSubscriptionContext

public SubscriptionContext getSubscriptionContext()

refreshInheritedConfig

@Beta
public void refreshInheritedConfig()

removeLocations

public void removeLocations(java.util.Collection locations)

setAttribute

public java.lang.Object 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
deprecated:
since 0.5; use setAttribute(AttributeSensor, Object), such as 
 T val = getConfig(KEY.getConfigKey());
 if (val != null) {
     setAttribute(KEY, val)
 }
Returns:
old value

setAttributeWithoutPublishing

public java.lang.Object setAttributeWithoutPublishing(AttributeSensor sensor, java.lang.Object val)
Like setAttribute(brooklyn.event.AttributeSensor, java.lang.Object), except does not publish an attribute-change event.

 

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