YOML = YAML object mapping language [BIG!]

api/src/main/java/org/apache/brooklyn/api/entity/EntityInitializer.java

@@ -23,19 +23,26 @@
 import org.apache.brooklyn.api.objs.EntityAdjunct;
 import org.apache.brooklyn.api.policy.Policy;
 import org.apache.brooklyn.api.sensor.Feed;
+import org.apache.brooklyn.util.yoml.annotations.Alias;
+import org.apache.brooklyn.util.yoml.annotations.YomlSingletonMap;
 
 /** 
  * Instances of this class supply logic which can be used to initialize entities. 
  * These can be added to an {@link EntitySpec} programmatically, or declared as part
  * of YAML recipes in a <code>brooklyn.initializers</code> section.
- * In the case of the latter, implementing classes should define a no-arg constructor
- * or a {@link Map} constructor so that YAML parameters can be supplied.
+ * <p>
+ * When intended for use from YAML, implementing classes should define 
+ * a single-argument constructor taking either a {@link Map} or a ConfigBag 
+ * so that YAML parameters can be supplied
+ * (or a no-arg constructor if parameters are not supported).
  * <p>
  * Note that initializers are only invoked on first creation; they are not called 
  * during a rebind. Instead, the typical pattern is that initializers will create
  * {@link EntityAdjunct} instances such as {@link Policy} and {@link Feed}
  * which will be attached during rebind.
  **/ 
+@YomlSingletonMap(keyForPrimitiveValue="type")
+@Alias("entity-initializer")
 public interface EntityInitializer {
 
     /** Applies initialization logic to a just-built entity.

api/src/main/java/org/apache/brooklyn/api/typereg/RegisteredTypeLoadingContext.java

@@ -27,6 +27,7 @@
 import org.apache.brooklyn.api.entity.EntitySpec;
 import org.apache.brooklyn.api.mgmt.classloading.BrooklynClassLoadingContext;
 import org.apache.brooklyn.api.typereg.BrooklynTypeRegistry.RegisteredTypeKind;
+import org.apache.brooklyn.util.yoml.internal.ConstructionInstruction;
 
 public interface RegisteredTypeLoadingContext {
 
@@ -37,6 +38,7 @@ public interface RegisteredTypeLoadingContext {
      * for specs, this refers to the target type, not the spec 
      * (eg {@link Entity} not {@link EntitySpec}). 
      * If nothing is specified, this returns {@link Object}'s class. */
+    // TODO extend to offer expected registered super type
     @Nonnull public Class<?> getExpectedJavaSuperType();
 
     /** encountered types, so that during resolution, 
@@ -47,4 +49,9 @@ public interface RegisteredTypeLoadingContext {
     /** A loader to use, supplying preferred or additional bundles and search paths */
     @Nullable public BrooklynClassLoadingContext getLoader();
 
+    /** Optional instructions on how to invoke the constructor,
+     * for use when a caller needs to specify a special constructor or factory method
+     * and/or specify parameters */
+    @Nullable public ConstructionInstruction getConstructorInstruction();
+
 }

camp/camp-brooklyn/src/main/java/org/apache/brooklyn/camp/brooklyn/spi/creation/BrooklynEntityDecorationResolver.java

@@ -35,12 +35,15 @@
 import org.apache.brooklyn.api.typereg.RegisteredType;
 import org.apache.brooklyn.camp.brooklyn.BrooklynCampReservedKeys;
 import org.apache.brooklyn.camp.brooklyn.spi.creation.BrooklynYamlTypeInstantiator.InstantiatorFromKey;
+import org.apache.brooklyn.camp.brooklyn.spi.dsl.DslAccessible;
+import org.apache.brooklyn.camp.brooklyn.spi.dsl.methods.BrooklynDslCommon;
 import org.apache.brooklyn.core.entity.BrooklynConfigKeys;
 import org.apache.brooklyn.core.mgmt.BrooklynTags;
 import org.apache.brooklyn.core.objs.BasicSpecParameter;
 import org.apache.brooklyn.core.typereg.RegisteredTypeLoadingContexts;
 import org.apache.brooklyn.core.typereg.RegisteredTypes;
 import org.apache.brooklyn.util.collections.MutableList;
