CAMEL-13439: Resolving data formats is a bit cumbersome. So lets init…

…ialize dataformats that has been setup via XML DSL or added as model, then they are ready to be used. Avoid using RouteContext as it was not needed and helps with modularization. Add some missing dataformats in the DSL.

components/camel-dozer/pom.xml

@@ -40,7 +40,7 @@
         <!-- requires camel-core -->
         <dependency>
             <groupId>org.apache.camel</groupId>
-            <artifactId>camel-core</artifactId>
+            <artifactId>camel-support</artifactId>
         </dependency>
         <dependency>
             <groupId>com.github.dozermapper</groupId>

components/camel-dozer/src/main/java/org/apache/camel/component/dozer/DozerProducer.java

@@ -18,7 +18,6 @@
 
 import org.apache.camel.Exchange;
 import org.apache.camel.Message;
-import org.apache.camel.model.DataFormatDefinition;
 import org.apache.camel.spi.DataFormat;
 import org.apache.camel.support.DefaultProducer;
 import org.apache.camel.support.processor.MarshalProcessor;
@@ -129,8 +128,7 @@ private synchronized UnmarshalProcessor resolveUnmarshaller(
             Exchange exchange, String dataFormatId) throws Exception {
 
         if (unmarshaller == null) {
-            DataFormat dataFormat = DataFormatDefinition.getDataFormat(
-                    exchange.getUnitOfWork().getRouteContext(), null, dataFormatId);
+            DataFormat dataFormat = exchange.getContext().resolveDataFormat(dataFormatId);
             if (dataFormat == null) {
                 throw new Exception("Unable to resolve data format for unmarshalling: " + dataFormatId);
             }
@@ -152,8 +150,7 @@ private synchronized MarshalProcessor resolveMarshaller(
             Exchange exchange, String dataFormatId) throws Exception {
 
         if (marshaller == null) {
-            DataFormat dataFormat = DataFormatDefinition.getDataFormat(
-                    exchange.getUnitOfWork().getRouteContext(), null, dataFormatId);
+            DataFormat dataFormat = exchange.getContext().resolveDataFormat(dataFormatId);
             if (dataFormat == null) {
                 throw new Exception("Unable to resolve data format for marshalling: " + dataFormatId);
             }

core/camel-core/src/main/java/org/apache/camel/impl/AbstractCamelContext.java

@@ -2555,6 +2555,7 @@ protected void doStartCamel() throws Exception {
         }
 
         // Start runtime catalog
+        // TODO: remove me as already started earlier
         getExtension(RuntimeCamelCatalog.class);
 
         // re-create endpoint registry as the cache size limit may be set after the constructor of this instance was called.
@@ -2590,6 +2591,16 @@ protected void doStartCamel() throws Exception {
             propertiesComponent = existing;
         }
 
+        // eager lookup data formats and bind to registry so the dataformats can be looked up and used
+        for (Map.Entry<String, DataFormatDefinition> e : dataFormats.entrySet()) {
+            String id = e.getKey();
+            DataFormatDefinition def = e.getValue();
+            log.debug("Creating Dataformat with id: {} and definition: {}", id, def);
+            DataFormat df = def.getDataFormat(this);
+            addService(df, true);
+            getRegistry().bind(id, df);
+        }
+
         // start components
         startServices(components.values());
 

core/camel-core/src/main/java/org/apache/camel/impl/transformer/DataFormatTransformer.java

@@ -93,13 +93,16 @@ public void transform(Message message, DataType from, DataType to) throws Except
         }
     }
 
-    /**
-     * A bit dirty hack to create DataFormat instance, as it requires a RouteContext anyway.
-     */
     private DataFormat getDataFormat(Exchange exchange) throws Exception {
+        // TODO: Move this to doStart and remove this method
         if (this.dataFormat == null) {
-            this.dataFormat = DataFormatDefinition.getDataFormat(
-                exchange.getUnitOfWork().getRouteContext(), this.dataFormatType, this.dataFormatRef);
+            if (this.dataFormatType != null) {
+                this.dataFormat = this.dataFormatType.getDataFormat(exchange.getContext());
+            } else if (this.dataFormatRef != null) {
+                this.dataFormat = exchange.getContext().resolveDataFormat(this.dataFormatRef);
+            }
+//            this.dataFormat = DataFormatDefinition.getDataFormat(
+//                exchange.getContext(), this.dataFormatType, this.dataFormatRef);
             if (this.dataFormat != null && !getCamelContext().hasService(this.dataFormat)) {
                 getCamelContext().addService(this.dataFormat, false);
             }

core/camel-core/src/main/java/org/apache/camel/model/DataFormatDefinition.java

@@ -29,11 +29,8 @@
 import org.apache.camel.CamelContext;
 import org.apache.camel.spi.DataFormat;
 import org.apache.camel.spi.Metadata;
-import org.apache.camel.spi.RouteContext;
 import org.apache.camel.support.IntrospectionSupport;
 import org.apache.camel.util.ObjectHelper;
-
-
 import static org.apache.camel.support.EndpointHelper.isReferenceParameter;
 
 /**
@@ -67,55 +64,55 @@ protected DataFormatDefinition(String dataFormatName) {
     /**
      * Factory method to create the data format
      *
-     * @param routeContext route context
+     * @param camelContext the camel context
      * @param type         the data format type
      * @param ref          reference to lookup for a data format
      * @return the data format or null if not possible to create
      */
-    public static DataFormat getDataFormat(RouteContext routeContext, DataFormatDefinition type, String ref) {
+    public static DataFormat getDataFormat(CamelContext camelContext, DataFormatDefinition type, String ref) {
         if (type == null) {
             ObjectHelper.notNull(ref, "ref or type");
 
             // try to let resolver see if it can resolve it, its not always possible
-            type = routeContext.getCamelContext().adapt(ModelCamelContext.class).resolveDataFormatDefinition(ref);
+            type = camelContext.adapt(ModelCamelContext.class).resolveDataFormatDefinition(ref);
 
             if (type != null) {
-                return type.getDataFormat(routeContext);
+                return type.getDataFormat(camelContext);
             }
 
-            DataFormat dataFormat = routeContext.getCamelContext().resolveDataFormat(ref);
+            DataFormat dataFormat = camelContext.resolveDataFormat(ref);
             if (dataFormat == null) {
                 throw new IllegalArgumentException("Cannot find data format in registry with ref: " + ref);
             }
 
             return dataFormat;
         } else {
-            return type.getDataFormat(routeContext);
+            return type.getDataFormat(camelContext);
         }
     }
 
-    public DataFormat getDataFormat(RouteContext routeContext) {
+    public DataFormat getDataFormat(CamelContext camelContext) {
         if (dataFormat == null) {
             Runnable propertyPlaceholdersChangeReverter = ProcessorDefinitionHelper.createPropertyPlaceholdersChangeReverter();
 
             // resolve properties before we create the data format
             try {
-                ProcessorDefinitionHelper.resolvePropertyPlaceholders(routeContext.getCamelContext(), this);
+                ProcessorDefinitionHelper.resolvePropertyPlaceholders(camelContext, this);
             } catch (Exception e) {
                 throw new IllegalArgumentException("Error resolving property placeholders on data format: " + this, e);
             }
             try {
-                dataFormat = createDataFormat(routeContext);
+                dataFormat = createDataFormat(camelContext);
                 if (dataFormat != null) {
                     // is enabled by default so assume true if null
                     final boolean contentTypeHeader = this.contentTypeHeader == null || this.contentTypeHeader;
                     try {
-                        setProperty(routeContext.getCamelContext(), dataFormat, "contentTypeHeader", contentTypeHeader);
+                        setProperty(camelContext, dataFormat, "contentTypeHeader", contentTypeHeader);
                     } catch (Exception e) {
                         // ignore as this option is optional and not all data formats support this
                     }
                     // configure the rest of the options
-                    configureDataFormat(dataFormat, routeContext.getCamelContext());
+                    configureDataFormat(dataFormat, camelContext);
                 } else {
                     throw new IllegalArgumentException(
                             "Data format '" + (dataFormatName != null ? dataFormatName : "<null>") + "' could not be created. "
@@ -131,10 +128,10 @@ public DataFormat getDataFormat(RouteContext routeContext) {
     /**
      * Factory method to create the data format instance
      */
-    protected DataFormat createDataFormat(RouteContext routeContext) {
+    protected DataFormat createDataFormat(CamelContext camelContext) {
         // must use getDataFormatName() as we need special logic in json dataformat
         if (getDataFormatName() != null) {
-            return routeContext.getCamelContext().createDataFormat(getDataFormatName());
+            return camelContext.createDataFormat(getDataFormatName());
         }
         return null;
     }

core/camel-core/src/main/java/org/apache/camel/model/MarshalDefinition.java

@@ -24,6 +24,7 @@
 
 import org.apache.camel.model.dataformat.ASN1DataFormat;
 import org.apache.camel.model.dataformat.AvroDataFormat;
+import org.apache.camel.model.dataformat.BarcodeDataFormat;
 import org.apache.camel.model.dataformat.Base64DataFormat;
 import org.apache.camel.model.dataformat.BeanioDataFormat;
 import org.apache.camel.model.dataformat.BindyDataFormat;
@@ -42,6 +43,8 @@
 import org.apache.camel.model.dataformat.JibxDataFormat;
 import org.apache.camel.model.dataformat.JsonApiDataFormat;
 import org.apache.camel.model.dataformat.JsonDataFormat;
+import org.apache.camel.model.dataformat.LZFDataFormat;
+import org.apache.camel.model.dataformat.MimeMultipartDataFormat;
 import org.apache.camel.model.dataformat.PGPDataFormat;
 import org.apache.camel.model.dataformat.ProtobufDataFormat;
 import org.apache.camel.model.dataformat.RssDataFormat;
@@ -74,6 +77,7 @@ public class MarshalDefinition extends NoOutputDefinition<MarshalDefinition> {
     @XmlElements({
         @XmlElement(required = false, name = "asn1", type = ASN1DataFormat.class),
         @XmlElement(required = false, name = "avro", type = AvroDataFormat.class),
+        @XmlElement(required = false, name = "barcode", type = BarcodeDataFormat.class),
         @XmlElement(required = false, name = "base64", type = Base64DataFormat.class),
         @XmlElement(required = false, name = "beanio", type = BeanioDataFormat.class),
         @XmlElement(required = false, name = "bindy", type = BindyDataFormat.class),
@@ -92,6 +96,8 @@ public class MarshalDefinition extends NoOutputDefinition<MarshalDefinition> {
         @XmlElement(required = false, name = "jibx", type = JibxDataFormat.class),
         @XmlElement(required = false, name = "json", type = JsonDataFormat.class),
         @XmlElement(required = false, name = "jsonApi", type = JsonApiDataFormat.class),
+        @XmlElement(required = false, name = "lzf", type = LZFDataFormat.class),
+        @XmlElement(required = false, name = "mimeMultipart", type = MimeMultipartDataFormat.class),
         @XmlElement(required = false, name = "protobuf", type = ProtobufDataFormat.class),
         @XmlElement(required = false, name = "rss", type = RssDataFormat.class),
         @XmlElement(required = false, name = "secureXML", type = XMLSecurityDataFormat.class),

core/camel-core/src/main/java/org/apache/camel/model/UnmarshalDefinition.java

@@ -24,6 +24,7 @@
 
 import org.apache.camel.model.dataformat.ASN1DataFormat;
 import org.apache.camel.model.dataformat.AvroDataFormat;
+import org.apache.camel.model.dataformat.BarcodeDataFormat;
 import org.apache.camel.model.dataformat.Base64DataFormat;
 import org.apache.camel.model.dataformat.BeanioDataFormat;
 import org.apache.camel.model.dataformat.BindyDataFormat;
@@ -42,6 +43,8 @@
 import org.apache.camel.model.dataformat.JibxDataFormat;
 import org.apache.camel.model.dataformat.JsonApiDataFormat;
 import org.apache.camel.model.dataformat.JsonDataFormat;
+import org.apache.camel.model.dataformat.LZFDataFormat;
+import org.apache.camel.model.dataformat.MimeMultipartDataFormat;
 import org.apache.camel.model.dataformat.PGPDataFormat;
 import org.apache.camel.model.dataformat.ProtobufDataFormat;
 import org.apache.camel.model.dataformat.RssDataFormat;
@@ -74,6 +77,7 @@ public class UnmarshalDefinition extends NoOutputDefinition<UnmarshalDefinition>
     @XmlElements({
         @XmlElement(required = false, name = "asn1", type = ASN1DataFormat.class),
         @XmlElement(required = false, name = "avro", type = AvroDataFormat.class),
+        @XmlElement(required = false, name = "barcode", type = BarcodeDataFormat.class),
         @XmlElement(required = false, name = "base64", type = Base64DataFormat.class),
         @XmlElement(required = false, name = "beanio", type = BeanioDataFormat.class),
         @XmlElement(required = false, name = "bindy", type = BindyDataFormat.class),
@@ -92,6 +96,8 @@ public class UnmarshalDefinition extends NoOutputDefinition<UnmarshalDefinition>
         @XmlElement(required = false, name = "jibx", type = JibxDataFormat.class),
         @XmlElement(required = false, name = "json", type = JsonDataFormat.class),
         @XmlElement(required = false, name = "jsonApi", type = JsonApiDataFormat.class),
+        @XmlElement(required = false, name = "lzf", type = LZFDataFormat.class),
+        @XmlElement(required = false, name = "mimeMultipart", type = MimeMultipartDataFormat.class),
         @XmlElement(required = false, name = "protobuf", type = ProtobufDataFormat.class),
         @XmlElement(required = false, name = "rss", type = RssDataFormat.class),
         @XmlElement(required = false, name = "secureXML", type = XMLSecurityDataFormat.class),

core/camel-core/src/main/java/org/apache/camel/model/dataformat/BindyDataFormat.java

@@ -104,7 +104,8 @@ public void setUnwrapSingleInstance(Boolean unwrapSingleInstance) {
         this.unwrapSingleInstance = unwrapSingleInstance;
     }
 
-    protected DataFormat createDataFormat(RouteContext routeContext) {
+    @Override
+    protected DataFormat createDataFormat(CamelContext camelContext) {
         if (classType == null && clazz == null) {
             throw new IllegalArgumentException("Either packages or classType must be specified");
         }
@@ -119,12 +120,12 @@ protected DataFormat createDataFormat(RouteContext routeContext) {
 
         if (clazz == null && classType != null) {
             try {
-                clazz = routeContext.getCamelContext().getClassResolver().resolveMandatoryClass(classType);
+                clazz = camelContext.getClassResolver().resolveMandatoryClass(classType);
             } catch (ClassNotFoundException e) {
                 throw RuntimeCamelException.wrapRuntimeCamelException(e);
             }
         }
-        return super.createDataFormat(routeContext);
+        return super.createDataFormat(camelContext);
     }
 
     @Override

core/camel-core/src/main/java/org/apache/camel/model/dataformat/BoonDataFormat.java

@@ -87,15 +87,15 @@ public void setUseList(boolean useList) {
     }  
 
     @Override
-    protected DataFormat createDataFormat(RouteContext routeContext) {
+    protected DataFormat createDataFormat(CamelContext camelContext) {
         if (unmarshalType == null && unmarshalTypeName != null) {
             try {
-                unmarshalType = routeContext.getCamelContext().getClassResolver().resolveMandatoryClass(unmarshalTypeName);
+                unmarshalType = camelContext.getClassResolver().resolveMandatoryClass(unmarshalTypeName);
             } catch (ClassNotFoundException e) {
                 throw RuntimeCamelException.wrapRuntimeCamelException(e);
             }
         }
-        return super.createDataFormat(routeContext);
+        return super.createDataFormat(camelContext);
     }
 
     @Override

core/camel-core/src/main/java/org/apache/camel/model/dataformat/CryptoDataFormat.java

@@ -63,21 +63,21 @@ public CryptoDataFormat() {
     }
 
     @Override
-    protected DataFormat createDataFormat(RouteContext routeContext) {
-        DataFormat cryptoFormat = super.createDataFormat(routeContext);
+    protected DataFormat createDataFormat(CamelContext camelContext) {
+        DataFormat cryptoFormat = super.createDataFormat(camelContext);
 
         if (ObjectHelper.isNotEmpty(keyRef)) {
-            Key key = CamelContextHelper.mandatoryLookup(routeContext.getCamelContext(), keyRef, Key.class);
-            setProperty(routeContext.getCamelContext(), cryptoFormat, "key", key);
+            Key key = CamelContextHelper.mandatoryLookup(camelContext, keyRef, Key.class);
+            setProperty(camelContext, cryptoFormat, "key", key);
         }
         if (ObjectHelper.isNotEmpty(algorithmParameterRef)) {
-            AlgorithmParameterSpec spec = CamelContextHelper.mandatoryLookup(routeContext.getCamelContext(),
+            AlgorithmParameterSpec spec = CamelContextHelper.mandatoryLookup(camelContext,
                     algorithmParameterRef, AlgorithmParameterSpec.class);
-            setProperty(routeContext.getCamelContext(), cryptoFormat, "AlgorithmParameterSpec", spec);
+            setProperty(camelContext, cryptoFormat, "AlgorithmParameterSpec", spec);
         }
         if (ObjectHelper.isNotEmpty(initVectorRef)) {
-            byte[] iv = CamelContextHelper.mandatoryLookup(routeContext.getCamelContext(), initVectorRef, byte[].class);
-            setProperty(routeContext.getCamelContext(), cryptoFormat, "InitializationVector", iv);
+            byte[] iv = CamelContextHelper.mandatoryLookup(camelContext, initVectorRef, byte[].class);
+            setProperty(camelContext, cryptoFormat, "InitializationVector", iv);
         }
         return cryptoFormat;
     }

core/camel-core/src/main/java/org/apache/camel/model/dataformat/CustomDataFormat.java

@@ -21,10 +21,10 @@
 import javax.xml.bind.annotation.XmlAttribute;
 import javax.xml.bind.annotation.XmlRootElement;
 
+import org.apache.camel.CamelContext;
 import org.apache.camel.model.DataFormatDefinition;
 import org.apache.camel.spi.DataFormat;
 import org.apache.camel.spi.Metadata;
-import org.apache.camel.spi.RouteContext;
 
 /**
  * To use a custom data format implementation that does not come out of the box from Apache Camel.
@@ -44,8 +44,8 @@ public CustomDataFormat(String ref) {
     }
 
     @Override
-    protected DataFormat createDataFormat(RouteContext routeContext) {
-        return DataFormatDefinition.getDataFormat(routeContext, null, ref);
+    protected DataFormat createDataFormat(CamelContext camelContext) {
+        return DataFormatDefinition.getDataFormat(camelContext, null, ref);
     }
 
     /**

core/camel-core/src/main/java/org/apache/camel/model/dataformat/FlatpackDataFormat.java

@@ -151,12 +151,12 @@ public void setParserFactoryRef(String parserFactoryRef) {
     }
 
     @Override
-    protected DataFormat createDataFormat(RouteContext routeContext) {
-        DataFormat flatpack = super.createDataFormat(routeContext);
+    protected DataFormat createDataFormat(CamelContext camelContext) {
+        DataFormat flatpack = super.createDataFormat(camelContext);
 
         if (ObjectHelper.isNotEmpty(parserFactoryRef)) {
-            Object parserFactory = CamelContextHelper.mandatoryLookup(routeContext.getCamelContext(), parserFactoryRef);
-            setProperty(routeContext.getCamelContext(), flatpack, "parserFactory", parserFactory);
+            Object parserFactory = CamelContextHelper.mandatoryLookup(camelContext, parserFactoryRef);
+            setProperty(camelContext, flatpack, "parserFactory", parserFactory);
         }
 
         return flatpack;

core/camel-core/src/main/java/org/apache/camel/model/dataformat/GzipDataFormat.java

@@ -18,6 +18,7 @@
 
 import javax.xml.bind.annotation.XmlRootElement;
 
+import org.apache.camel.CamelContext;
 import org.apache.camel.model.DataFormatDefinition;
 import org.apache.camel.spi.DataFormat;
 import org.apache.camel.spi.Metadata;
@@ -35,7 +36,7 @@ public GzipDataFormat() {
     }
 
     @Override
-    protected DataFormat createDataFormat(RouteContext routeContext) {
+    protected DataFormat createDataFormat(CamelContext camelContext) {
         return new org.apache.camel.impl.GzipDataFormat();
     }
 }