org.apache.brooklyn.core.objs

Class AbstractBrooklynObject

java.lang.Object

org.apache.brooklyn.core.objs.AbstractBrooklynObject

All Implemented Interfaces:

Rebindable, BrooklynObject, Configurable, Identifiable, BrooklynObjectInternal

Direct Known Subclasses:

AbstractEntity, AbstractEntityAdjunct, AbstractLocation, BasicManagedBundle, CatalogItemDtoAbstract

public abstract class AbstractBrooklynObject
extends java.lang.Object
implements BrooklynObjectInternal

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal

BrooklynObjectInternal.ConfigurationSupportInternal, BrooklynObjectInternal.RelationSupportInternal<T extends BrooklynObject>, BrooklynObjectInternal.SubscriptionSupportInternal

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

BrooklynObject.RelationSupport<T extends BrooklynObject>, BrooklynObject.SubscriptionSupport, BrooklynObject.TagSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.Configurable

Configurable.ConfigurationSupport

Constructor Summary

Constructors

Constructor and Description
AbstractBrooklynObject()
AbstractBrooklynObject(java.util.Map<?,?> properties)

Method Summary

Modifier and Type	Method and Description
void	addSearchPath(java.util.List<java.lang.String> ids)
java.lang.String	getCatalogItemId() The catalog item ID this object was loaded from.
java.util.List<java.lang.String>	getCatalogItemIdSearchPath() An immutable list of ids of catalog items that this item depends on in some way, with the item that directly defines it implicit, but other items it references explicit.
java.lang.String	getId()
ManagementContext	getManagementContext()
void	init() Called by framework (in new-style instances where spec was used) after configuring etc, but before a reference to this instance is shared.
void	rebind() Called by framework on rebind (in new-style instances): after configuring, but before the instance is managed, and before adjuncts are attached to entities, and before a reference to an object is shared.
BrooklynObjectInternal.RelationSupportInternal<?>	relations() Relations specify a typed, directed connection between two entities.
void	setCatalogItemId(java.lang.String id)
void	setCatalogItemIdAndSearchPath(java.lang.String catalogItemId, java.util.List<java.lang.String> ids)
abstract void	setDisplayName(java.lang.String newName)
void	setManagementContext(ManagementContextInternal managementContext)
void	stackCatalogItemId(java.lang.String id) Moves the current catalog item id onto the start of the search path, then sets the catalog item id to the supplied value.
BrooklynObject.TagSupport	tags() Tags are arbitrary objects which can be attached to an entity for subsequent reference.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal

config, getRebindSupport, subscriptions

Methods inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

getDisplayName

Methods inherited from interface org.apache.brooklyn.api.objs.Configurable

getConfig

Constructor Detail

AbstractBrooklynObject

public AbstractBrooklynObject()

AbstractBrooklynObject

public AbstractBrooklynObject(java.util.Map<?,?> properties)

Method Detail

setDisplayName

public abstract void setDisplayName(java.lang.String newName)

init

public void init()

Called by framework (in new-style instances where spec was used) after configuring etc, but before a reference to this instance is shared.

To preserve backwards compatibility for if the instance is constructed directly, one can call the code below, but that means it will be called after references to this policy have been shared with other entities.

 
 if (isLegacyConstruction()) {
     init();
 }
 
 

rebind

public void rebind()

Called by framework on rebind (in new-style instances):

• after configuring, but
• before the instance is managed, and
• before adjuncts are attached to entities, and
• before a reference to an object is shared.

Note that init() will not be called on rebind.

If you need to intercept behaviour after adjuncts are attached, consider AbstractEntity.onManagementStarting() (but probably worth raising a discussion on the mailing list!)

setManagementContext

public void setManagementContext(ManagementContextInternal managementContext)

getManagementContext

public ManagementContext getManagementContext()

Specified by:

getManagementContext in interface BrooklynObjectInternal

getId

public java.lang.String getId()

Specified by:

getId in interface Identifiable

setCatalogItemId

public void setCatalogItemId(java.lang.String id)

Specified by:

setCatalogItemId in interface BrooklynObjectInternal

setCatalogItemIdAndSearchPath

public void setCatalogItemIdAndSearchPath(java.lang.String catalogItemId,
                                          java.util.List<java.lang.String> ids)

Specified by:

setCatalogItemIdAndSearchPath in interface BrooklynObjectInternal

addSearchPath

public void addSearchPath(java.util.List<java.lang.String> ids)

Specified by:

addSearchPath in interface BrooklynObjectInternal

stackCatalogItemId

public void stackCatalogItemId(java.lang.String id)

Description copied from interface: BrooklynObjectInternal

Moves the current catalog item id onto the start of the search path, then sets the catalog item id to the supplied value.

Specified by:

stackCatalogItemId in interface BrooklynObjectInternal

getCatalogItemIdSearchPath

public java.util.List<java.lang.String> getCatalogItemIdSearchPath()

Description copied from interface: BrooklynObject

An immutable list of ids of catalog items that this item depends on in some way, with the item that directly defines it implicit, but other items it references explicit. Wrapping items are first in the list (i.e. wrapping items precede wrapped items), so for example, if the catalog is:

     items:
     - id: X
     - id: Y
       item: X
     - id: Z
       item: Y
 

the spec for Z will have getCatalogId() of Z and getCatalogItemIdSearchPath() of Y, X. (The self catalog ID is implicit at the head of the search path.)

Specified by:

getCatalogItemIdSearchPath in interface BrooklynObject

getCatalogItemId

public java.lang.String getCatalogItemId()

Description copied from interface: BrooklynObject

The catalog item ID this object was loaded from.

This can be used to understand the appropriate classloading context, such as for versioning purposes, as well as meta-information such as branding (maybe you can even get an icon) and potentially things like resource lifecycle (if a software version is being sunsetted).

In some cases this may be set heuristically from context and so may not be accurate. Callers can set an explicit catalog item ID if inferencing is not correct.

This should conform to OSGi specs for symbolic_name:version but weaker semantics are usually allowed so long as neither segment contains a : or whitespace.

Specified by:

getCatalogItemId in interface BrooklynObject

tags

public BrooklynObject.TagSupport tags()

Description copied from interface: BrooklynObject

Tags are arbitrary objects which can be attached to an entity for subsequent reference. They must not be null (as ImmutableMap may be used under the covers; also there is little point!); and they should be amenable to our persistence (on-disk serialization) and our JSON serialization in the REST API.

Specified by:

tags in interface BrooklynObject

relations

public BrooklynObjectInternal.RelationSupportInternal<?> relations()

Description copied from interface: BrooklynObject

Relations specify a typed, directed connection between two entities. Generic type is overridden in sub-interfaces.

Specified by:

relations in interface BrooklynObject

Specified by:

relations in interface BrooklynObjectInternal