Constructor Detail

• CatalogItemDo

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

Method Detail

• getDto

  public CatalogItem<T,SpecT> getDto()

• config

  public BrooklynObjectInternal.ConfigurationSupportInternal config()

  Config not supported for catalog item. See getPlanYaml().

  Specified by:

  config in interface BrooklynObjectInternal

  Specified by:

  config in interface Configurable

• setConfig

  public <U> U setConfig(ConfigKey<U> key,
                U val)

  Specified by:

  setConfig in interface Configurable

  Returns:

  the old value, or null if there was not one

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

  Specified by:

  getCatalogItemId in interface CatalogItem<T,SpecT>

• 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 and should not be shown in the catalog

• setCatalogItemId

  public void setCatalogItemId(java.lang.String id)

  Specified by:

  setCatalogItemId 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, or null if not known (e.g. if it comes from yaml)

• getName

  @Deprecated
  public java.lang.String getName()

  Deprecated. 

  Specified by:

  getName in interface CatalogItem<T,SpecT>

• getRegisteredTypeName

  @Deprecated
  public java.lang.String getRegisteredTypeName()

  Deprecated. 

  Specified by:

  getRegisteredTypeName in interface CatalogItem<T,SpecT>

• 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

• getTagSupport

  @Deprecated
  public BrooklynObject.TagSupport getTagSupport()

  Deprecated. 

  Specified by:

  getTagSupport 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>

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

• getJavaClass

  @Deprecated
  public java.lang.Class<T> getJavaClass()

  Deprecated. since 0.7.0 this is the legacy mechanism; still needed for policies and apps, but being phased out. new items should use getPlanYaml() and #newClassLoadingContext

• toString

  public java.lang.String toString()

  Overrides:

  toString in class java.lang.Object

• toXmlString

  public java.lang.String toXmlString()

  Specified by:

  toXmlString in interface CatalogItem<T,SpecT>

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

  Specified by:

  getRebindSupport in interface CatalogItem<T,SpecT>

  Specified by:

  getRebindSupport in interface Rebindable