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.basic.EntityInternal
  brooklyn.entity.rebind.Rebindable
      brooklyn.entity.Entity
          brooklyn.entity.basic.EntityLocal
              brooklyn.entity.trait.Identifiable
                  brooklyn.entity.trait.Configurable
All Superinterfaces:
Rebindable, Entity, EntityLocal, Identifiable, Configurable
@Beta
public interface EntityInternal
extends EntityLocal

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)

void clearLocations()

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

Effector getEffector(java.lang.String effectorName)

returns the effector registered against a given name
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
EntityDynamicType getMutableEntityType()

returns the dynamic type corresponding to the type of this entity instance
SubscriptionContext getSubscriptionContext()

void refreshInheritedConfig()

void removeAttribute(AttributeSensor attribute)

void removeLocations(java.util.Collection locations)

java.lang.Object setAttributeWithoutPublishing(AttributeSensor sensor, java.lang.Object val)

Like EntityLocal#setAttribute(AttributeSensor, Object)#setAttribute(AttributeSensor, Object), except does not publish an attribute-change event.
java.util.Map toMetadataRecord()

 
Methods inherited from interface EntityLocal
emit, getConfig, getConfig, getConfig, getExecutionContext, getManagementContext, removeAllEnrichers, removeAllPolicies, setAttribute, setConfig, setConfig, setConfig, setConfig, setDisplayName, subscribe, subscribeToChildren, subscribeToMembers, unsubscribe, unsubscribe
 
Methods inherited from interface Entity
addChild, addChild, addEnricher, addGroup, addPolicy, clearParent, getApplication, getApplicationId, getAttribute, getChildren, getConfig, getConfig, getCreationTime, getDisplayName, getEnrichers, getEntityType, getGroups, getIconUrl, getId, getLocations, getParent, getPolicies, getRebindSupport, invoke, removeChild, removeEnricher, removePolicy, setParent
 
Methods inherited from interface Configurable
setConfig
 

Method Detail

addLocations

public void addLocations(java.util.Collection locations)

clearLocations

public void clearLocations()

configure

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

destroy

void destroy();
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()

getEffector

Effector getEffector(String effectorName);
public Effector getEffector(java.lang.String effectorName)
returns the effector registered against a given name

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

getMutableEntityType

EntityDynamicType getMutableEntityType();
public EntityDynamicType getMutableEntityType()
returns the dynamic type corresponding to the type of this entity instance

getSubscriptionContext

public SubscriptionContext getSubscriptionContext()

refreshInheritedConfig

@Beta
public void refreshInheritedConfig()

removeAttribute

@Beta
public void removeAttribute(AttributeSensor attribute)

removeLocations

public void removeLocations(java.util.Collection locations)

setAttributeWithoutPublishing

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

toMetadataRecord

public java.util.Map toMetadataRecord()

 

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