org.apache.brooklyn.core.catalog.internal

Class BasicBrooklynCatalog

java.lang.Object

org.apache.brooklyn.core.catalog.internal.BasicBrooklynCatalog

All Implemented Interfaces:

BrooklynCatalog

public class BasicBrooklynCatalog
extends java.lang.Object
implements BrooklynCatalog

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BasicBrooklynCatalog.BrooklynLoaderTracker

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	AUTO_WRAP_CATALOG_YAML_AS_BUNDLE
static java.lang.String	BROOKLYN_WRAPPED_BOM_BUNDLE Header on bundle indicating it is a wrapped BOM with no other resources
static java.lang.String	CATALOG_BOM
static java.lang.String	ENRICHERS_KEY
static java.lang.String	LOCATIONS_KEY
static java.lang.String	NO_VERSION
static java.lang.String	OSGI_MANIFEST_VERSION_VALUE
static java.lang.String	POLICIES_KEY

Fields inherited from interface org.apache.brooklyn.api.catalog.BrooklynCatalog

DEFAULT_VERSION

Constructor Summary

Constructors

Constructor and Description
BasicBrooklynCatalog(ManagementContext mgmt)
BasicBrooklynCatalog(ManagementContext mgmt, CatalogDto dto)

Method Summary

Modifier and Type	Method and Description
void	addCatalogLegacyItemsOnRebind(java.lang.Iterable<? extends CatalogItem<?,?>> items) Deprecated.
void	addItem(CatalogItem<?,?> item) Deprecated.
CatalogItem<?,?>	addItem(java.lang.Class<?> type) Deprecated.
java.util.List<? extends CatalogItem<?,?>>	addItems(java.lang.String yaml) As #addItemsFromBundle(String, ManagedBundle) with a null bundle.
java.util.List<? extends CatalogItem<?,?>>	addItems(java.lang.String yaml, boolean forceUpdate) Deprecated. since 1.0.0 use addItems(String) or addItems(String, boolean, boolean)
java.util.List<? extends CatalogItem<?,?>>	addItems(java.lang.String yaml, boolean validate, boolean forceUpdate) Adds items (represented in yaml) to the catalog.
java.util.List<? extends CatalogItem<?,?>>	addItems(java.lang.String yaml, ManagedBundle bundle) Adds items (represented in yaml) to the catalog coming from the indicated managed bundle.
java.util.List<? extends CatalogItem<?,?>>	addItems(java.lang.String yaml, ManagedBundle bundle, boolean forceUpdate) As BrooklynCatalog.addItems(String, ManagedBundle) but exposing forcing option as per #addItem(String, boolean).
OsgiBundleInstallationResult	addItemsBundleResult(java.lang.String yaml, boolean forceUpdate) Like addItems(String, boolean) but returning the OsgiBundleInstallationResult for use from new environments.
void	addTypesFromBundleBom(java.lang.String yaml, ManagedBundle bundle, boolean forceUpdate, java.util.Map<RegisteredType,RegisteredType> result) Adds the given registered types defined in a bundle's catalog BOM; no validation performed, so caller should do that subsequently after loading all potential inter-dependent types.
boolean	blockIfNotLoaded(Duration timeout)
<T,SpecT extends AbstractBrooklynObjectSpec<? extends T,SpecT>> SpecT	createSpec(CatalogItem<T,SpecT> item) Deprecated.
void	deleteCatalogItem(java.lang.String symbolicName, java.lang.String version) Deprecated.
void	deleteCatalogItem(java.lang.String symbolicName, java.lang.String version, boolean alsoCheckTypeRegistry, boolean failIfNotFound) Deprecated.
CatalogDo	getCatalog()
<T,SpecT> CatalogItem<T,SpecT>	getCatalogItem(java.lang.Class<T> type, java.lang.String id, java.lang.String version) variant of BrooklynCatalog.getCatalogItem(String, String) which checks (and casts) type for convenience (returns null if type does not match)
CatalogItem<?,?>	getCatalogItem(java.lang.String symbolicName, java.lang.String version) Deprecated.
<T,SpecT> CatalogItem<T,SpecT>	getCatalogItemLegacy(java.lang.Class<T> type, java.lang.String id, java.lang.String version) As non-legacy method but only looking in legacy catalog
CatalogItem<?,?>	getCatalogItemLegacy(java.lang.String symbolicName, java.lang.String version) Deprecated.
<T,SpecT> java.lang.Iterable<CatalogItem<T,SpecT>>	getCatalogItems() Deprecated.
<T,SpecT> java.lang.Iterable<CatalogItem<T,SpecT>>	getCatalogItems(<any> filter) Deprecated.
<T,SpecT> java.lang.Iterable<CatalogItem<T,SpecT>>	getCatalogItemsLegacy() Deprecated.
<T,SpecT> java.lang.Iterable<CatalogItem<T,SpecT>>	getCatalogItemsLegacy(<any> filter) Deprecated.
static java.util.Map<?,?>	getCatalogMetadata(java.lang.String yaml)
java.lang.ClassLoader	getRootClassLoader()
static VersionedName	getVersionedName(java.util.Map<?,?> catalogMetadata) Deprecated. since 0.12.0 - use getVersionedName(Map, boolean)
static VersionedName	getVersionedName(java.util.Map<?,?> catalogMetadata, boolean required)
static <T,SpecT extends AbstractBrooklynObjectSpec<? extends T,SpecT>> SpecT	internalCreateSpecLegacy(ManagementContext mgmt, CatalogItem<T,SpecT> item, java.util.Set<java.lang.String> encounteredTypes, boolean includeDeprecatedTransformers) Deprecated. since introduction in 0.9.0, only used for backwards compatibility, can be removed any time; uses the type-creation info on the item. deprecated transformers must be included by routines which don't use BrooklynTypePlanTransformer instances; otherwise deprecated transformers should be excluded. (deprecation is taken as equivalent to having a new-style transformer.)
static boolean	isNoBundleOrSimpleWrappingBundle(ManagementContext mgmt, ManagedBundle b)
static boolean	isWrapperBundle(org.osgi.framework.Bundle b)
void	load() Loads this catalog.
AbstractBrooklynObjectSpec<?,?>	peekSpec(CatalogItem<?,?> item) Creates a spec for the given catalog item, throwing exceptions if any problems.
void	persist(CatalogItem<?,?> catalogItem) persists the catalog item to the object store, if persistence is enabled
void	reset(CatalogDto dto)
void	reset(CatalogDto dto, boolean failOnLoadError)
void	reset(java.util.Collection<CatalogItem<?,?>> entries) Resets the catalog to the given entries
ReferenceWithError<RegisteredType>	resolve(RegisteredType typeToValidate, RegisteredTypeLoadingContext constraint) Resolves the given object with respect to the catalog.
void	uninstallEmptyWrapperBundles()
java.util.Collection<java.lang.Throwable>	validateType(RegisteredType typeToValidate, RegisteredTypeLoadingContext constraint) Performs YAML validation on the given type, returning a collection of errors.
java.util.Map<RegisteredType,java.util.Collection<java.lang.Throwable>>	validateTypes(java.lang.Iterable<RegisteredType> typesToValidate) As #validateType(RegisteredType) but taking a set of types, returning a map whose keys are those types where validation failed, mapped to the collection of errors validating that type.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

