org.apache.brooklyn.core.catalog.internal

Class CatalogItemDtoAbstract<T,SpecT>

java.lang.Object

org.apache.brooklyn.core.objs.AbstractBrooklynObject

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

All Implemented Interfaces:

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

Direct Known Subclasses:

CatalogApplicationItemDto, CatalogEnricherItemDto, CatalogEntityItemDto, CatalogLocationItemDto, CatalogPolicyItemDto, CatalogTemplateItemDto

public abstract class CatalogItemDtoAbstract<T,SpecT>
extends AbstractBrooklynObject
implements CatalogItem<T,SpecT>

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

Nested classes/interfaces inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal

BrooklynObjectInternal.ConfigurationSupportInternal, BrooklynObjectInternal.RelationSupportInternal<T extends BrooklynObject>, BrooklynObjectInternal.SubscriptionSupportInternal

Constructor Summary

Constructors

Constructor and Description
CatalogItemDtoAbstract()

Method Summary

Modifier and Type	Method and Description
BrooklynObjectInternal.ConfigurationSupportInternal	config()
boolean	equals(java.lang.Object obj)
java.lang.String	getCatalogItemId() The catalog item ID this object was loaded from.
<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.
java.lang.String	getIconUrl()
java.lang.String	getId()
java.lang.String	getJavaType()
java.util.Collection<CatalogItem.CatalogBundle>	getLibraries()
java.lang.String	getPlanYaml()
RebindSupport<CatalogItemMemento>	getRebindSupport()
abstract java.lang.Class<SpecT>	getSpecType()
java.lang.String	getSymbolicName()
java.lang.String	getVersion()
int	hashCode()
boolean	isDeprecated()
boolean	isDisabled()
static java.util.Collection<CatalogItem.CatalogBundle>	parseLibraries(java.util.Collection<?> possibleLibraries) Parses an instance of CatalogLibrariesDto from the given List.
BrooklynObjectInternal.RelationSupportInternal<CatalogItem<T,SpecT>>	relations() Overrides the parent so that relations are not visible.
void	setCatalogItemId(java.lang.String id) Deprecated.
void	setContainingBundle(VersionedName versionedName)
void	setDeprecated(boolean deprecated)
void	setDisabled(boolean disabled)
void	setDisplayName(java.lang.String newName)
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 org.apache.brooklyn.core.objs.AbstractBrooklynObject

addSearchPath, getCatalogItemIdSearchPath, getManagementContext, init, rebind, setCatalogItemIdAndSearchPath, setManagementContext, stackCatalogItemId

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.brooklyn.api.catalog.CatalogItem

getCatalogItemJavaType, getCatalogItemType

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

getCatalogItemIdSearchPath

Constructor Detail

CatalogItemDtoAbstract

public CatalogItemDtoAbstract()

Method Detail

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

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

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.

This should conform to OSGi specs for symbolic_name:version but weaker semantics are usually allowed so long as neither segment contains a : or whitespace.

Specified by:

getCatalogItemId in interface CatalogItem<T,SpecT>

Specified by:

getCatalogItemId in interface BrooklynObject

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, if not described via a YAML spec. Normally null (and the type comes from yaml).

getContainingBundle

public java.lang.String getContainingBundle()

Specified by:

getContainingBundle 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 (i.e. its use is discouraged)

setDeprecated

public void setDeprecated(boolean deprecated)

Specified by:

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

setDisabled

public void setDisabled(boolean disabled)

Specified by:

setDisabled 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()

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

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

Overrides:

relations in class AbstractBrooklynObject

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

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

setContainingBundle

public void setContainingBundle(VersionedName versionedName)

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 or bundles. Will skip items that are not.

If a string is supplied, this tries heuristically to identify whether a reference is a bundle or a URL, as follows: - if the string contains a slash, it is treated as a URL (or classpath reference), e.g. /file.txt; - if the string is RegisteredTypeNaming#isGoodBrooklynTypeColonVersion(String)) with an OSGi version it is treated as a bundle, e.g. file:1; - if the string is ambiguous (has a single colon) a warning is given, and typically it is treated as a URL because OSGi versions are needed here, e.g. file:v1 is a URL, but for a transitional period (possibly ending in 0.13 as warning is introduced in 0.12) for compatibility with previous versions, versions starting with a number trigger bundle resolution, e.g. file:1.txt is a bundle for now (but in all these cases warnings are logged) - otherwise (multiple colons, or no colons) it is treated like a URL