org.apache.brooklyn.core.catalog.internal

Class CatalogItemDo<T,SpecT>

java.lang.Object

org.apache.brooklyn.core.catalog.internal.CatalogItemDo<T,SpecT>

All Implemented Interfaces:

CatalogItem<T,SpecT>, Rebindable, BrooklynObject, Configurable, Identifiable, BrooklynObjectInternal

public class CatalogItemDo<T,SpecT>
extends java.lang.Object
implements CatalogItem<T,SpecT>, BrooklynObjectInternal

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.catalog.CatalogItem

CatalogItem.CatalogBundle, CatalogItem.CatalogItemLibraries, CatalogItem.CatalogItemType

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
CatalogItemDo(CatalogDo catalog, CatalogItem<T,SpecT> itemDto)

Method Summary

Modifier and Type	Method and Description
void	addSearchPath(java.util.List<java.lang.String> searchPath)
BrooklynObjectInternal.ConfigurationSupportInternal	config()
java.lang.String	getCatalogItemId() Built up from CatalogItem.getSymbolicName() and CatalogItem.getVersion().
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.Class<T>	getCatalogItemJavaType()
CatalogItem.CatalogItemType	getCatalogItemType()
<U> U	getConfig(ConfigKey<U> key) Convenience for calling Configurable.ConfigurationSupport.get(ConfigKey), via code like config().get(key).
java.lang.String	getContainingBundle()
java.lang.String	getDescription()
java.lang.String	getDisplayName() A display name; recommended to be a concise single-line description.
CatalogItem<T,SpecT>	getDto()
java.lang.String	getIconUrl()
java.lang.String	getId()
java.lang.String	getJavaType()
java.util.Collection<CatalogItem.CatalogBundle>	getLibraries()
ManagementContext	getManagementContext()
java.lang.String	getPlanYaml()
RebindSupport<CatalogItemMemento>	getRebindSupport()
java.lang.Class<SpecT>	getSpecType()
java.lang.String	getSymbolicName()
java.lang.String	getVersion()
boolean	isDeprecated()
boolean	isDisabled()
BrooklynObjectInternal.RelationSupportInternal<CatalogItem<T,SpecT>>	relations() Overrides the parent so that relations are not visible.
void	setCatalogItemId(java.lang.String id)
void	setCatalogItemIdAndSearchPath(java.lang.String catalogItemId, java.util.List<java.lang.String> ids)
void	setDeprecated(boolean deprecated)
void	setDisabled(boolean diabled)
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.
BrooklynObjectInternal.SubscriptionSupportInternal	subscriptions() Subscriptions are the mechanism for receiving notifications of sensor-events (e.g.
BrooklynObject.TagSupport	tags() Tags are arbitrary objects which can be attached to an entity for subsequent reference.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CatalogItemDo

public CatalogItemDo(CatalogDo catalog,
                     CatalogItem<T,SpecT> itemDto)

Method Detail

getDto

public CatalogItem<T,SpecT> getDto()

getManagementContext

public ManagementContext getManagementContext()

Specified by:

getManagementContext in interface BrooklynObjectInternal

config

public BrooklynObjectInternal.ConfigurationSupportInternal config()

Specified by:

config in interface CatalogItem<T,SpecT>

Specified by:

config in interface Configurable

Specified by:

config in interface BrooklynObjectInternal

Throws:

UnsupportedOperationException; - Config not supported for catalog item. See getPlanYaml().

subscriptions

public BrooklynObjectInternal.SubscriptionSupportInternal subscriptions()

Description copied from interface: BrooklynObject

Subscriptions are the mechanism for receiving notifications of sensor-events (e.g. attribute-changed) from other entities.

Specified by:

subscriptions in interface CatalogItem<T,SpecT>

Specified by:

subscriptions in interface BrooklynObject

Specified by:

subscriptions in interface BrooklynObjectInternal

Throws:

UnsupportedOperationException; - subscriptions are not supported for catalog items

relations

public BrooklynObjectInternal.RelationSupportInternal<CatalogItem<T,SpecT>> relations()

Overrides the parent so that relations are not visible.

Specified by:

relations in interface BrooklynObject

Specified by:

relations in interface BrooklynObjectInternal

Returns:

an immutable empty relation support object; relations are not supported, but we do not throw on access to enable reads in a consistent manner

getConfig

public <U> U getConfig(ConfigKey<U> key)

Description copied from interface: Configurable

Convenience for calling Configurable.ConfigurationSupport.get(ConfigKey), via code like config().get(key).

Specified by:

getConfig in interface Configurable

getCatalogItemType

public CatalogItem.CatalogItemType getCatalogItemType()

Specified by:

getCatalogItemType in interface CatalogItem<T,SpecT>

getCatalogItemJavaType

public java.lang.Class<T> getCatalogItemJavaType()

Specified by:

getCatalogItemJavaType in interface CatalogItem<T,SpecT>

Returns:

The high-level type of this entity, e.g. Entity (not a specific Entity class)

getId

public java.lang.String getId()

Specified by:

getId in interface Identifiable

getCatalogItemId

public java.lang.String getCatalogItemId()

Description copied from interface: CatalogItem

Built up from CatalogItem.getSymbolicName() and CatalogItem.getVersion(). (It is a bit self-referential having this method on this type of BrooklynObject, but it is easier this than making the interface hierarchy more complicated.)

Specified by:

getCatalogItemId in interface CatalogItem<T,SpecT>

Specified by:

getCatalogItemId in interface BrooklynObject

setDeprecated

public void setDeprecated(boolean deprecated)

Specified by:

setDeprecated in interface CatalogItem<T,SpecT>

isDeprecated

public boolean isDeprecated()

Specified by:

isDeprecated in interface CatalogItem<T,SpecT>

Returns:

True if the item has been deprecated (i.e. its use is discouraged)

setDisabled

public void setDisabled(boolean diabled)

Specified by:

setDisabled in interface CatalogItem<T,SpecT>

isDisabled

public boolean isDisabled()

Specified by:

isDisabled in interface CatalogItem<T,SpecT>

Returns:

True if the item has been disabled (i.e. its use is forbidden, except for pre-existing apps)

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

Specified by:

addSearchPath 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

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

getJavaType

public java.lang.String getJavaType()

Specified by:

getJavaType in interface CatalogItem<T,SpecT>

Returns:

The underlying java type of the item represented, if not described via a YAML spec. Normally null (and the type comes from yaml).

getDisplayName

public java.lang.String getDisplayName()

Description copied from interface: BrooklynObject

A display name; recommended to be a concise single-line description.

Specified by:

getDisplayName 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

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface CatalogItem<T,SpecT>

getIconUrl

public java.lang.String getIconUrl()

Specified by:

getIconUrl in interface CatalogItem<T,SpecT>

getSymbolicName

public java.lang.String getSymbolicName()

Specified by:

getSymbolicName in interface CatalogItem<T,SpecT>

getContainingBundle

public java.lang.String getContainingBundle()

Specified by:

getContainingBundle in interface CatalogItem<T,SpecT>

getVersion

public java.lang.String getVersion()

Specified by:

getVersion in interface CatalogItem<T,SpecT>

getLibraries

@Nonnull
public java.util.Collection<CatalogItem.CatalogBundle> getLibraries()

Specified by:

getLibraries in interface CatalogItem<T,SpecT>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getSpecType

public java.lang.Class<SpecT> getSpecType()

Specified by:

getSpecType in interface CatalogItem<T,SpecT>

Returns:

The type of the spec e.g. EntitySpec corresponding to CatalogItem.getCatalogItemJavaType()

getPlanYaml

@Nullable
public java.lang.String getPlanYaml()

Specified by:

getPlanYaml in interface CatalogItem<T,SpecT>

Returns:

The underlying YAML for this item, if known; currently including `services:` or `brooklyn.policies:` prefix (but this will likely be removed)

getRebindSupport

public RebindSupport<CatalogItemMemento> getRebindSupport()

Specified by:

getRebindSupport in interface CatalogItem<T,SpecT>

Specified by:

getRebindSupport in interface Rebindable

Specified by:

getRebindSupport in interface BrooklynObjectInternal