POLICIES_KEY

public static final java.lang.String POLICIES_KEY

See Also:

Constant Field Values

ENRICHERS_KEY

public static final java.lang.String ENRICHERS_KEY

See Also:

Constant Field Values

LOCATIONS_KEY

public static final java.lang.String LOCATIONS_KEY

See Also:

Constant Field Values

NO_VERSION

public static final java.lang.String NO_VERSION

See Also:

Constant Field Values

CATALOG_BOM

public static final java.lang.String CATALOG_BOM

See Also:

Constant Field Values

OSGI_MANIFEST_VERSION_VALUE

public static final java.lang.String OSGI_MANIFEST_VERSION_VALUE

See Also:

Constant Field Values

BROOKLYN_WRAPPED_BOM_BUNDLE

public static final java.lang.String BROOKLYN_WRAPPED_BOM_BUNDLE

Header on bundle indicating it is a wrapped BOM with no other resources

See Also:

Constant Field Values

AUTO_WRAP_CATALOG_YAML_AS_BUNDLE

public static final boolean AUTO_WRAP_CATALOG_YAML_AS_BUNDLE

See Also:

Constant Field Values

Constructor Detail

BasicBrooklynCatalog

public BasicBrooklynCatalog(ManagementContext mgmt)

BasicBrooklynCatalog

public BasicBrooklynCatalog(ManagementContext mgmt,
                            CatalogDto dto)

