org.apache.brooklyn.core.plan

Interface PlanToSpecTransformer

All Superinterfaces:

ManagementContextInjectable

All Known Implementing Classes:

CampToSpecTransformer, JavaCatalogToSpecTransformer

Deprecated.

since 0.9.0 use BrooklynTypePlanTransformer

@Deprecated
public interface PlanToSpecTransformer
extends ManagementContextInjectable

Pluggable ServiceLoader interface for different plan-interpreters, that is, different ways of taking an application plan and returning an EntitySpec, and a CatalogItem and returning an AbstractBrooklynObjectSpec.

Method Summary

Modifier and Type	Method and Description
boolean	accepts(java.lang.String planType) Deprecated. whether this accepts the given plan type
EntitySpec<? extends Application>	createApplicationSpec(java.lang.String plan) Deprecated. 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) Deprecated. creates an object spec given a catalog item.
java.lang.String	getShortDescription() Deprecated. A short, human-readable name for this transformer

Methods inherited from interface org.apache.brooklyn.core.mgmt.ManagementContextInjectable

setManagementContext

Method Detail

getShortDescription

java.lang.String getShortDescription()

Deprecated.

A short, human-readable name for this transformer

accepts

boolean accepts(java.lang.String planType)

Deprecated.

whether this accepts the given plan type

createApplicationSpec

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

Deprecated.

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

should throw UnsupportedTypePlanException if not supported.

Throws:

PlanNotRecognizedException

UnsupportedTypePlanException

createCatalogSpec

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

Deprecated.

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 UnsupportedTypePlanException if this transformer does not know what to do with the plan.

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

UnsupportedTypePlanException