+import org.apache.brooklyn.util.collections.MutableMap;
 import org.apache.brooklyn.util.core.config.ConfigBag;
 import org.apache.brooklyn.util.core.task.DeferredSupplier;
 import org.apache.brooklyn.util.guava.Maybe;
@@ -77,13 +80,18 @@ protected List<? extends DT> buildListOfTheseDecorationsFromEntityAttributes(Con
         if (value==null) { return MutableList.of(); }
         if (value instanceof Iterable) {
             return buildListOfTheseDecorationsFromIterable((Iterable<?>)value);
+        } else if (canBuildFromMap()) {
+            if (value instanceof Map) {
+                return buildListOfTheseDecorationsFromMap((Map<?,?>)value);
+            } else {
+                throw new IllegalArgumentException(getDecorationKind()+" body should be map or iterable, not " + value.getClass());
+            }
         } else {
-            // in future may support types other than iterables here, 
-            // e.g. a map short form where the key is the type
             throw new IllegalArgumentException(getDecorationKind()+" body should be iterable, not " + value.getClass());
         }
     }
 
+
     protected Map<?,?> checkIsMap(Object decorationJson) {
         if (!(decorationJson instanceof Map)) {
             throw new IllegalArgumentException(getDecorationKind()+" value must be a Map, not " + 
@@ -100,6 +108,11 @@ protected List<DT> buildListOfTheseDecorationsFromIterable(Iterable<?> value) {
         return decorations;
     }
 
+    // optional if syntax supports a map input 
+    // (e.g. where the key is the type or the name)
+    protected boolean canBuildFromMap() { return false; }
+    protected List<DT> buildListOfTheseDecorationsFromMap(Map<?, ?> value) { throw new UnsupportedOperationException(); }
+
     protected abstract String getDecorationKind();
 
     protected abstract Object getDecorationAttributeJsonValue(ConfigBag attrs);
@@ -201,6 +214,22 @@ protected Object getDecorationAttributeJsonValue(ConfigBag attrs) {
         protected void addDecorationFromJsonMap(Map<?, ?> decorationJson, List<EntityInitializer> decorations) {
             decorations.add(instantiator.from(decorationJson).prefix("initializer").newInstance(EntityInitializer.class));
         }
+
+        @Override
+        protected boolean canBuildFromMap() {
+            return true;
+        }
+
+        @Override
+        protected List<EntityInitializer> buildListOfTheseDecorationsFromMap(Map<?, ?> value) {
+            ManagementContext mgmt = instantiator.loader.getManagementContext();
+            List<EntityInitializer> result = MutableList.of();
+            for (Map.Entry<?, ?> v: value.entrySet()) {
+                result.add(mgmt.getTypeRegistry().createBeanFromPlan("yoml", MutableMap.of(v.getKey(), v.getValue()), 
+                    RegisteredTypeLoadingContexts.loader(instantiator.loader), EntityInitializer.class));
+            }
+            return result;
+        }
     }
 
     // Not much value from extending from BrooklynEntityDecorationResolver, but let's not break the convention

camp/camp-brooklyn/src/main/java/org/apache/brooklyn/camp/brooklyn/spi/creation/BrooklynEntityMatcher.java

@@ -126,14 +126,14 @@ public boolean apply(Object deploymentPlanItem, AssemblyTemplateConstructor atc)
             brooklynFlags.putAll((Map<?,?>)origBrooklynFlags);
         }
 
-        addCustomMapAttributeIfNonNull(builder, attrs, BrooklynCampReservedKeys.BROOKLYN_CONFIG);
-        addCustomListAttributeIfNonNull(builder, attrs, BrooklynCampReservedKeys.BROOKLYN_POLICIES);
-        addCustomListAttributeIfNonNull(builder, attrs, BrooklynCampReservedKeys.BROOKLYN_ENRICHERS);
-        addCustomListAttributeIfNonNull(builder, attrs, BrooklynCampReservedKeys.BROOKLYN_INITIALIZERS);
-        addCustomListAttributeIfNonNull(builder, attrs, BrooklynCampReservedKeys.BROOKLYN_CHILDREN);
-        addCustomListAttributeIfNonNull(builder, attrs, BrooklynCampReservedKeys.BROOKLYN_PARAMETERS);
-        addCustomMapAttributeIfNonNull(builder, attrs, BrooklynCampReservedKeys.BROOKLYN_CATALOG);
-        addCustomListAttributeIfNonNull(builder, attrs, BrooklynCampReservedKeys.BROOKLYN_TAGS);
+        addCustomMapAttributeIfNonEmpty(builder, attrs, BrooklynCampReservedKeys.BROOKLYN_CONFIG);
+        addCustomListAttributeIfNonEmpty(builder, attrs, BrooklynCampReservedKeys.BROOKLYN_POLICIES);
+        addCustomListAttributeIfNonEmpty(builder, attrs, BrooklynCampReservedKeys.BROOKLYN_ENRICHERS);
+        addCustomAttributeIfNonEmpty(builder, attrs, BrooklynCampReservedKeys.BROOKLYN_INITIALIZERS, true, true);
+        addCustomListAttributeIfNonEmpty(builder, attrs, BrooklynCampReservedKeys.BROOKLYN_CHILDREN);
+        addCustomListAttributeIfNonEmpty(builder, attrs, BrooklynCampReservedKeys.BROOKLYN_PARAMETERS);
+        addCustomMapAttributeIfNonEmpty(builder, attrs, BrooklynCampReservedKeys.BROOKLYN_CATALOG);
+        addCustomListAttributeIfNonEmpty(builder, attrs, BrooklynCampReservedKeys.BROOKLYN_TAGS);
 
         brooklynFlags.putAll(attrs);
         if (!brooklynFlags.isEmpty()) {
@@ -150,35 +150,37 @@ public boolean apply(Object deploymentPlanItem, AssemblyTemplateConstructor atc)
      * as a custom attribute with type List.
      * @throws java.lang.IllegalArgumentException if map[key] is not an instance of List
      */
-    private void addCustomListAttributeIfNonNull(Builder<? extends PlatformComponentTemplate> builder, Map<?,?> attrs, String key) {
-        Object items = attrs.remove(key);
-        if (items != null) {
-            if (items instanceof List) {
-                List<?> itemList = (List<?>) items;
-                if (!itemList.isEmpty()) {
-                    builder.customAttribute(key, Lists.newArrayList(itemList));
-                }
-            } else {
-                throw new IllegalArgumentException(key + " must be a list, is: " + items.getClass().getName());
-            }
-        }
+    private void addCustomListAttributeIfNonEmpty(Builder<? extends PlatformComponentTemplate> builder, Map<?,?> attrs, String key) {
+        addCustomAttributeIfNonEmpty(builder, attrs, key, false, true);
     }
 
     /**
      * Looks for the given key in the map of attributes and adds it to the given builder
      * as a custom attribute with type Map.
      * @throws java.lang.IllegalArgumentException if map[key] is not an instance of Map
      */
-    private void addCustomMapAttributeIfNonNull(Builder<? extends PlatformComponentTemplate> builder, Map<?,?> attrs, String key) {
+    private void addCustomMapAttributeIfNonEmpty(Builder<? extends PlatformComponentTemplate> builder, Map<?,?> attrs, String key) {
+        addCustomAttributeIfNonEmpty(builder, attrs, key, true, false);
+    }
+
+    private void addCustomAttributeIfNonEmpty(Builder<? extends PlatformComponentTemplate> builder, Map<?,?> attrs, String key,
+            boolean allowMap, boolean allowList) {
         Object items = attrs.remove(key);
         if (items != null) {
-            if (items instanceof Map) {
+            if (allowMap && items instanceof Map) {
                 Map<?, ?> itemMap = (Map<?, ?>) items;
                 if (!itemMap.isEmpty()) {
                     builder.customAttribute(key, Maps.newHashMap(itemMap));
                 }
+            } else if (allowList && items instanceof List) {
+                List<?> itemList = (List<?>) items;
+                if (!itemList.isEmpty()) {
+                    builder.customAttribute(key, Lists.newArrayList(itemList));
+                }
             } else {
-                throw new IllegalArgumentException(key + " must be a map, is: " + items.getClass().getName());
+                throw new IllegalArgumentException(key + " must be a "+
+                    (allowMap && allowList ? "map or list" : allowMap ? "map" : allowList ? "list" : "<no type allowed>")+
+                    ", is: " + items.getClass().getName());
             }
         }
     }

camp/camp-brooklyn/src/main/java/org/apache/brooklyn/camp/brooklyn/spi/creation/CampTypePlanTransformer.java

@@ -22,14 +22,16 @@
 import java.util.Map;
 
 import org.apache.brooklyn.api.internal.AbstractBrooklynObjectSpec;
+import org.apache.brooklyn.api.typereg.BrooklynTypeRegistry.RegisteredTypeKind;
 import org.apache.brooklyn.api.typereg.RegisteredType;
 import org.apache.brooklyn.api.typereg.RegisteredType.TypeImplementationPlan;
 import org.apache.brooklyn.api.typereg.RegisteredTypeLoadingContext;
-import org.apache.brooklyn.api.typereg.BrooklynTypeRegistry.RegisteredTypeKind;
 import org.apache.brooklyn.core.typereg.AbstractFormatSpecificTypeImplementationPlan;
 import org.apache.brooklyn.core.typereg.AbstractTypePlanTransformer;
 import org.apache.brooklyn.core.typereg.BasicTypeImplementationPlan;
+import org.apache.brooklyn.core.typereg.RegisteredTypeInfo;
 import org.apache.brooklyn.core.typereg.RegisteredTypes;
+import org.apache.brooklyn.util.collections.MutableSet;
 import org.apache.brooklyn.util.guava.Maybe;
 
 import com.google.common.collect.ImmutableList;
@@ -84,28 +86,24 @@ protected double scoreForNonmatchingNonnullFormat(String planFormat, Object plan
 
     @Override
     protected AbstractBrooklynObjectSpec<?, ?> createSpec(RegisteredType type, RegisteredTypeLoadingContext context) throws Exception {
-        // TODO cache
+        // could cache and copy each time, if this bit is slow
+        // (but don't think it is now)
         return new CampResolver(mgmt, type, context).createSpec();
     }
 
     @Override
     protected Object createBean(RegisteredType type, RegisteredTypeLoadingContext context) throws Exception {
-        // beans not supported by this?
+        // beans not supported by this? - want YOML for this
         throw new IllegalStateException("beans not supported here");
     }
 
     @Override
-    public double scoreForTypeDefinition(String formatCode, Object catalogData) {
-        // TODO catalog parsing
-        return 0;
-    }
-
-    @Override
-    public List<RegisteredType> createFromTypeDefinition(String formatCode, Object catalogData) {
-        // TODO catalog parsing
-        return null;
+    public RegisteredTypeInfo getTypeInfo(RegisteredType type) {
+        // TODO collect immediate supertypes, as RegisteredType and Class instances
+        // we really want YOML for this however
+        return RegisteredTypeInfo.create(type, this, null, MutableSet.of());
     }
-
+    
     public static class CampTypeImplementationPlan extends AbstractFormatSpecificTypeImplementationPlan<String> {
         public CampTypeImplementationPlan(TypeImplementationPlan otherPlan) {
             super(FORMATS.get(0), String.class, otherPlan);

camp/camp-brooklyn/src/main/java/org/apache/brooklyn/camp/brooklyn/spi/dsl/BrooklynDslInterpreter.java

@@ -36,6 +36,8 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import com.google.common.base.CaseFormat;
+
 /**
  * {@link PlanInterpreter} which understands the $brooklyn DSL
  */
@@ -156,6 +158,9 @@ public Object evaluateOn(Object o, FunctionWithArgs f, boolean deepEvaluation) {
 
         String fn = f.getFunction();
         fn = Strings.removeFromStart(fn, BrooklynDslCommon.PREFIX);
+        if (fn.contains("-")) {
+            fn = CaseFormat.LOWER_HYPHEN.to(CaseFormat.LOWER_CAMEL, fn);
+        }
         if (fn.startsWith("function.")) {
             // If the function name starts with 'function.', then we look for the function in BrooklynDslCommon.Functions
             // As all functions in BrooklynDslCommon.Functions are static, we don't need to worry whether a class