Method Detail

blockIfNotLoaded

public boolean blockIfNotLoaded(Duration timeout)

reset

public void reset(CatalogDto dto)

reset

public void reset(CatalogDto dto,
                  boolean failOnLoadError)

reset

public void reset(java.util.Collection<CatalogItem<?,?>> entries)

Resets the catalog to the given entries

Specified by:

reset in interface BrooklynCatalog

getCatalog

public CatalogDo getCatalog()

getCatalogItem

@Deprecated
public CatalogItem<?,?> getCatalogItem(java.lang.String symbolicName,
                                                   java.lang.String version)

Deprecated.

Specified by:

getCatalogItem in interface BrooklynCatalog

Returns:

The item matching the given given symbolicName and optionally CatalogItem.getVersion(), taking the best version if the version is BrooklynCatalog.DEFAULT_VERSION or null, returning null if no matches are found.

getCatalogItemLegacy

@Deprecated
public CatalogItem<?,?> getCatalogItemLegacy(java.lang.String symbolicName,
                                                         java.lang.String version)

Deprecated.

Description copied from interface: BrooklynCatalog

As BrooklynCatalog.getCatalogItem(String, String) but only looking in legacy catalog

Specified by:

getCatalogItemLegacy in interface BrooklynCatalog

deleteCatalogItem

@Deprecated
public void deleteCatalogItem(java.lang.String symbolicName,
                                          java.lang.String version)

Deprecated.

Specified by:

deleteCatalogItem in interface BrooklynCatalog

deleteCatalogItem

@Deprecated
public void deleteCatalogItem(java.lang.String symbolicName,
                                          java.lang.String version,
                                          boolean alsoCheckTypeRegistry,
                                          boolean failIfNotFound)

Deprecated.

Description copied from interface: BrooklynCatalog

Deletes the item with the given symbolicName and version

Specified by:

deleteCatalogItem in interface BrooklynCatalog

getCatalogItem

public <T,SpecT> CatalogItem<T,SpecT> getCatalogItem(java.lang.Class<T> type,
                                                     java.lang.String id,
                                                     java.lang.String version)

Description copied from interface: BrooklynCatalog

variant of BrooklynCatalog.getCatalogItem(String, String) which checks (and casts) type for convenience (returns null if type does not match)

Specified by:

getCatalogItem in interface BrooklynCatalog

getCatalogItemLegacy

public <T,SpecT> CatalogItem<T,SpecT> getCatalogItemLegacy(java.lang.Class<T> type,
                                                           java.lang.String id,
                                                           java.lang.String version)

Description copied from interface: BrooklynCatalog

As non-legacy method but only looking in legacy catalog

Specified by:

getCatalogItemLegacy in interface BrooklynCatalog

persist

public void persist(CatalogItem<?,?> catalogItem)

Description copied from interface: BrooklynCatalog

persists the catalog item to the object store, if persistence is enabled

Specified by:

persist in interface BrooklynCatalog

getRootClassLoader

public java.lang.ClassLoader getRootClassLoader()

Specified by:

getRootClassLoader in interface BrooklynCatalog

Returns:

The classloader which should be used to load classes and entities; this includes all the catalog's classloaders in the right order. This is a wrapper which will update as the underlying catalog items change, so it is safe for callers to keep a handle on this.

load

public void load()

Loads this catalog. No effect if already loaded.

peekSpec

public AbstractBrooklynObjectSpec<?,?> peekSpec(CatalogItem<?,?> item)

Description copied from interface: BrooklynCatalog

Creates a spec for the given catalog item, throwing exceptions if any problems. The returned spec is intended for getting additional information about the item. It should not be used for creating entities/apps! See EntityManagementUtils.createEntitySpecForApplication(ManagementContext mgmt, String plan) for how apps are deployed.

Specified by:

peekSpec in interface BrooklynCatalog

createSpec

@Deprecated
public <T,SpecT extends AbstractBrooklynObjectSpec<? extends T,SpecT>> SpecT createSpec(CatalogItem<T,SpecT> item)

Deprecated.

Description copied from interface: BrooklynCatalog

Creates a spec for the given catalog item, throwing exceptions if any problems. Use of this method is strongly discouraged. It causes the catalog item to be re-parsed every time, which is very inefficient.

Specified by:

createSpec in interface BrooklynCatalog

internalCreateSpecLegacy

