org.apache.brooklyn.core.typereg

Class BasicManagedBundle

java.lang.Object

org.apache.brooklyn.core.objs.AbstractBrooklynObject

org.apache.brooklyn.core.typereg.BasicManagedBundle

All Implemented Interfaces:

Rebindable, BrooklynObject, Configurable, Identifiable, ManagedBundle, OsgiBundleWithUrl, BrooklynObjectInternal

public class BasicManagedBundle
extends AbstractBrooklynObject
implements ManagedBundle, BrooklynObjectInternal

Nested Class Summary

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

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

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

Constructor Summary

Constructors

Constructor and Description
BasicManagedBundle() Creates an empty one, with an ID, expecting other fields will be populated.
BasicManagedBundle(java.lang.String name, java.lang.String version, java.lang.String url, Credentials credentials, java.lang.String checksum)
BasicManagedBundle(java.lang.String name, java.lang.String version, java.lang.String url, java.lang.String checksum)

Method Summary

Modifier and Type	Method and Description
BrooklynObjectInternal.ConfigurationSupportInternal	config()
boolean	equals(java.lang.Object obj)
java.lang.String	getChecksum() MD5 checksum of the contents of bundle as installed to OSGi
<T> T	getConfig(ConfigKey<T> key) Convenience for calling Configurable.ConfigurationSupport.get(ConfigKey), via code like config().get(key).
java.lang.String	getDisplayName() A display name; recommended to be a concise single-line description.
java.lang.String	getOsgiUniqueUrl() Gets the (internal) value to be used as the location in bundleContext.install(location).
java.lang.String	getOsgiVersionString() guaranteed to be in OSGi syntax, or null if name+version not available
boolean	getPersistenceNeeded()
RebindSupport<?>	getRebindSupport()
java.lang.String	getSuppliedVersionString() string as defined by caller; not necessarily in OSGi syntax
java.lang.String	getSymbolicName()
java.lang.String	getUrl() where this bundle can be downloaded; typically required unless we are guaranteed the bundle will be manually installed or handled by persistence
Credentials	getUrlCredential()
VersionedName	getVersionedName()
int	hashCode()
boolean	isNameResolved()
static ManagedBundle	of(CatalogItem.CatalogBundle bundle)
void	setChecksum(java.lang.String md5Checksum)
void	setDisplayName(java.lang.String newName)
void	setPersistenceNeeded(boolean val)
void	setSymbolicName(java.lang.String symbolicName)
void	setUrl(java.lang.String url)
void	setVersion(java.lang.String version)
BrooklynObjectInternal.SubscriptionSupportInternal	subscriptions() Subscriptions are the mechanism for receiving notifications of sensor-events (e.g.
java.lang.String	toString()

Methods inherited from class org.apache.brooklyn.core.objs.AbstractBrooklynObject

addSearchPath, getCatalogItemId, getCatalogItemIdSearchPath, getId, getManagementContext, init, rebind, relations, setCatalogItemId, setCatalogItemIdAndSearchPath, setManagementContext, stackCatalogItemId, tags

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal

addSearchPath, getManagementContext, relations, setCatalogItemId, setCatalogItemIdAndSearchPath, stackCatalogItemId

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

getCatalogItemId, getCatalogItemIdSearchPath, tags

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

getId

Constructor Detail

BasicManagedBundle

public BasicManagedBundle()

Creates an empty one, with an ID, expecting other fields will be populated.

BasicManagedBundle

public BasicManagedBundle(java.lang.String name,
                          java.lang.String version,
                          java.lang.String url,
                          @Nullable
                          java.lang.String checksum)

BasicManagedBundle

public BasicManagedBundle(java.lang.String name,
                          java.lang.String version,
                          java.lang.String url,
                          Credentials credentials,
                          @Nullable
                          java.lang.String checksum)

Method Detail

isNameResolved

public boolean isNameResolved()

Specified by:

isNameResolved in interface OsgiBundleWithUrl

Returns:

true if we have a name and version for this bundle; false if not, e.g. if we only know the URL and we haven't loaded it yet

getSymbolicName

public java.lang.String getSymbolicName()

Specified by:

getSymbolicName in interface OsgiBundleWithUrl

setSymbolicName

public void setSymbolicName(java.lang.String symbolicName)

getSuppliedVersionString

public java.lang.String getSuppliedVersionString()

Description copied from interface: OsgiBundleWithUrl

string as defined by caller; not necessarily in OSGi syntax

Specified by:

getSuppliedVersionString in interface OsgiBundleWithUrl

getOsgiVersionString

public java.lang.String getOsgiVersionString()

Description copied from interface: OsgiBundleWithUrl

guaranteed to be in OSGi syntax, or null if name+version not available

Specified by:

getOsgiVersionString in interface OsgiBundleWithUrl

setVersion

public void setVersion(java.lang.String version)

getVersionedName

public VersionedName getVersionedName()

Specified by:

getVersionedName in interface ManagedBundle

Specified by:

getVersionedName in interface OsgiBundleWithUrl

Returns:

the VersionedName for this bundle, or null if not available

getUrl

public java.lang.String getUrl()

Description copied from interface: OsgiBundleWithUrl

where this bundle can be downloaded; typically required unless we are guaranteed the bundle will be manually installed or handled by persistence

Specified by:

getUrl in interface OsgiBundleWithUrl

getUrlCredential

public Credentials getUrlCredential()

Specified by:

getUrlCredential in interface OsgiBundleWithUrl

Returns:

The credential that shold be used to obtain the bundle from OsgiBundleWithUrl.getUrl().

setUrl

public void setUrl(java.lang.String url)

getOsgiUniqueUrl

public java.lang.String getOsgiUniqueUrl()

Gets the (internal) value to be used as the location in bundleContext.install(location). It thus allows us to tell if a cached OSGi bundle is the same as a bundle we are about to install (e.g. one we get from persisted state), or have retrieved from the initial catalog. Care should be taken to set the checksum before using the OSGi unique url.

Specified by:

getOsgiUniqueUrl in interface ManagedBundle

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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

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

getConfig

public <T> T getConfig(ConfigKey<T> 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

getRebindSupport

public RebindSupport<?> getRebindSupport()

Specified by:

getRebindSupport in interface Rebindable

Specified by:

getRebindSupport in interface BrooklynObjectInternal

config

public BrooklynObjectInternal.ConfigurationSupportInternal config()

Specified by:

config in interface Configurable

Specified by:

config in interface BrooklynObjectInternal

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 BrooklynObject

Specified by:

subscriptions in interface BrooklynObjectInternal

setDisplayName

public void setDisplayName(java.lang.String newName)

Specified by:

setDisplayName in class AbstractBrooklynObject

getChecksum

public java.lang.String getChecksum()

Description copied from interface: ManagedBundle

MD5 checksum of the contents of bundle as installed to OSGi

Specified by:

getChecksum in interface ManagedBundle

setChecksum

public void setChecksum(java.lang.String md5Checksum)

of

public static ManagedBundle of(CatalogItem.CatalogBundle bundle)

setPersistenceNeeded

public void setPersistenceNeeded(boolean val)

getPersistenceNeeded

public boolean getPersistenceNeeded()