org.apache.brooklyn.api.catalog

Interface BrooklynCatalog

All Known Implementing Classes:

BasicBrooklynCatalog

public interface BrooklynCatalog

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_VERSION Version set in catalog when creator does not supply a version, to mean a low priority item; and used when requesting to indicate the best version.

Method Summary

Modifier and Type	Method and Description
void	addCatalogLegacyItemsOnRebind(java.lang.Iterable<? extends CatalogItem<?,?>> items) Deprecated. since 1.0.0; instead use bundles in persisted state!
void	addItem(CatalogItem<?,?> item) Deprecated. since 0.7.0 Construct catalogs with yaml (referencing OSGi bundles) instead
CatalogItem<?,?>	addItem(java.lang.Class<?> clazz) Deprecated. since 0.7.0 Construct catalogs with OSGi bundles instead. This is used in a handful of tests which should be rewritten to refer to OSGi bundles.
java.lang.Iterable<? extends CatalogItem<?,?>>	addItems(java.lang.String yaml) As #addItemsFromBundle(String, ManagedBundle) with a null bundle.
java.lang.Iterable<? extends CatalogItem<?,?>>	addItems(java.lang.String yaml, boolean forceUpdate) Deprecated. since 1.0.0 use addItems(String) or addItems(String, boolean, boolean)
java.lang.Iterable<? extends CatalogItem<?,?>>	addItems(java.lang.String yaml, boolean validate, boolean forceUpdate) Adds items (represented in yaml) to the catalog.
java.lang.Iterable<? extends CatalogItem<?,?>>	addItems(java.lang.String yaml, ManagedBundle definingBundle) Adds items (represented in yaml) to the catalog coming from the indicated managed bundle.
java.lang.Iterable<? extends CatalogItem<?,?>>	addItems(java.lang.String yaml, ManagedBundle bundle, boolean forceUpdate) As addItems(String, ManagedBundle) but exposing forcing option as per #addItem(String, boolean).
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.
<T,SpecT extends AbstractBrooklynObjectSpec<? extends T,SpecT>> SpecT	createSpec(CatalogItem<T,SpecT> item) Deprecated. since 0.10.0; use peekSpec(CatalogItem) for a preview of what the item corresponds to.
void	deleteCatalogItem(java.lang.String symbolicName, java.lang.String version) Deprecated. since 0.12.0 use BrooklynTypeRegistry instead
void	deleteCatalogItem(java.lang.String symbolicName, java.lang.String version, boolean alsoCheckTypeRegistry, boolean failIfNotFound) Deprecated. since introduced in 1.0.0, only used for transitioning
<T,SpecT> CatalogItem<T,SpecT>	getCatalogItem(java.lang.Class<T> type, java.lang.String symbolicName, java.lang.String version) Deprecated. since 0.12.0 use BrooklynTypeRegistry instead
CatalogItem<?,?>	getCatalogItem(java.lang.String symbolicName, java.lang.String version) Deprecated. since 0.12.0 use BrooklynTypeRegistry instead
<T,SpecT> CatalogItem<T,SpecT>	getCatalogItemLegacy(java.lang.Class<T> type, java.lang.String symbolicName, java.lang.String version) Deprecated. since 0.12.0 only provided to allow TypeRegistry to see the legacy items
CatalogItem<?,?>	getCatalogItemLegacy(java.lang.String symbolicName, java.lang.String version) Deprecated. since 0.12.0 only provided to allow TypeRegistry to see the legacy items
<T,SpecT> java.lang.Iterable<CatalogItem<T,SpecT>>	getCatalogItems() Deprecated. since 0.12.0 use BrooklynTypeRegistry instead
<T,SpecT> java.lang.Iterable<CatalogItem<T,SpecT>>	getCatalogItems(<any> filter) Deprecated. since 0.12.0 use BrooklynTypeRegistry instead
<T,SpecT> java.lang.Iterable<CatalogItem<T,SpecT>>	getCatalogItemsLegacy() Deprecated. since 0.12.0 only provided to allow TypeRegistry to see the legacy items
<T,SpecT> java.lang.Iterable<CatalogItem<T,SpecT>>	getCatalogItemsLegacy(<any> filter) Deprecated. since 0.12.0 only provided to allow TypeRegistry to see the legacy items
java.lang.ClassLoader	getRootClassLoader()
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(java.util.Collection<CatalogItem<?,?>> entries)
java.util.Collection<java.lang.Throwable>	validateType(RegisteredType typeToValidate, RegisteredTypeLoadingContext optionalConstraint) 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.

