You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2020/09/07 07:40:56 UTC
[camel] branch master updated: CAMEL-15478: camel-as2 uses
javasource parser instead of javadoc for generating api component source
code.
This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/master by this push:
new b0f308e CAMEL-15478: camel-as2 uses javasource parser instead of javadoc for generating api component source code.
b0f308e is described below
commit b0f308e26ac0a99cfc718dff0519ce26fb3396f0
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Mon Sep 7 09:38:19 2020 +0200
CAMEL-15478: camel-as2 uses javasource parser instead of javadoc for generating api component source code.
---
components/camel-as2/camel-as2-api/pom.xml | 45 +++-------------------
components/camel-as2/camel-as2-component/pom.xml | 28 +++++++-------
.../as2/AS2ClientManagerEndpointConfiguration.java | 16 ++++----
.../org/apache/camel/component/as2/as2.json | 2 +-
.../src/main/docs/as2-component.adoc | 16 ++++----
5 files changed, 37 insertions(+), 70 deletions(-)
diff --git a/components/camel-as2/camel-as2-api/pom.xml b/components/camel-as2/camel-as2-api/pom.xml
index 1760923..ee3b7e0 100644
--- a/components/camel-as2/camel-as2-api/pom.xml
+++ b/components/camel-as2/camel-as2-api/pom.xml
@@ -27,7 +27,6 @@
</parent>
<artifactId>camel-as2-api</artifactId>
-
<name>Camel :: AS2 :: API</name>
<description>Camel AS2 API</description>
@@ -84,54 +83,22 @@
</dependencies>
<build>
- <defaultGoal>install</defaultGoal>
<plugins>
-
- <!-- to generate API Javadoc -->
<plugin>
- <groupId>org.apache.camel</groupId>
- <artifactId>camel-javadoc-plugin</artifactId>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-source-plugin</artifactId>
+ <version>3.2.1</version>
<executions>
<execution>
- <id>add-javadoc</id>
- <phase>generate-test-resources</phase>
+ <id>attach-sources</id>
+ <phase>verify</phase>
<goals>
- <goal>jar</goal>
+ <goal>jar-no-fork</goal>
</goals>
- <configuration>
- <attach>true</attach>
- <source>${jdk.version}</source>
- <quiet>true</quiet>
- <detectOfflineLinks>false</detectOfflineLinks>
- <javadocVersion>1.8.0</javadocVersion>
- <encoding>UTF-8</encoding>
- <locale>en</locale>
- </configuration>
</execution>
</executions>
</plugin>
-
</plugins>
</build>
- <!-- Disable Java 8 doclint checks to avoid Javadoc plugin failures -->
- <profiles>
- <profile>
- <id>doclint-java8-disable</id>
- <activation>
- <jdk>[1.8,</jdk>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <configuration>
- <additionalparam>-Xdoclint:none</additionalparam>
- </configuration>
- </plugin>
- </plugins>
- </build>
- </profile>
- </profiles>
</project>
diff --git a/components/camel-as2/camel-as2-component/pom.xml b/components/camel-as2/camel-as2-component/pom.xml
index 7905730..5c006b4 100644
--- a/components/camel-as2/camel-as2-component/pom.xml
+++ b/components/camel-as2/camel-as2-component/pom.xml
@@ -53,15 +53,6 @@
<version>${project.version}</version>
</dependency>
- <!-- Component API javadoc in provided scope to read API signatures -->
- <dependency>
- <groupId>org.apache.camel</groupId>
- <artifactId>camel-as2-api</artifactId>
- <version>${project.version}</version>
- <type>javadoc</type>
- <scope>provided</scope>
- </dependency>
-
<!-- testing -->
<dependency>
<groupId>org.apache.camel</groupId>
@@ -110,11 +101,11 @@
<api>
<apiName>client</apiName>
<proxyClass>org.apache.camel.component.as2.api.AS2ClientManager</proxyClass>
- <fromJavadoc>
+ <fromJavasource>
<excludeMethods>
createSigningGenerator|createEncryptingGenerator|createCompressorGenerator|createEncryptor|createCompressor
</excludeMethods>
- </fromJavadoc>
+ </fromJavasource>
<nullableOptions>
<nullableOption>ediMessageTransferEncoding</nullableOption>
<nullableOption>signingAlgorithm</nullableOption>
@@ -130,9 +121,9 @@
<api>
<apiName>server</apiName>
<proxyClass>org.apache.camel.component.as2.api.AS2ServerManager</proxyClass>
- <fromJavadoc>
+ <fromJavasource>
<excludeMethods>stopListening|handleMDNResponse</excludeMethods>
- </fromJavadoc>
+ </fromJavasource>
<excludeConfigNames>handler</excludeConfigNames>
<!-- <nullableOptions>
<nullableOption>decryptingPrivateKey</nullableOption>
@@ -145,13 +136,22 @@
<excludeConfigNames />
<excludeConfigTypes />
<extraOptions />
- <fromJavadoc />
+ <fromJavasource />
<aliases />
<nullableOptions />
-->
</configuration>
</execution>
</executions>
+ <dependencies>
+ <!-- Component API to read API signatures -->
+ <dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-as2-api</artifactId>
+ <version>${project.version}</version>
+ <classifier>sources</classifier>
+ </dependency>
+ </dependencies>
</plugin>
<plugin>
<!-- we need to generate additional configurer classes -->
diff --git a/components/camel-as2/camel-as2-component/src/generated/java/org/apache/camel/component/as2/AS2ClientManagerEndpointConfiguration.java b/components/camel-as2/camel-as2-component/src/generated/java/org/apache/camel/component/as2/AS2ClientManagerEndpointConfiguration.java
index 59044ad..a790f66 100644
--- a/components/camel-as2/camel-as2-component/src/generated/java/org/apache/camel/component/as2/AS2ClientManagerEndpointConfiguration.java
+++ b/components/camel-as2/camel-as2-component/src/generated/java/org/apache/camel/component/as2/AS2ClientManagerEndpointConfiguration.java
@@ -18,13 +18,13 @@ import org.apache.camel.spi.UriParams;
public final class AS2ClientManagerEndpointConfiguration extends AS2Configuration {
@UriParam(description = "AS2 name of sender")
private String as2From;
- @UriParam(description = "The structure of AS2 to send; see")
+ @UriParam(description = "The structure of AS2 to send; see AS2MessageStructure")
private org.apache.camel.component.as2.api.AS2MessageStructure as2MessageStructure;
@UriParam(description = "AS2 name of recipient")
private String as2To;
- @UriParam(description = "The algorithm used to compress the message or")
+ @UriParam(description = "The algorithm used to compress the message or null if sending EDI message uncompressed")
private org.apache.camel.component.as2.api.AS2CompressionAlgorithm compressionAlgorithm;
- @UriParam(description = "An RFC2822 address to request a receipt or")
+ @UriParam(description = "An RFC2822 address to request a receipt or null if no receipt requested")
private String dispositionNotificationTo;
@UriParam(description = "EDI message to transport")
private String ediMessage;
@@ -32,19 +32,19 @@ public final class AS2ClientManagerEndpointConfiguration extends AS2Configuratio
private org.apache.http.entity.ContentType ediMessageContentType;
@UriParam(description = "The transfer encoding used to transport EDI message")
private String ediMessageTransferEncoding;
- @UriParam(description = "The algorithm used to encrypt the message or")
+ @UriParam(description = "The algorithm used to encrypt the message or null if sending EDI message unencrypted")
private org.apache.camel.component.as2.api.AS2EncryptionAlgorithm encryptingAlgorithm;
- @UriParam(description = "The chain of certificates used to encrypt the message or")
+ @UriParam(description = "The chain of certificates used to encrypt the message or null if sending EDI message unencrypted")
private java.security.cert.Certificate[] encryptingCertificateChain;
@UriParam(description = "RFC2822 address of sender")
private String from;
@UriParam(description = "Resource location to deliver message")
private String requestUri;
- @UriParam(description = "The senders list of signing algorithms for signing receipt, in preferred order, or")
+ @UriParam(description = "The senders list of signing algorithms for signing receipt, in preferred order, or null if requesting an unsigned receipt.")
private String[] signedReceiptMicAlgorithms;
- @UriParam(description = "The algorithm used to sign the message or")
+ @UriParam(description = "The algorithm used to sign the message or null if sending EDI message unsigned")
private org.apache.camel.component.as2.api.AS2SignatureAlgorithm signingAlgorithm;
- @UriParam(description = "The chain of certificates used to sign the message or")
+ @UriParam(description = "The chain of certificates used to sign the message or null if sending EDI message unsigned")
private java.security.cert.Certificate[] signingCertificateChain;
@UriParam(description = "The private key used to sign EDI message")
private java.security.PrivateKey signingPrivateKey;
diff --git a/components/camel-as2/camel-as2-component/src/generated/resources/org/apache/camel/component/as2/as2.json b/components/camel-as2/camel-as2-component/src/generated/resources/org/apache/camel/component/as2/as2.json
index 14e66ee..3c07a86 100644
--- a/components/camel-as2/camel-as2-component/src/generated/resources/org/apache/camel/component/as2/as2.json
+++ b/components/camel-as2/camel-as2-component/src/generated/resources/org/apache/camel/component/as2/as2.json
@@ -82,7 +82,7 @@
"useFixedDelay": { "kind": "parameter", "displayName": "Use Fixed Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": "true", "description": "Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details." }
},
"apiProperties": {
- "client": { "as2From": { "kind": "parameter", "displayName": "As2 From", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "AS2 name of sender" }, "as2MessageStructure": { "kind": "parameter", "displayName": "As2 Message Structure", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.as2.api.AS2MessageStructure", "enum": [ "P [...]
+ "client": { "as2From": { "kind": "parameter", "displayName": "As2 From", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "AS2 name of sender" }, "as2MessageStructure": { "kind": "parameter", "displayName": "As2 Message Structure", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.as2.api.AS2MessageStructure", "enum": [ "P [...]
"server": { "requestUriPattern": { "kind": "parameter", "displayName": "Request Uri Pattern", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "" } }
}
}
diff --git a/components/camel-as2/camel-as2-component/src/main/docs/as2-component.adoc b/components/camel-as2/camel-as2-component/src/main/docs/as2-component.adoc
index 272a557..b634339 100644
--- a/components/camel-as2/camel-as2-component/src/main/docs/as2-component.adoc
+++ b/components/camel-as2/camel-as2-component/src/main/docs/as2-component.adoc
@@ -162,20 +162,20 @@ The following lists each API name and method and its additional parameters.
|===
| Name | Description | Type
| *as2From* | AS2 name of sender | String
-| *as2MessageStructure* | The structure of AS2 to send; see | AS2MessageStructure
+| *as2MessageStructure* | The structure of AS2 to send; see AS2MessageStructure | AS2MessageStructure
| *as2To* | AS2 name of recipient | String
-| *compressionAlgorithm* | The algorithm used to compress the message or | AS2CompressionAlgorithm
-| *dispositionNotificationTo* | An RFC2822 address to request a receipt or | String
+| *compressionAlgorithm* | The algorithm used to compress the message or null if sending EDI message uncompressed | AS2CompressionAlgorithm
+| *dispositionNotificationTo* | An RFC2822 address to request a receipt or null if no receipt requested | String
| *ediMessage* | EDI message to transport | String
| *ediMessageContentType* | The content typw of EDI message | ContentType
| *ediMessageTransferEncoding* | The transfer encoding used to transport EDI message | String
-| *encryptingAlgorithm* | The algorithm used to encrypt the message or | AS2EncryptionAlgorithm
-| *encryptingCertificateChain* | The chain of certificates used to encrypt the message or | Certificate[]
+| *encryptingAlgorithm* | The algorithm used to encrypt the message or null if sending EDI message unencrypted | AS2EncryptionAlgorithm
+| *encryptingCertificateChain* | The chain of certificates used to encrypt the message or null if sending EDI message unencrypted | Certificate[]
| *from* | RFC2822 address of sender | String
| *requestUri* | Resource location to deliver message | String
-| *signedReceiptMicAlgorithms* | The senders list of signing algorithms for signing receipt, in preferred order, or | String[]
-| *signingAlgorithm* | The algorithm used to sign the message or | AS2SignatureAlgorithm
-| *signingCertificateChain* | The chain of certificates used to sign the message or | Certificate[]
+| *signedReceiptMicAlgorithms* | The senders list of signing algorithms for signing receipt, in preferred order, or null if requesting an unsigned receipt. | String[]
+| *signingAlgorithm* | The algorithm used to sign the message or null if sending EDI message unsigned | AS2SignatureAlgorithm
+| *signingCertificateChain* | The chain of certificates used to sign the message or null if sending EDI message unsigned | Certificate[]
| *signingPrivateKey* | The private key used to sign EDI message | PrivateKey
| *subject* | Message subject | String
|===