Constructor Detail

• CatalogItemDtoAbstract

  public CatalogItemDtoAbstract()

Method Detail

• 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

• getId

  public java.lang.String getId()

  Specified by:

  getId in interface Identifiable

  Overrides:

  getId in class AbstractBrooklynObject

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

  Specified by:

  getCatalogItemId in interface BrooklynObject

  Specified by:

  getCatalogItemId in interface CatalogItem<T,SpecT>

  Overrides:

  getCatalogItemId in class AbstractBrooklynObject

• 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

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

• 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

• setDeprecated

  public void setDeprecated(boolean deprecated)

  Specified by:

  setDeprecated in interface CatalogItem<T,SpecT>

• getLibraries

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

  Specified by:

  getLibraries in interface CatalogItem<T,SpecT>

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

• hashCode

  public int hashCode()

  Overrides:

  hashCode in class java.lang.Object

• equals

  public boolean equals(java.lang.Object obj)

  Overrides:

  equals in class java.lang.Object

• toString

  public java.lang.String toString()

  Overrides:

  toString in class java.lang.Object

• getSpecType

  public abstract 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()

• toXmlString

  public java.lang.String toXmlString()

  Specified by:

  toXmlString in interface CatalogItem<T,SpecT>

• 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

• setDisplayName

  public void setDisplayName(java.lang.String newName)

  Specified by:

  setDisplayName in class AbstractBrooklynObject

• 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

  Overrides:

  tags in class AbstractBrooklynObject

• setCatalogItemId

  @Deprecated
  public void setCatalogItemId(java.lang.String id)

  Deprecated. 

  Specified by:

  setCatalogItemId in interface BrooklynObjectInternal

  Overrides:

  setCatalogItemId in class AbstractBrooklynObject

• parseLibraries

  public static java.util.Collection<CatalogItem.CatalogBundle> parseLibraries(java.util.Collection<?> possibleLibraries)

  Parses an instance of CatalogLibrariesDto from the given List. Expects the list entries to be either Strings or Maps of String -> String. Will skip items that are not.