Field Detail

DEFAULT_VERSION

static final java.lang.String DEFAULT_VERSION

Version set in catalog when creator does not supply a version, to mean a low priority item; and used when requesting to indicate the best version. (See getCatalogItem(String, String) for discussion of the best version.)

See Also:

Constant Field Values

Method Detail

getCatalogItem

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

Deprecated. since 0.12.0 use BrooklynTypeRegistry instead

Returns:

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

getCatalogItemLegacy

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

Deprecated. since 0.12.0 only provided to allow TypeRegistry to see the legacy items

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

deleteCatalogItem

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

Deprecated. since 0.12.0 use BrooklynTypeRegistry instead

Throws:

java.util.NoSuchElementException - if not found

deleteCatalogItem

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

Deprecated. since introduced in 1.0.0, only used for transitioning

Deletes the item with the given symbolicName and version

Throws:

java.util.NoSuchElementException - if not found

getCatalogItem

@Deprecated
<T,SpecT> CatalogItem<T,SpecT> getCatalogItem(java.lang.Class<T> type,
                                                          java.lang.String symbolicName,
                                                          java.lang.String version)

Deprecated. since 0.12.0 use BrooklynTypeRegistry instead

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

getCatalogItemLegacy

@Deprecated
<T,SpecT> CatalogItem<T,SpecT> getCatalogItemLegacy(java.lang.Class<T> type,
                                                                java.lang.String symbolicName,
                                                                java.lang.String version)

Deprecated. since 0.12.0 only provided to allow TypeRegistry to see the legacy items

As non-legacy method but only looking in legacy catalog

getCatalogItems

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

Deprecated. since 0.12.0 use BrooklynTypeRegistry instead

Returns:

All items in the catalog

getCatalogItemsLegacy

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

Deprecated. since 0.12.0 only provided to allow TypeRegistry to see the legacy items

As non-legacy method but only looking in legacy catalog

getCatalogItems

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

Deprecated. since 0.12.0 use BrooklynTypeRegistry instead

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

getCatalogItemsLegacy

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

Deprecated. since 0.12.0 only provided to allow TypeRegistry to see the legacy items

As non-legacy method but only looking in legacy catalog

persist

void persist(CatalogItem<?,?> catalogItem)

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

getRootClassLoader

java.lang.ClassLoader getRootClassLoader()

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.

createSpec

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

Deprecated. since 0.10.0; use peekSpec(CatalogItem) for a preview of what the item corresponds to.

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.

peekSpec

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

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.

Since:

0.10.0

addTypesFromBundleBom

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

validateTypes

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. An empty map result indicates no validation errors in the types passed in.

validateType

java.util.Collection<java.lang.Throwable> validateType(RegisteredType typeToValidate,
                                                       @Nullable
                                                       RegisteredTypeLoadingContext optionalConstraint)

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.

addItems

java.lang.Iterable<? extends CatalogItem<?,?>> addItems(java.lang.String yaml)

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

addItems

java.lang.Iterable<? extends CatalogItem<?,?>> addItems(java.lang.String yaml,
                                                        @Nullable
                                                        ManagedBundle definingBundle)

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

Throws:

java.lang.IllegalArgumentException - if the yaml was invalid

addItems

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

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

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

Parameters:

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

Throws:

java.lang.IllegalArgumentException - if the yaml was invalid

addItems

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

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

Parameters:

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

Throws:

java.lang.IllegalArgumentException - if the yaml was invalid

addItems

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

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

addItem

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

Deprecated. since 0.7.0 Construct catalogs with yaml (referencing OSGi bundles) instead

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

addCatalogLegacyItemsOnRebind

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

Deprecated. since 1.0.0; instead use bundles in persisted state!

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

Since:

1.0.0 (only for legacy backwards compatibility)

addItem

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

Deprecated. since 0.7.0 Construct catalogs with OSGi bundles instead. This is used in a handful of tests which should be rewritten to refer to OSGi bundles.

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.

reset

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