This is an automated email from the ASF dual-hosted git repository. davsclaus pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel-spring-boot.git
The following commit(s) were added to refs/heads/main by this push: new 543d819 CAMEL-16615: Create Jackson based dataformats for Avro and Protobuf 543d819 is described below commit 543d81948b94863325e662b0a1ed2d98db4823c3 Author: Claus Ibsen <claus.ib...@gmail.com> AuthorDate: Fri May 14 21:06:37 2021 +0200 CAMEL-16615: Create Jackson based dataformats for Avro and Protobuf --- .../springboot/catalog/dataformats.properties | 2 + .../catalog/dataformats/avro-jackson.json | 39 +++ .../catalog/dataformats/protobuf-jackson.json | 39 +++ components-starter/README.adoc | 6 +- .../camel-jackson-avro-starter/pom.xml | 48 ++++ .../src/main/docs/jackson-avro-starter.adoc | 49 ++++ .../JacksonAvroDataFormatAutoConfiguration.java | 80 ++++++ .../JacksonAvroDataFormatConfiguration.java | 284 +++++++++++++++++++++ .../src/main/resources/META-INF/LICENSE.txt | 203 +++++++++++++++ .../src/main/resources/META-INF/NOTICE.txt | 11 + .../src/main/resources/META-INF/spring.factories | 19 ++ .../src/main/resources/META-INF/spring.provides | 17 ++ .../camel-jackson-protobuf-starter/pom.xml | 48 ++++ .../src/main/docs/jackson-protobuf-starter.adoc | 49 ++++ ...JacksonProtobufDataFormatAutoConfiguration.java | 80 ++++++ .../JacksonProtobufDataFormatConfiguration.java | 284 +++++++++++++++++++++ .../src/main/resources/META-INF/LICENSE.txt | 203 +++++++++++++++ .../src/main/resources/META-INF/NOTICE.txt | 11 + .../src/main/resources/META-INF/spring.factories | 19 ++ .../src/main/resources/META-INF/spring.provides | 17 ++ components-starter/pom.xml | 2 + docs/modules/ROOT/pages/jackson-avro-starter.adoc | 49 ++++ .../ROOT/pages/jackson-protobuf-starter.adoc | 49 ++++ docs/modules/ROOT/pages/list.adoc | 6 +- tooling/camel-spring-boot-bom/pom.xml | 10 + tooling/camel-spring-boot-dependencies/pom.xml | 10 + 26 files changed, 1632 insertions(+), 2 deletions(-) diff --git a/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/dataformats.properties b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/dataformats.properties index b7ffb64..6140827 100644 --- a/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/dataformats.properties +++ b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/dataformats.properties @@ -1,6 +1,7 @@ any23 asn1 avro +avro-jackson barcode base64 beanio @@ -30,6 +31,7 @@ lzf mime-multipart pgp protobuf +protobuf-jackson rss secureXML soapjaxb diff --git a/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/dataformats/avro-jackson.json b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/dataformats/avro-jackson.json new file mode 100644 index 0000000..c2819a9 --- /dev/null +++ b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/dataformats/avro-jackson.json @@ -0,0 +1,39 @@ +{ + "dataformat": { + "kind": "dataformat", + "name": "avro-jackson", + "title": "Avro Jackson", + "description": "Marshal POJOs to Avro and back using Jackson.", + "deprecated": false, + "firstVersion": "3.10.0", + "label": "dataformat,transformation", + "javaType": "org.apache.camel.component.jackson.avro.JacksonAvroDataFormat", + "supportLevel": "Preview", + "groupId": "org.apache.camel.springboot", + "artifactId": "camel-jackson-avro-starter", + "version": "3.10.0-SNAPSHOT", + "modelName": "avro", + "modelJavaType": "org.apache.camel.model.dataformat.AvroDataFormat" + }, + "properties": { + "objectMapper": { "kind": "attribute", "displayName": "Object Mapper", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Lookup and use the existing ObjectMapper with the given id when using Jackson." }, + "useDefaultObjectMapper": { "kind": "attribute", "displayName": "Use Default Object Mapper", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether to lookup and use default Jackson ObjectMapper from the registry." }, + "unmarshalTypeName": { "kind": "attribute", "displayName": "Unmarshal Type Name", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Class name of the java type to use when unmarshalling" }, + "jsonViewTypeName": { "kind": "attribute", "displayName": "Json View Type Name", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "When marshalling a POJO to JSON you might want to exclude certain fields from the JSON output. With Jackson you can use JSON views to accomplish this. This option is to refer to the class which has JsonView annotations" }, + "include": { "kind": "attribute", "displayName": "Include", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "If you want to marshal a pojo to JSON, and the pojo has some fields with null values. And you want to skip these null values, you can set this option to NON_NULL" }, + "allowJmsType": { "kind": "attribute", "displayName": "Allow Jms Type", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Used for JMS users to allow the JMSType header from the JMS spec to specify a FQN classname to use to unmarshal to." }, + "collectionTypeName": { "kind": "attribute", "displayName": "Collection Type Name", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Refers to a custom collection type to lookup in the registry to use. This option should rarely be used, but allows to use different collection types than java.util.Collection based as default." }, + "useList": { "kind": "attribute", "displayName": "Use List", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "To unmarshal to a List of Map or a List of Pojo." }, + "moduleClassNames": { "kind": "attribute", "displayName": "Module Class Names", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "To use custom Jackson modules com.fasterxml.jackson.databind.Module specified as a String with FQN class names. Multiple classes can be separated by comma." }, + "moduleRefs": { "kind": "attribute", "displayName": "Module Refs", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "To use custom Jackson modules referred from the Camel registry. Multiple modules can be separated by comma." }, + "enableFeatures": { "kind": "attribute", "displayName": "Enable Features", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Set of features to enable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jack [...] + "disableFeatures": { "kind": "attribute", "displayName": "Disable Features", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Set of features to disable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.j [...] + "allowUnmarshallType": { "kind": "attribute", "displayName": "Allow Unmarshall Type", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If enabled then Jackson is allowed to attempt to use the CamelJacksonUnmarshalType header during the unmarshalling. This should only be enabled when desired to be used." }, + "timezone": { "kind": "attribute", "displayName": "Timezone", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "If set then Jackson will use the Timezone when marshalling\/unmarshalling." }, + "autoDiscoverObjectMapper": { "kind": "attribute", "displayName": "Auto Discover Object Mapper", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If set to true then Jackson will lookup for an objectMapper into the registry" }, + "contentTypeHeader": { "kind": "attribute", "displayName": "Content Type Header", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether the data format should set the Content-Type header with the type from the data format. For example application\/xml for data formats marshalling to XML, or application\/json for data formats marshalling to JSON" }, + "schemaResolver": { "kind": "attribute", "displayName": "Schema Resolver", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Optional schema resolver used to lookup schemas for the data in transit." }, + "autoDiscoverSchemaResolver": { "kind": "attribute", "displayName": "Auto Discover Schema Resolver", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "When not disabled, the SchemaResolver will be looked up into the registry" }, + "id": { "kind": "attribute", "displayName": "Id", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The id of this node" } + } +} diff --git a/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/dataformats/protobuf-jackson.json b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/dataformats/protobuf-jackson.json new file mode 100644 index 0000000..de26fac --- /dev/null +++ b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/dataformats/protobuf-jackson.json @@ -0,0 +1,39 @@ +{ + "dataformat": { + "kind": "dataformat", + "name": "protobuf-jackson", + "title": "Protobuf Jackson", + "description": "Marshal POJOs to Protobuf and back using Jackson.", + "deprecated": false, + "firstVersion": "3.10.0", + "label": "dataformat,transformation", + "javaType": "org.apache.camel.component.jackson.protobuf.JacksonProtobufDataFormat", + "supportLevel": "Preview", + "groupId": "org.apache.camel.springboot", + "artifactId": "camel-jackson-protobuf-starter", + "version": "3.10.0-SNAPSHOT", + "modelName": "protobuf", + "modelJavaType": "org.apache.camel.model.dataformat.ProtobufDataFormat" + }, + "properties": { + "contentTypeHeader": { "kind": "attribute", "displayName": "Content Type Header", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether the data format should set the Content-Type header with the type from the data format. For example application\/xml for data formats marshalling to XML, or application\/json for data formats marshalling to JSON" }, + "objectMapper": { "kind": "attribute", "displayName": "Object Mapper", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Lookup and use the existing ObjectMapper with the given id when using Jackson." }, + "useDefaultObjectMapper": { "kind": "attribute", "displayName": "Use Default Object Mapper", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether to lookup and use default Jackson ObjectMapper from the registry." }, + "unmarshalTypeName": { "kind": "attribute", "displayName": "Unmarshal Type Name", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Class name of the java type to use when unmarshalling" }, + "jsonViewTypeName": { "kind": "attribute", "displayName": "Json View Type Name", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "When marshalling a POJO to JSON you might want to exclude certain fields from the JSON output. With Jackson you can use JSON views to accomplish this. This option is to refer to the class which has JsonView annotations" }, + "include": { "kind": "attribute", "displayName": "Include", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "If you want to marshal a pojo to JSON, and the pojo has some fields with null values. And you want to skip these null values, you can set this option to NON_NULL" }, + "allowJmsType": { "kind": "attribute", "displayName": "Allow Jms Type", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Used for JMS users to allow the JMSType header from the JMS spec to specify a FQN classname to use to unmarshal to." }, + "collectionTypeName": { "kind": "attribute", "displayName": "Collection Type Name", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Refers to a custom collection type to lookup in the registry to use. This option should rarely be used, but allows to use different collection types than java.util.Collection based as default." }, + "useList": { "kind": "attribute", "displayName": "Use List", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "To unmarshal to a List of Map or a List of Pojo." }, + "moduleClassNames": { "kind": "attribute", "displayName": "Module Class Names", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "To use custom Jackson modules com.fasterxml.jackson.databind.Module specified as a String with FQN class names. Multiple classes can be separated by comma." }, + "moduleRefs": { "kind": "attribute", "displayName": "Module Refs", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "To use custom Jackson modules referred from the Camel registry. Multiple modules can be separated by comma." }, + "enableFeatures": { "kind": "attribute", "displayName": "Enable Features", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Set of features to enable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jack [...] + "disableFeatures": { "kind": "attribute", "displayName": "Disable Features", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Set of features to disable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.j [...] + "allowUnmarshallType": { "kind": "attribute", "displayName": "Allow Unmarshall Type", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If enabled then Jackson is allowed to attempt to use the CamelJacksonUnmarshalType header during the unmarshalling. This should only be enabled when desired to be used." }, + "timezone": { "kind": "attribute", "displayName": "Timezone", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "If set then Jackson will use the Timezone when marshalling\/unmarshalling." }, + "autoDiscoverObjectMapper": { "kind": "attribute", "displayName": "Auto Discover Object Mapper", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If set to true then Jackson will lookup for an objectMapper into the registry" }, + "schemaResolver": { "kind": "attribute", "displayName": "Schema Resolver", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Optional schema resolver used to lookup schemas for the data in transit." }, + "autoDiscoverSchemaResolver": { "kind": "attribute", "displayName": "Auto Discover Schema Resolver", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "When not disabled, the SchemaResolver will be looked up into the registry" }, + "id": { "kind": "attribute", "displayName": "Id", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The id of this node" } + } +} diff --git a/components-starter/README.adoc b/components-starter/README.adoc index 58e94ea..4668fb2 100644 --- a/components-starter/README.adoc +++ b/components-starter/README.adoc @@ -680,7 +680,7 @@ Number of Camel components: 332 in 268 JAR artifacts (1 deprecated) == Camel Data Formats // dataformats: START -Number of Camel data formats: 46 in 38 JAR artifacts (0 deprecated) +Number of Camel data formats: 48 in 40 JAR artifacts (0 deprecated) [width="100%",cols="4,3,3,3,6",options="header"] |=== @@ -692,6 +692,8 @@ Number of Camel data formats: 46 in 38 JAR artifacts (0 deprecated) | xref:latest@components:dataformats:avro-dataformat.adoc[Avro] | camel-avro-starter | Stable | 2.14 | Serialize and deserialize messages using Apache Avro binary data format. +| xref:latest@components:dataformats:avro-jackson-dataformat.adoc[Avro Jackson] | camel-jackson-avro-starter | Preview | 3.10 | Marshal POJOs to Avro and back using Jackson. + | xref:latest@components:dataformats:barcode-dataformat.adoc[Barcode] | camel-barcode-starter | Stable | 2.14 | Transform strings to various 1D/2D barcode bitmap formats and back. | xref:latest@components:dataformats:base64-dataformat.adoc[Base64] | camel-base64-starter | Stable | 2.11 | Encode and decode data using Base64. @@ -750,6 +752,8 @@ Number of Camel data formats: 46 in 38 JAR artifacts (0 deprecated) | xref:latest@components:dataformats:protobuf-dataformat.adoc[Protobuf] | camel-protobuf-starter | Stable | 2.2 | Serialize and deserialize Java objects using Google's Protocol buffers. +| xref:latest@components:dataformats:protobuf-jackson-dataformat.adoc[Protobuf Jackson] | camel-jackson-protobuf-starter | Preview | 3.10 | Marshal POJOs to Protobuf and back using Jackson. + | xref:latest@components:dataformats:rss-dataformat.adoc[RSS] | camel-rss-starter | Stable | 2.1 | Transform from ROME SyndFeed Java Objects to XML and vice-versa. | xref:latest@components:dataformats:soapjaxb-dataformat.adoc[SOAP] | camel-soap-starter | Stable | 2.3 | Marshal Java objects to SOAP messages and back. diff --git a/components-starter/camel-jackson-avro-starter/pom.xml b/components-starter/camel-jackson-avro-starter/pom.xml new file mode 100644 index 0000000..4202bb0 --- /dev/null +++ b/components-starter/camel-jackson-avro-starter/pom.xml @@ -0,0 +1,48 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +--> +<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> + <modelVersion>4.0.0</modelVersion> + <parent> + <groupId>org.apache.camel.springboot</groupId> + <artifactId>components-starter</artifactId> + <version>3.10.0-SNAPSHOT</version> + </parent> + <artifactId>camel-jackson-avro-starter</artifactId> + <packaging>jar</packaging> + <!-- <name>Camel SB Starters :: Name Here</name>--> + <dependencies> + <dependency> + <groupId>org.springframework.boot</groupId> + <artifactId>spring-boot-starter</artifactId> + <version>${spring-boot-version}</version> + </dependency> + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-jackson-avro</artifactId> + <version>${camel-version}</version> + </dependency> + <!--START OF GENERATED CODE--> + <dependency> + <groupId>org.apache.camel.springboot</groupId> + <artifactId>camel-core-starter</artifactId> + </dependency> + <!--END OF GENERATED CODE--> + </dependencies> +</project> diff --git a/components-starter/camel-jackson-avro-starter/src/main/docs/jackson-avro-starter.adoc b/components-starter/camel-jackson-avro-starter/src/main/docs/jackson-avro-starter.adoc new file mode 100644 index 0000000..719a517 --- /dev/null +++ b/components-starter/camel-jackson-avro-starter/src/main/docs/jackson-avro-starter.adoc @@ -0,0 +1,49 @@ +// spring-boot-auto-configure options: START +:page-partial: +:doctitle: Camel Spring Boot Starter for jackson-avro + +== Spring Boot Auto-Configuration + +When using jackson-avro with Spring Boot make sure to use the following Maven dependency to have support for auto configuration: + +[source,xml] +---- +<dependency> + <groupId>org.apache.camel.springboot</groupId> + <artifactId>camel-jackson-avro-starter</artifactId> + <version>x.x.x</version> + <!-- use the same version as your Camel core version --> +</dependency> +---- + + +The component supports 19 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.dataformat.avro-jackson.allow-jms-type* | Used for JMS users to allow the JMSType header from the JMS spec to specify a FQN classname to use to unmarshal to. | false | Boolean +| *camel.dataformat.avro-jackson.allow-unmarshall-type* | If enabled then Jackson is allowed to attempt to use the CamelJacksonUnmarshalType header during the unmarshalling. This should only be enabled when desired to be used. | false | Boolean +| *camel.dataformat.avro-jackson.auto-discover-object-mapper* | If set to true then Jackson will lookup for an objectMapper into the registry | false | Boolean +| *camel.dataformat.avro-jackson.auto-discover-schema-resolver* | When not disabled, the SchemaResolver will be looked up into the registry | true | Boolean +| *camel.dataformat.avro-jackson.collection-type-name* | Refers to a custom collection type to lookup in the registry to use. This option should rarely be used, but allows to use different collection types than java.util.Collection based as default. | | String +| *camel.dataformat.avro-jackson.content-type-header* | Whether the data format should set the Content-Type header with the type from the data format. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSON | true | Boolean +| *camel.dataformat.avro-jackson.disable-features* | Set of features to disable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma | | String +| *camel.dataformat.avro-jackson.enable-features* | Set of features to enable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma | | String +| *camel.dataformat.avro-jackson.enabled* | Whether to enable auto configuration of the avro-jackson data format. This is enabled by default. | | Boolean +| *camel.dataformat.avro-jackson.include* | If you want to marshal a pojo to JSON, and the pojo has some fields with null values. And you want to skip these null values, you can set this option to NON_NULL | | String +| *camel.dataformat.avro-jackson.json-view-type-name* | When marshalling a POJO to JSON you might want to exclude certain fields from the JSON output. With Jackson you can use JSON views to accomplish this. This option is to refer to the class which has JsonView annotations | | String +| *camel.dataformat.avro-jackson.module-class-names* | To use custom Jackson modules com.fasterxml.jackson.databind.Module specified as a String with FQN class names. Multiple classes can be separated by comma. | | String +| *camel.dataformat.avro-jackson.module-refs* | To use custom Jackson modules referred from the Camel registry. Multiple modules can be separated by comma. | | String +| *camel.dataformat.avro-jackson.object-mapper* | Lookup and use the existing ObjectMapper with the given id when using Jackson. | | String +| *camel.dataformat.avro-jackson.schema-resolver* | Optional schema resolver used to lookup schemas for the data in transit. | | String +| *camel.dataformat.avro-jackson.timezone* | If set then Jackson will use the Timezone when marshalling/unmarshalling. | | String +| *camel.dataformat.avro-jackson.unmarshal-type-name* | Class name of the java type to use when unmarshalling | | String +| *camel.dataformat.avro-jackson.use-default-object-mapper* | Whether to lookup and use default Jackson ObjectMapper from the registry. | true | Boolean +| *camel.dataformat.avro-jackson.use-list* | To unmarshal to a List of Map or a List of Pojo. | false | Boolean +|=== + + +// spring-boot-auto-configure options: END diff --git a/components-starter/camel-jackson-avro-starter/src/main/java/org/apache/camel/component/jackson/avro/springboot/JacksonAvroDataFormatAutoConfiguration.java b/components-starter/camel-jackson-avro-starter/src/main/java/org/apache/camel/component/jackson/avro/springboot/JacksonAvroDataFormatAutoConfiguration.java new file mode 100644 index 0000000..92eea28 --- /dev/null +++ b/components-starter/camel-jackson-avro-starter/src/main/java/org/apache/camel/component/jackson/avro/springboot/JacksonAvroDataFormatAutoConfiguration.java @@ -0,0 +1,80 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.camel.component.jackson.avro.springboot; + +import javax.annotation.Generated; +import org.apache.camel.CamelContext; +import org.apache.camel.component.jackson.avro.JacksonAvroDataFormat; +import org.apache.camel.spi.DataFormat; +import org.apache.camel.spi.DataFormatCustomizer; +import org.apache.camel.spring.boot.CamelAutoConfiguration; +import org.apache.camel.spring.boot.DataFormatConfigurationProperties; +import org.apache.camel.spring.boot.util.CamelPropertiesHelper; +import org.apache.camel.spring.boot.util.ConditionalOnCamelContextAndAutoConfigurationBeans; +import org.apache.camel.spring.boot.util.ConditionalOnHierarchicalProperties; +import org.apache.camel.spring.boot.util.HierarchicalPropertiesEvaluator; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.autoconfigure.AutoConfigureAfter; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.boot.convert.ApplicationConversionService; +import org.springframework.context.ApplicationContext; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Conditional; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.Lazy; + +/** + * Generated by camel-package-maven-plugin - do not edit this file! + */ +@Generated("org.apache.camel.springboot.maven.SpringBootAutoConfigurationMojo") +@Configuration(proxyBeanMethods = false) +@AutoConfigureAfter(CamelAutoConfiguration.class) +@Conditional(ConditionalOnCamelContextAndAutoConfigurationBeans.class) +@EnableConfigurationProperties({DataFormatConfigurationProperties.class,JacksonAvroDataFormatConfiguration.class}) +@ConditionalOnHierarchicalProperties({"camel.dataformat", "camel.dataformat.avro-jackson"}) +public class JacksonAvroDataFormatAutoConfiguration { + + @Autowired + private ApplicationContext applicationContext; + private final CamelContext camelContext; + @Autowired + private JacksonAvroDataFormatConfiguration configuration; + + public JacksonAvroDataFormatAutoConfiguration( + org.apache.camel.CamelContext camelContext) { + this.camelContext = camelContext; + } + + @Lazy + @Bean + public DataFormatCustomizer configureJacksonAvroDataFormatFactory() { + return new DataFormatCustomizer() { + @Override + public void configure(String name, DataFormat target) { + CamelPropertiesHelper.copyProperties(camelContext, configuration, target); + } + @Override + public boolean isEnabled(String name, DataFormat target) { + return HierarchicalPropertiesEvaluator.evaluate( + applicationContext, + "camel.dataformat.customizer", + "camel.dataformat.avro-jackson.customizer") + && target instanceof JacksonAvroDataFormat; + } + }; + } +} \ No newline at end of file diff --git a/components-starter/camel-jackson-avro-starter/src/main/java/org/apache/camel/component/jackson/avro/springboot/JacksonAvroDataFormatConfiguration.java b/components-starter/camel-jackson-avro-starter/src/main/java/org/apache/camel/component/jackson/avro/springboot/JacksonAvroDataFormatConfiguration.java new file mode 100644 index 0000000..89036d5 --- /dev/null +++ b/components-starter/camel-jackson-avro-starter/src/main/java/org/apache/camel/component/jackson/avro/springboot/JacksonAvroDataFormatConfiguration.java @@ -0,0 +1,284 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.camel.component.jackson.avro.springboot; + +import javax.annotation.Generated; +import org.apache.camel.spring.boot.DataFormatConfigurationPropertiesCommon; +import org.springframework.boot.context.properties.ConfigurationProperties; + +/** + * Marshal POJOs to Avro and back using Jackson. + * + * Generated by camel-package-maven-plugin - do not edit this file! + */ +@Generated("org.apache.camel.springboot.maven.SpringBootAutoConfigurationMojo") +@ConfigurationProperties(prefix = "camel.dataformat.avro-jackson") +public class JacksonAvroDataFormatConfiguration + extends + DataFormatConfigurationPropertiesCommon { + + /** + * Whether to enable auto configuration of the avro-jackson data format. + * This is enabled by default. + */ + private Boolean enabled; + /** + * Lookup and use the existing ObjectMapper with the given id when using + * Jackson. + */ + private String objectMapper; + /** + * Whether to lookup and use default Jackson ObjectMapper from the registry. + */ + private Boolean useDefaultObjectMapper = true; + /** + * Class name of the java type to use when unmarshalling + */ + private String unmarshalTypeName; + /** + * When marshalling a POJO to JSON you might want to exclude certain fields + * from the JSON output. With Jackson you can use JSON views to accomplish + * this. This option is to refer to the class which has JsonView annotations + */ + private String jsonViewTypeName; + /** + * If you want to marshal a pojo to JSON, and the pojo has some fields with + * null values. And you want to skip these null values, you can set this + * option to NON_NULL + */ + private String include; + /** + * Used for JMS users to allow the JMSType header from the JMS spec to + * specify a FQN classname to use to unmarshal to. + */ + private Boolean allowJmsType = false; + /** + * Refers to a custom collection type to lookup in the registry to use. This + * option should rarely be used, but allows to use different collection + * types than java.util.Collection based as default. + */ + private String collectionTypeName; + /** + * To unmarshal to a List of Map or a List of Pojo. + */ + private Boolean useList = false; + /** + * To use custom Jackson modules com.fasterxml.jackson.databind.Module + * specified as a String with FQN class names. Multiple classes can be + * separated by comma. + */ + private String moduleClassNames; + /** + * To use custom Jackson modules referred from the Camel registry. Multiple + * modules can be separated by comma. + */ + private String moduleRefs; + /** + * Set of features to enable on the Jackson + * com.fasterxml.jackson.databind.ObjectMapper. The features should be a + * name that matches a enum from + * com.fasterxml.jackson.databind.SerializationFeature, + * com.fasterxml.jackson.databind.DeserializationFeature, or + * com.fasterxml.jackson.databind.MapperFeature Multiple features can be + * separated by comma + */ + private String enableFeatures; + /** + * Set of features to disable on the Jackson + * com.fasterxml.jackson.databind.ObjectMapper. The features should be a + * name that matches a enum from + * com.fasterxml.jackson.databind.SerializationFeature, + * com.fasterxml.jackson.databind.DeserializationFeature, or + * com.fasterxml.jackson.databind.MapperFeature Multiple features can be + * separated by comma + */ + private String disableFeatures; + /** + * If enabled then Jackson is allowed to attempt to use the + * CamelJacksonUnmarshalType header during the unmarshalling. This should + * only be enabled when desired to be used. + */ + private Boolean allowUnmarshallType = false; + /** + * If set then Jackson will use the Timezone when marshalling/unmarshalling. + */ + private String timezone; + /** + * If set to true then Jackson will lookup for an objectMapper into the + * registry + */ + private Boolean autoDiscoverObjectMapper = false; + /** + * Whether the data format should set the Content-Type header with the type + * from the data format. For example application/xml for data formats + * marshalling to XML, or application/json for data formats marshalling to + * JSON + */ + private Boolean contentTypeHeader = true; + /** + * Optional schema resolver used to lookup schemas for the data in transit. + */ + private String schemaResolver; + /** + * When not disabled, the SchemaResolver will be looked up into the registry + */ + private Boolean autoDiscoverSchemaResolver = true; + + public String getObjectMapper() { + return objectMapper; + } + + public void setObjectMapper(String objectMapper) { + this.objectMapper = objectMapper; + } + + public Boolean getUseDefaultObjectMapper() { + return useDefaultObjectMapper; + } + + public void setUseDefaultObjectMapper(Boolean useDefaultObjectMapper) { + this.useDefaultObjectMapper = useDefaultObjectMapper; + } + + public String getUnmarshalTypeName() { + return unmarshalTypeName; + } + + public void setUnmarshalTypeName(String unmarshalTypeName) { + this.unmarshalTypeName = unmarshalTypeName; + } + + public String getJsonViewTypeName() { + return jsonViewTypeName; + } + + public void setJsonViewTypeName(String jsonViewTypeName) { + this.jsonViewTypeName = jsonViewTypeName; + } + + public String getInclude() { + return include; + } + + public void setInclude(String include) { + this.include = include; + } + + public Boolean getAllowJmsType() { + return allowJmsType; + } + + public void setAllowJmsType(Boolean allowJmsType) { + this.allowJmsType = allowJmsType; + } + + public String getCollectionTypeName() { + return collectionTypeName; + } + + public void setCollectionTypeName(String collectionTypeName) { + this.collectionTypeName = collectionTypeName; + } + + public Boolean getUseList() { + return useList; + } + + public void setUseList(Boolean useList) { + this.useList = useList; + } + + public String getModuleClassNames() { + return moduleClassNames; + } + + public void setModuleClassNames(String moduleClassNames) { + this.moduleClassNames = moduleClassNames; + } + + public String getModuleRefs() { + return moduleRefs; + } + + public void setModuleRefs(String moduleRefs) { + this.moduleRefs = moduleRefs; + } + + public String getEnableFeatures() { + return enableFeatures; + } + + public void setEnableFeatures(String enableFeatures) { + this.enableFeatures = enableFeatures; + } + + public String getDisableFeatures() { + return disableFeatures; + } + + public void setDisableFeatures(String disableFeatures) { + this.disableFeatures = disableFeatures; + } + + public Boolean getAllowUnmarshallType() { + return allowUnmarshallType; + } + + public void setAllowUnmarshallType(Boolean allowUnmarshallType) { + this.allowUnmarshallType = allowUnmarshallType; + } + + public String getTimezone() { + return timezone; + } + + public void setTimezone(String timezone) { + this.timezone = timezone; + } + + public Boolean getAutoDiscoverObjectMapper() { + return autoDiscoverObjectMapper; + } + + public void setAutoDiscoverObjectMapper(Boolean autoDiscoverObjectMapper) { + this.autoDiscoverObjectMapper = autoDiscoverObjectMapper; + } + + public Boolean getContentTypeHeader() { + return contentTypeHeader; + } + + public void setContentTypeHeader(Boolean contentTypeHeader) { + this.contentTypeHeader = contentTypeHeader; + } + + public String getSchemaResolver() { + return schemaResolver; + } + + public void setSchemaResolver(String schemaResolver) { + this.schemaResolver = schemaResolver; + } + + public Boolean getAutoDiscoverSchemaResolver() { + return autoDiscoverSchemaResolver; + } + + public void setAutoDiscoverSchemaResolver(Boolean autoDiscoverSchemaResolver) { + this.autoDiscoverSchemaResolver = autoDiscoverSchemaResolver; + } +} \ No newline at end of file diff --git a/components-starter/camel-jackson-avro-starter/src/main/resources/META-INF/LICENSE.txt b/components-starter/camel-jackson-avro-starter/src/main/resources/META-INF/LICENSE.txt new file mode 100644 index 0000000..6b0b127 --- /dev/null +++ b/components-starter/camel-jackson-avro-starter/src/main/resources/META-INF/LICENSE.txt @@ -0,0 +1,203 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/components-starter/camel-jackson-avro-starter/src/main/resources/META-INF/NOTICE.txt b/components-starter/camel-jackson-avro-starter/src/main/resources/META-INF/NOTICE.txt new file mode 100644 index 0000000..2e215bf --- /dev/null +++ b/components-starter/camel-jackson-avro-starter/src/main/resources/META-INF/NOTICE.txt @@ -0,0 +1,11 @@ + ========================================================================= + == NOTICE file corresponding to the section 4 d of == + == the Apache License, Version 2.0, == + == in this case for the Apache Camel distribution. == + ========================================================================= + + This product includes software developed by + The Apache Software Foundation (http://www.apache.org/). + + Please read the different LICENSE files present in the licenses directory of + this distribution. diff --git a/components-starter/camel-jackson-avro-starter/src/main/resources/META-INF/spring.factories b/components-starter/camel-jackson-avro-starter/src/main/resources/META-INF/spring.factories new file mode 100644 index 0000000..b0a0f62 --- /dev/null +++ b/components-starter/camel-jackson-avro-starter/src/main/resources/META-INF/spring.factories @@ -0,0 +1,19 @@ +## --------------------------------------------------------------------------- +## Licensed to the Apache Software Foundation (ASF) under one or more +## contributor license agreements. See the NOTICE file distributed with +## this work for additional information regarding copyright ownership. +## The ASF licenses this file to You under the Apache License, Version 2.0 +## (the "License"); you may not use this file except in compliance with +## the License. You may obtain a copy of the License at +## +## http://www.apache.org/licenses/LICENSE-2.0 +## +## Unless required by applicable law or agreed to in writing, software +## distributed under the License is distributed on an "AS IS" BASIS, +## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +## See the License for the specific language governing permissions and +## limitations under the License. +## --------------------------------------------------------------------------- + +org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ +org.apache.camel.component.jackson.avro.springboot.JacksonAvroDataFormatAutoConfiguration diff --git a/components-starter/camel-jackson-avro-starter/src/main/resources/META-INF/spring.provides b/components-starter/camel-jackson-avro-starter/src/main/resources/META-INF/spring.provides new file mode 100644 index 0000000..b7cb4a2 --- /dev/null +++ b/components-starter/camel-jackson-avro-starter/src/main/resources/META-INF/spring.provides @@ -0,0 +1,17 @@ +## --------------------------------------------------------------------------- +## Licensed to the Apache Software Foundation (ASF) under one or more +## contributor license agreements. See the NOTICE file distributed with +## this work for additional information regarding copyright ownership. +## The ASF licenses this file to You under the Apache License, Version 2.0 +## (the "License"); you may not use this file except in compliance with +## the License. You may obtain a copy of the License at +## +## http://www.apache.org/licenses/LICENSE-2.0 +## +## Unless required by applicable law or agreed to in writing, software +## distributed under the License is distributed on an "AS IS" BASIS, +## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +## See the License for the specific language governing permissions and +## limitations under the License. +## --------------------------------------------------------------------------- +provides: camel-jackson-avro diff --git a/components-starter/camel-jackson-protobuf-starter/pom.xml b/components-starter/camel-jackson-protobuf-starter/pom.xml new file mode 100644 index 0000000..97c116d --- /dev/null +++ b/components-starter/camel-jackson-protobuf-starter/pom.xml @@ -0,0 +1,48 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +--> +<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> + <modelVersion>4.0.0</modelVersion> + <parent> + <groupId>org.apache.camel.springboot</groupId> + <artifactId>components-starter</artifactId> + <version>3.10.0-SNAPSHOT</version> + </parent> + <artifactId>camel-jackson-protobuf-starter</artifactId> + <packaging>jar</packaging> + <!-- <name>Camel SB Starters :: Name Here</name>--> + <dependencies> + <dependency> + <groupId>org.springframework.boot</groupId> + <artifactId>spring-boot-starter</artifactId> + <version>${spring-boot-version}</version> + </dependency> + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-jackson-protobuf</artifactId> + <version>${camel-version}</version> + </dependency> + <!--START OF GENERATED CODE--> + <dependency> + <groupId>org.apache.camel.springboot</groupId> + <artifactId>camel-core-starter</artifactId> + </dependency> + <!--END OF GENERATED CODE--> + </dependencies> +</project> diff --git a/components-starter/camel-jackson-protobuf-starter/src/main/docs/jackson-protobuf-starter.adoc b/components-starter/camel-jackson-protobuf-starter/src/main/docs/jackson-protobuf-starter.adoc new file mode 100644 index 0000000..1835840 --- /dev/null +++ b/components-starter/camel-jackson-protobuf-starter/src/main/docs/jackson-protobuf-starter.adoc @@ -0,0 +1,49 @@ +// spring-boot-auto-configure options: START +:page-partial: +:doctitle: Camel Spring Boot Starter for jackson-protobuf + +== Spring Boot Auto-Configuration + +When using jackson-protobuf with Spring Boot make sure to use the following Maven dependency to have support for auto configuration: + +[source,xml] +---- +<dependency> + <groupId>org.apache.camel.springboot</groupId> + <artifactId>camel-jackson-protobuf-starter</artifactId> + <version>x.x.x</version> + <!-- use the same version as your Camel core version --> +</dependency> +---- + + +The component supports 19 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.dataformat.protobuf-jackson.allow-jms-type* | Used for JMS users to allow the JMSType header from the JMS spec to specify a FQN classname to use to unmarshal to. | false | Boolean +| *camel.dataformat.protobuf-jackson.allow-unmarshall-type* | If enabled then Jackson is allowed to attempt to use the CamelJacksonUnmarshalType header during the unmarshalling. This should only be enabled when desired to be used. | false | Boolean +| *camel.dataformat.protobuf-jackson.auto-discover-object-mapper* | If set to true then Jackson will lookup for an objectMapper into the registry | false | Boolean +| *camel.dataformat.protobuf-jackson.auto-discover-schema-resolver* | When not disabled, the SchemaResolver will be looked up into the registry | true | Boolean +| *camel.dataformat.protobuf-jackson.collection-type-name* | Refers to a custom collection type to lookup in the registry to use. This option should rarely be used, but allows to use different collection types than java.util.Collection based as default. | | String +| *camel.dataformat.protobuf-jackson.content-type-header* | Whether the data format should set the Content-Type header with the type from the data format. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSON | true | Boolean +| *camel.dataformat.protobuf-jackson.disable-features* | Set of features to disable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma | | String +| *camel.dataformat.protobuf-jackson.enable-features* | Set of features to enable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma | | String +| *camel.dataformat.protobuf-jackson.enabled* | Whether to enable auto configuration of the protobuf-jackson data format. This is enabled by default. | | Boolean +| *camel.dataformat.protobuf-jackson.include* | If you want to marshal a pojo to JSON, and the pojo has some fields with null values. And you want to skip these null values, you can set this option to NON_NULL | | String +| *camel.dataformat.protobuf-jackson.json-view-type-name* | When marshalling a POJO to JSON you might want to exclude certain fields from the JSON output. With Jackson you can use JSON views to accomplish this. This option is to refer to the class which has JsonView annotations | | String +| *camel.dataformat.protobuf-jackson.module-class-names* | To use custom Jackson modules com.fasterxml.jackson.databind.Module specified as a String with FQN class names. Multiple classes can be separated by comma. | | String +| *camel.dataformat.protobuf-jackson.module-refs* | To use custom Jackson modules referred from the Camel registry. Multiple modules can be separated by comma. | | String +| *camel.dataformat.protobuf-jackson.object-mapper* | Lookup and use the existing ObjectMapper with the given id when using Jackson. | | String +| *camel.dataformat.protobuf-jackson.schema-resolver* | Optional schema resolver used to lookup schemas for the data in transit. | | String +| *camel.dataformat.protobuf-jackson.timezone* | If set then Jackson will use the Timezone when marshalling/unmarshalling. | | String +| *camel.dataformat.protobuf-jackson.unmarshal-type-name* | Class name of the java type to use when unmarshalling | | String +| *camel.dataformat.protobuf-jackson.use-default-object-mapper* | Whether to lookup and use default Jackson ObjectMapper from the registry. | true | Boolean +| *camel.dataformat.protobuf-jackson.use-list* | To unmarshal to a List of Map or a List of Pojo. | false | Boolean +|=== + + +// spring-boot-auto-configure options: END diff --git a/components-starter/camel-jackson-protobuf-starter/src/main/java/org/apache/camel/component/jackson/protobuf/springboot/JacksonProtobufDataFormatAutoConfiguration.java b/components-starter/camel-jackson-protobuf-starter/src/main/java/org/apache/camel/component/jackson/protobuf/springboot/JacksonProtobufDataFormatAutoConfiguration.java new file mode 100644 index 0000000..679eb8a --- /dev/null +++ b/components-starter/camel-jackson-protobuf-starter/src/main/java/org/apache/camel/component/jackson/protobuf/springboot/JacksonProtobufDataFormatAutoConfiguration.java @@ -0,0 +1,80 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.camel.component.jackson.protobuf.springboot; + +import javax.annotation.Generated; +import org.apache.camel.CamelContext; +import org.apache.camel.component.jackson.protobuf.JacksonProtobufDataFormat; +import org.apache.camel.spi.DataFormat; +import org.apache.camel.spi.DataFormatCustomizer; +import org.apache.camel.spring.boot.CamelAutoConfiguration; +import org.apache.camel.spring.boot.DataFormatConfigurationProperties; +import org.apache.camel.spring.boot.util.CamelPropertiesHelper; +import org.apache.camel.spring.boot.util.ConditionalOnCamelContextAndAutoConfigurationBeans; +import org.apache.camel.spring.boot.util.ConditionalOnHierarchicalProperties; +import org.apache.camel.spring.boot.util.HierarchicalPropertiesEvaluator; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.autoconfigure.AutoConfigureAfter; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.boot.convert.ApplicationConversionService; +import org.springframework.context.ApplicationContext; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Conditional; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.Lazy; + +/** + * Generated by camel-package-maven-plugin - do not edit this file! + */ +@Generated("org.apache.camel.springboot.maven.SpringBootAutoConfigurationMojo") +@Configuration(proxyBeanMethods = false) +@AutoConfigureAfter(CamelAutoConfiguration.class) +@Conditional(ConditionalOnCamelContextAndAutoConfigurationBeans.class) +@EnableConfigurationProperties({DataFormatConfigurationProperties.class,JacksonProtobufDataFormatConfiguration.class}) +@ConditionalOnHierarchicalProperties({"camel.dataformat", "camel.dataformat.protobuf-jackson"}) +public class JacksonProtobufDataFormatAutoConfiguration { + + @Autowired + private ApplicationContext applicationContext; + private final CamelContext camelContext; + @Autowired + private JacksonProtobufDataFormatConfiguration configuration; + + public JacksonProtobufDataFormatAutoConfiguration( + org.apache.camel.CamelContext camelContext) { + this.camelContext = camelContext; + } + + @Lazy + @Bean + public DataFormatCustomizer configureJacksonProtobufDataFormatFactory() { + return new DataFormatCustomizer() { + @Override + public void configure(String name, DataFormat target) { + CamelPropertiesHelper.copyProperties(camelContext, configuration, target); + } + @Override + public boolean isEnabled(String name, DataFormat target) { + return HierarchicalPropertiesEvaluator.evaluate( + applicationContext, + "camel.dataformat.customizer", + "camel.dataformat.protobuf-jackson.customizer") + && target instanceof JacksonProtobufDataFormat; + } + }; + } +} \ No newline at end of file diff --git a/components-starter/camel-jackson-protobuf-starter/src/main/java/org/apache/camel/component/jackson/protobuf/springboot/JacksonProtobufDataFormatConfiguration.java b/components-starter/camel-jackson-protobuf-starter/src/main/java/org/apache/camel/component/jackson/protobuf/springboot/JacksonProtobufDataFormatConfiguration.java new file mode 100644 index 0000000..9d452d4 --- /dev/null +++ b/components-starter/camel-jackson-protobuf-starter/src/main/java/org/apache/camel/component/jackson/protobuf/springboot/JacksonProtobufDataFormatConfiguration.java @@ -0,0 +1,284 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.camel.component.jackson.protobuf.springboot; + +import javax.annotation.Generated; +import org.apache.camel.spring.boot.DataFormatConfigurationPropertiesCommon; +import org.springframework.boot.context.properties.ConfigurationProperties; + +/** + * Marshal POJOs to Protobuf and back using Jackson. + * + * Generated by camel-package-maven-plugin - do not edit this file! + */ +@Generated("org.apache.camel.springboot.maven.SpringBootAutoConfigurationMojo") +@ConfigurationProperties(prefix = "camel.dataformat.protobuf-jackson") +public class JacksonProtobufDataFormatConfiguration + extends + DataFormatConfigurationPropertiesCommon { + + /** + * Whether to enable auto configuration of the protobuf-jackson data format. + * This is enabled by default. + */ + private Boolean enabled; + /** + * Whether the data format should set the Content-Type header with the type + * from the data format. For example application/xml for data formats + * marshalling to XML, or application/json for data formats marshalling to + * JSON + */ + private Boolean contentTypeHeader = true; + /** + * Lookup and use the existing ObjectMapper with the given id when using + * Jackson. + */ + private String objectMapper; + /** + * Whether to lookup and use default Jackson ObjectMapper from the registry. + */ + private Boolean useDefaultObjectMapper = true; + /** + * Class name of the java type to use when unmarshalling + */ + private String unmarshalTypeName; + /** + * When marshalling a POJO to JSON you might want to exclude certain fields + * from the JSON output. With Jackson you can use JSON views to accomplish + * this. This option is to refer to the class which has JsonView annotations + */ + private String jsonViewTypeName; + /** + * If you want to marshal a pojo to JSON, and the pojo has some fields with + * null values. And you want to skip these null values, you can set this + * option to NON_NULL + */ + private String include; + /** + * Used for JMS users to allow the JMSType header from the JMS spec to + * specify a FQN classname to use to unmarshal to. + */ + private Boolean allowJmsType = false; + /** + * Refers to a custom collection type to lookup in the registry to use. This + * option should rarely be used, but allows to use different collection + * types than java.util.Collection based as default. + */ + private String collectionTypeName; + /** + * To unmarshal to a List of Map or a List of Pojo. + */ + private Boolean useList = false; + /** + * To use custom Jackson modules com.fasterxml.jackson.databind.Module + * specified as a String with FQN class names. Multiple classes can be + * separated by comma. + */ + private String moduleClassNames; + /** + * To use custom Jackson modules referred from the Camel registry. Multiple + * modules can be separated by comma. + */ + private String moduleRefs; + /** + * Set of features to enable on the Jackson + * com.fasterxml.jackson.databind.ObjectMapper. The features should be a + * name that matches a enum from + * com.fasterxml.jackson.databind.SerializationFeature, + * com.fasterxml.jackson.databind.DeserializationFeature, or + * com.fasterxml.jackson.databind.MapperFeature Multiple features can be + * separated by comma + */ + private String enableFeatures; + /** + * Set of features to disable on the Jackson + * com.fasterxml.jackson.databind.ObjectMapper. The features should be a + * name that matches a enum from + * com.fasterxml.jackson.databind.SerializationFeature, + * com.fasterxml.jackson.databind.DeserializationFeature, or + * com.fasterxml.jackson.databind.MapperFeature Multiple features can be + * separated by comma + */ + private String disableFeatures; + /** + * If enabled then Jackson is allowed to attempt to use the + * CamelJacksonUnmarshalType header during the unmarshalling. This should + * only be enabled when desired to be used. + */ + private Boolean allowUnmarshallType = false; + /** + * If set then Jackson will use the Timezone when marshalling/unmarshalling. + */ + private String timezone; + /** + * If set to true then Jackson will lookup for an objectMapper into the + * registry + */ + private Boolean autoDiscoverObjectMapper = false; + /** + * Optional schema resolver used to lookup schemas for the data in transit. + */ + private String schemaResolver; + /** + * When not disabled, the SchemaResolver will be looked up into the registry + */ + private Boolean autoDiscoverSchemaResolver = true; + + public Boolean getContentTypeHeader() { + return contentTypeHeader; + } + + public void setContentTypeHeader(Boolean contentTypeHeader) { + this.contentTypeHeader = contentTypeHeader; + } + + public String getObjectMapper() { + return objectMapper; + } + + public void setObjectMapper(String objectMapper) { + this.objectMapper = objectMapper; + } + + public Boolean getUseDefaultObjectMapper() { + return useDefaultObjectMapper; + } + + public void setUseDefaultObjectMapper(Boolean useDefaultObjectMapper) { + this.useDefaultObjectMapper = useDefaultObjectMapper; + } + + public String getUnmarshalTypeName() { + return unmarshalTypeName; + } + + public void setUnmarshalTypeName(String unmarshalTypeName) { + this.unmarshalTypeName = unmarshalTypeName; + } + + public String getJsonViewTypeName() { + return jsonViewTypeName; + } + + public void setJsonViewTypeName(String jsonViewTypeName) { + this.jsonViewTypeName = jsonViewTypeName; + } + + public String getInclude() { + return include; + } + + public void setInclude(String include) { + this.include = include; + } + + public Boolean getAllowJmsType() { + return allowJmsType; + } + + public void setAllowJmsType(Boolean allowJmsType) { + this.allowJmsType = allowJmsType; + } + + public String getCollectionTypeName() { + return collectionTypeName; + } + + public void setCollectionTypeName(String collectionTypeName) { + this.collectionTypeName = collectionTypeName; + } + + public Boolean getUseList() { + return useList; + } + + public void setUseList(Boolean useList) { + this.useList = useList; + } + + public String getModuleClassNames() { + return moduleClassNames; + } + + public void setModuleClassNames(String moduleClassNames) { + this.moduleClassNames = moduleClassNames; + } + + public String getModuleRefs() { + return moduleRefs; + } + + public void setModuleRefs(String moduleRefs) { + this.moduleRefs = moduleRefs; + } + + public String getEnableFeatures() { + return enableFeatures; + } + + public void setEnableFeatures(String enableFeatures) { + this.enableFeatures = enableFeatures; + } + + public String getDisableFeatures() { + return disableFeatures; + } + + public void setDisableFeatures(String disableFeatures) { + this.disableFeatures = disableFeatures; + } + + public Boolean getAllowUnmarshallType() { + return allowUnmarshallType; + } + + public void setAllowUnmarshallType(Boolean allowUnmarshallType) { + this.allowUnmarshallType = allowUnmarshallType; + } + + public String getTimezone() { + return timezone; + } + + public void setTimezone(String timezone) { + this.timezone = timezone; + } + + public Boolean getAutoDiscoverObjectMapper() { + return autoDiscoverObjectMapper; + } + + public void setAutoDiscoverObjectMapper(Boolean autoDiscoverObjectMapper) { + this.autoDiscoverObjectMapper = autoDiscoverObjectMapper; + } + + public String getSchemaResolver() { + return schemaResolver; + } + + public void setSchemaResolver(String schemaResolver) { + this.schemaResolver = schemaResolver; + } + + public Boolean getAutoDiscoverSchemaResolver() { + return autoDiscoverSchemaResolver; + } + + public void setAutoDiscoverSchemaResolver(Boolean autoDiscoverSchemaResolver) { + this.autoDiscoverSchemaResolver = autoDiscoverSchemaResolver; + } +} \ No newline at end of file diff --git a/components-starter/camel-jackson-protobuf-starter/src/main/resources/META-INF/LICENSE.txt b/components-starter/camel-jackson-protobuf-starter/src/main/resources/META-INF/LICENSE.txt new file mode 100644 index 0000000..6b0b127 --- /dev/null +++ b/components-starter/camel-jackson-protobuf-starter/src/main/resources/META-INF/LICENSE.txt @@ -0,0 +1,203 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/components-starter/camel-jackson-protobuf-starter/src/main/resources/META-INF/NOTICE.txt b/components-starter/camel-jackson-protobuf-starter/src/main/resources/META-INF/NOTICE.txt new file mode 100644 index 0000000..2e215bf --- /dev/null +++ b/components-starter/camel-jackson-protobuf-starter/src/main/resources/META-INF/NOTICE.txt @@ -0,0 +1,11 @@ + ========================================================================= + == NOTICE file corresponding to the section 4 d of == + == the Apache License, Version 2.0, == + == in this case for the Apache Camel distribution. == + ========================================================================= + + This product includes software developed by + The Apache Software Foundation (http://www.apache.org/). + + Please read the different LICENSE files present in the licenses directory of + this distribution. diff --git a/components-starter/camel-jackson-protobuf-starter/src/main/resources/META-INF/spring.factories b/components-starter/camel-jackson-protobuf-starter/src/main/resources/META-INF/spring.factories new file mode 100644 index 0000000..8da36d9 --- /dev/null +++ b/components-starter/camel-jackson-protobuf-starter/src/main/resources/META-INF/spring.factories @@ -0,0 +1,19 @@ +## --------------------------------------------------------------------------- +## Licensed to the Apache Software Foundation (ASF) under one or more +## contributor license agreements. See the NOTICE file distributed with +## this work for additional information regarding copyright ownership. +## The ASF licenses this file to You under the Apache License, Version 2.0 +## (the "License"); you may not use this file except in compliance with +## the License. You may obtain a copy of the License at +## +## http://www.apache.org/licenses/LICENSE-2.0 +## +## Unless required by applicable law or agreed to in writing, software +## distributed under the License is distributed on an "AS IS" BASIS, +## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +## See the License for the specific language governing permissions and +## limitations under the License. +## --------------------------------------------------------------------------- + +org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ +org.apache.camel.component.jackson.protobuf.springboot.JacksonProtobufDataFormatAutoConfiguration diff --git a/components-starter/camel-jackson-protobuf-starter/src/main/resources/META-INF/spring.provides b/components-starter/camel-jackson-protobuf-starter/src/main/resources/META-INF/spring.provides new file mode 100644 index 0000000..29934d3 --- /dev/null +++ b/components-starter/camel-jackson-protobuf-starter/src/main/resources/META-INF/spring.provides @@ -0,0 +1,17 @@ +## --------------------------------------------------------------------------- +## Licensed to the Apache Software Foundation (ASF) under one or more +## contributor license agreements. See the NOTICE file distributed with +## this work for additional information regarding copyright ownership. +## The ASF licenses this file to You under the Apache License, Version 2.0 +## (the "License"); you may not use this file except in compliance with +## the License. You may obtain a copy of the License at +## +## http://www.apache.org/licenses/LICENSE-2.0 +## +## Unless required by applicable law or agreed to in writing, software +## distributed under the License is distributed on an "AS IS" BASIS, +## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +## See the License for the specific language governing permissions and +## limitations under the License. +## --------------------------------------------------------------------------- +provides: camel-jackson-protobuf diff --git a/components-starter/pom.xml b/components-starter/pom.xml index 0a1b483..54be78b 100644 --- a/components-starter/pom.xml +++ b/components-starter/pom.xml @@ -257,6 +257,8 @@ <module>camel-ipfs-starter</module> <module>camel-irc-starter</module> <module>camel-ironmq-starter</module> + <module>camel-jackson-avro-starter</module> + <module>camel-jackson-protobuf-starter</module> <module>camel-jackson-starter</module> <module>camel-jacksonxml-starter</module> <module>camel-jasypt-starter</module> diff --git a/docs/modules/ROOT/pages/jackson-avro-starter.adoc b/docs/modules/ROOT/pages/jackson-avro-starter.adoc new file mode 100644 index 0000000..719a517 --- /dev/null +++ b/docs/modules/ROOT/pages/jackson-avro-starter.adoc @@ -0,0 +1,49 @@ +// spring-boot-auto-configure options: START +:page-partial: +:doctitle: Camel Spring Boot Starter for jackson-avro + +== Spring Boot Auto-Configuration + +When using jackson-avro with Spring Boot make sure to use the following Maven dependency to have support for auto configuration: + +[source,xml] +---- +<dependency> + <groupId>org.apache.camel.springboot</groupId> + <artifactId>camel-jackson-avro-starter</artifactId> + <version>x.x.x</version> + <!-- use the same version as your Camel core version --> +</dependency> +---- + + +The component supports 19 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.dataformat.avro-jackson.allow-jms-type* | Used for JMS users to allow the JMSType header from the JMS spec to specify a FQN classname to use to unmarshal to. | false | Boolean +| *camel.dataformat.avro-jackson.allow-unmarshall-type* | If enabled then Jackson is allowed to attempt to use the CamelJacksonUnmarshalType header during the unmarshalling. This should only be enabled when desired to be used. | false | Boolean +| *camel.dataformat.avro-jackson.auto-discover-object-mapper* | If set to true then Jackson will lookup for an objectMapper into the registry | false | Boolean +| *camel.dataformat.avro-jackson.auto-discover-schema-resolver* | When not disabled, the SchemaResolver will be looked up into the registry | true | Boolean +| *camel.dataformat.avro-jackson.collection-type-name* | Refers to a custom collection type to lookup in the registry to use. This option should rarely be used, but allows to use different collection types than java.util.Collection based as default. | | String +| *camel.dataformat.avro-jackson.content-type-header* | Whether the data format should set the Content-Type header with the type from the data format. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSON | true | Boolean +| *camel.dataformat.avro-jackson.disable-features* | Set of features to disable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma | | String +| *camel.dataformat.avro-jackson.enable-features* | Set of features to enable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma | | String +| *camel.dataformat.avro-jackson.enabled* | Whether to enable auto configuration of the avro-jackson data format. This is enabled by default. | | Boolean +| *camel.dataformat.avro-jackson.include* | If you want to marshal a pojo to JSON, and the pojo has some fields with null values. And you want to skip these null values, you can set this option to NON_NULL | | String +| *camel.dataformat.avro-jackson.json-view-type-name* | When marshalling a POJO to JSON you might want to exclude certain fields from the JSON output. With Jackson you can use JSON views to accomplish this. This option is to refer to the class which has JsonView annotations | | String +| *camel.dataformat.avro-jackson.module-class-names* | To use custom Jackson modules com.fasterxml.jackson.databind.Module specified as a String with FQN class names. Multiple classes can be separated by comma. | | String +| *camel.dataformat.avro-jackson.module-refs* | To use custom Jackson modules referred from the Camel registry. Multiple modules can be separated by comma. | | String +| *camel.dataformat.avro-jackson.object-mapper* | Lookup and use the existing ObjectMapper with the given id when using Jackson. | | String +| *camel.dataformat.avro-jackson.schema-resolver* | Optional schema resolver used to lookup schemas for the data in transit. | | String +| *camel.dataformat.avro-jackson.timezone* | If set then Jackson will use the Timezone when marshalling/unmarshalling. | | String +| *camel.dataformat.avro-jackson.unmarshal-type-name* | Class name of the java type to use when unmarshalling | | String +| *camel.dataformat.avro-jackson.use-default-object-mapper* | Whether to lookup and use default Jackson ObjectMapper from the registry. | true | Boolean +| *camel.dataformat.avro-jackson.use-list* | To unmarshal to a List of Map or a List of Pojo. | false | Boolean +|=== + + +// spring-boot-auto-configure options: END diff --git a/docs/modules/ROOT/pages/jackson-protobuf-starter.adoc b/docs/modules/ROOT/pages/jackson-protobuf-starter.adoc new file mode 100644 index 0000000..1835840 --- /dev/null +++ b/docs/modules/ROOT/pages/jackson-protobuf-starter.adoc @@ -0,0 +1,49 @@ +// spring-boot-auto-configure options: START +:page-partial: +:doctitle: Camel Spring Boot Starter for jackson-protobuf + +== Spring Boot Auto-Configuration + +When using jackson-protobuf with Spring Boot make sure to use the following Maven dependency to have support for auto configuration: + +[source,xml] +---- +<dependency> + <groupId>org.apache.camel.springboot</groupId> + <artifactId>camel-jackson-protobuf-starter</artifactId> + <version>x.x.x</version> + <!-- use the same version as your Camel core version --> +</dependency> +---- + + +The component supports 19 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.dataformat.protobuf-jackson.allow-jms-type* | Used for JMS users to allow the JMSType header from the JMS spec to specify a FQN classname to use to unmarshal to. | false | Boolean +| *camel.dataformat.protobuf-jackson.allow-unmarshall-type* | If enabled then Jackson is allowed to attempt to use the CamelJacksonUnmarshalType header during the unmarshalling. This should only be enabled when desired to be used. | false | Boolean +| *camel.dataformat.protobuf-jackson.auto-discover-object-mapper* | If set to true then Jackson will lookup for an objectMapper into the registry | false | Boolean +| *camel.dataformat.protobuf-jackson.auto-discover-schema-resolver* | When not disabled, the SchemaResolver will be looked up into the registry | true | Boolean +| *camel.dataformat.protobuf-jackson.collection-type-name* | Refers to a custom collection type to lookup in the registry to use. This option should rarely be used, but allows to use different collection types than java.util.Collection based as default. | | String +| *camel.dataformat.protobuf-jackson.content-type-header* | Whether the data format should set the Content-Type header with the type from the data format. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSON | true | Boolean +| *camel.dataformat.protobuf-jackson.disable-features* | Set of features to disable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma | | String +| *camel.dataformat.protobuf-jackson.enable-features* | Set of features to enable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma | | String +| *camel.dataformat.protobuf-jackson.enabled* | Whether to enable auto configuration of the protobuf-jackson data format. This is enabled by default. | | Boolean +| *camel.dataformat.protobuf-jackson.include* | If you want to marshal a pojo to JSON, and the pojo has some fields with null values. And you want to skip these null values, you can set this option to NON_NULL | | String +| *camel.dataformat.protobuf-jackson.json-view-type-name* | When marshalling a POJO to JSON you might want to exclude certain fields from the JSON output. With Jackson you can use JSON views to accomplish this. This option is to refer to the class which has JsonView annotations | | String +| *camel.dataformat.protobuf-jackson.module-class-names* | To use custom Jackson modules com.fasterxml.jackson.databind.Module specified as a String with FQN class names. Multiple classes can be separated by comma. | | String +| *camel.dataformat.protobuf-jackson.module-refs* | To use custom Jackson modules referred from the Camel registry. Multiple modules can be separated by comma. | | String +| *camel.dataformat.protobuf-jackson.object-mapper* | Lookup and use the existing ObjectMapper with the given id when using Jackson. | | String +| *camel.dataformat.protobuf-jackson.schema-resolver* | Optional schema resolver used to lookup schemas for the data in transit. | | String +| *camel.dataformat.protobuf-jackson.timezone* | If set then Jackson will use the Timezone when marshalling/unmarshalling. | | String +| *camel.dataformat.protobuf-jackson.unmarshal-type-name* | Class name of the java type to use when unmarshalling | | String +| *camel.dataformat.protobuf-jackson.use-default-object-mapper* | Whether to lookup and use default Jackson ObjectMapper from the registry. | true | Boolean +| *camel.dataformat.protobuf-jackson.use-list* | To unmarshal to a List of Map or a List of Pojo. | false | Boolean +|=== + + +// spring-boot-auto-configure options: END diff --git a/docs/modules/ROOT/pages/list.adoc b/docs/modules/ROOT/pages/list.adoc index 58e94ea..4668fb2 100644 --- a/docs/modules/ROOT/pages/list.adoc +++ b/docs/modules/ROOT/pages/list.adoc @@ -680,7 +680,7 @@ Number of Camel components: 332 in 268 JAR artifacts (1 deprecated) == Camel Data Formats // dataformats: START -Number of Camel data formats: 46 in 38 JAR artifacts (0 deprecated) +Number of Camel data formats: 48 in 40 JAR artifacts (0 deprecated) [width="100%",cols="4,3,3,3,6",options="header"] |=== @@ -692,6 +692,8 @@ Number of Camel data formats: 46 in 38 JAR artifacts (0 deprecated) | xref:latest@components:dataformats:avro-dataformat.adoc[Avro] | camel-avro-starter | Stable | 2.14 | Serialize and deserialize messages using Apache Avro binary data format. +| xref:latest@components:dataformats:avro-jackson-dataformat.adoc[Avro Jackson] | camel-jackson-avro-starter | Preview | 3.10 | Marshal POJOs to Avro and back using Jackson. + | xref:latest@components:dataformats:barcode-dataformat.adoc[Barcode] | camel-barcode-starter | Stable | 2.14 | Transform strings to various 1D/2D barcode bitmap formats and back. | xref:latest@components:dataformats:base64-dataformat.adoc[Base64] | camel-base64-starter | Stable | 2.11 | Encode and decode data using Base64. @@ -750,6 +752,8 @@ Number of Camel data formats: 46 in 38 JAR artifacts (0 deprecated) | xref:latest@components:dataformats:protobuf-dataformat.adoc[Protobuf] | camel-protobuf-starter | Stable | 2.2 | Serialize and deserialize Java objects using Google's Protocol buffers. +| xref:latest@components:dataformats:protobuf-jackson-dataformat.adoc[Protobuf Jackson] | camel-jackson-protobuf-starter | Preview | 3.10 | Marshal POJOs to Protobuf and back using Jackson. + | xref:latest@components:dataformats:rss-dataformat.adoc[RSS] | camel-rss-starter | Stable | 2.1 | Transform from ROME SyndFeed Java Objects to XML and vice-versa. | xref:latest@components:dataformats:soapjaxb-dataformat.adoc[SOAP] | camel-soap-starter | Stable | 2.3 | Marshal Java objects to SOAP messages and back. diff --git a/tooling/camel-spring-boot-bom/pom.xml b/tooling/camel-spring-boot-bom/pom.xml index 370f6a1..d86bd46 100644 --- a/tooling/camel-spring-boot-bom/pom.xml +++ b/tooling/camel-spring-boot-bom/pom.xml @@ -775,6 +775,16 @@ </dependency> <dependency> <groupId>org.apache.camel.springboot</groupId> + <artifactId>camel-jackson-avro-starter</artifactId> + <version>${project.version}</version> + </dependency> + <dependency> + <groupId>org.apache.camel.springboot</groupId> + <artifactId>camel-jackson-protobuf-starter</artifactId> + <version>${project.version}</version> + </dependency> + <dependency> + <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-jackson-starter</artifactId> <version>${project.version}</version> </dependency> diff --git a/tooling/camel-spring-boot-dependencies/pom.xml b/tooling/camel-spring-boot-dependencies/pom.xml index 38ba6e7..2d93eb9 100644 --- a/tooling/camel-spring-boot-dependencies/pom.xml +++ b/tooling/camel-spring-boot-dependencies/pom.xml @@ -1148,6 +1148,16 @@ </dependency> <dependency> <groupId>org.apache.camel.springboot</groupId> + <artifactId>camel-jackson-avro-starter</artifactId> + <version>${project.version}</version> + </dependency> + <dependency> + <groupId>org.apache.camel.springboot</groupId> + <artifactId>camel-jackson-protobuf-starter</artifactId> + <version>${project.version}</version> + </dependency> + <dependency> + <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-jackson-starter</artifactId> <version>${project.version}</version> </dependency>