This is an automated email from the ASF dual-hosted git repository. acosentino pushed a commit to branch apicurio-archetype in repository https://gitbox.apache.org/repos/asf/camel-kafka-connector.git
commit de0c72bbd113ca3a4d6e98b78cc134331cdf2f53 Author: Andrea Cosentino <[email protected]> AuthorDate: Tue Dec 1 08:07:03 2020 +0100 Added docs for Apicurio archetype --- .../ROOT/pages/archetype-apicurio-connector.adoc | 189 +++++++++++++++++++++ 1 file changed, 189 insertions(+) diff --git a/docs/modules/ROOT/pages/archetype-apicurio-connector.adoc b/docs/modules/ROOT/pages/archetype-apicurio-connector.adoc new file mode 100644 index 0000000..83e4462 --- /dev/null +++ b/docs/modules/ROOT/pages/archetype-apicurio-connector.adoc @@ -0,0 +1,189 @@ +[[ArchetypeApicurioConnector-ArchetypeApicurioConnector]] += Apicurio connector Archetypes + +In camel-kafka-connector we provide the camel-kafka-connector-extensible-apicurio-archetype for extending the features of a connector with a apicurio bits and make it extensible. + +You can create a camel-kafka-connector project ready to be extended. + +You can do that through the following command. + +[source,bash] +---- +> mvn archetype:generate -DarchetypeGroupId=org.apache.camel.kafkaconnector.archetypes -DarchetypeArtifactId=camel-kafka-connector-extensible-apicurio-archetype -DarchetypeVersion=0.7.0-SNAPSHOT +[INFO] Scanning for projects... +[INFO] +[INFO] ------------------< org.apache.maven:standalone-pom >------------------- +[INFO] Building Maven Stub Project (No POM) 1 +[INFO] --------------------------------[ pom ]--------------------------------- +[INFO] +[INFO] >>> maven-archetype-plugin:3.1.2:generate (default-cli) > generate-sources @ standalone-pom >>> +[INFO] +[INFO] <<< maven-archetype-plugin:3.1.2:generate (default-cli) < generate-sources @ standalone-pom <<< +[INFO] +[INFO] +[INFO] --- maven-archetype-plugin:3.1.2:generate (default-cli) @ standalone-pom --- +[INFO] Generating project in Interactive mode +[INFO] Archetype repository not defined. Using the one from [org.apache.camel.kafkaconnector.archetypes:camel-kafka-connector-extensible-apicurio-archetype:0.7.0-SNAPSHOT] found in catalog local +Define value for property 'groupId': org.apache.camel.kafkaconnector.extended +Define value for property 'artifactId': myconnector-extended +Define value for property 'version' 1.0-SNAPSHOT: : +Define value for property 'package' org.apache.camel.kafkaconnector.extended: : +Define value for property 'camel-kafka-connector-name': camel-aws2-s3-kafka-connector +[INFO] Using property: camel-kafka-connector-version = 0.7.0-SNAPSHOT +Confirm properties configuration: +groupId: org.apache.camel.kafkaconnector.extended +artifactId: myconnector-extended +version: 1.0-SNAPSHOT +package: org.apache.camel.kafkaconnector.extended +camel-kafka-connector-name: camel-aws2-s3-kafka-connector +camel-kafka-connector-version: 0.7.0-SNAPSHOT + Y: : Y +[INFO] ---------------------------------------------------------------------------- +[INFO] Using following parameters for creating project from Archetype: camel-kafka-connector-extensible-apicurio-archetype:0.7.0-SNAPSHOT +[INFO] ---------------------------------------------------------------------------- +[INFO] Parameter: groupId, Value: org.apache.camel.kafkaconnector.extended +[INFO] Parameter: artifactId, Value: myconnector-extended +[INFO] Parameter: version, Value: 1.0-SNAPSHOT +[INFO] Parameter: package, Value: org.apache.camel.kafkaconnector.extended +[INFO] Parameter: packageInPathFormat, Value: org/apache/camel/kafkaconnector/extended +[INFO] Parameter: package, Value: org.apache.camel.kafkaconnector.extended +[INFO] Parameter: version, Value: 1.0-SNAPSHOT +[INFO] Parameter: groupId, Value: org.apache.camel.kafkaconnector.extended +[INFO] Parameter: camel-kafka-connector-name, Value: camel-aws2-s3-kafka-connector +[INFO] Parameter: camel-kafka-connector-version, Value: 0.7.0-SNAPSHOT +[INFO] Parameter: artifactId, Value: myconnector-extended +[INFO] Project created from Archetype in dir: /home/workspace/myconnector-extended +[INFO] ------------------------------------------------------------------------ +[INFO] BUILD SUCCESS +[INFO] ------------------------------------------------------------------------ +[INFO] Total time: 30.376 s +[INFO] Finished at: 2020-12-01T08:01:09+01:00 +[INFO] ------------------------------------------------------------------------ +---- + +In the pom of the created project you can add the dependencies you need. + +This is the resulting POM + +[source,xml] +---- +<?xml version="1.0" encoding="UTF-8"?> +<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.kafkaconnector</groupId> + <artifactId>parent</artifactId> + <version>0.7.0-SNAPSHOT</version> + </parent> + + <groupId>org.apache.camel.kafkaconnector.extended</groupId> + <artifactId>myconnector-extended</artifactId> + <packaging>jar</packaging> + <version>1.0-SNAPSHOT</version> + + <name>A Camel Kafka Connector extended</name> + + <properties> + <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> + <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding> + <camel-kafka-connector-version>${project.version}</camel-kafka-connector-version> + <apicurio.registry.version>1.3.1.Final</apicurio.registry.version> + <resteasy.version>4.5.6.Final</resteasy.version> + </properties> + + <dependencies> + <dependency> + <groupId>org.apache.kafka</groupId> + <artifactId>connect-api</artifactId> + <scope>provided</scope> + <version>${kafka.version}</version> + </dependency> + <dependency> + <groupId>org.apache.kafka</groupId> + <artifactId>connect-transforms</artifactId> + <scope>provided</scope> + <version>${kafka.version}</version> + </dependency> + <dependency> + <groupId>org.apache.camel.kafkaconnector</groupId> + <artifactId>camel-kafka-connector</artifactId> + <version>0.7.0-SNAPSHOT</version> + </dependency> + <dependency> + <groupId>org.apache.camel.kafkaconnector</groupId> + <artifactId>camel-aws2-s3-kafka-connector</artifactId> + <version>0.7.0-SNAPSHOT</version> + </dependency> + <dependency> + <groupId>org.jboss.resteasy</groupId> + <artifactId>resteasy-client</artifactId> + <version>${resteasy.version}</version> + </dependency> + <dependency> + <groupId>io.apicurio</groupId> + <artifactId>apicurio-registry-rest-client</artifactId> + <version>${apicurio.registry.version}</version> + </dependency> + <!-- Add your optional dependencies here --> + </dependencies> + <build> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-surefire-plugin</artifactId> + <version>3.0.0-M4</version> + <configuration> + <failIfNoTests>false</failIfNoTests> + </configuration> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-jar-plugin</artifactId> + <version>3.1.0</version> + <configuration> + <archive> + <manifest> + <addDefaultImplementationEntries>true</addDefaultImplementationEntries> + <addDefaultSpecificationEntries>true</addDefaultSpecificationEntries> + </manifest> + </archive> + </configuration> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-compiler-plugin</artifactId> + <version>2.5.1</version> + <inherited>true</inherited> + <configuration> + <source>1.8</source> + <target>1.8</target> + </configuration> + </plugin> + <plugin> + <artifactId>maven-assembly-plugin</artifactId> + <version>2.5.3</version> + <configuration> + <descriptors> + <descriptor>src/main/assembly/package.xml</descriptor> + </descriptors> + </configuration> + <executions> + <execution> + <id>make-assembly</id> + <phase>package</phase> + <goals> + <goal>single</goal> + </goals> + </execution> + </executions> + </plugin> + </plugins> + </build> + +</project> +---- + +Now, you are able to add whatever you need in the project, at the end you'll need just to build and you'll get a zipped or tar.gz connector.
