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

• getName

  @Deprecated
  java.lang.String getName()

  Deprecated. since 0.7.0. Use BrooklynObject.getDisplayName()

• getRegisteredTypeName

  @Deprecated
  java.lang.String getRegisteredTypeName()

  Deprecated. since 0.7.0. Use getSymbolicName()

• getDescription

  @Nullable
  java.lang.String getDescription()

• getIconUrl

  @Nullable
  java.lang.String getIconUrl()

• getSymbolicName

  java.lang.String getSymbolicName()

• getVersion

  java.lang.String getVersion()

• getLibraries

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

• toXmlString

  java.lang.String toXmlString()

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