org.apache.brooklyn.core.catalog.internal

Class JavaCatalogToSpecTransformer

java.lang.Object

org.apache.brooklyn.core.catalog.internal.JavaCatalogToSpecTransformer

All Implemented Interfaces:

ManagementContextInjectable, PlanToSpecTransformer

public class JavaCatalogToSpecTransformer
extends java.lang.Object
implements PlanToSpecTransformer

Instantiates classes from a registered type which simply defines the java class name and OSGi bundles to use.

This is used where a RegisteredType is defined simply with the name of a java class (no YAML etc); and for legacy old-style (c0.7.0) catalog items (defined in catalog.xml only) with structure, only a single type.

Constructor Summary

Constructors

Constructor and Description
JavaCatalogToSpecTransformer()

Method Summary

Modifier and Type	Method and Description
boolean	accepts(java.lang.String planType) whether this accepts the given plan type
EntitySpec<? extends Application>	createApplicationSpec(java.lang.String plan) creates an EntitySpec given a complete plan textual description for a top-level application, according to the transformation rules this understands.
<T,SpecT extends AbstractBrooklynObjectSpec<? extends T,SpecT>> SpecT	createCatalogSpec(CatalogItem<T,SpecT> item, java.util.Set<java.lang.String> encounteredTypes) creates an object spec given a catalog item.
java.lang.String	getShortDescription() A short, human-readable name for this transformer
void	setManagementContext(ManagementContext mgmt) Sets the ManagementContext reference.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaCatalogToSpecTransformer

public JavaCatalogToSpecTransformer()

Method Detail

setManagementContext

public void setManagementContext(ManagementContext mgmt)

Description copied from interface: ManagementContextInjectable

Sets the ManagementContext reference.

Specified by:

setManagementContext in interface ManagementContextInjectable

getShortDescription

public java.lang.String getShortDescription()

Description copied from interface: PlanToSpecTransformer

A short, human-readable name for this transformer

Specified by:

getShortDescription in interface PlanToSpecTransformer

accepts

public boolean accepts(java.lang.String planType)

Description copied from interface: PlanToSpecTransformer

whether this accepts the given plan type

Specified by:

accepts in interface PlanToSpecTransformer

createApplicationSpec

public EntitySpec<? extends Application> createApplicationSpec(java.lang.String plan)
                                                        throws PlanNotRecognizedException

Description copied from interface: PlanToSpecTransformer

creates an EntitySpec given a complete plan textual description for a top-level application, according to the transformation rules this understands.

should throw PlanNotRecognizedException if not supported.

Specified by:

createApplicationSpec in interface PlanToSpecTransformer

Throws:

PlanNotRecognizedException

createCatalogSpec

public <T,SpecT extends AbstractBrooklynObjectSpec<? extends T,SpecT>> SpecT createCatalogSpec(CatalogItem<T,SpecT> item,
                                                                                               java.util.Set<java.lang.String> encounteredTypes)
                                                                                        throws PlanNotRecognizedException

Description copied from interface: PlanToSpecTransformer

creates an object spec given a catalog item.

the catalog item might be known by type, or its source plan fragment text might be inspected and transformed. implementations will typically look at the CatalogItem.getCatalogItemType() first.

should throw PlanNotRecognizedException if this transformer does not know what to do with the plan.

Specified by:

createCatalogSpec in interface PlanToSpecTransformer

Parameters:

item - - The catalog item to convert to a spec. The item might not be fully populated (i.e. missing symbolicName if called from the catalog parser).

encounteredTypes - - The symbolicNames of catalog items being resolved up the stack, but not including item.

Throws:

PlanNotRecognizedException