BasicBrooklynCatalog (Apache Brooklyn)

java.lang.Object
- brooklyn.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

Nested Classes
Modifier and Type	Class and Description
`static class`	`BasicBrooklynCatalog.BrooklynLoaderTracker`

Constructor Summary

Constructors
Constructor and Description

BasicBrooklynCatalog(ManagementContext mgmt)

BasicBrooklynCatalog(ManagementContext mgmt, CatalogDto dto)

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

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addItem(CatalogItem<?,?> item)` Deprecated.
`CatalogItem<?,?>`	`addItem(java.lang.Class<?> type)` Deprecated.
`CatalogItem<?,?>`	`addItem(java.lang.String yaml)` Adds an item (represented in yaml) to the catalog.
`boolean`	`blockIfNotLoaded(Duration timeout)`
`<T,SpecT> SpecT`	`createSpec(CatalogItem<T,SpecT> item)` creates a spec for the given catalog item, throwing exceptions if any problems
`void`	`deleteCatalogItem(java.lang.String id)`
`CatalogDo`	`getCatalog()`
`<T,SpecT> CatalogItem<T,SpecT>`	`getCatalogItem(java.lang.Class<T> type, java.lang.String id)` variant of `BrooklynCatalog.getCatalogItem(String)` which checks (and casts) type for convenience (returns null if type does not match)
`CatalogItem<?,?>`	`getCatalogItem(java.lang.String idOrRegisteredTypeName)`
`<T,SpecT> java.lang.Iterable<CatalogItem<T,SpecT>>`	`getCatalogItems()`
`<T,SpecT> java.lang.Iterable<CatalogItem<T,SpecT>>`	`getCatalogItems(com.google.common.base.Predicate<? super CatalogItem<T,SpecT>> filter)` convenience for filtering items in the catalog; see CatalogPredicates for useful filters
`java.lang.ClassLoader`	`getRootClassLoader()`
`void`	`load()` Loads this catalog
`<T,SpecT> java.lang.Class<? extends T>`	`loadClass(CatalogItem<T,SpecT> item)` Deprecated.
`<T> java.lang.Class<? extends T>`	`loadClassByType(java.lang.String typeName, java.lang.Class<T> typeClass)` Deprecated.
`void`	`reset(CatalogDto dto)`
`void`	`reset(java.util.Collection<CatalogItem<?,?>> entries)` Resets the catalog to the given entries
`void`	`resetCatalogToContentsAtConfiguredUrl()`
`java.lang.String`	`toXmlString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 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(java.util.Collection<CatalogItem<?,?>> entries)
```
    Resets the catalog to the given entries
    
    Specified by:
    
    reset in interface BrooklynCatalog
  - getCatalog
```
public CatalogDo getCatalog()
```
  - getCatalogItem
```
public CatalogItem<?,?> getCatalogItem(java.lang.String idOrRegisteredTypeName)
```
    Specified by:
    
    getCatalogItem in interface BrooklynCatalog
    
    Returns:
    The item with the given ID or registeredTypeName, or null if not found.
  - deleteCatalogItem
```
public void deleteCatalogItem(java.lang.String id)
```
    Specified by:
    
    deleteCatalogItem in interface BrooklynCatalog
  - getCatalogItem
```
public <T,SpecT> CatalogItem<T,SpecT> getCatalogItem(java.lang.Class<T> type,
                                            java.lang.String id)
```
    Description copied from interface: BrooklynCatalog
    
    variant of BrooklynCatalog.getCatalogItem(String) which checks (and casts) type for convenience (returns null if type does not match)
    
    Specified by:
    
    getCatalogItem 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
  - load
```
public void load()
```
    Loads this catalog
  - createSpec
```
public <T,SpecT> SpecT createSpec(CatalogItem<T,SpecT> item)
```
    Description copied from interface: BrooklynCatalog
    
    creates a spec for the given catalog item, throwing exceptions if any problems
    
    Specified by:
    
    createSpec in interface BrooklynCatalog
  - loadClass
```
@Deprecated
public <T,SpecT> java.lang.Class<? extends T> loadClass(CatalogItem<T,SpecT> item)
```
    Deprecated.
    
    Description copied from interface: BrooklynCatalog
    
    throws exceptions if any problems
    
    Specified by:
    
    loadClass in interface BrooklynCatalog
  - loadClassByType
```
@Deprecated
public <T> java.lang.Class<? extends T> loadClassByType(java.lang.String typeName,
                                                          java.lang.Class<T> typeClass)
```
    Deprecated.
    
    Specified by:
    
    loadClassByType in interface BrooklynCatalog
  - addItem
```
public CatalogItem<?,?> addItem(java.lang.String yaml)
```
    Description copied from interface: BrooklynCatalog
    
    Adds an item (represented in yaml) to the catalog.
    
    Specified by:
    
    addItem in interface BrooklynCatalog
  - 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
  - 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
```
public <T,SpecT> java.lang.Iterable<CatalogItem<T,SpecT>> getCatalogItems()
```
    Specified by:
    
    getCatalogItems in interface BrooklynCatalog
    
    Returns:
    All items in the catalog
  - getCatalogItems
```
public <T,SpecT> java.lang.Iterable<CatalogItem<T,SpecT>> getCatalogItems(com.google.common.base.Predicate<? super CatalogItem<T,SpecT>> filter)
```
    Description copied from interface: BrooklynCatalog
    
    convenience for filtering items in the catalog; see CatalogPredicates for useful filters
    
    Specified by:
    
    getCatalogItems in interface BrooklynCatalog
  - toXmlString
```
public java.lang.String toXmlString()
```
  - resetCatalogToContentsAtConfiguredUrl
```
public void resetCatalogToContentsAtConfiguredUrl()
```

Class BasicBrooklynCatalog

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BasicBrooklynCatalog

BasicBrooklynCatalog

Method Detail

blockIfNotLoaded

reset

reset

getCatalog

getCatalogItem

deleteCatalogItem

getCatalogItem

getRootClassLoader

load

createSpec

loadClass

loadClassByType

addItem

addItem

addItem

getCatalogItems

getCatalogItems

toXmlString

resetCatalogToContentsAtConfiguredUrl