@Deprecated
public static <T,SpecT extends AbstractBrooklynObjectSpec<? extends T,SpecT>> SpecT internalCreateSpecLegacy(ManagementContext mgmt,
                                                                                                                         CatalogItem<T,SpecT> item,
                                                                                                                         java.util.Set<java.lang.String> encounteredTypes,
                                                                                                                         boolean includeDeprecatedTransformers)

Deprecated. since introduction in 0.9.0, only used for backwards compatibility, can be removed any time; uses the type-creation info on the item. deprecated transformers must be included by routines which don't use BrooklynTypePlanTransformer instances; otherwise deprecated transformers should be excluded. (deprecation is taken as equivalent to having a new-style transformer.)

getCatalogMetadata

public static java.util.Map<?,?> getCatalogMetadata(java.lang.String yaml)

getVersionedName

@Deprecated
public static VersionedName getVersionedName(java.util.Map<?,?> catalogMetadata)

Deprecated. since 0.12.0 - use getVersionedName(Map, boolean)

getVersionedName

public static VersionedName getVersionedName(java.util.Map<?,?> catalogMetadata,
                                             boolean required)

isNoBundleOrSimpleWrappingBundle

public static boolean isNoBundleOrSimpleWrappingBundle(ManagementContext mgmt,
                                                       ManagedBundle b)

isWrapperBundle

public static boolean isWrapperBundle(org.osgi.framework.Bundle b)

addItems

public java.util.List<? extends CatalogItem<?,?>> addItems(java.lang.String yaml)

Description copied from interface: BrooklynCatalog

As #addItemsFromBundle(String, ManagedBundle) with a null bundle. (Only used for legacy-mode additions.)

Specified by:

addItems in interface BrooklynCatalog

addItems

@Deprecated
public java.util.List<? extends CatalogItem<?,?>> addItems(java.lang.String yaml,
                                                                       boolean forceUpdate)

Deprecated. since 1.0.0 use addItems(String) or addItems(String, boolean, boolean)

Description copied from interface: BrooklynCatalog

Adds items (represented in yaml) to the catalog. (Only used for legacy-mode additions.)

Specified by:

addItems in interface BrooklynCatalog

forceUpdate - If true allows catalog update even when an item exists with the same symbolicName and version

addItems

public java.util.List<? extends CatalogItem<?,?>> addItems(java.lang.String yaml,
                                                           boolean validate,
                                                           boolean forceUpdate)

Description copied from interface: BrooklynCatalog

Adds items (represented in yaml) to the catalog. (Only used for legacy-mode additions.)

Specified by:

addItems in interface BrooklynCatalog

validate - Whether to validate the types (default true)

forceUpdate - If true allows catalog update even when an item exists with the same symbolicName and version

addItemsBundleResult

public OsgiBundleInstallationResult addItemsBundleResult(java.lang.String yaml,
                                                         boolean forceUpdate)

Like addItems(String, boolean) but returning the OsgiBundleInstallationResult for use from new environments. If not using OSGi the bundle/code/etc fields are null but the types will always be set.

addItems

public java.util.List<? extends CatalogItem<?,?>> addItems(java.lang.String yaml,
                                                           ManagedBundle bundle)

Description copied from interface: BrooklynCatalog

Adds items (represented in yaml) to the catalog coming from the indicated managed bundle. Fails if the same version exists in catalog (unless snapshot). (Only used for legacy-mode additions.)

Specified by:

addItems in interface BrooklynCatalog

addItems

public java.util.List<? extends CatalogItem<?,?>> addItems(java.lang.String yaml,
                                                           ManagedBundle bundle,
                                                           boolean forceUpdate)

Description copied from interface: BrooklynCatalog

As BrooklynCatalog.addItems(String, ManagedBundle) but exposing forcing option as per #addItem(String, boolean). (Only used for legacy-mode additions.)

Specified by:

addItems in interface BrooklynCatalog

addTypesFromBundleBom

public void addTypesFromBundleBom(java.lang.String yaml,
                                  ManagedBundle bundle,
                                  boolean forceUpdate,
                                  java.util.Map<RegisteredType,RegisteredType> result)

Description copied from interface: BrooklynCatalog

Adds the given registered types defined in a bundle's catalog BOM; no validation performed, so caller should do that subsequently after loading all potential inter-dependent types. Optionally updates a supplied (empty) map containing newly added types as keys and any previously existing type they replace as values, for reference or for use rolling back (this is populated with work done so far if the method throws an error).

