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

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

  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.

• deleteCatalogItem

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

  Throws:

  java.util.NoSuchElementException - if not found

• getCatalogItem

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

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

• getCatalogItems

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

  Returns:

  All items in the catalog

• getCatalogItems

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

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

• 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

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

  creates a spec for the given catalog item, throwing exceptions if any problems

• addItem

  @Deprecated
  CatalogItem<?,?> addItem(java.lang.String yaml)

  Deprecated. since 0.7.0 use addItems(String, boolean)
  Adds an item (represented in yaml) to the catalog. Fails if the same version exists in catalog.

  Throws:

  java.lang.IllegalArgumentException - if the yaml was invalid

• addItem

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

  Deprecated. since 0.7.0 use addItems(String, boolean)
  Adds an item (represented in yaml) to the catalog.

  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)

  Adds items (represented in yaml) to the catalog. Fails if the same version exists in catalog.

  Throws:

  java.lang.IllegalArgumentException - if the yaml was invalid

• addItems

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

  Adds items (represented in yaml) to the catalog.

  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

• 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

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