This is an automated email from the ASF dual-hosted git repository.
gnodet pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new 516477b6c34 Add a method to ResultErrorHelper to avoid the usage of
deprecated method (#14958)
516477b6c34 is described below
commit 516477b6c34c2ae9b93e52c1942bccfc1e634438
Author: Guillaume Nodet <[email protected]>
AuthorDate: Mon Jul 29 10:13:36 2024 +0200
Add a method to ResultErrorHelper to avoid the usage of deprecated method
(#14958)
---
...KinesisFirehose2ComponentVerifierExtension.java | 8 ++++----
.../aws2/kms/KMS2ComponentVerifierExtension.java | 6 +++---
.../aws2/sts/STS2ComponentVerifierExtension.java | 6 +++---
.../dropbox/DropboxComponentVerifierExtension.java | 4 ++--
.../ElasticsearchComponentVerifierExtension.java | 4 ++--
.../mail/GoogleMailComponentVerifierExtension.java | 6 +++---
...GoogleMailStreamComponentVerifierExtension.java | 6 +++---
.../sheets/GoogleSheetsVerifierExtension.java | 6 +++---
.../component/jira/JiraVerifierExtension.java | 2 +-
.../minio/MinioComponentVerifierExtension.java | 6 +++---
.../verifier/MongoComponentVerifierExtension.java | 6 +++---
.../OpensearchComponentVerifierExtension.java | 4 ++--
.../mqtt5/PahoMqtt5ComponentVerifierExtension.java | 2 +-
.../paho/PahoComponentVerifierExtension.java | 2 +-
.../rest/RestComponentVerifierExtensionTest.java | 2 +-
.../component/rest/RestComponentVerifierTest.java | 2 +-
.../extension/verifier/ResultErrorHelper.java | 24 ++++++++++++++++------
17 files changed, 54 insertions(+), 42 deletions(-)
diff --git
a/components/camel-aws/camel-aws2-kinesis/src/main/java/org/apache/camel/component/aws2/firehose/KinesisFirehose2ComponentVerifierExtension.java
b/components/camel-aws/camel-aws2-kinesis/src/main/java/org/apache/camel/component/aws2/firehose/KinesisFirehose2ComponentVerifierExtension.java
index b6e53cadbd2..527b724eeea 100644
---
a/components/camel-aws/camel-aws2-kinesis/src/main/java/org/apache/camel/component/aws2/firehose/KinesisFirehose2ComponentVerifierExtension.java
+++
b/components/camel-aws/camel-aws2-kinesis/src/main/java/org/apache/camel/component/aws2/firehose/KinesisFirehose2ComponentVerifierExtension.java
@@ -47,10 +47,10 @@ public class KinesisFirehose2ComponentVerifierExtension
extends DefaultComponent
protected Result verifyParameters(Map<String, Object> parameters) {
ResultBuilder builder =
ResultBuilder.withStatusAndScope(Result.Status.OK, Scope.PARAMETERS)
- .error(ResultErrorHelper.requiresOption("accessKey",
parameters))
- .error(ResultErrorHelper.requiresOption("secretKey",
parameters))
- .error(ResultErrorHelper.requiresOption("region", parameters))
- .error(ResultErrorHelper.requiresOption("streamName",
parameters));
+ .error(ResultErrorHelper.requiresOption(parameters,
"accessKey"))
+ .error(ResultErrorHelper.requiresOption(parameters,
"secretKey"))
+ .error(ResultErrorHelper.requiresOption(parameters, "region"))
+ .error(ResultErrorHelper.requiresOption(parameters,
"streamName"));
// Validate using the catalog
diff --git
a/components/camel-aws/camel-aws2-kms/src/main/java/org/apache/camel/component/aws2/kms/KMS2ComponentVerifierExtension.java
b/components/camel-aws/camel-aws2-kms/src/main/java/org/apache/camel/component/aws2/kms/KMS2ComponentVerifierExtension.java
index 6b6d0f61b56..9cb4e3a9e73 100644
---
a/components/camel-aws/camel-aws2-kms/src/main/java/org/apache/camel/component/aws2/kms/KMS2ComponentVerifierExtension.java
+++
b/components/camel-aws/camel-aws2-kms/src/main/java/org/apache/camel/component/aws2/kms/KMS2ComponentVerifierExtension.java
@@ -47,9 +47,9 @@ public class KMS2ComponentVerifierExtension extends
DefaultComponentVerifierExte
protected Result verifyParameters(Map<String, Object> parameters) {
ResultBuilder builder =
ResultBuilder.withStatusAndScope(Result.Status.OK, Scope.PARAMETERS)
- .error(ResultErrorHelper.requiresOption("accessKey",
parameters))
- .error(ResultErrorHelper.requiresOption("secretKey",
parameters))
- .error(ResultErrorHelper.requiresOption("region", parameters));
+ .error(ResultErrorHelper.requiresOption(parameters,
"accessKey"))
+ .error(ResultErrorHelper.requiresOption(parameters,
"secretKey"))
+ .error(ResultErrorHelper.requiresOption(parameters, "region"));
// Validate using the catalog
diff --git
a/components/camel-aws/camel-aws2-sts/src/main/java/org/apache/camel/component/aws2/sts/STS2ComponentVerifierExtension.java
b/components/camel-aws/camel-aws2-sts/src/main/java/org/apache/camel/component/aws2/sts/STS2ComponentVerifierExtension.java
index 0dab737ea24..e721feddc2e 100644
---
a/components/camel-aws/camel-aws2-sts/src/main/java/org/apache/camel/component/aws2/sts/STS2ComponentVerifierExtension.java
+++
b/components/camel-aws/camel-aws2-sts/src/main/java/org/apache/camel/component/aws2/sts/STS2ComponentVerifierExtension.java
@@ -47,9 +47,9 @@ public class STS2ComponentVerifierExtension extends
DefaultComponentVerifierExte
protected Result verifyParameters(Map<String, Object> parameters) {
ResultBuilder builder =
ResultBuilder.withStatusAndScope(Result.Status.OK, Scope.PARAMETERS)
- .error(ResultErrorHelper.requiresOption("accessKey",
parameters))
- .error(ResultErrorHelper.requiresOption("secretKey",
parameters))
- .error(ResultErrorHelper.requiresOption("region", parameters));
+ .error(ResultErrorHelper.requiresOption(parameters,
"accessKey"))
+ .error(ResultErrorHelper.requiresOption(parameters,
"secretKey"))
+ .error(ResultErrorHelper.requiresOption(parameters, "region"));
// Validate using the catalog
diff --git
a/components/camel-dropbox/src/main/java/org/apache/camel/component/dropbox/DropboxComponentVerifierExtension.java
b/components/camel-dropbox/src/main/java/org/apache/camel/component/dropbox/DropboxComponentVerifierExtension.java
index a993eec2902..1b7423f83c2 100644
---
a/components/camel-dropbox/src/main/java/org/apache/camel/component/dropbox/DropboxComponentVerifierExtension.java
+++
b/components/camel-dropbox/src/main/java/org/apache/camel/component/dropbox/DropboxComponentVerifierExtension.java
@@ -42,8 +42,8 @@ public class DropboxComponentVerifierExtension extends
DefaultComponentVerifierE
@Override
protected Result verifyParameters(Map<String, Object> parameters) {
ResultBuilder builder =
ResultBuilder.withStatusAndScope(Result.Status.OK, Scope.PARAMETERS)
- .error(ResultErrorHelper.requiresOption("accessToken",
parameters))
- .error(ResultErrorHelper.requiresOption("clientIdentifier",
parameters));
+ .error(ResultErrorHelper.requiresOption(parameters,
"accessToken"))
+ .error(ResultErrorHelper.requiresOption(parameters,
"clientIdentifier"));
return builder.build();
}
diff --git
a/components/camel-elasticsearch/src/main/java/org/apache/camel/component/es/ElasticsearchComponentVerifierExtension.java
b/components/camel-elasticsearch/src/main/java/org/apache/camel/component/es/ElasticsearchComponentVerifierExtension.java
index 4d38ed4403d..6460cd609af 100644
---
a/components/camel-elasticsearch/src/main/java/org/apache/camel/component/es/ElasticsearchComponentVerifierExtension.java
+++
b/components/camel-elasticsearch/src/main/java/org/apache/camel/component/es/ElasticsearchComponentVerifierExtension.java
@@ -49,8 +49,8 @@ public class ElasticsearchComponentVerifierExtension extends
DefaultComponentVer
protected Result verifyParameters(Map<String, Object> parameters) {
ResultBuilder builder =
ResultBuilder.withStatusAndScope(Result.Status.OK, Scope.PARAMETERS)
- .error(ResultErrorHelper.requiresOption("clusterName",
parameters))
- .error(ResultErrorHelper.requiresOption("hostAddresses",
parameters));
+ .error(ResultErrorHelper.requiresOption(parameters,
"clusterName"))
+ .error(ResultErrorHelper.requiresOption(parameters,
"hostAddresses"));
// Validate using the catalog
super.verifyParametersAgainstCatalog(builder, parameters);
diff --git
a/components/camel-google/camel-google-mail/src/main/java/org/apache/camel/component/google/mail/GoogleMailComponentVerifierExtension.java
b/components/camel-google/camel-google-mail/src/main/java/org/apache/camel/component/google/mail/GoogleMailComponentVerifierExtension.java
index 23ced87e5e6..2c6117fde1f 100644
---
a/components/camel-google/camel-google-mail/src/main/java/org/apache/camel/component/google/mail/GoogleMailComponentVerifierExtension.java
+++
b/components/camel-google/camel-google-mail/src/main/java/org/apache/camel/component/google/mail/GoogleMailComponentVerifierExtension.java
@@ -42,9 +42,9 @@ public class GoogleMailComponentVerifierExtension extends
DefaultComponentVerifi
protected Result verifyParameters(Map<String, Object> parameters) {
ResultBuilder builder =
ResultBuilder.withStatusAndScope(Result.Status.OK, Scope.PARAMETERS)
- .error(ResultErrorHelper.requiresOption("applicationName",
parameters))
- .error(ResultErrorHelper.requiresOption("clientId",
parameters))
- .error(ResultErrorHelper.requiresOption("clientSecret",
parameters));
+ .error(ResultErrorHelper.requiresOption(parameters,
"applicationName"))
+ .error(ResultErrorHelper.requiresOption(parameters,
"clientId"))
+ .error(ResultErrorHelper.requiresOption(parameters,
"clientSecret"));
return builder.build();
}
diff --git
a/components/camel-google/camel-google-mail/src/main/java/org/apache/camel/component/google/mail/stream/GoogleMailStreamComponentVerifierExtension.java
b/components/camel-google/camel-google-mail/src/main/java/org/apache/camel/component/google/mail/stream/GoogleMailStreamComponentVerifierExtension.java
index 54c47232c05..0c3e6bf9856 100644
---
a/components/camel-google/camel-google-mail/src/main/java/org/apache/camel/component/google/mail/stream/GoogleMailStreamComponentVerifierExtension.java
+++
b/components/camel-google/camel-google-mail/src/main/java/org/apache/camel/component/google/mail/stream/GoogleMailStreamComponentVerifierExtension.java
@@ -45,9 +45,9 @@ public class GoogleMailStreamComponentVerifierExtension
extends DefaultComponent
protected Result verifyParameters(Map<String, Object> parameters) {
ResultBuilder builder =
ResultBuilder.withStatusAndScope(Result.Status.OK, Scope.PARAMETERS)
- .error(ResultErrorHelper.requiresOption("applicationName",
parameters))
- .error(ResultErrorHelper.requiresOption("clientId",
parameters))
- .error(ResultErrorHelper.requiresOption("clientSecret",
parameters));
+ .error(ResultErrorHelper.requiresOption(parameters,
"applicationName"))
+ .error(ResultErrorHelper.requiresOption(parameters,
"clientId"))
+ .error(ResultErrorHelper.requiresOption(parameters,
"clientSecret"));
return builder.build();
}
diff --git
a/components/camel-google/camel-google-sheets/src/main/java/org/apache/camel/component/google/sheets/GoogleSheetsVerifierExtension.java
b/components/camel-google/camel-google-sheets/src/main/java/org/apache/camel/component/google/sheets/GoogleSheetsVerifierExtension.java
index dec69a38564..245f6ebfd65 100644
---
a/components/camel-google/camel-google-sheets/src/main/java/org/apache/camel/component/google/sheets/GoogleSheetsVerifierExtension.java
+++
b/components/camel-google/camel-google-sheets/src/main/java/org/apache/camel/component/google/sheets/GoogleSheetsVerifierExtension.java
@@ -44,9 +44,9 @@ public class GoogleSheetsVerifierExtension extends
DefaultComponentVerifierExten
@Override
protected Result verifyParameters(Map<String, Object> parameters) {
ResultBuilder builder =
ResultBuilder.withStatusAndScope(Result.Status.OK, Scope.PARAMETERS)
- .error(ResultErrorHelper.requiresOption("applicationName",
parameters))
- .error(ResultErrorHelper.requiresOption("clientId",
parameters))
- .error(ResultErrorHelper.requiresOption("clientSecret",
parameters));
+ .error(ResultErrorHelper.requiresOption(parameters,
"applicationName"))
+ .error(ResultErrorHelper.requiresOption(parameters,
"clientId"))
+ .error(ResultErrorHelper.requiresOption(parameters,
"clientSecret"));
return builder.build();
}
diff --git
a/components/camel-jira/src/main/java/org/apache/camel/component/jira/JiraVerifierExtension.java
b/components/camel-jira/src/main/java/org/apache/camel/component/jira/JiraVerifierExtension.java
index bdd0cad68c4..f042c638b6e 100644
---
a/components/camel-jira/src/main/java/org/apache/camel/component/jira/JiraVerifierExtension.java
+++
b/components/camel-jira/src/main/java/org/apache/camel/component/jira/JiraVerifierExtension.java
@@ -46,7 +46,7 @@ public class JiraVerifierExtension extends
DefaultComponentVerifierExtension {
@Override
protected Result verifyParameters(Map<String, Object> parameters) {
ResultBuilder builder =
ResultBuilder.withStatusAndScope(Result.Status.OK, Scope.PARAMETERS)
- .error(ResultErrorHelper.requiresOption(JIRA_URL, parameters))
+ .error(ResultErrorHelper.requiresOption(parameters, JIRA_URL))
.errors(ResultErrorHelper.requiresAny(parameters,
OptionsGroup.withName("basic_authentication")
.options("username", "password",
"!requestToken", "!privateKey", "!consumerKey",
diff --git
a/components/camel-minio/src/main/java/org/apache/camel/component/minio/MinioComponentVerifierExtension.java
b/components/camel-minio/src/main/java/org/apache/camel/component/minio/MinioComponentVerifierExtension.java
index 5733cb3de4e..4b0117f89f9 100644
---
a/components/camel-minio/src/main/java/org/apache/camel/component/minio/MinioComponentVerifierExtension.java
+++
b/components/camel-minio/src/main/java/org/apache/camel/component/minio/MinioComponentVerifierExtension.java
@@ -46,9 +46,9 @@ public class MinioComponentVerifierExtension extends
DefaultComponentVerifierExt
protected Result verifyParameters(Map<String, Object> parameters) {
ResultBuilder builder =
ResultBuilder.withStatusAndScope(Result.Status.OK, Scope.PARAMETERS)
- .error(ResultErrorHelper.requiresOption("accessKey",
parameters))
- .error(ResultErrorHelper.requiresOption("secretKey",
parameters))
- .error(ResultErrorHelper.requiresOption("region", parameters));
+ .error(ResultErrorHelper.requiresOption(parameters,
"accessKey"))
+ .error(ResultErrorHelper.requiresOption(parameters,
"secretKey"))
+ .error(ResultErrorHelper.requiresOption(parameters, "region"));
// Validate using the catalog
diff --git
a/components/camel-mongodb/src/main/java/org/apache/camel/component/mongodb/verifier/MongoComponentVerifierExtension.java
b/components/camel-mongodb/src/main/java/org/apache/camel/component/mongodb/verifier/MongoComponentVerifierExtension.java
index b83215d9a6e..0ecf3e0575b 100644
---
a/components/camel-mongodb/src/main/java/org/apache/camel/component/mongodb/verifier/MongoComponentVerifierExtension.java
+++
b/components/camel-mongodb/src/main/java/org/apache/camel/component/mongodb/verifier/MongoComponentVerifierExtension.java
@@ -49,9 +49,9 @@ public class MongoComponentVerifierExtension extends
DefaultComponentVerifierExt
@Override
public Result verifyParameters(Map<String, Object> parameters) {
ResultBuilder builder =
ResultBuilder.withStatusAndScope(Result.Status.OK, Scope.PARAMETERS)
- .error(ResultErrorHelper.requiresOption("host", parameters))
- .error(ResultErrorHelper.requiresOption("user", parameters))
- .error(ResultErrorHelper.requiresOption("password",
parameters));
+ .error(ResultErrorHelper.requiresOption(parameters, "host"))
+ .error(ResultErrorHelper.requiresOption(parameters, "user"))
+ .error(ResultErrorHelper.requiresOption(parameters,
"password"));
return builder.build();
}
diff --git
a/components/camel-opensearch/src/main/java/org/apache/camel/component/opensearch/OpensearchComponentVerifierExtension.java
b/components/camel-opensearch/src/main/java/org/apache/camel/component/opensearch/OpensearchComponentVerifierExtension.java
index c7f5a50a382..a38f5636ae4 100644
---
a/components/camel-opensearch/src/main/java/org/apache/camel/component/opensearch/OpensearchComponentVerifierExtension.java
+++
b/components/camel-opensearch/src/main/java/org/apache/camel/component/opensearch/OpensearchComponentVerifierExtension.java
@@ -49,8 +49,8 @@ public class OpensearchComponentVerifierExtension extends
DefaultComponentVerifi
protected Result verifyParameters(Map<String, Object> parameters) {
ResultBuilder builder =
ResultBuilder.withStatusAndScope(Result.Status.OK, Scope.PARAMETERS)
- .error(ResultErrorHelper.requiresOption("clusterName",
parameters))
- .error(ResultErrorHelper.requiresOption("hostAddresses",
parameters));
+ .error(ResultErrorHelper.requiresOption(parameters,
"clusterName"))
+ .error(ResultErrorHelper.requiresOption(parameters,
"hostAddresses"));
// Validate using the catalog
super.verifyParametersAgainstCatalog(builder, parameters);
diff --git
a/components/camel-paho-mqtt5/src/main/java/org/apache/camel/component/paho/mqtt5/PahoMqtt5ComponentVerifierExtension.java
b/components/camel-paho-mqtt5/src/main/java/org/apache/camel/component/paho/mqtt5/PahoMqtt5ComponentVerifierExtension.java
index 9d9124270c4..9d07c6052bc 100644
---
a/components/camel-paho-mqtt5/src/main/java/org/apache/camel/component/paho/mqtt5/PahoMqtt5ComponentVerifierExtension.java
+++
b/components/camel-paho-mqtt5/src/main/java/org/apache/camel/component/paho/mqtt5/PahoMqtt5ComponentVerifierExtension.java
@@ -44,7 +44,7 @@ public class PahoMqtt5ComponentVerifierExtension extends
DefaultComponentVerifie
@Override
protected Result verifyParameters(Map<String, Object> parameters) {
return ResultBuilder.withStatusAndScope(Result.Status.OK,
Scope.PARAMETERS)
- .error(ResultErrorHelper.requiresOption("brokerUrl",
parameters))
+ .error(ResultErrorHelper.requiresOption(parameters,
"brokerUrl"))
.build();
}
diff --git
a/components/camel-paho/src/main/java/org/apache/camel/component/paho/PahoComponentVerifierExtension.java
b/components/camel-paho/src/main/java/org/apache/camel/component/paho/PahoComponentVerifierExtension.java
index 3e7c54a5f57..71a0f6ba4ce 100644
---
a/components/camel-paho/src/main/java/org/apache/camel/component/paho/PahoComponentVerifierExtension.java
+++
b/components/camel-paho/src/main/java/org/apache/camel/component/paho/PahoComponentVerifierExtension.java
@@ -44,7 +44,7 @@ public class PahoComponentVerifierExtension extends
DefaultComponentVerifierExte
@Override
protected Result verifyParameters(Map<String, Object> parameters) {
return ResultBuilder.withStatusAndScope(Result.Status.OK,
Scope.PARAMETERS)
- .error(ResultErrorHelper.requiresOption("brokerUrl",
parameters))
+ .error(ResultErrorHelper.requiresOption(parameters,
"brokerUrl"))
.build();
}
diff --git
a/core/camel-core/src/test/java/org/apache/camel/component/rest/RestComponentVerifierExtensionTest.java
b/core/camel-core/src/test/java/org/apache/camel/component/rest/RestComponentVerifierExtensionTest.java
index ff14c9d86c7..978c76f863d 100644
---
a/core/camel-core/src/test/java/org/apache/camel/component/rest/RestComponentVerifierExtensionTest.java
+++
b/core/camel-core/src/test/java/org/apache/camel/component/rest/RestComponentVerifierExtensionTest.java
@@ -106,7 +106,7 @@ public class RestComponentVerifierExtensionTest extends
ContextTestSupport {
@Override
public Result verify(Scope scope, Map<String, Object>
parameters) {
return
ResultBuilder.withStatusAndScope(RestComponentVerifierExtension.Result.Status.OK,
scope)
-
.error(ResultErrorHelper.requiresOption("authProxy", parameters).orElse(null))
+
.error(ResultErrorHelper.requiresOption(parameters, "authProxy"))
.build();
}
});
diff --git
a/core/camel-core/src/test/java/org/apache/camel/component/rest/RestComponentVerifierTest.java
b/core/camel-core/src/test/java/org/apache/camel/component/rest/RestComponentVerifierTest.java
index 5351a509c35..99367ba1230 100644
---
a/core/camel-core/src/test/java/org/apache/camel/component/rest/RestComponentVerifierTest.java
+++
b/core/camel-core/src/test/java/org/apache/camel/component/rest/RestComponentVerifierTest.java
@@ -101,7 +101,7 @@ public class RestComponentVerifierTest extends
ContextTestSupport {
@Override
public Result verify(Scope scope, Map<String, Object>
parameters) {
return
ResultBuilder.withStatusAndScope(RestComponentVerifierExtension.Result.Status.OK,
scope)
-
.error(ResultErrorHelper.requiresOption("authProxy", parameters).orElse(null))
+
.error(ResultErrorHelper.requiresOption(parameters, "authProxy"))
.build();
}
});
diff --git
a/core/camel-support/src/main/java/org/apache/camel/component/extension/verifier/ResultErrorHelper.java
b/core/camel-support/src/main/java/org/apache/camel/component/extension/verifier/ResultErrorHelper.java
index 6552ce716cc..ebe3e411c87 100644
---
a/core/camel-support/src/main/java/org/apache/camel/component/extension/verifier/ResultErrorHelper.java
+++
b/core/camel-support/src/main/java/org/apache/camel/component/extension/verifier/ResultErrorHelper.java
@@ -45,16 +45,28 @@ public final class ResultErrorHelper {
/**
*
- * @param parameterName the required option
- * @param parameters the
- * @return
+ * @param parameterName the required option
+ * @param parameters the parameters
+ * @return an optional error
+ *
+ * @deprecated use {@link #requiresOption(Map, String)}
instead
*/
+ @Deprecated
public static Optional<VerificationError> requiresOption(String
parameterName, Map<String, Object> parameters) {
+ return Optional.ofNullable(requiresOption(parameters, parameterName));
+ }
+
+ /**
+ *
+ * @param parameterName the required option
+ * @param parameters the parameters
+ * @return an error or null
+ */
+ public static VerificationError requiresOption(Map<String, Object>
parameters, String parameterName) {
if (ObjectHelper.isEmpty(parameters.get(parameterName))) {
- return
Optional.of(ResultErrorBuilder.withMissingOption(parameterName).build());
+ return ResultErrorBuilder.withMissingOption(parameterName).build();
}
-
- return Optional.empty();
+ return null;
}
/**