Specified by:

addTypesFromBundleBom in interface BrooklynCatalog

validateTypes

public java.util.Map<RegisteredType,java.util.Collection<java.lang.Throwable>> validateTypes(java.lang.Iterable<RegisteredType> typesToValidate)

Description copied from interface: BrooklynCatalog

As #validateType(RegisteredType) but taking a set of types, returning a map whose keys are those types where validation failed, mapped to the collection of errors validating that type. An empty map result indicates no validation errors in the types passed in.

Specified by:

validateTypes in interface BrooklynCatalog

validateType

public java.util.Collection<java.lang.Throwable> validateType(RegisteredType typeToValidate,
                                                              RegisteredTypeLoadingContext constraint)

Description copied from interface: BrooklynCatalog

Performs YAML validation on the given type, returning a collection of errors. An empty result indicates no validation errors in the type passed in.

Validation may be side-effecting in that it sets metadata and refines supertypes for the given registered type.

Specified by:

validateType in interface BrooklynCatalog

resolve

public ReferenceWithError<RegisteredType> resolve(RegisteredType typeToValidate,
                                                  RegisteredTypeLoadingContext constraint)

Resolves the given object with respect to the catalog. Returns any errors found while trying to resolve. The argument may be changed (e.g. its kind set, supertypes set), and normal usage is to add a type in an "unresolved" state if things may need to reference it, then call resolve here, then replace what was added with the argument given here.

addItem

@Deprecated
public void addItem(CatalogItem<?,?> item)

Deprecated.

Description copied from interface: BrooklynCatalog

adds an item to the 'manual' catalog; this does not update the classpath or have a record to the java Class

Specified by:

addItem in interface BrooklynCatalog

addCatalogLegacyItemsOnRebind

@Deprecated
public void addCatalogLegacyItemsOnRebind(java.lang.Iterable<? extends CatalogItem<?,?>> items)

Deprecated.

Description copied from interface: BrooklynCatalog

adds the given items to the catalog, similar to BrooklynCatalog.reset(Collection) but where it just adds without removing the existing content. Note this is very different from BrooklynCatalog.addItem(CatalogItem), which adds to the 'manual' catalog.

Specified by:

addCatalogLegacyItemsOnRebind in interface BrooklynCatalog

addItem

@Deprecated
public CatalogItem<?,?> addItem(java.lang.Class<?> type)

Deprecated.

Description copied from interface: BrooklynCatalog

Creates a catalog item and adds it to the 'manual' catalog, with the corresponding Class definition (loaded by a classloader) registered and available in the classloader.

Note that the class will be available for this session only, although the record of the item will appear in the catalog DTO if exported, so it is recommended to edit the 'manual' catalog DTO if using it to generate a catalog, either adding the appropriate classpath URL or removing this entry.

Specified by:

addItem in interface BrooklynCatalog

getCatalogItems

@Deprecated
public <T,SpecT> java.lang.Iterable<CatalogItem<T,SpecT>> getCatalogItems()

Deprecated.

Specified by:

getCatalogItems in interface BrooklynCatalog

Returns:

All items in the catalog

getCatalogItemsLegacy

@Deprecated
public <T,SpecT> java.lang.Iterable<CatalogItem<T,SpecT>> getCatalogItemsLegacy()

Deprecated.

Description copied from interface: BrooklynCatalog

As non-legacy method but only looking in legacy catalog

Specified by:

getCatalogItemsLegacy in interface BrooklynCatalog

getCatalogItems

@Deprecated
public <T,SpecT> java.lang.Iterable<CatalogItem<T,SpecT>> getCatalogItems(<any> filter)

Deprecated.

Description copied from interface: BrooklynCatalog

convenience for filtering items in the catalog; see CatalogPredicates for useful filters

Specified by:

getCatalogItems in interface BrooklynCatalog

getCatalogItemsLegacy

@Deprecated
public <T,SpecT> java.lang.Iterable<CatalogItem<T,SpecT>> getCatalogItemsLegacy(<any> filter)

Deprecated.

Description copied from interface: BrooklynCatalog

As non-legacy method but only looking in legacy catalog

Specified by:

getCatalogItemsLegacy in interface BrooklynCatalog

uninstallEmptyWrapperBundles

public void uninstallEmptyWrapperBundles()