org.apache.brooklyn.core.typereg

Interface BrooklynTypePlanTransformer

All Superinterfaces:

ManagementContextInjectable

All Known Implementing Classes:

AbstractTypePlanTransformer, CampTypePlanTransformer, JavaClassNameTypePlanTransformer

public interface BrooklynTypePlanTransformer
extends ManagementContextInjectable

Interface for use by schemes which provide the capability to transform plans (serialized descriptions) to brooklyn objecs and specs.

To add a new plan transformation scheme, simply create an implementation and declare it as a java service (cf ServiceLoader).

Implementations may wish to extend AbstractTypePlanTransformer which simplifies the process.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	create(RegisteredType type, RegisteredTypeLoadingContext context) Creates a new instance of the indicated type, or throws if not supported; this method is used by the BrooklynTypeRegistry when it creates instances, so implementations must respect the BrooklynTypeRegistry.RegisteredTypeKind semantics and the RegisteredTypeLoadingContext (or return null / throw).
java.util.List<RegisteredType>	createFromTypeDefinition(java.lang.String formatCode, java.lang.Object catalogData)
java.lang.String	getFormatCode()
java.lang.String	getFormatDescription()
java.lang.String	getFormatName()
double	scoreForType(RegisteredType type, RegisteredTypeLoadingContext context) Determines how appropriate is this transformer for the RegisteredType.getPlan() of the type.
double	scoreForTypeDefinition(java.lang.String formatCode, java.lang.Object catalogData)

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

setManagementContext

Method Detail

getFormatCode

java.lang.String getFormatCode()

Returns:

An identifier for the transformer. This may be used by RegisteredType instances to target a specific transformer.

getFormatName

java.lang.String getFormatName()

Returns:

A display name for this transformer. This may be used to prompt a user what type of plan they are supplying.

getFormatDescription

java.lang.String getFormatDescription()

Returns:

A description for this transformer

scoreForType

double scoreForType(@Nonnull
                    RegisteredType type,
                    @Nonnull
                    RegisteredTypeLoadingContext context)

Determines how appropriate is this transformer for the RegisteredType.getPlan() of the type. The framework guarantees arguments are nonnull, and that the RegisteredType.getPlan() is also not-null. However many fields on the RegisteredType may be null, including RegisteredType.getId() for an ad hoc creation (eg if invoked from BrooklynTypeRegistry.createBeanFromPlan(String, Object, RegisteredTypeLoadingContext, Class))

Returns:

A co-ordinated score / confidence value in the range 0 to 1. 0 means not compatible, 1 means this is clearly the intended transformer and no others need be tried (for instance because the format is explicitly specified), and values between 0 and 1 indicate how likely a transformer believes it should be used. Values greater than 0.5 are generally reserved for the presence of marker tags or files which strongly indicate that the format is compatible.

create

@Nullable
java.lang.Object create(@Nonnull
                                  RegisteredType type,
                                  @Nonnull
                                  RegisteredTypeLoadingContext context)

Creates a new instance of the indicated type, or throws if not supported; this method is used by the BrooklynTypeRegistry when it creates instances, so implementations must respect the BrooklynTypeRegistry.RegisteredTypeKind semantics and the RegisteredTypeLoadingContext (or return null / throw).

The framework guarantees this will only be invoked when scoreForType(RegisteredType, RegisteredTypeLoadingContext) has returned a positive value, and the same constraints on the inputs as for that method apply.

Implementations should either return null or throw UnsupportedTypePlanException if they cannot instantiate the given RegisteredType.getPlan().

scoreForTypeDefinition

@Beta
double scoreForTypeDefinition(java.lang.String formatCode,
                                    java.lang.Object catalogData)

createFromTypeDefinition

@Beta
java.util.List<RegisteredType> createFromTypeDefinition(java.lang.String formatCode,
                                                              java.lang.Object catalogData)