org.apache.brooklyn.api.catalog

Interface CatalogItem<T,SpecT>

All Superinterfaces:

BrooklynObject, Configurable, Identifiable, Rebindable

All Known Implementing Classes:

CatalogApplicationItemDto, CatalogEnricherItemDto, CatalogEntityItemDto, CatalogItemDo, CatalogItemDtoAbstract, CatalogLocationItemDto, CatalogPolicyItemDto, CatalogTemplateItemDto

public interface CatalogItem<T,SpecT>
extends BrooklynObject, Rebindable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	CatalogItem.CatalogBundle
static interface	CatalogItem.CatalogItemLibraries Deprecated. since 0.7.0 in favour of CatalogItem.CatalogBundle, kept for rebind compatibility
static class	CatalogItem.CatalogItemType

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

Method Summary

Modifier and Type	Method and Description
Configurable.ConfigurationSupport	config()
java.lang.String	getCatalogItemId() Built up from getSymbolicName() and getVersion().
java.lang.Class<T>	getCatalogItemJavaType()
CatalogItem.CatalogItemType	getCatalogItemType()
java.lang.String	getContainingBundle()
java.lang.String	getDescription()
java.lang.String	getIconUrl()
java.lang.String	getJavaType() Deprecated. since 0.9.0. Use plan based items instead (getPlanYaml())
java.util.Collection<CatalogItem.CatalogBundle>	getLibraries()
java.lang.String	getPlanYaml()
RebindSupport<CatalogItemMemento>	getRebindSupport()
java.lang.Class<SpecT>	getSpecType()
java.lang.String	getSymbolicName()
java.lang.String	getVersion()
boolean	isDeprecated()
boolean	isDisabled()
void	setDeprecated(boolean deprecated)
void	setDisabled(boolean disabled)
BrooklynObject.SubscriptionSupport	subscriptions() Subscriptions are the mechanism for receiving notifications of sensor-events (e.g.

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

getCatalogItemIdSearchPath, getDisplayName, relations, tags

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

getId

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

getConfig

Method Detail

config

Configurable.ConfigurationSupport config()

Specified by:

config in interface Configurable

Throws:

UnsupportedOperationException; - config not supported for catalog items

subscriptions

BrooklynObject.SubscriptionSupport 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 BrooklynObject

Throws:

UnsupportedOperationException; - subscriptions are not supported for catalog items

getCatalogItemType

CatalogItem.CatalogItemType getCatalogItemType()

getCatalogItemJavaType

java.lang.Class<T> getCatalogItemJavaType()

Returns:

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

getSpecType

java.lang.Class<SpecT> getSpecType()

Returns:

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

getJavaType

@Deprecated
 @Nullable
java.lang.String getJavaType()

Deprecated. since 0.9.0. Use plan based items instead (getPlanYaml())

Returns:

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

getDescription

@Nullable
java.lang.String getDescription()

getIconUrl

@Nullable
java.lang.String getIconUrl()

getSymbolicName

java.lang.String getSymbolicName()

getContainingBundle

java.lang.String getContainingBundle()

getVersion

java.lang.String getVersion()

getLibraries

java.util.Collection<CatalogItem.CatalogBundle> getLibraries()

getPlanYaml

@Nullable
java.lang.String getPlanYaml()

Returns:

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

getRebindSupport

RebindSupport<CatalogItemMemento> getRebindSupport()

Specified by:

getRebindSupport in interface Rebindable

getCatalogItemId

java.lang.String getCatalogItemId()

Built up from getSymbolicName() and 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 BrooklynObject

setDeprecated

void setDeprecated(boolean deprecated)

setDisabled

void setDisabled(boolean disabled)

isDeprecated

boolean isDeprecated()

Returns:

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

isDisabled

boolean isDisabled()

Returns:

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