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 2018/07/18 13:38:53 UTC
[camel] branch master updated: CAMEL-12660: spring boot auto
configuration. Polished the javadoc documentation for the options.
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 071a0da CAMEL-12660: spring boot auto configuration. Polished the javadoc documentation for the options.
071a0da is described below
commit 071a0da7d8785bffad5873ea9a5bf8c8c2204a32
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Wed Jul 18 15:38:23 2018 +0200
CAMEL-12660: spring boot auto configuration. Polished the javadoc documentation for the options.
---
.../camel-avro/src/main/docs/avro-component.adoc | 4 +-
.../camel-avro/src/main/docs/avro-dataformat.adoc | 2 +-
.../camel/component/avro/AvroConfiguration.java | 5 +-
.../camel-aws/src/main/docs/aws-cw-component.adoc | 6 +-
.../camel-aws/src/main/docs/aws-ddb-component.adoc | 6 +-
.../src/main/docs/aws-ddbstream-component.adoc | 27 +-
.../camel-aws/src/main/docs/aws-ec2-component.adoc | 6 +-
.../src/main/docs/aws-kinesis-component.adoc | 29 +-
.../main/docs/aws-kinesis-firehose-component.adoc | 14 +-
.../camel-aws/src/main/docs/aws-kms-component.adoc | 6 +-
.../src/main/docs/aws-lambda-component.adoc | 4 +-
.../camel-aws/src/main/docs/aws-mq-component.adoc | 6 +-
.../camel-aws/src/main/docs/aws-ses-component.adoc | 6 +-
.../camel-aws/src/main/docs/aws-sns-component.adoc | 6 +-
.../camel-aws/src/main/docs/aws-sqs-component.adoc | 12 +-
.../camel-aws/src/main/docs/aws-swf-component.adoc | 4 +-
.../camel/component/aws/cw/CwConfiguration.java | 21 +-
.../camel/component/aws/ddb/DdbConfiguration.java | 18 +-
.../camel/component/aws/ec2/EC2Configuration.java | 18 +-
.../camel/component/aws/kms/KMSConfiguration.java | 18 +-
.../component/aws/lambda/LambdaConfiguration.java | 12 +-
.../camel/component/aws/mq/MQConfiguration.java | 18 +-
.../camel/component/aws/sdb/SdbConfiguration.java | 18 +-
.../camel/component/aws/ses/SesConfiguration.java | 18 +-
.../camel/component/aws/sns/SnsConfiguration.java | 18 +-
.../camel/component/aws/sqs/SqsConfiguration.java | 26 +-
.../camel/component/aws/swf/SWFConfiguration.java | 12 +-
.../ws/springboot/WsComponentConfiguration.java | 2 +-
.../springboot/AvroComponentConfiguration.java | 3 +
.../cw/springboot/CwComponentConfiguration.java | 9 +
.../ddb/springboot/DdbComponentConfiguration.java | 9 +
.../DdbStreamComponentConfiguration.java | 35 +++
.../ec2/springboot/EC2ComponentConfiguration.java | 9 +
.../KinesisFirehoseComponentConfiguration.java | 22 ++
.../springboot/KinesisComponentConfiguration.java | 42 +++
.../kms/springboot/KMSComponentConfiguration.java | 9 +
.../springboot/LambdaComponentConfiguration.java | 6 +
.../mq/springboot/MQComponentConfiguration.java | 9 +
.../s3/springboot/S3ComponentConfiguration.java | 25 +-
.../ses/springboot/SesComponentConfiguration.java | 9 +
.../sns/springboot/SnsComponentConfiguration.java | 9 +
.../sqs/springboot/SqsComponentConfiguration.java | 16 ++
.../swf/springboot/SWFComponentConfiguration.java | 8 +-
.../box/springboot/BoxComponentConfiguration.java | 55 +---
.../BraintreeComponentConfiguration.java | 2 +-
.../springboot/CacheComponentConfiguration.java | 7 +-
.../CaffeineCacheComponentConfiguration.java | 4 +-
.../CaffeineLoadCacheComponentConfiguration.java | 4 +-
.../DigitalSignatureComponentConfiguration.java | 60 ++---
.../springboot/EhcacheComponentConfiguration.java | 16 +-
.../springboot/EtcdComponentConfiguration.java | 10 -
.../springboot/FacebookComponentConfiguration.java | 2 +-
.../springboot/FhirComponentConfiguration.java | 60 +++++
.../GoogleCalendarComponentConfiguration.java | 2 +-
.../GoogleDriveComponentConfiguration.java | 2 +-
.../GoogleMailComponentConfiguration.java | 3 +-
.../GoogleMailStreamComponentConfiguration.java | 3 +-
.../springboot/HttpComponentConfiguration.java | 2 +-
.../springboot/HttpComponentConfiguration.java | 2 +-
.../InfinispanComponentConfiguration.java | 35 ++-
.../jms/springboot/JmsComponentConfiguration.java | 117 ++++----
.../springboot/KafkaComponentConfiguration.java | 118 ++++-----
.../springboot/KestrelComponentConfiguration.java | 6 +-
.../springboot/LinkedInComponentConfiguration.java | 2 +-
.../springboot/MailComponentConfiguration.java | 19 +-
.../springboot/MllpComponentConfiguration.java | 98 +------
.../springboot/NagiosComponentConfiguration.java | 2 -
.../NettyHttpComponentConfiguration.java | 29 +-
.../springboot/NettyComponentConfiguration.java | 40 ++-
.../NettyHttpComponentConfiguration.java | 25 +-
.../springboot/NettyComponentConfiguration.java | 85 +++---
.../SalesforceComponentConfiguration.java | 29 +-
.../ServiceNowComponentConfiguration.java | 3 +
.../sip/springboot/SipComponentConfiguration.java | 2 +-
.../springboot/SmppComponentConfiguration.java | 175 ++++--------
.../ssh/springboot/SshComponentConfiguration.java | 57 +---
.../springboot/TwilioComponentConfiguration.java | 6 -
.../WordpressComponentConfiguration.java | 18 ++
.../XmlSignatureComponentConfiguration.java | 293 ++++++++-------------
.../springboot/YammerComponentConfiguration.java | 4 +-
.../springboot/ZendeskComponentConfiguration.java | 18 --
.../ZooKeeperComponentConfiguration.java | 2 -
.../camel/maven/packaging/JSonSchemaHelper.java | 17 ++
.../packaging/SpringBootAutoConfigurationMojo.java | 22 ++
84 files changed, 979 insertions(+), 1039 deletions(-)
diff --git a/components/camel-avro/src/main/docs/avro-component.adoc b/components/camel-avro/src/main/docs/avro-component.adoc
index 3443db0..f5d0588 100644
--- a/components/camel-avro/src/main/docs/avro-component.adoc
+++ b/components/camel-avro/src/main/docs/avro-component.adoc
@@ -204,7 +204,7 @@ with the following path and query parameters:
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
-| *transport* | *Required* Transport to use | | AvroTransport
+| *transport* | *Required* Transport to use, can be either http or netty | | AvroTransport
| *port* | *Required* Port number to use | | int
| *host* | *Required* Hostname to use | | String
| *messageName* | The name of the message to send. | | String
@@ -251,7 +251,7 @@ The component supports 15 options, which are listed below.
type will be auto detected | false | Boolean
| *camel.component.avro.configuration.single-parameter* | If true, consumer parameter won't be wrapped into array. Will fail if
protocol specifies more then 1 parameter for the message | false | Boolean
-| *camel.component.avro.configuration.transport* | | | AvroTransport
+| *camel.component.avro.configuration.transport* | Transport to use, can be either http or netty | | AvroTransport
| *camel.component.avro.configuration.uri-authority* | Authority to use (username and password) | | String
| *camel.component.avro.enabled* | Enable avro component | true | Boolean
| *camel.component.avro.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when
diff --git a/components/camel-avro/src/main/docs/avro-dataformat.adoc b/components/camel-avro/src/main/docs/avro-dataformat.adoc
index 19b1fc2..bc80173 100644
--- a/components/camel-avro/src/main/docs/avro-dataformat.adoc
+++ b/components/camel-avro/src/main/docs/avro-dataformat.adoc
@@ -163,7 +163,7 @@ The component supports 15 options, which are listed below.
type will be auto detected | false | Boolean
| *camel.component.avro.configuration.single-parameter* | If true, consumer parameter won't be wrapped into array. Will fail if
protocol specifies more then 1 parameter for the message | false | Boolean
-| *camel.component.avro.configuration.transport* | | | AvroTransport
+| *camel.component.avro.configuration.transport* | Transport to use, can be either http or netty | | AvroTransport
| *camel.component.avro.configuration.uri-authority* | Authority to use (username and password) | | String
| *camel.component.avro.enabled* | Enable avro component | true | Boolean
| *camel.component.avro.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when
diff --git a/components/camel-avro/src/main/java/org/apache/camel/component/avro/AvroConfiguration.java b/components/camel-avro/src/main/java/org/apache/camel/component/avro/AvroConfiguration.java
index ea22270..542c88b 100644
--- a/components/camel-avro/src/main/java/org/apache/camel/component/avro/AvroConfiguration.java
+++ b/components/camel-avro/src/main/java/org/apache/camel/component/avro/AvroConfiguration.java
@@ -119,12 +119,15 @@ public class AvroConfiguration implements Cloneable {
}
/**
- * Transport to use
+ * Transport to use, can be either http or netty
*/
public void setTransport(String transport) {
this.transport = AvroTransport.valueOf(transport);
}
+ /**
+ * Transport to use, can be either http or netty
+ */
public void setTransport(AvroTransport transport) {
this.transport = transport;
}
diff --git a/components/camel-aws/src/main/docs/aws-cw-component.adoc b/components/camel-aws/src/main/docs/aws-cw-component.adoc
index 9ff7e39..0fe05d1 100644
--- a/components/camel-aws/src/main/docs/aws-cw-component.adoc
+++ b/components/camel-aws/src/main/docs/aws-cw-component.adoc
@@ -101,9 +101,9 @@ The component supports 16 options, which are listed below.
| *camel.component.aws-cw.configuration.amazon-cw-client* | To use the AmazonCloudWatch as the client | | AmazonCloudWatch
| *camel.component.aws-cw.configuration.name* | The metric name | | String
| *camel.component.aws-cw.configuration.namespace* | The metric namespace | | String
-| *camel.component.aws-cw.configuration.proxy-host* | | | String
-| *camel.component.aws-cw.configuration.proxy-port* | | | Integer
-| *camel.component.aws-cw.configuration.region* | | | String
+| *camel.component.aws-cw.configuration.proxy-host* | To define a proxy host when instantiating the CW client | | String
+| *camel.component.aws-cw.configuration.proxy-port* | To define a proxy port when instantiating the CW client | | Integer
+| *camel.component.aws-cw.configuration.region* | The region in which CW client needs to work | | String
| *camel.component.aws-cw.configuration.secret-key* | Amazon AWS Secret Key | | String
| *camel.component.aws-cw.configuration.timestamp* | The metric timestamp | | Date
| *camel.component.aws-cw.configuration.unit* | The metric unit | | String
diff --git a/components/camel-aws/src/main/docs/aws-ddb-component.adoc b/components/camel-aws/src/main/docs/aws-ddb-component.adoc
index 2487991..abf3ae3 100644
--- a/components/camel-aws/src/main/docs/aws-ddb-component.adoc
+++ b/components/camel-aws/src/main/docs/aws-ddb-component.adoc
@@ -103,11 +103,11 @@ The component supports 18 options, which are listed below.
| *camel.component.aws-ddb.configuration.key-attribute-name* | Attribute name when creating table | | String
| *camel.component.aws-ddb.configuration.key-attribute-type* | Attribute type when creating table | | String
| *camel.component.aws-ddb.configuration.operation* | What operation to perform | | DdbOperations
-| *camel.component.aws-ddb.configuration.proxy-host* | | | String
-| *camel.component.aws-ddb.configuration.proxy-port* | | | Integer
+| *camel.component.aws-ddb.configuration.proxy-host* | To define a proxy host when instantiating the DDB client | | String
+| *camel.component.aws-ddb.configuration.proxy-port* | To define a proxy port when instantiating the DDB client | | Integer
| *camel.component.aws-ddb.configuration.read-capacity* | The provisioned throughput to reserve for reading resources from your
table | | Long
-| *camel.component.aws-ddb.configuration.region* | | | String
+| *camel.component.aws-ddb.configuration.region* | The region in which DDB client needs to work | | String
| *camel.component.aws-ddb.configuration.secret-key* | Amazon AWS Secret Key | | String
| *camel.component.aws-ddb.configuration.table-name* | The name of the table currently worked with. | | String
| *camel.component.aws-ddb.configuration.write-capacity* | The provisioned throughput to reserved for writing resources to your
diff --git a/components/camel-aws/src/main/docs/aws-ddbstream-component.adoc b/components/camel-aws/src/main/docs/aws-ddbstream-component.adoc
index 143afbf..1ad0587 100644
--- a/components/camel-aws/src/main/docs/aws-ddbstream-component.adoc
+++ b/components/camel-aws/src/main/docs/aws-ddbstream-component.adoc
@@ -114,16 +114,23 @@ The component supports 15 options, which are listed below.
|===
| Name | Description | Default | Type
| *camel.component.aws-ddbstream.access-key* | Amazon AWS Access Key | | String
-| *camel.component.aws-ddbstream.configuration.access-key* | | | String
-| *camel.component.aws-ddbstream.configuration.amazon-dynamo-db-streams-client* | | | AmazonDynamoDBStreams
-| *camel.component.aws-ddbstream.configuration.iterator-type* | | | ShardIteratorType
-| *camel.component.aws-ddbstream.configuration.max-results-per-request* | | | Integer
-| *camel.component.aws-ddbstream.configuration.proxy-host* | | | String
-| *camel.component.aws-ddbstream.configuration.proxy-port* | | | Integer
-| *camel.component.aws-ddbstream.configuration.region* | | | String
-| *camel.component.aws-ddbstream.configuration.secret-key* | | | String
-| *camel.component.aws-ddbstream.configuration.sequence-number-provider* | | | SequenceNumberProvider
-| *camel.component.aws-ddbstream.configuration.table-name* | | | String
+| *camel.component.aws-ddbstream.configuration.access-key* | "Amazon AWS Access Key" | | String
+| *camel.component.aws-ddbstream.configuration.amazon-dynamo-db-streams-client* | "Amazon DynamoDB client to use for all requests for this endpoint" | | AmazonDynamoDBStreams
+| *camel.component.aws-ddbstream.configuration.iterator-type* | "Defines where in the DynaboDB stream" +
+ " to start getting records. Note that using TRIM_HORIZON can cause a"
+ + " significant delay before the stream has caught up to real-time."+
+ " if {AT,AFTER}_SEQUENCE_NUMBER are used, then a sequenceNumberProvider"
+ + " MUST be supplied." | | ShardIteratorType
+| *camel.component.aws-ddbstream.configuration.max-results-per-request* | "Maximum number of records that will be fetched in each poll" | | Integer
+| *camel.component.aws-ddbstream.configuration.proxy-host* | "To define a proxy host when instantiating the DDBStreams client" | | String
+| *camel.component.aws-ddbstream.configuration.proxy-port* | "To define a proxy port when instantiating the DDBStreams client" | | Integer
+| *camel.component.aws-ddbstream.configuration.region* | "The region in which DDBStreams client needs to work" | | String
+| *camel.component.aws-ddbstream.configuration.secret-key* | "Amazon AWS Secret Key" | | String
+| *camel.component.aws-ddbstream.configuration.sequence-number-provider* | "Provider for the sequence number when" +
+ " using one of the two ShardIteratorType.{AT,AFTER}_SEQUENCE_NUMBER"
+ +
+ " iterator types. Can be a registry reference or a literal sequence number." | | SequenceNumberProvider
+| *camel.component.aws-ddbstream.configuration.table-name* | "Name of the dynamodb table" | | String
| *camel.component.aws-ddbstream.enabled* | Enable aws-ddbstream component | true | Boolean
| *camel.component.aws-ddbstream.region* | Amazon AWS Region | | String
| *camel.component.aws-ddbstream.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when
diff --git a/components/camel-aws/src/main/docs/aws-ec2-component.adoc b/components/camel-aws/src/main/docs/aws-ec2-component.adoc
index a54b9da..8087452 100644
--- a/components/camel-aws/src/main/docs/aws-ec2-component.adoc
+++ b/components/camel-aws/src/main/docs/aws-ec2-component.adoc
@@ -97,9 +97,9 @@ The component supports 12 options, which are listed below.
startInstances, stopInstances, terminateInstances, describeInstances,
describeInstancesStatus, rebootInstances, monitorInstances,
unmonitorInstances, createTags or deleteTags | | EC2Operations
-| *camel.component.aws-ec2.configuration.proxy-host* | | | String
-| *camel.component.aws-ec2.configuration.proxy-port* | | | Integer
-| *camel.component.aws-ec2.configuration.region* | | | String
+| *camel.component.aws-ec2.configuration.proxy-host* | To define a proxy host when instantiating the EC2 client | | String
+| *camel.component.aws-ec2.configuration.proxy-port* | To define a proxy port when instantiating the EC2 client | | Integer
+| *camel.component.aws-ec2.configuration.region* | The region in which EC2 client needs to work | | String
| *camel.component.aws-ec2.configuration.secret-key* | Amazon AWS Secret Key | | String
| *camel.component.aws-ec2.enabled* | Enable aws-ec2 component | true | Boolean
| *camel.component.aws-ec2.region* | The region in which EC2 client needs to work | | String
diff --git a/components/camel-aws/src/main/docs/aws-kinesis-component.adoc b/components/camel-aws/src/main/docs/aws-kinesis-component.adoc
index c2b4dff..c2ffd5a 100644
--- a/components/camel-aws/src/main/docs/aws-kinesis-component.adoc
+++ b/components/camel-aws/src/main/docs/aws-kinesis-component.adoc
@@ -117,18 +117,23 @@ The component supports 17 options, which are listed below.
|===
| Name | Description | Default | Type
| *camel.component.aws-kinesis.access-key* | Amazon AWS Access Key | | String
-| *camel.component.aws-kinesis.configuration.access-key* | | | String
-| *camel.component.aws-kinesis.configuration.amazon-kinesis-client* | | | AmazonKinesis
-| *camel.component.aws-kinesis.configuration.iterator-type* | | | ShardIteratorType
-| *camel.component.aws-kinesis.configuration.max-results-per-request* | | 1 | Integer
-| *camel.component.aws-kinesis.configuration.proxy-host* | | | String
-| *camel.component.aws-kinesis.configuration.proxy-port* | | | Integer
-| *camel.component.aws-kinesis.configuration.region* | | | String
-| *camel.component.aws-kinesis.configuration.secret-key* | | | String
-| *camel.component.aws-kinesis.configuration.sequence-number* | | | String
-| *camel.component.aws-kinesis.configuration.shard-closed* | | | KinesisShardClosed StrategyEnum
-| *camel.component.aws-kinesis.configuration.shard-id* | | | String
-| *camel.component.aws-kinesis.configuration.stream-name* | | | String
+| *camel.component.aws-kinesis.configuration.access-key* | "Amazon AWS Access Key" | | String
+| *camel.component.aws-kinesis.configuration.amazon-kinesis-client* | "Amazon Kinesis client to use for all requests for this endpoint" | | AmazonKinesis
+| *camel.component.aws-kinesis.configuration.iterator-type* | "Defines where in the Kinesis stream to start getting records" | | ShardIteratorType
+| *camel.component.aws-kinesis.configuration.max-results-per-request* | "Maximum number of records that will be fetched in each poll" | 1 | Integer
+| *camel.component.aws-kinesis.configuration.proxy-host* | "To define a proxy host when instantiating the DDBStreams client" | | String
+| *camel.component.aws-kinesis.configuration.proxy-port* | "To define a proxy port when instantiating the DDBStreams client" | | Integer
+| *camel.component.aws-kinesis.configuration.region* | "The region in which Kinesis client needs to work" | | String
+| *camel.component.aws-kinesis.configuration.secret-key* | "Amazon AWS Secret Key" | | String
+| *camel.component.aws-kinesis.configuration.sequence-number* | "The sequence number to start polling from. Required if iteratorType is set to AFTER_SEQUENCE_NUMBER or AT_SEQUENCE_NUMBER" | | String
+| *camel.component.aws-kinesis.configuration.shard-closed* | "Define what will be the behavior in case of shard closed. Possible value are ignore, silent and fail."
+ +
+ "In case of ignore a message will be logged and the consumer will restart from the beginning,"
+ +
+ "in case of silent there will be no logging and the consumer will start from the beginning,"
+ + "in case of fail a ReachedClosedStateException will be raised" | | KinesisShardClosed StrategyEnum
+| *camel.component.aws-kinesis.configuration.shard-id* | "Defines which shardId in the Kinesis stream to get records from" | | String
+| *camel.component.aws-kinesis.configuration.stream-name* | "Name of the stream" | | String
| *camel.component.aws-kinesis.enabled* | Enable aws-kinesis component | true | Boolean
| *camel.component.aws-kinesis.region* | Amazon AWS Region | | String
| *camel.component.aws-kinesis.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when
diff --git a/components/camel-aws/src/main/docs/aws-kinesis-firehose-component.adoc b/components/camel-aws/src/main/docs/aws-kinesis-firehose-component.adoc
index 4eb41b4..9d49498 100644
--- a/components/camel-aws/src/main/docs/aws-kinesis-firehose-component.adoc
+++ b/components/camel-aws/src/main/docs/aws-kinesis-firehose-component.adoc
@@ -93,13 +93,13 @@ The component supports 12 options, which are listed below.
|===
| Name | Description | Default | Type
| *camel.component.aws-kinesis-firehose.access-key* | Amazon AWS Access Key | | String
-| *camel.component.aws-kinesis-firehose.configuration.access-key* | | | String
-| *camel.component.aws-kinesis-firehose.configuration.amazon-kinesis-firehose-client* | | | AmazonKinesisFirehose
-| *camel.component.aws-kinesis-firehose.configuration.proxy-host* | | | String
-| *camel.component.aws-kinesis-firehose.configuration.proxy-port* | | | Integer
-| *camel.component.aws-kinesis-firehose.configuration.region* | | | String
-| *camel.component.aws-kinesis-firehose.configuration.secret-key* | | | String
-| *camel.component.aws-kinesis-firehose.configuration.stream-name* | | | String
+| *camel.component.aws-kinesis-firehose.configuration.access-key* | "Amazon AWS Access Key" | | String
+| *camel.component.aws-kinesis-firehose.configuration.amazon-kinesis-firehose-client* | "Amazon Kinesis Firehose client to use for all requests for this endpoint" | | AmazonKinesisFirehose
+| *camel.component.aws-kinesis-firehose.configuration.proxy-host* | "To define a proxy host when instantiating the DDBStreams client" | | String
+| *camel.component.aws-kinesis-firehose.configuration.proxy-port* | "To define a proxy port when instantiating the DDBStreams client" | | Integer
+| *camel.component.aws-kinesis-firehose.configuration.region* | "The region in which Kinesis client needs to work" | | String
+| *camel.component.aws-kinesis-firehose.configuration.secret-key* | "Amazon AWS Secret Key" | | String
+| *camel.component.aws-kinesis-firehose.configuration.stream-name* | "Name of the stream" | | String
| *camel.component.aws-kinesis-firehose.enabled* | Enable aws-kinesis-firehose component | true | Boolean
| *camel.component.aws-kinesis-firehose.region* | Amazon AWS Region | | String
| *camel.component.aws-kinesis-firehose.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when
diff --git a/components/camel-aws/src/main/docs/aws-kms-component.adoc b/components/camel-aws/src/main/docs/aws-kms-component.adoc
index 2871b64..2863bb9 100644
--- a/components/camel-aws/src/main/docs/aws-kms-component.adoc
+++ b/components/camel-aws/src/main/docs/aws-kms-component.adoc
@@ -94,9 +94,9 @@ The component supports 12 options, which are listed below.
| *camel.component.aws-kms.configuration.access-key* | Amazon AWS Access Key | | String
| *camel.component.aws-kms.configuration.kms-client* | To use a existing configured AWS KMS as client | | AWSKMS
| *camel.component.aws-kms.configuration.operation* | The operation to perform | | KMSOperations
-| *camel.component.aws-kms.configuration.proxy-host* | | | String
-| *camel.component.aws-kms.configuration.proxy-port* | | | Integer
-| *camel.component.aws-kms.configuration.region* | | | String
+| *camel.component.aws-kms.configuration.proxy-host* | To define a proxy host when instantiating the KMS client | | String
+| *camel.component.aws-kms.configuration.proxy-port* | To define a proxy port when instantiating the KMS client | | Integer
+| *camel.component.aws-kms.configuration.region* | The region in which KMS client needs to work | | String
| *camel.component.aws-kms.configuration.secret-key* | Amazon AWS Secret Key | | String
| *camel.component.aws-kms.enabled* | Whether to enable auto configuration of the aws-kms component. This is
enabled by default. | | Boolean
diff --git a/components/camel-aws/src/main/docs/aws-lambda-component.adoc b/components/camel-aws/src/main/docs/aws-lambda-component.adoc
index e53c980..3cf9931 100644
--- a/components/camel-aws/src/main/docs/aws-lambda-component.adoc
+++ b/components/camel-aws/src/main/docs/aws-lambda-component.adoc
@@ -102,8 +102,8 @@ The component supports 13 options, which are listed below.
| *camel.component.aws-lambda.configuration.function* | Name of the Lambda function. | | String
| *camel.component.aws-lambda.configuration.operation* | The operation to perform. It can be listFunctions, getFunction,
createFunction, deleteFunction or invokeFunction | | LambdaOperations
-| *camel.component.aws-lambda.configuration.proxy-host* | | | String
-| *camel.component.aws-lambda.configuration.proxy-port* | | | Integer
+| *camel.component.aws-lambda.configuration.proxy-host* | To define a proxy host when instantiating the Lambda client | | String
+| *camel.component.aws-lambda.configuration.proxy-port* | To define a proxy port when instantiating the Lambda client | | Integer
| *camel.component.aws-lambda.configuration.region* | Amazon AWS Region | | String
| *camel.component.aws-lambda.configuration.secret-key* | Amazon AWS Secret Key | | String
| *camel.component.aws-lambda.enabled* | Whether to enable auto configuration of the aws-lambda component. This is
diff --git a/components/camel-aws/src/main/docs/aws-mq-component.adoc b/components/camel-aws/src/main/docs/aws-mq-component.adoc
index def5b11..4525194 100644
--- a/components/camel-aws/src/main/docs/aws-mq-component.adoc
+++ b/components/camel-aws/src/main/docs/aws-mq-component.adoc
@@ -95,9 +95,9 @@ The component supports 12 options, which are listed below.
| *camel.component.aws-mq.configuration.amazon-mq-client* | To use a existing configured AmazonMQClient as client | | AmazonMQ
| *camel.component.aws-mq.configuration.operation* | The operation to perform. It can be
listBrokers,createBroker,deleteBroker | | MQOperations
-| *camel.component.aws-mq.configuration.proxy-host* | | | String
-| *camel.component.aws-mq.configuration.proxy-port* | | | Integer
-| *camel.component.aws-mq.configuration.region* | | | String
+| *camel.component.aws-mq.configuration.proxy-host* | To define a proxy host when instantiating the MQ client | | String
+| *camel.component.aws-mq.configuration.proxy-port* | To define a proxy port when instantiating the MQ client | | Integer
+| *camel.component.aws-mq.configuration.region* | The region in which MQ client needs to work | | String
| *camel.component.aws-mq.configuration.secret-key* | Amazon AWS Secret Key | | String
| *camel.component.aws-mq.enabled* | Whether to enable auto configuration of the aws-mq component. This is
enabled by default. | | Boolean
diff --git a/components/camel-aws/src/main/docs/aws-ses-component.adoc b/components/camel-aws/src/main/docs/aws-ses-component.adoc
index a2636d8..ce24605 100644
--- a/components/camel-aws/src/main/docs/aws-ses-component.adoc
+++ b/components/camel-aws/src/main/docs/aws-ses-component.adoc
@@ -97,9 +97,9 @@ The component supports 16 options, which are listed below.
| *camel.component.aws-ses.configuration.access-key* | Amazon AWS Access Key | | String
| *camel.component.aws-ses.configuration.amazon-s-e-s-client* | To use the AmazonSimpleEmailService as the client | | AmazonSimpleEmail Service
| *camel.component.aws-ses.configuration.from* | The sender's email address. | | String
-| *camel.component.aws-ses.configuration.proxy-host* | | | String
-| *camel.component.aws-ses.configuration.proxy-port* | | | Integer
-| *camel.component.aws-ses.configuration.region* | | | String
+| *camel.component.aws-ses.configuration.proxy-host* | To define a proxy host when instantiating the SES client | | String
+| *camel.component.aws-ses.configuration.proxy-port* | To define a proxy port when instantiating the SES client | | Integer
+| *camel.component.aws-ses.configuration.region* | The region in which SES client needs to work | | String
| *camel.component.aws-ses.configuration.reply-to-addresses* | List of reply-to email address(es) for the message, override it using
'CamelAwsSesReplyToAddresses' header. | | List
| *camel.component.aws-ses.configuration.return-path* | The email address to which bounce notifications are to be forwarded,
diff --git a/components/camel-aws/src/main/docs/aws-sns-component.adoc b/components/camel-aws/src/main/docs/aws-sns-component.adoc
index d3180e0..db63cdc 100644
--- a/components/camel-aws/src/main/docs/aws-sns-component.adoc
+++ b/components/camel-aws/src/main/docs/aws-sns-component.adoc
@@ -102,9 +102,9 @@ The component supports 16 options, which are listed below.
| *camel.component.aws-sns.configuration.amazon-s-n-s-client* | To use the AmazonSNS as the client | | AmazonSNS
| *camel.component.aws-sns.configuration.message-structure* | The message structure to use such as json | | String
| *camel.component.aws-sns.configuration.policy* | The policy for this queue | | String
-| *camel.component.aws-sns.configuration.proxy-host* | | | String
-| *camel.component.aws-sns.configuration.proxy-port* | | | Integer
-| *camel.component.aws-sns.configuration.region* | | | String
+| *camel.component.aws-sns.configuration.proxy-host* | To define a proxy host when instantiating the SNS client | | String
+| *camel.component.aws-sns.configuration.proxy-port* | To define a proxy port when instantiating the SNS client | | Integer
+| *camel.component.aws-sns.configuration.region* | The region in which SNS client needs to work | | String
| *camel.component.aws-sns.configuration.secret-key* | Amazon AWS Secret Key | | String
| *camel.component.aws-sns.configuration.subject* | The subject which is used if the message header 'CamelAwsSnsSubject'
is not present. | | String
diff --git a/components/camel-aws/src/main/docs/aws-sqs-component.adoc b/components/camel-aws/src/main/docs/aws-sqs-component.adoc
index a4436e6..bff369c 100644
--- a/components/camel-aws/src/main/docs/aws-sqs-component.adoc
+++ b/components/camel-aws/src/main/docs/aws-sqs-component.adoc
@@ -140,7 +140,8 @@ The component supports 30 options, which are listed below.
| *camel.component.aws-sqs.configuration.amazon-s-q-s-client* | To use the AmazonSQS as client | | AmazonSQS
| *camel.component.aws-sqs.configuration.attribute-names* | A list of attribute names to receive when consuming. Multiple names
can be separated by comma. | | String
-| *camel.component.aws-sqs.configuration.concurrent-consumers* | | 1 | Integer
+| *camel.component.aws-sqs.configuration.concurrent-consumers* | Allows you to use multiple threads to poll the sqs queue to increase
+ throughput | 1 | Integer
| *camel.component.aws-sqs.configuration.default-visibility-timeout* | The default visibility timeout (in seconds) | | Integer
| *camel.component.aws-sqs.configuration.delay-seconds* | Delay sending messages for a number of seconds. | | Integer
| *camel.component.aws-sqs.configuration.delete-after-read* | Delete message from SQS after it has been read | true | Boolean
@@ -159,13 +160,16 @@ The component supports 30 options, which are listed below.
| *camel.component.aws-sqs.configuration.message-retention-period* | The messageRetentionPeriod (in seconds) a message will be retained by
SQS for this queue. | | Integer
| *camel.component.aws-sqs.configuration.policy* | The policy for this queue | | String
-| *camel.component.aws-sqs.configuration.proxy-host* | | | String
-| *camel.component.aws-sqs.configuration.proxy-port* | | | Integer
+| *camel.component.aws-sqs.configuration.proxy-host* | To define a proxy host when instantiating the SQS client | | String
+| *camel.component.aws-sqs.configuration.proxy-port* | To define a proxy port when instantiating the SQS client | | Integer
| *camel.component.aws-sqs.configuration.queue-name* | Name of queue. The queue will be created if they don't already
exists. | | String
| *camel.component.aws-sqs.configuration.queue-owner-a-w-s-account-id* | Specify the queue owner aws account id when you need to connect the
queue with different account owner. | | String
-| *camel.component.aws-sqs.configuration.queue-url* | | | String
+| *camel.component.aws-sqs.configuration.queue-url* | To define the queueUrl explicitly. All other parameters, which would
+ influence the queueUrl, are ignored. This parameter is intended to be
+ used, to connect to a mock implementation of SQS, for testing
+ purposes. | | String
| *camel.component.aws-sqs.configuration.receive-message-wait-time-seconds* | If you do not specify WaitTimeSeconds in the request, the queue
attribute ReceiveMessageWaitTimeSeconds is used to determine how long
to wait. | | Integer
diff --git a/components/camel-aws/src/main/docs/aws-swf-component.adoc b/components/camel-aws/src/main/docs/aws-swf-component.adoc
index 3c8b273..8519580 100644
--- a/components/camel-aws/src/main/docs/aws-swf-component.adoc
+++ b/components/camel-aws/src/main/docs/aws-swf-component.adoc
@@ -128,7 +128,7 @@ The component supports 32 options, which are listed below.
serializing/deserializing the data. | | DataConverter
| *camel.component.aws-swf.configuration.domain-name* | The workflow domain to use. | | String
| *camel.component.aws-swf.configuration.event-name* | The workflow or activity event name to use. | | String
-| *camel.component.aws-swf.configuration.execution-start-to-close-timeout* | | 3600 | String
+| *camel.component.aws-swf.configuration.execution-start-to-close-timeout* | Set the execution start to close timeout. | 3600 | String
| *camel.component.aws-swf.configuration.operation* | Workflow operation | START | String
| *camel.component.aws-swf.configuration.region* | Amazon AWS Region. | | String
| *camel.component.aws-swf.configuration.s-w-client-parameters* | To configure the AmazonSimpleWorkflowClient using the key/values from
@@ -140,7 +140,7 @@ The component supports 32 options, which are listed below.
@param startWorkflowOptionsParameters | | Map
| *camel.component.aws-swf.configuration.state-result-type* | The type of the result when a workflow state is queried. | | String
-| *camel.component.aws-swf.configuration.task-start-to-close-timeout* | | 600 | String
+| *camel.component.aws-swf.configuration.task-start-to-close-timeout* | Set the task start to close timeout. | 600 | String
| *camel.component.aws-swf.configuration.termination-details* | Details for terminating a workflow. | | String
| *camel.component.aws-swf.configuration.termination-reason* | The reason for terminating a workflow. | | String
| *camel.component.aws-swf.configuration.type* | Activity or workflow | | String
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/cw/CwConfiguration.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/cw/CwConfiguration.java
index a802422..183c714 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/cw/CwConfiguration.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/cw/CwConfiguration.java
@@ -139,37 +139,36 @@ public class CwConfiguration implements Cloneable {
public void setAmazonCwClient(AmazonCloudWatch amazonCwClient) {
this.amazonCwClient = amazonCwClient;
}
-
-
- /**
- * To define a proxy host when instantiating the CW client
- */
+
public String getProxyHost() {
return proxyHost;
}
+ /**
+ * To define a proxy host when instantiating the CW client
+ */
public void setProxyHost(String proxyHost) {
this.proxyHost = proxyHost;
}
- /**
- * To define a proxy port when instantiating the CW client
- */
public Integer getProxyPort() {
return proxyPort;
}
+ /**
+ * To define a proxy port when instantiating the CW client
+ */
public void setProxyPort(Integer proxyPort) {
this.proxyPort = proxyPort;
}
- /**
- * The region in which CW client needs to work
- */
public String getRegion() {
return region;
}
+ /**
+ * The region in which CW client needs to work
+ */
public void setRegion(String region) {
this.region = region;
}
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddb/DdbConfiguration.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddb/DdbConfiguration.java
index f245ec4..0328137 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddb/DdbConfiguration.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ddb/DdbConfiguration.java
@@ -164,35 +164,35 @@ public class DdbConfiguration implements Cloneable {
this.keyAttributeType = keyAttributeType;
}
- /**
- * To define a proxy host when instantiating the DDB client
- */
public String getProxyHost() {
return proxyHost;
}
+ /**
+ * To define a proxy host when instantiating the DDB client
+ */
public void setProxyHost(String proxyHost) {
this.proxyHost = proxyHost;
}
- /**
- * To define a proxy port when instantiating the DDB client
- */
public Integer getProxyPort() {
return proxyPort;
}
+ /**
+ * To define a proxy port when instantiating the DDB client
+ */
public void setProxyPort(Integer proxyPort) {
this.proxyPort = proxyPort;
}
- /**
- * The region in which DDB client needs to work
- */
public String getRegion() {
return region;
}
+ /**
+ * The region in which DDB client needs to work
+ */
public void setRegion(String region) {
this.region = region;
}
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ec2/EC2Configuration.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ec2/EC2Configuration.java
index 0576cb7..12b6b08 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ec2/EC2Configuration.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ec2/EC2Configuration.java
@@ -91,35 +91,35 @@ public class EC2Configuration implements Cloneable {
this.operation = operation;
}
- /**
- * To define a proxy host when instantiating the EC2 client
- */
public String getProxyHost() {
return proxyHost;
}
+ /**
+ * To define a proxy host when instantiating the EC2 client
+ */
public void setProxyHost(String proxyHost) {
this.proxyHost = proxyHost;
}
- /**
- * To define a proxy port when instantiating the EC2 client
- */
public Integer getProxyPort() {
return proxyPort;
}
+ /**
+ * To define a proxy port when instantiating the EC2 client
+ */
public void setProxyPort(Integer proxyPort) {
this.proxyPort = proxyPort;
}
- /**
- * The region in which EC2 client needs to work
- */
public String getRegion() {
return region;
}
+ /**
+ * The region in which EC2 client needs to work
+ */
public void setRegion(String region) {
this.region = region;
}
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/kms/KMSConfiguration.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/kms/KMSConfiguration.java
index f5b7f86..b7f7e81 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/kms/KMSConfiguration.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/kms/KMSConfiguration.java
@@ -90,35 +90,35 @@ public class KMSConfiguration implements Cloneable {
this.operation = operation;
}
- /**
- * To define a proxy host when instantiating the KMS client
- */
public String getProxyHost() {
return proxyHost;
}
+ /**
+ * To define a proxy host when instantiating the KMS client
+ */
public void setProxyHost(String proxyHost) {
this.proxyHost = proxyHost;
}
- /**
- * To define a proxy port when instantiating the KMS client
- */
public Integer getProxyPort() {
return proxyPort;
}
+ /**
+ * To define a proxy port when instantiating the KMS client
+ */
public void setProxyPort(Integer proxyPort) {
this.proxyPort = proxyPort;
}
- /**
- * The region in which KMS client needs to work
- */
public String getRegion() {
return region;
}
+ /**
+ * The region in which KMS client needs to work
+ */
public void setRegion(String region) {
this.region = region;
}
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/lambda/LambdaConfiguration.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/lambda/LambdaConfiguration.java
index cd11aa4..d9bb878 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/lambda/LambdaConfiguration.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/lambda/LambdaConfiguration.java
@@ -112,24 +112,24 @@ public class LambdaConfiguration implements Cloneable {
this.operation = operation;
}
- /**
- * To define a proxy host when instantiating the Lambda client
- */
public String getProxyHost() {
return proxyHost;
}
+ /**
+ * To define a proxy host when instantiating the Lambda client
+ */
public void setProxyHost(String proxyHost) {
this.proxyHost = proxyHost;
}
- /**
- * To define a proxy port when instantiating the Lambda client
- */
public Integer getProxyPort() {
return proxyPort;
}
+ /**
+ * To define a proxy port when instantiating the Lambda client
+ */
public void setProxyPort(Integer proxyPort) {
this.proxyPort = proxyPort;
}
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/mq/MQConfiguration.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/mq/MQConfiguration.java
index 2fabf9c..8788849 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/mq/MQConfiguration.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/mq/MQConfiguration.java
@@ -90,35 +90,35 @@ public class MQConfiguration implements Cloneable {
this.operation = operation;
}
- /**
- * To define a proxy host when instantiating the MQ client
- */
public String getProxyHost() {
return proxyHost;
}
+ /**
+ * To define a proxy host when instantiating the MQ client
+ */
public void setProxyHost(String proxyHost) {
this.proxyHost = proxyHost;
}
- /**
- * To define a proxy port when instantiating the MQ client
- */
public Integer getProxyPort() {
return proxyPort;
}
+ /**
+ * To define a proxy port when instantiating the MQ client
+ */
public void setProxyPort(Integer proxyPort) {
this.proxyPort = proxyPort;
}
- /**
- * The region in which MQ client needs to work
- */
public String getRegion() {
return region;
}
+ /**
+ * The region in which MQ client needs to work
+ */
public void setRegion(String region) {
this.region = region;
}
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sdb/SdbConfiguration.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sdb/SdbConfiguration.java
index d93fbe4..c299651 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sdb/SdbConfiguration.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sdb/SdbConfiguration.java
@@ -124,35 +124,35 @@ public class SdbConfiguration {
this.consistentRead = consistentRead;
}
- /**
- * To define a proxy host when instantiating the SDB client
- */
public String getProxyHost() {
return proxyHost;
}
+ /**
+ * To define a proxy host when instantiating the SDB client
+ */
public void setProxyHost(String proxyHost) {
this.proxyHost = proxyHost;
}
- /**
- * To define a proxy port when instantiating the SDB client
- */
public Integer getProxyPort() {
return proxyPort;
}
+ /**
+ * To define a proxy port when instantiating the SDB client
+ */
public void setProxyPort(Integer proxyPort) {
this.proxyPort = proxyPort;
}
- /**
- * The region in which SDB client needs to work
- */
public String getRegion() {
return region;
}
+ /**
+ * The region in which SDB client needs to work
+ */
public void setRegion(String region) {
this.region = region;
}
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ses/SesConfiguration.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ses/SesConfiguration.java
index ffc69f3..ee817d2 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/ses/SesConfiguration.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/ses/SesConfiguration.java
@@ -152,35 +152,35 @@ public class SesConfiguration implements Cloneable {
this.replyToAddresses = Arrays.asList(replyToAddresses.split(","));
}
- /**
- * To define a proxy host when instantiating the SES client
- */
public String getProxyHost() {
return proxyHost;
}
+ /**
+ * To define a proxy host when instantiating the SES client
+ */
public void setProxyHost(String proxyHost) {
this.proxyHost = proxyHost;
}
- /**
- * To define a proxy port when instantiating the SES client
- */
public Integer getProxyPort() {
return proxyPort;
}
+ /**
+ * To define a proxy port when instantiating the SES client
+ */
public void setProxyPort(Integer proxyPort) {
this.proxyPort = proxyPort;
}
- /**
- * The region in which SES client needs to work
- */
public String getRegion() {
return region;
}
+ /**
+ * The region in which SES client needs to work
+ */
public void setRegion(String region) {
this.region = region;
}
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sns/SnsConfiguration.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sns/SnsConfiguration.java
index dccb223..80f5ef2 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sns/SnsConfiguration.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sns/SnsConfiguration.java
@@ -138,35 +138,35 @@ public class SnsConfiguration implements Cloneable {
this.messageStructure = messageStructure;
}
- /**
- * To define a proxy host when instantiating the SNS client
- */
public String getProxyHost() {
return proxyHost;
}
+ /**
+ * To define a proxy host when instantiating the SNS client
+ */
public void setProxyHost(String proxyHost) {
this.proxyHost = proxyHost;
}
- /**
- * To define a proxy port when instantiating the SNS client
- */
public Integer getProxyPort() {
return proxyPort;
}
+ /**
+ * To define a proxy port when instantiating the SNS client
+ */
public void setProxyPort(Integer proxyPort) {
this.proxyPort = proxyPort;
}
- /**
- * The region in which SNS client needs to work
- */
public String getRegion() {
return region;
}
+ /**
+ * The region in which SNS client needs to work
+ */
public void setRegion(String region) {
this.region = region;
}
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sqs/SqsConfiguration.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sqs/SqsConfiguration.java
index 6c02929..9714074 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/sqs/SqsConfiguration.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/sqs/SqsConfiguration.java
@@ -337,47 +337,47 @@ public class SqsConfiguration implements Cloneable {
this.region = region;
}
- /**
- * Allows you to use multiple threads to poll the sqs queue to increase throughput
- */
public int getConcurrentConsumers() {
return concurrentConsumers;
}
+ /**
+ * Allows you to use multiple threads to poll the sqs queue to increase throughput
+ */
public void setConcurrentConsumers(int concurrentConsumers) {
this.concurrentConsumers = concurrentConsumers;
}
- /**
- * To define the queueUrl explicitly. All other parameters, which would influence the queueUrl, are ignored.
- * This parameter is intended to be used, to connect to a mock implementation of SQS, for testing purposes.
- */
public String getQueueUrl() {
return queueUrl;
}
+ /**
+ * To define the queueUrl explicitly. All other parameters, which would influence the queueUrl, are ignored.
+ * This parameter is intended to be used, to connect to a mock implementation of SQS, for testing purposes.
+ */
public void setQueueUrl(String queueUrl) {
this.queueUrl = queueUrl;
}
- /**
- * To define a proxy host when instantiating the SQS client
- */
public String getProxyHost() {
return proxyHost;
}
+ /**
+ * To define a proxy host when instantiating the SQS client
+ */
public void setProxyHost(String proxyHost) {
this.proxyHost = proxyHost;
}
- /**
- * To define a proxy port when instantiating the SQS client
- */
public Integer getProxyPort() {
return proxyPort;
}
+ /**
+ * To define a proxy port when instantiating the SQS client
+ */
public void setProxyPort(Integer proxyPort) {
this.proxyPort = proxyPort;
}
diff --git a/components/camel-aws/src/main/java/org/apache/camel/component/aws/swf/SWFConfiguration.java b/components/camel-aws/src/main/java/org/apache/camel/component/aws/swf/SWFConfiguration.java
index d756d94..c790389 100644
--- a/components/camel-aws/src/main/java/org/apache/camel/component/aws/swf/SWFConfiguration.java
+++ b/components/camel-aws/src/main/java/org/apache/camel/component/aws/swf/SWFConfiguration.java
@@ -370,24 +370,24 @@ public class SWFConfiguration implements Cloneable {
this.activityThreadPoolSize = activityThreadPoolSize;
}
- /**
- * Set the execution start to close timeout.
- */
public String getExecutionStartToCloseTimeout() {
return executionStartToCloseTimeout;
}
+ /**
+ * Set the execution start to close timeout.
+ */
public void setExecutionStartToCloseTimeout(String executionStartToCloseTimeout) {
this.executionStartToCloseTimeout = executionStartToCloseTimeout;
}
- /**
- * Set the task start to close timeout.
- */
public String getTaskStartToCloseTimeout() {
return taskStartToCloseTimeout;
}
+ /**
+ * Set the task start to close timeout.
+ */
public void setTaskStartToCloseTimeout(String taskStartToCloseTimeout) {
this.taskStartToCloseTimeout = taskStartToCloseTimeout;
}
diff --git a/platforms/spring-boot/components-starter/camel-ahc-ws-starter/src/main/java/org/apache/camel/component/ahc/ws/springboot/WsComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-ahc-ws-starter/src/main/java/org/apache/camel/component/ahc/ws/springboot/WsComponentConfiguration.java
index c547a68..4a4e73c 100644
--- a/platforms/spring-boot/components-starter/camel-ahc-ws-starter/src/main/java/org/apache/camel/component/ahc/ws/springboot/WsComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-ahc-ws-starter/src/main/java/org/apache/camel/component/ahc/ws/springboot/WsComponentConfiguration.java
@@ -32,7 +32,7 @@ public class WsComponentConfiguration
ComponentConfigurationPropertiesCommon {
/**
- * Whether to enable auto configuration of the ahc-ws component. This is
+ * Whether to enable auto configuration of the ahc-wss component. This is
* enabled by default.
*/
private Boolean enabled;
diff --git a/platforms/spring-boot/components-starter/camel-avro-starter/src/main/java/org/apache/camel/component/avro/springboot/AvroComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-avro-starter/src/main/java/org/apache/camel/component/avro/springboot/AvroComponentConfiguration.java
index 70ef9a0..264ba6e 100644
--- a/platforms/spring-boot/components-starter/camel-avro-starter/src/main/java/org/apache/camel/component/avro/springboot/AvroComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-avro-starter/src/main/java/org/apache/camel/component/avro/springboot/AvroComponentConfiguration.java
@@ -81,6 +81,9 @@ public class AvroComponentConfiguration
* Avro protocol to use
*/
private Protocol protocol;
+ /**
+ * Transport to use, can be either http or netty
+ */
private AvroTransport transport;
/**
* Avro protocol location
diff --git a/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/cw/springboot/CwComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/cw/springboot/CwComponentConfiguration.java
index 4947183..9c2b12f 100644
--- a/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/cw/springboot/CwComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/cw/springboot/CwComponentConfiguration.java
@@ -137,8 +137,17 @@ public class CwComponentConfiguration
* To use the AmazonCloudWatch as the client
*/
private AmazonCloudWatch amazonCwClient;
+ /**
+ * To define a proxy host when instantiating the CW client
+ */
private String proxyHost;
+ /**
+ * To define a proxy port when instantiating the CW client
+ */
private Integer proxyPort;
+ /**
+ * The region in which CW client needs to work
+ */
private String region;
public String getAccessKey() {
diff --git a/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/ddb/springboot/DdbComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/ddb/springboot/DdbComponentConfiguration.java
index 7cd073b..162bb9b 100644
--- a/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/ddb/springboot/DdbComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/ddb/springboot/DdbComponentConfiguration.java
@@ -150,8 +150,17 @@ public class DdbComponentConfiguration
* Attribute type when creating table
*/
private String keyAttributeType;
+ /**
+ * To define a proxy host when instantiating the DDB client
+ */
private String proxyHost;
+ /**
+ * To define a proxy port when instantiating the DDB client
+ */
private Integer proxyPort;
+ /**
+ * The region in which DDB client needs to work
+ */
private String region;
public String getAccessKey() {
diff --git a/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/ddbstream/springboot/DdbStreamComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/ddbstream/springboot/DdbStreamComponentConfiguration.java
index e4cfe06..1400d38 100644
--- a/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/ddbstream/springboot/DdbStreamComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/ddbstream/springboot/DdbStreamComponentConfiguration.java
@@ -107,15 +107,50 @@ public class DdbStreamComponentConfiguration
public static class DdbStreamConfigurationNestedConfiguration {
public static final Class CAMEL_NESTED_CLASS = org.apache.camel.component.aws.ddbstream.DdbStreamConfiguration.class;
+ /**
+ * Amazon DynamoDB client to use for all requests for this endpoint
+ */
private AmazonDynamoDBStreams amazonDynamoDbStreamsClient;
+ /**
+ * Amazon AWS Access Key
+ */
private String accessKey;
+ /**
+ * Amazon AWS Secret Key
+ */
private String secretKey;
+ /**
+ * The region in which DDBStreams client needs to work
+ */
private String region;
+ /**
+ * Maximum number of records that will be fetched in each poll
+ */
private Integer maxResultsPerRequest;
+ /**
+ * Name of the dynamodb table
+ */
private String tableName;
+ /**
+ * Defines where in the DynaboDB stream to start getting records. Note
+ * that using TRIM_HORIZON can cause a significant delay before the
+ * stream has caught up to real-time. if AT,AFTER_SEQUENCE_NUMBER are
+ * used, then a sequenceNumberProvider MUST be supplied.
+ */
private ShardIteratorType iteratorType = ShardIteratorType.LATEST;
+ /**
+ * Provider for the sequence number when using one of the two
+ * ShardIteratorType.AT,AFTER_SEQUENCE_NUMBER iterator types. Can be a
+ * registry reference or a literal sequence number.
+ */
private SequenceNumberProvider sequenceNumberProvider;
+ /**
+ * To define a proxy host when instantiating the DDBStreams client
+ */
private String proxyHost;
+ /**
+ * To define a proxy port when instantiating the DDBStreams client
+ */
private Integer proxyPort;
public AmazonDynamoDBStreams getAmazonDynamoDbStreamsClient() {
diff --git a/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/ec2/springboot/EC2ComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/ec2/springboot/EC2ComponentConfiguration.java
index a58a8d3..4a6d391 100644
--- a/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/ec2/springboot/EC2ComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/ec2/springboot/EC2ComponentConfiguration.java
@@ -124,8 +124,17 @@ public class EC2ComponentConfiguration
* unmonitorInstances, createTags or deleteTags
*/
private EC2Operations operation;
+ /**
+ * To define a proxy host when instantiating the EC2 client
+ */
private String proxyHost;
+ /**
+ * To define a proxy port when instantiating the EC2 client
+ */
private Integer proxyPort;
+ /**
+ * The region in which EC2 client needs to work
+ */
private String region;
public AmazonEC2Client getAmazonEc2Client() {
diff --git a/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/firehose/springboot/KinesisFirehoseComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/firehose/springboot/KinesisFirehoseComponentConfiguration.java
index 82d0e59..a64422b 100644
--- a/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/firehose/springboot/KinesisFirehoseComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/firehose/springboot/KinesisFirehoseComponentConfiguration.java
@@ -105,12 +105,34 @@ public class KinesisFirehoseComponentConfiguration
public static class KinesisFirehoseConfigurationNestedConfiguration {
public static final Class CAMEL_NESTED_CLASS = org.apache.camel.component.aws.firehose.KinesisFirehoseConfiguration.class;
+ /**
+ * Amazon Kinesis Firehose client to use for all requests for this
+ * endpoint
+ */
private AmazonKinesisFirehose amazonKinesisFirehoseClient;
+ /**
+ * Name of the stream
+ */
private String streamName;
+ /**
+ * Amazon AWS Access Key
+ */
private String accessKey;
+ /**
+ * Amazon AWS Secret Key
+ */
private String secretKey;
+ /**
+ * The region in which Kinesis client needs to work
+ */
private String region;
+ /**
+ * To define a proxy host when instantiating the DDBStreams client
+ */
private String proxyHost;
+ /**
+ * To define a proxy port when instantiating the DDBStreams client
+ */
private Integer proxyPort;
public AmazonKinesisFirehose getAmazonKinesisFirehoseClient() {
diff --git a/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/kinesis/springboot/KinesisComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/kinesis/springboot/KinesisComponentConfiguration.java
index b0243de..58d7c8e 100644
--- a/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/kinesis/springboot/KinesisComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/kinesis/springboot/KinesisComponentConfiguration.java
@@ -108,17 +108,59 @@ public class KinesisComponentConfiguration
public static class KinesisConfigurationNestedConfiguration {
public static final Class CAMEL_NESTED_CLASS = org.apache.camel.component.aws.kinesis.KinesisConfiguration.class;
+ /**
+ * Amazon Kinesis client to use for all requests for this endpoint
+ */
private AmazonKinesis amazonKinesisClient;
+ /**
+ * Maximum number of records that will be fetched in each poll
+ */
private Integer maxResultsPerRequest = 1;
+ /**
+ * Name of the stream
+ */
private String streamName;
+ /**
+ * Defines where in the Kinesis stream to start getting records
+ */
private ShardIteratorType iteratorType = ShardIteratorType.TRIM_HORIZON;
+ /**
+ * Defines which shardId in the Kinesis stream to get records from
+ */
private String shardId;
+ /**
+ * The sequence number to start polling from. Required if iteratorType
+ * is set to AFTER_SEQUENCE_NUMBER or AT_SEQUENCE_NUMBER
+ */
private String sequenceNumber;
+ /**
+ * Define what will be the behavior in case of shard closed. Possible
+ * value are ignore, silent and fail.In case of ignore a message will be
+ * logged and the consumer will restart from the beginning,in case of
+ * silent there will be no logging and the consumer will start from the
+ * beginning,in case of fail a ReachedClosedStateException will be
+ * raised
+ */
private KinesisShardClosedStrategyEnum shardClosed = KinesisShardClosedStrategyEnum.ignore;
+ /**
+ * Amazon AWS Access Key
+ */
private String accessKey;
+ /**
+ * Amazon AWS Secret Key
+ */
private String secretKey;
+ /**
+ * The region in which Kinesis client needs to work
+ */
private String region;
+ /**
+ * To define a proxy host when instantiating the DDBStreams client
+ */
private String proxyHost;
+ /**
+ * To define a proxy port when instantiating the DDBStreams client
+ */
private Integer proxyPort;
public AmazonKinesis getAmazonKinesisClient() {
diff --git a/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/kms/springboot/KMSComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/kms/springboot/KMSComponentConfiguration.java
index 4a9d374..f55bb67 100644
--- a/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/kms/springboot/KMSComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/kms/springboot/KMSComponentConfiguration.java
@@ -121,8 +121,17 @@ public class KMSComponentConfiguration
* The operation to perform
*/
private KMSOperations operation;
+ /**
+ * To define a proxy host when instantiating the KMS client
+ */
private String proxyHost;
+ /**
+ * To define a proxy port when instantiating the KMS client
+ */
private Integer proxyPort;
+ /**
+ * The region in which KMS client needs to work
+ */
private String region;
public AWSKMS getKmsClient() {
diff --git a/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/lambda/springboot/LambdaComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/lambda/springboot/LambdaComponentConfiguration.java
index e67bf30..dc3c0e2 100644
--- a/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/lambda/springboot/LambdaComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/lambda/springboot/LambdaComponentConfiguration.java
@@ -131,7 +131,13 @@ public class LambdaComponentConfiguration
* createFunction, deleteFunction or invokeFunction
*/
private LambdaOperations operation;
+ /**
+ * To define a proxy host when instantiating the Lambda client
+ */
private String proxyHost;
+ /**
+ * To define a proxy port when instantiating the Lambda client
+ */
private Integer proxyPort;
public String getFunction() {
diff --git a/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/mq/springboot/MQComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/mq/springboot/MQComponentConfiguration.java
index df06c0c..ca0ed52 100644
--- a/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/mq/springboot/MQComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/mq/springboot/MQComponentConfiguration.java
@@ -122,8 +122,17 @@ public class MQComponentConfiguration
* listBrokers,createBroker,deleteBroker
*/
private MQOperations operation;
+ /**
+ * To define a proxy host when instantiating the MQ client
+ */
private String proxyHost;
+ /**
+ * To define a proxy port when instantiating the MQ client
+ */
private Integer proxyPort;
+ /**
+ * The region in which MQ client needs to work
+ */
private String region;
public AmazonMQ getAmazonMqClient() {
diff --git a/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/s3/springboot/S3ComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/s3/springboot/S3ComponentConfiguration.java
index 7b6c835..6d8eb7d 100644
--- a/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/s3/springboot/S3ComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/s3/springboot/S3ComponentConfiguration.java
@@ -115,7 +115,7 @@ public class S3ComponentConfiguration
private Long partSize = 26214400L;
/**
* If it is true, camel will upload the file with multi part format, the
- * part size is decided by the option of `partSize`
+ * part size is decided by the option of partSize
*/
private Boolean multiPartUpload = false;
/**
@@ -127,8 +127,8 @@ public class S3ComponentConfiguration
*/
private String secretKey;
/**
- * Reference to a `com.amazonaws.services.sqs.AmazonS3` in the
- * link:registry.html[Registry].
+ * Reference to a com.amazonaws.services.sqs.AmazonS3 in the
+ * link:registry.htmlRegistry.
*/
private AmazonS3 amazonS3Client;
/**
@@ -163,13 +163,12 @@ public class S3ComponentConfiguration
/**
* Delete objects from S3 after they have been retrieved. The delete is
* only performed if the Exchange is committed. If a rollback occurs,
- * the object is not deleted.
- * <p/>
- * If this option is false, then the same objects will be retrieve over
- * and over again on the polls. Therefore you need to use the Idempotent
- * Consumer EIP in the route to filter out duplicates. You can filter
- * using the {@link S3Constants#BUCKET_NAME} and {@link S3Constants#KEY}
- * headers, or only the {@link S3Constants#KEY} header.
+ * the object is not deleted. If this option is false, then the same
+ * objects will be retrieve over and over again on the polls. Therefore
+ * you need to use the Idempotent Consumer EIP in the route to filter
+ * out duplicates. You can filter using the link S3ConstantsBUCKET_NAME
+ * and link S3ConstantsKEY headers, or only the link S3ConstantsKEY
+ * header.
*/
private Boolean deleteAfterRead = true;
/**
@@ -178,17 +177,17 @@ public class S3ComponentConfiguration
private Boolean deleteAfterWrite = false;
/**
* The policy for this queue to set in the
- * `com.amazonaws.services.s3.AmazonS3#setBucketPolicy()` method.
+ * com.amazonaws.services.s3.AmazonS3setBucketPolicy() method.
*/
private String policy;
/**
* The storage class to set in the
- * `com.amazonaws.services.s3.model.PutObjectRequest` request.
+ * com.amazonaws.services.s3.model.PutObjectRequest request.
*/
private String storageClass;
/**
* Sets the server-side encryption algorithm when encrypting the object
- * using AWS-managed keys. For example use <tt>AES256</tt>.
+ * using AWS-managed keys. For example use AES256.
*/
private String serverSideEncryption;
/**
diff --git a/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/ses/springboot/SesComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/ses/springboot/SesComponentConfiguration.java
index c568888..eb94199 100644
--- a/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/ses/springboot/SesComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/ses/springboot/SesComponentConfiguration.java
@@ -141,8 +141,17 @@ public class SesComponentConfiguration
* 'CamelAwsSesReplyToAddresses' header.
*/
private List replyToAddresses;
+ /**
+ * To define a proxy host when instantiating the SES client
+ */
private String proxyHost;
+ /**
+ * To define a proxy port when instantiating the SES client
+ */
private Integer proxyPort;
+ /**
+ * The region in which SES client needs to work
+ */
private String region;
public String getAccessKey() {
diff --git a/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/sns/springboot/SnsComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/sns/springboot/SnsComponentConfiguration.java
index 6c3fa4f..213404e 100644
--- a/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/sns/springboot/SnsComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/sns/springboot/SnsComponentConfiguration.java
@@ -138,8 +138,17 @@ public class SnsComponentConfiguration
* The message structure to use such as json
*/
private String messageStructure;
+ /**
+ * To define a proxy host when instantiating the SNS client
+ */
private String proxyHost;
+ /**
+ * To define a proxy port when instantiating the SNS client
+ */
private Integer proxyPort;
+ /**
+ * The region in which SNS client needs to work
+ */
private String region;
public String getSubject() {
diff --git a/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/sqs/springboot/SqsComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/sqs/springboot/SqsComponentConfiguration.java
index 55f7083..d06b7bd 100644
--- a/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/sqs/springboot/SqsComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/sqs/springboot/SqsComponentConfiguration.java
@@ -212,9 +212,25 @@ public class SqsComponentConfiguration
* queueOwnerAWSAccountId to build the service URL.
*/
private String region;
+ /**
+ * Allows you to use multiple threads to poll the sqs queue to increase
+ * throughput
+ */
private Integer concurrentConsumers = 1;
+ /**
+ * To define the queueUrl explicitly. All other parameters, which would
+ * influence the queueUrl, are ignored. This parameter is intended to be
+ * used, to connect to a mock implementation of SQS, for testing
+ * purposes.
+ */
private String queueUrl;
+ /**
+ * To define a proxy host when instantiating the SQS client
+ */
private String proxyHost;
+ /**
+ * To define a proxy port when instantiating the SQS client
+ */
private Integer proxyPort;
public String getAmazonAWSHost() {
diff --git a/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/swf/springboot/SWFComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/swf/springboot/SWFComponentConfiguration.java
index ac5bf09..bd0b452 100644
--- a/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/swf/springboot/SWFComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-aws-starter/src/main/java/org/apache/camel/component/aws/swf/springboot/SWFComponentConfiguration.java
@@ -164,8 +164,6 @@ public class SWFComponentConfiguration
/**
* To configure the StartWorkflowOptions using the key/values from the
* Map.
- *
- * @param startWorkflowOptionsParameters
*/
private Map startWorkflowOptionsParameters;
/**
@@ -218,7 +216,13 @@ public class SWFComponentConfiguration
* Maximum number of threads in work pool for activity.
*/
private Integer activityThreadPoolSize = 100;
+ /**
+ * Set the execution start to close timeout.
+ */
private String executionStartToCloseTimeout = "3600";
+ /**
+ * Set the task start to close timeout.
+ */
private String taskStartToCloseTimeout = "600";
public String getAccessKey() {
diff --git a/platforms/spring-boot/components-starter/camel-box-starter/src/main/java/org/apache/camel/component/box/springboot/BoxComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-box-starter/src/main/java/org/apache/camel/component/box/springboot/BoxComponentConfiguration.java
index 65a0d2b..fc839cf 100644
--- a/platforms/spring-boot/components-starter/camel-box-starter/src/main/java/org/apache/camel/component/box/springboot/BoxComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-box-starter/src/main/java/org/apache/camel/component/box/springboot/BoxComponentConfiguration.java
@@ -75,115 +75,66 @@ public class BoxComponentConfiguration
public static final Class CAMEL_NESTED_CLASS = org.apache.camel.component.box.BoxConfiguration.class;
/**
* What kind of operation to perform
- *
- * @param apiNamethe
- * API Name to set
*/
private BoxApiName apiName;
/**
* What sub operation to use for the selected operation
- *
- * @param methodNamethe
- * methodName to set
*/
private String methodName;
/**
* The enterprise ID to use for an App Enterprise.
- *
- * @param enterpriseIdthe
- * enterpriseId to set
*/
private String enterpriseId;
/**
* The user ID to use for an App User.
- *
- * @param userIdthe
- * userId to set
*/
private String userId;
/**
* The ID for public key for validating the JWT signature.
- *
- * @param publicKeyIdthe
- * publicKeyId to set
*/
private String publicKeyId;
/**
* The private key for generating the JWT signature.
- *
- * @param privateKeythe
- * privateKey to set
*/
private String privateKeyFile;
/**
* The password for the private key.
- *
- * @param privateKeyPasswordthe
- * privateKeyPassword to set
*/
private String privateKeyPassword;
/**
- * The type of authentication for connection.
- * <p>
- * Types of Authentication:
- * <ul>
- * <li>STANDARD_AUTHENTICATION - OAuth 2.0 (3-legged)</li>
- * <li>SERVER_AUTHENTICATION - OAuth 2.0 with JSON Web Tokens</li>
- * </ul>
- *
- * @param authenticationTypethe
- * authenticationType to set
+ * The type of authentication for connection. Types of Authentication:
+ * STANDARD_AUTHENTICATION - OAuth 2.0 (3-legged) SERVER_AUTHENTICATION
+ * - OAuth 2.0 with JSON Web Tokens
*/
private String authenticationType = "APP_USER_AUTHENTICATION";
/**
* Box application client ID
- *
- * @param clientIdthe
- * clientId to set
*/
private String clientId;
/**
* Box application client secret
- *
- * @param clientSecretthe
- * clientSecret to set
*/
private String clientSecret;
/**
* Box user name, MUST be provided
- *
- * @param userNamethe
- * userName to set
*/
private String userName;
/**
* Box user password, MUST be provided if authSecureStorage is not set,
* or returns null on first call
- *
- * @param userPasswordthe
- * userPassword to set
*/
private String userPassword;
/**
* Custom HTTP params for settings like proxy host
- *
- * @param httpParamsthe
- * httpParams to set
*/
private Map httpParams;
/**
* To configure security using SSLContextParameters.
- *
- * @param sslContextParametersthe
- * sslContextParameters to set
*/
@NestedConfigurationProperty
private SSLContextParameters sslContextParameters;
/**
* Custom Access Token Cache for storing and retrieving access tokens.
- *
- * @param accessTokenCache
- * - the Custom Access Token Cache
*/
private IAccessTokenCache accessTokenCache;
diff --git a/platforms/spring-boot/components-starter/camel-braintree-starter/src/main/java/org/apache/camel/component/braintree/springboot/BraintreeComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-braintree-starter/src/main/java/org/apache/camel/component/braintree/springboot/BraintreeComponentConfiguration.java
index f8fe742..2bd20fe 100644
--- a/platforms/spring-boot/components-starter/camel-braintree-starter/src/main/java/org/apache/camel/component/braintree/springboot/BraintreeComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-braintree-starter/src/main/java/org/apache/camel/component/braintree/springboot/BraintreeComponentConfiguration.java
@@ -109,7 +109,7 @@ public class BraintreeComponentConfiguration
*/
private Integer proxyPort;
/**
- * Set logging level for http calls, @see java.util.logging.Level
+ * Set logging level for http calls, see java.util.logging.Level
*/
private Level httpLogLevel;
/**
diff --git a/platforms/spring-boot/components-starter/camel-cache-starter/src/main/java/org/apache/camel/component/cache/springboot/CacheComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-cache-starter/src/main/java/org/apache/camel/component/cache/springboot/CacheComponentConfiguration.java
index b731016..226da4f 100644
--- a/platforms/spring-boot/components-starter/camel-cache-starter/src/main/java/org/apache/camel/component/cache/springboot/CacheComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-cache-starter/src/main/java/org/apache/camel/component/cache/springboot/CacheComponentConfiguration.java
@@ -112,11 +112,8 @@ public class CacheComponentConfiguration
/**
* Which eviction strategy to use when maximum number of elements in
* memory is reached. The strategy defines which elements to be removed.
- * <ul>
- * <li>LRU - Lest Recently Used</li>
- * <li>LFU - Lest Frequently Used</li>
- * <li>FIFO - First In First Out</li>
- * </ul>
+ * LRU - Lest Recently Used LFU - Lest Frequently Used FIFO - First In
+ * First Out
*/
private MemoryStoreEvictionPolicy memoryStoreEvictionPolicy;
/**
diff --git a/platforms/spring-boot/components-starter/camel-caffeine-starter/src/main/java/org/apache/camel/component/caffeine/cache/springboot/CaffeineCacheComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-caffeine-starter/src/main/java/org/apache/camel/component/caffeine/cache/springboot/CaffeineCacheComponentConfiguration.java
index dccd298..f0a52bd 100644
--- a/platforms/spring-boot/components-starter/camel-caffeine-starter/src/main/java/org/apache/camel/component/caffeine/cache/springboot/CaffeineCacheComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-caffeine-starter/src/main/java/org/apache/camel/component/caffeine/cache/springboot/CaffeineCacheComponentConfiguration.java
@@ -89,11 +89,11 @@ public class CaffeineCacheComponentConfiguration
*/
private Object key;
/**
- * The cache key type, default "java.lang.Object"
+ * The cache key type, default java.lang.Object
*/
private String keyType = "java.lang.Object";
/**
- * The cache value type, default "java.lang.Object"
+ * The cache value type, default java.lang.Object
*/
private String valueType = "java.lang.Object";
/**
diff --git a/platforms/spring-boot/components-starter/camel-caffeine-starter/src/main/java/org/apache/camel/component/caffeine/load/springboot/CaffeineLoadCacheComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-caffeine-starter/src/main/java/org/apache/camel/component/caffeine/load/springboot/CaffeineLoadCacheComponentConfiguration.java
index 0a86dfc..217d31d 100644
--- a/platforms/spring-boot/components-starter/camel-caffeine-starter/src/main/java/org/apache/camel/component/caffeine/load/springboot/CaffeineLoadCacheComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-caffeine-starter/src/main/java/org/apache/camel/component/caffeine/load/springboot/CaffeineLoadCacheComponentConfiguration.java
@@ -90,11 +90,11 @@ public class CaffeineLoadCacheComponentConfiguration
*/
private Object key;
/**
- * The cache key type, default "java.lang.Object"
+ * The cache key type, default java.lang.Object
*/
private String keyType = "java.lang.Object";
/**
- * The cache value type, default "java.lang.Object"
+ * The cache value type, default java.lang.Object
*/
private String valueType = "java.lang.Object";
/**
diff --git a/platforms/spring-boot/components-starter/camel-crypto-starter/src/main/java/org/apache/camel/component/crypto/springboot/DigitalSignatureComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-crypto-starter/src/main/java/org/apache/camel/component/crypto/springboot/DigitalSignatureComponentConfiguration.java
index 984c26b..932a61e 100644
--- a/platforms/spring-boot/components-starter/camel-crypto-starter/src/main/java/org/apache/camel/component/crypto/springboot/DigitalSignatureComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-crypto-starter/src/main/java/org/apache/camel/component/crypto/springboot/DigitalSignatureComponentConfiguration.java
@@ -22,7 +22,6 @@ import java.security.PublicKey;
import java.security.SecureRandom;
import java.security.cert.Certificate;
import javax.annotation.Generated;
-import org.apache.camel.CamelContext;
import org.apache.camel.component.crypto.CryptoOperation;
import org.apache.camel.spring.boot.ComponentConfigurationPropertiesCommon;
import org.apache.camel.util.jsse.KeyStoreParameters;
@@ -77,7 +76,6 @@ public class DigitalSignatureComponentConfiguration
public static class DigitalSignatureConfigurationNestedConfiguration {
public static final Class CAMEL_NESTED_CLASS = org.apache.camel.component.crypto.DigitalSignatureConfiguration.class;
- private CamelContext camelContext;
/**
* The logical name of this operation.
*/
@@ -88,18 +86,15 @@ public class DigitalSignatureComponentConfiguration
*/
private String algorithm = "SHA1WithDSA";
/**
- * Sets the alias used to query the KeyStore for keys and
- * {@link java.security.cert.Certificate Certificates} to be used in
- * signing and verifying exchanges. This value can be provided at
- * runtime via the message header
- * {@link org.apache.camel.component.crypto.DigitalSignatureConstants#KEYSTORE_ALIAS}
+ * Sets the alias used to query the KeyStore for keys and link
+ * java.security.cert.Certificate Certificates to be used in signing and
+ * verifying exchanges. This value can be provided at runtime via the
+ * message header link org.apache.camel.component.crypto.
+ * DigitalSignatureConstantsKEYSTORE_ALIAS
*/
private String alias;
/**
* Set the PrivateKey that should be used to sign the exchange
- *
- * @param privateKey
- * the key with with to sign the exchange.
*/
private PrivateKey privateKey;
/**
@@ -113,8 +108,7 @@ public class DigitalSignatureComponentConfiguration
*/
private PublicKey publicKey;
/**
- * Sets the reference name for a publicKey that can be fond in the
- * registry.
+ * references that should be resolved when the context changes
*/
private String publicKeyName;
/**
@@ -129,11 +123,11 @@ public class DigitalSignatureComponentConfiguration
private String certificateName;
/**
* Sets the KeyStore that can contain keys and Certficates for use in
- * signing and verifying exchanges. A {@link KeyStore} is typically used
- * with an alias, either one supplied in the Route definition or
- * dynamically via the message header "CamelSignatureKeyStoreAlias". If
- * no alias is supplied and there is only a single entry in the
- * Keystore, then this single entry will be used.
+ * signing and verifying exchanges. A KeyStore is typically used with an
+ * alias, either one supplied in the Route definition or dynamically via
+ * the message header CamelSignatureKeyStoreAlias. If no alias is
+ * supplied and there is only a single entry in the Keystore, then this
+ * single entry will be used.
*/
private KeyStore keystore;
/**
@@ -142,26 +136,23 @@ public class DigitalSignatureComponentConfiguration
*/
private String keystoreName;
/**
- * Sets the password used to access an aliased {@link PrivateKey} in the
+ * Sets the password used to access an aliased PrivateKey in the
* KeyStore.
*/
private char[] password;
/**
* Sets the KeyStore that can contain keys and Certficates for use in
* signing and verifying exchanges based on the given
- * KeyStoreParameters. A {@link KeyStore} is typically used with an
- * alias, either one supplied in the Route definition or dynamically via
- * the message header "CamelSignatureKeyStoreAlias". If no alias is
- * supplied and there is only a single entry in the Keystore, then this
- * single entry will be used.
+ * KeyStoreParameters. A KeyStore is typically used with an alias,
+ * either one supplied in the Route definition or dynamically via the
+ * message header CamelSignatureKeyStoreAlias. If no alias is supplied
+ * and there is only a single entry in the Keystore, then this single
+ * entry will be used.
*/
@NestedConfigurationProperty
private KeyStoreParameters keyStoreParameters;
/**
* Set the SecureRandom used to initialize the Signature service
- *
- * @param secureRandom
- * the random used to init the Signature service
*/
private SecureRandom secureRandom;
/**
@@ -175,10 +166,7 @@ public class DigitalSignatureComponentConfiguration
private Integer bufferSize = 2048;
/**
* Set the id of the security provider that provides the configured
- * {@link Signature} algorithm.
- *
- * @param provider
- * the id of the security provider
+ * Signature algorithm.
*/
private String provider;
/**
@@ -193,16 +181,12 @@ public class DigitalSignatureComponentConfiguration
* passwords may escape if unset.
*/
private Boolean clearHeaders = true;
+ /**
+ * Set the Crypto operation from that supplied after the crypto scheme
+ * in the endpoint uri e.g. crypto:sign sets sign as the operation.
+ */
private CryptoOperation cryptoOperation;
- public CamelContext getCamelContext() {
- return camelContext;
- }
-
- public void setCamelContext(CamelContext camelContext) {
- this.camelContext = camelContext;
- }
-
public String getName() {
return name;
}
diff --git a/platforms/spring-boot/components-starter/camel-ehcache-starter/src/main/java/org/apache/camel/component/ehcache/springboot/EhcacheComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-ehcache-starter/src/main/java/org/apache/camel/component/ehcache/springboot/EhcacheComponentConfiguration.java
index 86acc14..95d8861 100644
--- a/platforms/spring-boot/components-starter/camel-ehcache-starter/src/main/java/org/apache/camel/component/ehcache/springboot/EhcacheComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-ehcache-starter/src/main/java/org/apache/camel/component/ehcache/springboot/EhcacheComponentConfiguration.java
@@ -175,20 +175,32 @@ public class EhcacheComponentConfiguration
* The cache manager configuration
*/
private Configuration cacheManagerConfiguration;
+ /**
+ * Set the delivery mode (ordered, unordered)
+ */
private EventOrdering eventOrdering = EventOrdering.ORDERED;
+ /**
+ * Set the delivery mode (synchronous, asynchronous)
+ */
private EventFiring eventFiring = EventFiring.ASYNCHRONOUS;
+ /**
+ * Set the type of events to listen for
+ */
private Set eventTypes;
/**
* The default cache configuration to be used to create caches.
*/
private CacheConfiguration configuration;
+ /**
+ * A map of cache configuration to be used to create caches.
+ */
private Map configurations;
/**
- * The cache key type, default "java.lang.Object"
+ * The cache key type, default java.lang.Object
*/
private String keyType = "java.lang.Object";
/**
- * The cache value type, default "java.lang.Object"
+ * The cache value type, default java.lang.Object
*/
private String valueType = "java.lang.Object";
diff --git a/platforms/spring-boot/components-starter/camel-etcd-starter/src/main/java/org/apache/camel/component/etcd/springboot/EtcdComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-etcd-starter/src/main/java/org/apache/camel/component/etcd/springboot/EtcdComponentConfiguration.java
index dfea370..aea1d75 100644
--- a/platforms/spring-boot/components-starter/camel-etcd-starter/src/main/java/org/apache/camel/component/etcd/springboot/EtcdComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-etcd-starter/src/main/java/org/apache/camel/component/etcd/springboot/EtcdComponentConfiguration.java
@@ -17,7 +17,6 @@
package org.apache.camel.component.etcd.springboot;
import javax.annotation.Generated;
-import org.apache.camel.CamelContext;
import org.apache.camel.spring.boot.ComponentConfigurationPropertiesCommon;
import org.apache.camel.util.jsse.SSLContextParameters;
import org.springframework.boot.context.properties.ConfigurationProperties;
@@ -133,7 +132,6 @@ public class EtcdComponentConfiguration
public static class EtcdConfigurationNestedConfiguration {
public static final Class CAMEL_NESTED_CLASS = org.apache.camel.component.etcd.EtcdConfiguration.class;
- private CamelContext camelContext;
/**
* To set the URIs the client connects.
*/
@@ -176,14 +174,6 @@ public class EtcdComponentConfiguration
*/
private String servicePath = "/services/";
- public CamelContext getCamelContext() {
- return camelContext;
- }
-
- public void setCamelContext(CamelContext camelContext) {
- this.camelContext = camelContext;
- }
-
public String getUris() {
return uris;
}
diff --git a/platforms/spring-boot/components-starter/camel-facebook-starter/src/main/java/org/apache/camel/component/facebook/springboot/FacebookComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-facebook-starter/src/main/java/org/apache/camel/component/facebook/springboot/FacebookComponentConfiguration.java
index 4d48a07..3b1627b 100644
--- a/platforms/spring-boot/components-starter/camel-facebook-starter/src/main/java/org/apache/camel/component/facebook/springboot/FacebookComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-facebook-starter/src/main/java/org/apache/camel/component/facebook/springboot/FacebookComponentConfiguration.java
@@ -158,7 +158,7 @@ public class FacebookComponentConfiguration
private Boolean mbeanEnabled = false;
/**
* Default OAuth permissions. Comma separated permission names. See
- * https://developers.facebook.com/docs/reference/login/#permissions for
+ * https://developers.facebook.com/docs/reference/login/permissions for
* the detail
*/
private String oAuthPermissions;
diff --git a/platforms/spring-boot/components-starter/camel-fhir-starter/src/main/java/org/apache/camel/component/fhir/springboot/FhirComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-fhir-starter/src/main/java/org/apache/camel/component/fhir/springboot/FhirComponentConfiguration.java
index 0875e18..8c9a3a5 100644
--- a/platforms/spring-boot/components-starter/camel-fhir-starter/src/main/java/org/apache/camel/component/fhir/springboot/FhirComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-fhir-starter/src/main/java/org/apache/camel/component/fhir/springboot/FhirComponentConfiguration.java
@@ -71,7 +71,13 @@ public class FhirComponentConfiguration
public static class FhirConfigurationNestedConfiguration {
public static final Class CAMEL_NESTED_CLASS = org.apache.camel.component.fhir.FhirConfiguration.class;
+ /**
+ * The FHIR server base URL
+ */
private String serverUrl;
+ /**
+ * Pretty print all request
+ */
private Boolean prettyPrint = false;
/**
* What kind of operation to perform
@@ -81,22 +87,76 @@ public class FhirComponentConfiguration
* What sub operation to use for the selected operation
*/
private String methodName;
+ /**
+ * FhirContext is an expensive object to create. To avoid creating
+ * multiple instances, it can be set directly.
+ */
private FhirContext fhirContext;
+ /**
+ * Force conformance check
+ */
private Boolean forceConformanceCheck = false;
+ /**
+ * Username to use for basic authentication
+ */
private String username;
+ /**
+ * Username to use for basic authentication
+ */
private String password;
+ /**
+ * OAuth access token
+ */
private String accessToken;
+ /**
+ * Will log every requests and responses
+ */
private Boolean log = false;
+ /**
+ * Compresses outgoing (POST/PUT) contents to the GZIP format
+ */
private Boolean compress = false;
+ /**
+ * HTTP session cookie to add to every request
+ */
private String sessionCookie;
+ /**
+ * When this option is set, model classes will not be scanned for
+ * children until the child list for the given type is actually
+ * accessed.
+ */
private Boolean deferModelScanning = false;
+ /**
+ * How long to try and establish the initial TCP connection (in ms)
+ */
private Integer connectionTimeout = 10000;
+ /**
+ * How long to block for individual read/write operations (in ms)
+ */
private Integer socketTimeout = 10000;
+ /**
+ * The proxy host
+ */
private String proxyHost;
+ /**
+ * The proxy password
+ */
private String proxyPassword;
+ /**
+ * The proxy port
+ */
private Integer proxyPort;
+ /**
+ * The proxy username
+ */
private String proxyUser;
+ /**
+ * "To use the custom client"
+ */
private IGenericClient client;
+ /**
+ * "To use the custom client factory"
+ */
private IRestfulClientFactory clientFactory;
public String getServerUrl() {
diff --git a/platforms/spring-boot/components-starter/camel-google-calendar-starter/src/main/java/org/apache/camel/component/google/calendar/springboot/GoogleCalendarComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-google-calendar-starter/src/main/java/org/apache/camel/component/google/calendar/springboot/GoogleCalendarComponentConfiguration.java
index b9d9092..8211828 100644
--- a/platforms/spring-boot/components-starter/camel-google-calendar-starter/src/main/java/org/apache/camel/component/google/calendar/springboot/GoogleCalendarComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-google-calendar-starter/src/main/java/org/apache/camel/component/google/calendar/springboot/GoogleCalendarComponentConfiguration.java
@@ -117,7 +117,7 @@ public class GoogleCalendarComponentConfiguration
private String refreshToken;
/**
* Google calendar application name. Example would be
- * "camel-google-calendar/1.0"
+ * camel-google-calendar/1.0
*/
private String applicationName;
/**
diff --git a/platforms/spring-boot/components-starter/camel-google-drive-starter/src/main/java/org/apache/camel/component/google/drive/springboot/GoogleDriveComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-google-drive-starter/src/main/java/org/apache/camel/component/google/drive/springboot/GoogleDriveComponentConfiguration.java
index 3f80db6..d5dd6fd 100644
--- a/platforms/spring-boot/components-starter/camel-google-drive-starter/src/main/java/org/apache/camel/component/google/drive/springboot/GoogleDriveComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-google-drive-starter/src/main/java/org/apache/camel/component/google/drive/springboot/GoogleDriveComponentConfiguration.java
@@ -113,7 +113,7 @@ public class GoogleDriveComponentConfiguration
private String refreshToken;
/**
* Google drive application name. Example would be
- * "camel-google-drive/1.0"
+ * camel-google-drive/1.0
*/
private String applicationName;
/**
diff --git a/platforms/spring-boot/components-starter/camel-google-mail-starter/src/main/java/org/apache/camel/component/google/mail/springboot/GoogleMailComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-google-mail-starter/src/main/java/org/apache/camel/component/google/mail/springboot/GoogleMailComponentConfiguration.java
index 590ac63..b7723db 100644
--- a/platforms/spring-boot/components-starter/camel-google-mail-starter/src/main/java/org/apache/camel/component/google/mail/springboot/GoogleMailComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-google-mail-starter/src/main/java/org/apache/camel/component/google/mail/springboot/GoogleMailComponentConfiguration.java
@@ -110,8 +110,7 @@ public class GoogleMailComponentConfiguration
*/
private String refreshToken;
/**
- * Google mail application name. Example would be
- * "camel-google-mail/1.0"
+ * Google mail application name. Example would be camel-google-mail/1.0
*/
private String applicationName;
diff --git a/platforms/spring-boot/components-starter/camel-google-mail-starter/src/main/java/org/apache/camel/component/google/mail/stream/springboot/GoogleMailStreamComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-google-mail-starter/src/main/java/org/apache/camel/component/google/mail/stream/springboot/GoogleMailStreamComponentConfiguration.java
index 4e2065a..0a5d1e4 100644
--- a/platforms/spring-boot/components-starter/camel-google-mail-starter/src/main/java/org/apache/camel/component/google/mail/stream/springboot/GoogleMailStreamComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-google-mail-starter/src/main/java/org/apache/camel/component/google/mail/stream/springboot/GoogleMailStreamComponentConfiguration.java
@@ -101,8 +101,7 @@ public class GoogleMailStreamComponentConfiguration
*/
private String refreshToken;
/**
- * Google mail application name. Example would be
- * "camel-google-mail/1.0"
+ * Google mail application name. Example would be camel-google-mail/1.0
*/
private String applicationName;
/**
diff --git a/platforms/spring-boot/components-starter/camel-http-starter/src/main/java/org/apache/camel/component/http/springboot/HttpComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-http-starter/src/main/java/org/apache/camel/component/http/springboot/HttpComponentConfiguration.java
index 9df4074..ea00bd5 100644
--- a/platforms/spring-boot/components-starter/camel-http-starter/src/main/java/org/apache/camel/component/http/springboot/HttpComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-http-starter/src/main/java/org/apache/camel/component/http/springboot/HttpComponentConfiguration.java
@@ -32,7 +32,7 @@ public class HttpComponentConfiguration
ComponentConfigurationPropertiesCommon {
/**
- * Whether to enable auto configuration of the http component. This is
+ * Whether to enable auto configuration of the https component. This is
* enabled by default.
*/
private Boolean enabled;
diff --git a/platforms/spring-boot/components-starter/camel-http4-starter/src/main/java/org/apache/camel/component/http4/springboot/HttpComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-http4-starter/src/main/java/org/apache/camel/component/http4/springboot/HttpComponentConfiguration.java
index 4c9399c..c71dd5b 100644
--- a/platforms/spring-boot/components-starter/camel-http4-starter/src/main/java/org/apache/camel/component/http4/springboot/HttpComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-http4-starter/src/main/java/org/apache/camel/component/http4/springboot/HttpComponentConfiguration.java
@@ -32,7 +32,7 @@ public class HttpComponentConfiguration
ComponentConfigurationPropertiesCommon {
/**
- * Whether to enable auto configuration of the http4 component. This is
+ * Whether to enable auto configuration of the https4 component. This is
* enabled by default.
*/
private Boolean enabled;
diff --git a/platforms/spring-boot/components-starter/camel-infinispan-starter/src/main/java/org/apache/camel/component/infinispan/springboot/InfinispanComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-infinispan-starter/src/main/java/org/apache/camel/component/infinispan/springboot/InfinispanComponentConfiguration.java
index 2c3e9ce..a2c1268 100644
--- a/platforms/spring-boot/components-starter/camel-infinispan-starter/src/main/java/org/apache/camel/component/infinispan/springboot/InfinispanComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-infinispan-starter/src/main/java/org/apache/camel/component/infinispan/springboot/InfinispanComponentConfiguration.java
@@ -92,8 +92,6 @@ public class InfinispanComponentConfiguration
public static final Class CAMEL_NESTED_CLASS = org.apache.camel.component.infinispan.InfinispanConfiguration.class;
/**
* The operation to perform.
- *
- * @deprecated replaced by @{link setOperation}
*/
@Deprecated
private String command = "PUT";
@@ -101,28 +99,49 @@ public class InfinispanComponentConfiguration
* The operation to perform.
*/
private InfinispanOperation operation = InfinispanOperation.PUT;
+ /**
+ * Specifies the host of the cache on Infinispan instance
+ */
private String hosts;
+ /**
+ * Specifies the cache Container to connect
+ */
private BasicCacheContainer cacheContainer;
+ /**
+ * If true, the consumer will receive notifications synchronously
+ */
private Boolean sync = true;
+ /**
+ * If true, the listener will be installed for the entire cluster
+ */
private Boolean clusteredListener = false;
/**
* Specifies the set of event types to register by the consumer.
- * Multiple event can be separated by comma.
- * <p/>
- * The possible event types are: CACHE_ENTRY_ACTIVATED,
- * CACHE_ENTRY_PASSIVATED, CACHE_ENTRY_VISITED, CACHE_ENTRY_LOADED,
- * CACHE_ENTRY_EVICTED, CACHE_ENTRY_CREATED, CACHE_ENTRY_REMOVED,
- * CACHE_ENTRY_MODIFIED, TRANSACTION_COMPLETED, TRANSACTION_REGISTERED,
+ * Multiple event can be separated by comma. The possible event types
+ * are: CACHE_ENTRY_ACTIVATED, CACHE_ENTRY_PASSIVATED,
+ * CACHE_ENTRY_VISITED, CACHE_ENTRY_LOADED, CACHE_ENTRY_EVICTED,
+ * CACHE_ENTRY_CREATED, CACHE_ENTRY_REMOVED, CACHE_ENTRY_MODIFIED,
+ * TRANSACTION_COMPLETED, TRANSACTION_REGISTERED,
* CACHE_ENTRY_INVALIDATED, DATA_REHASHED, TOPOLOGY_CHANGED,
* PARTITION_STATUS_CHANGED
*/
private Set eventTypes;
+ /**
+ * Returns the custom listener in use, if provided
+ */
private InfinispanCustomListener customListener;
/**
* Specifies the query builder.
*/
private InfinispanQueryBuilder queryBuilder;
+ /**
+ * A comma separated list of Flag to be applied by default on each cache
+ * invocation, not applicable to remote caches.
+ */
private Flag[] flags;
+ /**
+ * An implementation specific URI for the CacheManager
+ */
private String configurationUri;
/**
* Implementation specific properties for the CacheManager
diff --git a/platforms/spring-boot/components-starter/camel-jms-starter/src/main/java/org/apache/camel/component/jms/springboot/JmsComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-jms-starter/src/main/java/org/apache/camel/component/jms/springboot/JmsComponentConfiguration.java
index 262d8c4..c75206b 100644
--- a/platforms/spring-boot/components-starter/camel-jms-starter/src/main/java/org/apache/camel/component/jms/springboot/JmsComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-jms-starter/src/main/java/org/apache/camel/component/jms/springboot/JmsComponentConfiguration.java
@@ -1302,9 +1302,9 @@ public class JmsComponentConfiguration
private ConsumerType consumerType = ConsumerType.Default;
/**
* Sets the default connection factory to be used if a connection
- * factory is not specified for either
- * {@link #setTemplateConnectionFactory(ConnectionFactory)} or
- * {@link #setListenerConnectionFactory(ConnectionFactory)}
+ * factory is not specified for either link
+ * setTemplateConnectionFactory(ConnectionFactory) or link
+ * setListenerConnectionFactory(ConnectionFactory)
*/
private ConnectionFactory connectionFactory;
/**
@@ -1342,15 +1342,22 @@ public class JmsComponentConfiguration
* avoid this its recommended to enable this option.
*/
private Boolean acceptMessagesWhileStopping = false;
+ /**
+ * Whether the DefaultMessageListenerContainer used in the reply
+ * managers for request-reply messaging allow the link
+ * DefaultMessageListenerContainerrunningAllowed() flag to quick stop in
+ * case link JmsConfigurationisAcceptMessagesWhileStopping() is enabled,
+ * and org.apache.camel.CamelContext is currently being stopped. This
+ * quick stop ability is enabled by default in the regular JMS consumers
+ * but to enable for reply managers you must enable this flag.
+ */
private Boolean allowReplyManagerQuickStop = false;
/**
* Sets the JMS client ID to use. Note that this value, if specified,
* must be unique and can only be used by a single JMS connection
* instance. It is typically only required for durable topic
- * subscriptions.
- * <p>
- * If using Apache ActiveMQ you may prefer to use Virtual Topics
- * instead.
+ * subscriptions. If using Apache ActiveMQ you may prefer to use Virtual
+ * Topics instead.
*/
private String clientId;
/**
@@ -1406,9 +1413,7 @@ public class JmsComponentConfiguration
* Specifies the default number of concurrent consumers when consuming
* from JMS (not for request/reply over JMS). See also the
* maxMessagesPerTask option to control dynamic scaling up/down of
- * threads.
- * <p>
- * When doing request/reply over JMS then the option
+ * threads. When doing request/reply over JMS then the option
* replyToConcurrentConsumers is used to control number of concurrent
* consumers on the reply message listener.
*/
@@ -1421,7 +1426,7 @@ public class JmsComponentConfiguration
private Integer replyToConcurrentConsumers = 1;
/**
* The number of messages per task. -1 is unlimited. If you use a range
- * for concurrent consumers (eg min < max), then this option can be used
+ * for concurrent consumers (eg min max), then this option can be used
* to set a value to eg 100 to control how fast the consumers will
* shrink when less work is required.
*/
@@ -1490,9 +1495,7 @@ public class JmsComponentConfiguration
* Specifies the maximum number of concurrent consumers when consuming
* from JMS (not for request/reply over JMS). See also the
* maxMessagesPerTask option to control dynamic scaling up/down of
- * threads.
- * <p>
- * When doing request/reply over JMS then the option
+ * threads. When doing request/reply over JMS then the option
* replyToMaxConcurrentConsumers is used to control number of concurrent
* consumers on the reply message listener.
*/
@@ -1653,7 +1656,7 @@ public class JmsComponentConfiguration
/**
* The timeout for waiting for a reply when using the InOut Exchange
* Pattern (in milliseconds). The default is 20 seconds. You can include
- * the header "CamelJmsRequestTimeout" to override this endpoint
+ * the header CamelJmsRequestTimeout to override this endpoint
* configured timeout value, and thus have per message individual
* timeout values. See also the requestTimeoutCheckerInterval option.
*/
@@ -1708,7 +1711,7 @@ public class JmsComponentConfiguration
* brokers which do not care whether JMS header keys contain illegal
* characters. You can provide your own implementation of the
* org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it
- * using the # notation.
+ * using the notation.
*/
private JmsKeyFormatStrategy jmsKeyFormatStrategy;
/**
@@ -1724,9 +1727,9 @@ public class JmsComponentConfiguration
private Boolean transferExchange = false;
/**
* Controls whether or not to include serialized headers. Applies only
- * when {@link #isTransferExchange()} is {@code true} . This requires
- * that the objects are serializable. Camel will exclude any
- * non-serializable objects and log it at WARN level.
+ * when link isTransferExchange() is true. This requires that the
+ * objects are serializable. Camel will exclude any non-serializable
+ * objects and log it at WARN level.
*/
private Boolean allowSerializedHeaders = false;
/**
@@ -1745,15 +1748,13 @@ public class JmsComponentConfiguration
/**
* If enabled and you are using Request Reply messaging (InOut) and an
* Exchange failed with a SOAP fault (not exception) on the consumer
- * side, then the fault flag on
- * {@link org.apache.camel.Message#isFault()} will be send back in the
- * response as a JMS header with the key
- * {@link JmsConstants#JMS_TRANSFER_FAULT} . If the client is Camel, the
- * returned fault flag will be set on the
- * {@link org.apache.camel.Message#setFault(boolean)} .
- * <p>
- * You may want to enable this when using Camel components that support
- * faults such as SOAP based such as cxf or spring-ws.
+ * side, then the fault flag on link org.apache.camel.MessageisFault()
+ * will be send back in the response as a JMS header with the key link
+ * JmsConstantsJMS_TRANSFER_FAULT. If the client is Camel, the returned
+ * fault flag will be set on the link
+ * org.apache.camel.MessagesetFault(boolean). You may want to enable
+ * this when using Camel components that support faults such as SOAP
+ * based such as cxf or spring-ws.
*/
private Boolean transferFault = false;
/**
@@ -1866,9 +1867,9 @@ public class JmsComponentConfiguration
* ThreadPoolTaskExecutor with optimal values - cached threadpool-like).
* If not set, it defaults to the previous behaviour, which uses a
* cached thread pool for consumer endpoints and SimpleAsync for reply
- * consumers. The use of ThreadPool is recommended to reduce
- * "thread trash" in elastic configurations with dynamically increasing
- * and decreasing concurrent consumers.
+ * consumers. The use of ThreadPool is recommended to reduce thread
+ * trash in elastic configurations with dynamically increasing and
+ * decreasing concurrent consumers.
*/
private DefaultTaskExecutorType defaultTaskExecutorType;
/**
@@ -1880,8 +1881,8 @@ public class JmsComponentConfiguration
private Boolean includeAllJMSXProperties = false;
/**
* To use the given MessageCreatedStrategy which are invoked when Camel
- * creates new instances of <tt>javax.jms.Message</tt> objects when
- * Camel is sending a JMS message.
+ * creates new instances of javax.jms.Message objects when Camel is
+ * sending a JMS message.
*/
private MessageCreatedStrategy messageCreatedStrategy;
/**
@@ -1900,53 +1901,43 @@ public class JmsComponentConfiguration
private String correlationProperty;
/**
* This option is used to allow additional headers which may have values
- * that are invalid according to JMS specification. + For example some
+ * that are invalid according to JMS specification. For example some
* message systems such as WMQ do this with header names using prefix
* JMS_IBM_MQMD_ containing values with byte array or other invalid
- * types. + You can specify multiple header names separated by comma,
- * and use * as suffix for wildcard matching.
+ * types. You can specify multiple header names separated by comma, and
+ * use as suffix for wildcard matching.
*/
private String allowAdditionalHeaders;
/**
* Set whether to make the subscription durable. The durable
* subscription name to be used can be specified through the
- * "subscriptionName" property.
- * <p>
- * Default is "false". Set this to "true" to register a durable
- * subscription, typically in combination with a "subscriptionName"
- * value (unless your message listener class name is good enough as
- * subscription name).
- * <p>
- * Only makes sense when listening to a topic (pub-sub domain),
- * therefore this method switches the "pubSubDomain" flag as well.
+ * subscriptionName property. Default is false. Set this to true to
+ * register a durable subscription, typically in combination with a
+ * subscriptionName value (unless your message listener class name is
+ * good enough as subscription name). Only makes sense when listening to
+ * a topic (pub-sub domain), therefore this method switches the
+ * pubSubDomain flag as well.
*/
private Boolean subscriptionDurable = false;
/**
* Set whether to make the subscription shared. The shared subscription
- * name to be used can be specified through the "subscriptionName"
- * property.
- * <p>
- * Default is "false". Set this to "true" to register a shared
- * subscription, typically in combination with a "subscriptionName"
- * value (unless your message listener class name is good enough as
+ * name to be used can be specified through the subscriptionName
+ * property. Default is false. Set this to true to register a shared
+ * subscription, typically in combination with a subscriptionName value
+ * (unless your message listener class name is good enough as
* subscription name). Note that shared subscriptions may also be
* durable, so this flag can (and often will) be combined with
- * "subscriptionDurable" as well.
- * <p>
- * Only makes sense when listening to a topic (pub-sub domain),
- * therefore this method switches the "pubSubDomain" flag as well.
- * <p>
- * <b>Requires a JMS 2.0 compatible message broker.</b>
+ * subscriptionDurable as well. Only makes sense when listening to a
+ * topic (pub-sub domain), therefore this method switches the
+ * pubSubDomain flag as well. Requires a JMS 2.0 compatible message
+ * broker.
*/
private Boolean subscriptionShared = false;
/**
* Set the name of a subscription to create. To be applied in case of a
- * topic (pub-sub domain) with a shared or durable subscription.
- * <p>
- * The subscription name needs to be unique within this client's JMS
- * client id. Default is the class name of the specified message
- * listener.
- * <p>
+ * topic (pub-sub domain) with a shared or durable subscription. The
+ * subscription name needs to be unique within this client's JMS client
+ * id. Default is the class name of the specified message listener.
* Note: Only 1 concurrent consumer (which is the default of this
* message listener container) is allowed for each subscription, except
* for a shared subscription (which requires JMS 2.0).
diff --git a/platforms/spring-boot/components-starter/camel-kafka-starter/src/main/java/org/apache/camel/component/kafka/springboot/KafkaComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-kafka-starter/src/main/java/org/apache/camel/component/kafka/springboot/KafkaComponentConfiguration.java
index 77491d4..d01f829 100644
--- a/platforms/spring-boot/components-starter/camel-kafka-starter/src/main/java/org/apache/camel/component/kafka/springboot/KafkaComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-kafka-starter/src/main/java/org/apache/camel/component/kafka/springboot/KafkaComponentConfiguration.java
@@ -232,12 +232,10 @@ public class KafkaComponentConfiguration
*/
private Boolean autoCommitEnable = true;
/**
- * Whether to allow doing manual commits via {@link KafkaManualCommit} .
- * <p/>
- * If this option is enabled then an instance of
- * {@link KafkaManualCommit} is stored on the {@link Exchange} message
- * header, which allows end users to access this API and perform manual
- * offset commits via the Kafka consumer.
+ * Whether to allow doing manual commits via KafkaManualCommit. If this
+ * option is enabled then an instance of KafkaManualCommit is stored on
+ * the Exchange message header, which allows end users to access this
+ * API and perform manual offset commits via the Kafka consumer.
*/
private Boolean allowManualCommit = false;
/**
@@ -257,6 +255,16 @@ public class KafkaComponentConfiguration
* that much data to accumulate before answering the request.
*/
private Integer fetchMinBytes = 1;
+ /**
+ * The maximum amount of data the server should return for a fetch
+ * request This is not an absolute maximum, if the first message in the
+ * first non-empty partition of the fetch is larger than this value, the
+ * message will still be returned to ensure that the consumer can make
+ * progress. The maximum message size accepted by the broker is defined
+ * via message.max.bytes (broker config) or max.message.bytes (topic
+ * config). Note that the consumer performs multiple fetches in
+ * parallel.
+ */
private Integer fetchMaxBytes = 52428800;
/**
* The maximum amount of time the server will block before answering the
@@ -280,29 +288,27 @@ public class KafkaComponentConfiguration
private String autoCommitOnStop = "sync";
/**
* This options controls what happens when a consumer is processing an
- * exchange and it fails. If the option is <tt>false</tt> then the
- * consumer continues to the next message and processes it. If the
- * option is <tt>true</tt> then the consumer breaks out, and will seek
- * back to offset of the message that caused a failure, and then
- * re-attempt to process this message. However this can lead to endless
- * processing of the same message if its bound to fail every time, eg a
- * poison message. Therefore its recommended to deal with that for
- * example by using Camel's error handler.
+ * exchange and it fails. If the option is false then the consumer
+ * continues to the next message and processes it. If the option is true
+ * then the consumer breaks out, and will seek back to offset of the
+ * message that caused a failure, and then re-attempt to process this
+ * message. However this can lead to endless processing of the same
+ * message if its bound to fail every time, eg a poison message.
+ * Therefore its recommended to deal with that for example by using
+ * Camel's error handler.
*/
private Boolean breakOnFirstError = false;
/**
* URL of the Kafka brokers to use. The format is
* host1:port1,host2:port2, and the list can be a subset of brokers or a
- * VIP pointing to a subset of brokers.
- * <p/>
- * This option is known as <tt>bootstrap.servers</tt> in the Kafka
- * documentation.
+ * VIP pointing to a subset of brokers. This option is known as
+ * bootstrap.servers in the Kafka documentation.
*/
private String brokers;
/**
* This parameter allows you to specify the compression codec for all
- * data generated by this producer. Valid values are "none", "gzip" and
- * "snappy".
+ * data generated by this producer. Valid values are none, gzip and
+ * snappy.
*/
private String compressionCodec = "none";
/**
@@ -360,11 +366,10 @@ public class KafkaComponentConfiguration
* (typically operating system usernames). The rules are evaluated in
* order and the first rule that matches a principal name is used to map
* it to a short name. Any later rules in the list are ignored. By
- * default, principal names of the form {username}/{hostname}@{REALM}
- * are mapped to {username}. For more details on the format please see
- * <a href=\"#security_authz\"> security authorization and acls</a>.
- * <p/>
- * Multiple values can be separated by comma
+ * default, principal names of the form username/hostnameREALM are
+ * mapped to username. For more details on the format please see
+ * security authorization and acls. Multiple values can be separated by
+ * comma
*/
private String kerberosPrincipalToLocalRules = "DEFAULT";
/**
@@ -426,16 +431,14 @@ public class KafkaComponentConfiguration
private String saslKerberosServiceName;
/**
* The Simple Authentication and Security Layer (SASL) Mechanism used.
- * For the valid values see <a href=
- * "http://www.iana.org/assignments/sasl-mechanisms/sasl-mechanisms.xhtml"
- * >http://www.iana.org/assignments/sasl-mechanisms/sasl-mechanisms.
- * xhtml</a>
+ * For the valid values see
+ * http://www.iana.org/assignments/sasl-mechanisms/sasl-mechanisms.xhtml
*/
private String saslMechanism = "GSSAPI";
/**
* Expose the kafka sasl.jaas.config parameter Example:
* org.apache.kafka.common.security.plain.PlainLoginModule required
- * username="USERNAME" password="PASSWORD";
+ * username=USERNAME password=PASSWORD;
*/
private String saslJaasConfig;
/**
@@ -444,8 +447,8 @@ public class KafkaComponentConfiguration
*/
private String securityProtocol = "PLAINTEXT";
/**
- * SSL configuration using a Camel {@link SSLContextParameters} object.
- * If configured it's applied before the other SSL endpoint parameters.
+ * SSL configuration using a Camel SSLContextParameters object. If
+ * configured it's applied before the other SSL endpoint parameters.
*/
@NestedConfigurationProperty
private SSLContextParameters sslContextParameters;
@@ -486,14 +489,14 @@ public class KafkaComponentConfiguration
private Integer bufferMemorySize = 33554432;
/**
* The record key (or null if no key is specified). If this option has
- * been configured then it take precedence over header
- * {@link KafkaConstants#KEY}
+ * been configured then it take precedence over header link
+ * KafkaConstantsKEY
*/
private String key;
/**
* The partition to which the record will be sent (or null if no
* partition was specified). If this option has been configured then it
- * take precedence over header {@link KafkaConstants#PARTITION_KEY}
+ * take precedence over header link KafkaConstantsPARTITION_KEY
*/
private Integer partitionKey;
/**
@@ -552,7 +555,7 @@ public class KafkaComponentConfiguration
* occurs only under load when records arrive faster than they can be
* sent out. However in some circumstances the client may want to reduce
* the number of requests even under moderate load. This setting
- * accomplishes this by adding a small amount of artificial delay—that
+ * accomplishes this by adding a small amount of artificial delaythat
* is, rather than immediately sending out a record the producer will
* wait for up to the given delay to allow other records to be sent so
* that the sends can be batched together. This can be thought of as
@@ -637,7 +640,7 @@ public class KafkaComponentConfiguration
private Integer heartbeatIntervalMs = 3000;
/**
* The maximum amount of data per-partition the server will return. The
- * maximum total memory used for a request will be #partitions *
+ * maximum total memory used for a request will be partitions
* max.partition.fetch.bytes. This size must be at least as large as the
* maximum message size the server allows or else it is possible for the
* producer to send messages larger than the consumer can fetch. If that
@@ -704,41 +707,38 @@ public class KafkaComponentConfiguration
*/
private String seekTo;
/**
- * To use a custom worker pool for continue routing {@link Exchange}
- * after kafka server has acknowledge the message that was sent to it
- * from {@link KafkaProducer} using asynchronous non-blocking
- * processing.
+ * To use a custom worker pool for continue routing Exchange after kafka
+ * server has acknowledge the message that was sent to it from
+ * KafkaProducer using asynchronous non-blocking processing.
*/
private ExecutorService workerPool;
/**
* Number of core threads for the worker pool for continue routing
- * {@link Exchange} after kafka server has acknowledge the message that
- * was sent to it from {@link KafkaProducer} using asynchronous
- * non-blocking processing.
+ * Exchange after kafka server has acknowledge the message that was sent
+ * to it from KafkaProducer using asynchronous non-blocking processing.
*/
private Integer workerPoolCoreSize = 10;
/**
* Maximum number of threads for the worker pool for continue routing
- * {@link Exchange} after kafka server has acknowledge the message that
- * was sent to it from {@link KafkaProducer} using asynchronous
- * non-blocking processing.
+ * Exchange after kafka server has acknowledge the message that was sent
+ * to it from KafkaProducer using asynchronous non-blocking processing.
*/
private Integer workerPoolMaxSize = 20;
/**
- * Whether the producer should store the {@link RecordMetadata} results
- * from sending to Kafka. The results are stored in a {@link List}
- * containing the {@link RecordMetadata} metadata's. The list is stored
- * on a header with the key {@link KafkaConstants#KAFKA_RECORDMETA}
+ * Whether the producer should store the RecordMetadata results from
+ * sending to Kafka. The results are stored in a List containing the
+ * RecordMetadata metadata's. The list is stored on a header with the
+ * key link KafkaConstantsKAFKA_RECORDMETA
*/
private Boolean recordMetadata = true;
/**
* Sets interceptors for producer or consumers. Producer interceptors
* have to be classes implementing
- * {@link org.apache.kafka.clients.producer.ProducerInterceptor}
- * Consumer interceptors have to be classes implementing
- * {@link org.apache.kafka.clients.consumer.ConsumerInterceptor} Note
- * that if you use Producer interceptor on a consumer it will throw a
- * class cast exception in runtime
+ * org.apache.kafka.clients.producer.ProducerInterceptor Consumer
+ * interceptors have to be classes implementing
+ * org.apache.kafka.clients.consumer.ConsumerInterceptor Note that if
+ * you use Producer interceptor on a consumer it will throw a class cast
+ * exception in runtime
*/
private String interceptorClasses;
/**
@@ -766,17 +766,11 @@ public class KafkaComponentConfiguration
/**
* Sets custom KafkaHeaderDeserializer for deserialization kafka headers
* values to camel headers values.
- *
- * @param kafkaHeaderDeserializer
- * custom kafka header deserializer to be used
*/
private KafkaHeaderDeserializer kafkaHeaderDeserializer;
/**
* Sets custom KafkaHeaderDeserializer for serialization camel headers
* values to kafka headers values.
- *
- * @param kafkaHeaderSerializer
- * custom kafka header serializer to be used
*/
private KafkaHeaderSerializer kafkaHeaderSerializer;
diff --git a/platforms/spring-boot/components-starter/camel-kestrel-starter/src/main/java/org/apache/camel/component/kestrel/springboot/KestrelComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-kestrel-starter/src/main/java/org/apache/camel/component/kestrel/springboot/KestrelComponentConfiguration.java
index c2eaefd..a93282d 100644
--- a/platforms/spring-boot/components-starter/camel-kestrel-starter/src/main/java/org/apache/camel/component/kestrel/springboot/KestrelComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-kestrel-starter/src/main/java/org/apache/camel/component/kestrel/springboot/KestrelComponentConfiguration.java
@@ -70,15 +70,15 @@ public class KestrelComponentConfiguration
public static class KestrelConfigurationNestedConfiguration {
public static final Class CAMEL_NESTED_CLASS = org.apache.camel.component.kestrel.KestrelConfiguration.class;
/**
- * The addresses
+ * The address(es) on which kestrel is running
*/
private String[] addresses;
/**
- * The wait time in milliseconds
+ * How long a given wait should block (server side), in milliseconds
*/
private Integer waitTimeMs = 100;
/**
- * The number of concurrent consumers
+ * How many concurrent listeners to schedule for the thread pool
*/
private Integer concurrentConsumers = 1;
diff --git a/platforms/spring-boot/components-starter/camel-linkedin-starter/src/main/java/org/apache/camel/component/linkedin/springboot/LinkedInComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-linkedin-starter/src/main/java/org/apache/camel/component/linkedin/springboot/LinkedInComponentConfiguration.java
index 44d3f44..9571e0b 100644
--- a/platforms/spring-boot/components-starter/camel-linkedin-starter/src/main/java/org/apache/camel/component/linkedin/springboot/LinkedInComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-linkedin-starter/src/main/java/org/apache/camel/component/linkedin/springboot/LinkedInComponentConfiguration.java
@@ -106,7 +106,7 @@ public class LinkedInComponentConfiguration
private String clientSecret;
/**
* List of LinkedIn scopes as specified at
- * https://developer.linkedin.com/documents/authentication#granting
+ * https://developer.linkedin.com/documents/authenticationgranting
*/
private OAuthScope[] scopes;
/**
diff --git a/platforms/spring-boot/components-starter/camel-mail-starter/src/main/java/org/apache/camel/component/mail/springboot/MailComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-mail-starter/src/main/java/org/apache/camel/component/mail/springboot/MailComponentConfiguration.java
index 4be098d..16b60fd 100644
--- a/platforms/spring-boot/components-starter/camel-mail-starter/src/main/java/org/apache/camel/component/mail/springboot/MailComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-mail-starter/src/main/java/org/apache/camel/component/mail/springboot/MailComponentConfiguration.java
@@ -38,7 +38,7 @@ public class MailComponentConfiguration
ComponentConfigurationPropertiesCommon {
/**
- * Whether to enable auto configuration of the imap component. This is
+ * Whether to enable auto configuration of the pop3s component. This is
* enabled by default.
*/
private Boolean enabled;
@@ -100,9 +100,8 @@ public class MailComponentConfiguration
public static class MailConfigurationNestedConfiguration {
public static final Class CAMEL_NESTED_CLASS = org.apache.camel.component.mail.MailConfiguration.class;
/**
- * To use a custom
- * {@link org.apache.camel.component.mail.JavaMailSender} for sending
- * emails.
+ * To use a custom org.apache.camel.component.mail.JavaMailSender for
+ * sending emails.
*/
private JavaMailSender javaMailSender;
/**
@@ -286,19 +285,17 @@ public class MailComponentConfiguration
/**
* If the mail consumer cannot retrieve a given mail message, then this
* option allows to skip the message and move on to retrieve the next
- * mail message.
- * <p/>
- * The default behavior would be the consumer throws an exception and no
- * mails from the batch would be able to be routed by Camel.
+ * mail message. The default behavior would be the consumer throws an
+ * exception and no mails from the batch would be able to be routed by
+ * Camel.
*/
private Boolean skipFailedMessage = false;
/**
* If the mail consumer cannot retrieve a given mail message, then this
* option allows to handle the caused exception by the consumer's error
* handler. By enable the bridge error handler on the consumer, then the
- * Camel routing error handler can handle the exception instead.
- * <p/>
- * The default behavior would be the consumer throws an exception and no
+ * Camel routing error handler can handle the exception instead. The
+ * default behavior would be the consumer throws an exception and no
* mails from the batch would be able to be routed by Camel.
*/
private Boolean handleFailedMessage = false;
diff --git a/platforms/spring-boot/components-starter/camel-mllp-starter/src/main/java/org/apache/camel/component/mllp/springboot/MllpComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-mllp-starter/src/main/java/org/apache/camel/component/mllp/springboot/MllpComponentConfiguration.java
index c5b61bd..b3a9b56 100644
--- a/platforms/spring-boot/components-starter/camel-mllp-starter/src/main/java/org/apache/camel/component/mllp/springboot/MllpComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-mllp-starter/src/main/java/org/apache/camel/component/mllp/springboot/MllpComponentConfiguration.java
@@ -115,28 +115,19 @@ public class MllpComponentConfiguration
* message and handled by the routing Error Handler. If disabled, the
* consumer will use the org.apache.camel.spi.ExceptionHandler to deal
* with exceptions by logging them at WARN or ERROR level and ignored.
- *
- * @param bridgeErrorHandler
*/
private Boolean bridgeErrorHandler = true;
/**
* Sets the exchange pattern when the consumer creates an exchange.
- *
- * @param exchangePattern
*/
private ExchangePattern exchangePattern = ExchangePattern.InOut;
/**
* Sets whether synchronous processing should be strictly used (this
* component only supports synchronous operations).
- *
- * @param synchronous
*/
private Boolean synchronous = true;
/**
* Set the CamelCharsetName property on the exchange
- *
- * @param charsetName
- * the charset
*/
private String charsetName;
/**
@@ -156,39 +147,24 @@ public class MllpComponentConfiguration
*/
private Integer bindRetryInterval = 5000;
/**
- * Timeout (in milliseconds) while waiting for a TCP connection
- * <p/>
- * TCP Server Only
- *
- * @param acceptTimeout
- * timeout in milliseconds
+ * Timeout (in milliseconds) while waiting for a TCP connection TCP
+ * Server Only
*/
private Integer acceptTimeout = 60000;
/**
* TCP Server Only - Allow the endpoint to start before the TCP
* ServerSocket is bound. In some environments, it may be desirable to
* allow the endpoint to start before the TCP ServerSocket is bound.
- *
- * @param lenientBind
- * if true, the ServerSocket will be bound asynchronously;
- * otherwise the ServerSocket will be bound synchronously.
*/
private Boolean lenientBind = false;
/**
- * Timeout (in milliseconds) for establishing for a TCP connection
- * <p/>
- * TCP Client only
- *
- * @param connectTimeout
- * timeout in milliseconds
+ * Timeout (in milliseconds) for establishing for a TCP connection TCP
+ * Client only
*/
private Integer connectTimeout = 30000;
/**
* The SO_TIMEOUT value (in milliseconds) used when waiting for the
* start of an MLLP frame
- *
- * @param receiveTimeout
- * timeout in milliseconds
*/
private Integer receiveTimeout = 15000;
/**
@@ -196,23 +172,11 @@ public class MllpComponentConfiguration
* be allowed. If a new connection is received and the maximum is number
* are already established, the new connection will be reset
* immediately.
- *
- * @param maxConcurrentConsumers
- * the maximum number of concurrent consumer connections
- * allowed
*/
private Integer maxConcurrentConsumers = 5;
/**
* The maximum number of timeouts (specified by receiveTimeout) allowed
* before the TCP Connection will be reset.
- *
- * @param maxReceiveTimeouts
- * maximum number of receiveTimeouts
- * @deprecated Use the idleTimeout URI parameter. For backward
- * compibility, setting this parameter will result in an
- * idle timeout of maxReceiveTimeouts * receiveTimeout. If
- * idleTimeout is also specified, this parameter will be
- * ignored.
*/
@Deprecated
private Integer maxReceiveTimeouts;
@@ -220,85 +184,49 @@ public class MllpComponentConfiguration
* The approximate idle time allowed before the Client TCP Connection
* will be reset. A null value or a value less than or equal to zero
* will disable the idle timeout.
- *
- * @param idleTimeout
- * timeout in milliseconds
*/
private Integer idleTimeout;
/**
* The SO_TIMEOUT value (in milliseconds) used after the start of an
* MLLP frame has been received
- *
- * @param readTimeout
- * timeout in milliseconds
*/
private Integer readTimeout = 5000;
/**
* Enable/disable the SO_KEEPALIVE socket option.
- *
- * @param keepAlive
- * enable SO_KEEPALIVE when true; disable SO_KEEPALIVE when
- * false; use system default when null
*/
private Boolean keepAlive = true;
/**
* Enable/disable the TCP_NODELAY socket option.
- *
- * @param tcpNoDelay
- * enable TCP_NODELAY when true; disable TCP_NODELAY when
- * false; use system default when null
*/
private Boolean tcpNoDelay = true;
/**
* Enable/disable the SO_REUSEADDR socket option.
- *
- * @param reuseAddress
- * enable SO_REUSEADDR when true; disable SO_REUSEADDR when
- * false; use system default when null
*/
private Boolean reuseAddress = false;
/**
* Sets the SO_RCVBUF option to the specified value (in bytes)
- *
- * @param receiveBufferSize
- * the SO_RCVBUF option value. If null, the system default is
- * used
*/
private Integer receiveBufferSize = 8192;
/**
* Sets the SO_SNDBUF option to the specified value (in bytes)
- *
- * @param sendBufferSize
- * the SO_SNDBUF option value. If null, the system default is
- * used
*/
private Integer sendBufferSize = 8192;
/**
* Enable/Disable the automatic generation of a MLLP Acknowledgement
* MLLP Consumers only
- *
- * @param autoAck
- * enabled if true, otherwise disabled
*/
private Boolean autoAck = true;
/**
* Enable/Disable the automatic generation of message headers from the
* HL7 Message MLLP Consumers only
- *
- * @param hl7Headers
- * enabled if true, otherwise disabled
*/
private Boolean hl7Headers = true;
/**
* Enable/Disable strict compliance to the MLLP standard. The MLLP
- * standard specifies [START_OF_BLOCK]hl7
- * payload[END_OF_BLOCK][END_OF_DATA], however, some systems do not send
- * the final END_OF_DATA byte. This setting controls whether or not the
- * final END_OF_DATA byte is required or optional.
- *
- * @param requireEndOfData
- * the trailing END_OF_DATA byte is required if true;
- * optional otherwise
+ * standard specifies START_OF_BLOCKhl7 payloadEND_OF_BLOCKEND_OF_DATA,
+ * however, some systems do not send the final END_OF_DATA byte. This
+ * setting controls whether or not the final END_OF_DATA byte is
+ * required or optional.
*/
private Boolean requireEndOfData = true;
/**
@@ -309,9 +237,6 @@ public class MllpComponentConfiguration
* set, the value of MSH-18 will be used to determine th appropriate
* character set. If MSH-18 is not set, then the default ISO-8859-1
* character set will be use.
- *
- * @param stringPayload
- * enabled if true, otherwise disabled
*/
private Boolean stringPayload = true;
/**
@@ -321,18 +246,11 @@ public class MllpComponentConfiguration
* validation). If and invalid payload is detected, a
* MllpInvalidMessageException (for consumers) or a
* MllpInvalidAcknowledgementException will be thrown.
- *
- * @param validatePayload
- * enabled if true, otherwise disabled
*/
private Boolean validatePayload = false;
/**
* Enable/Disable the buffering of HL7 payloads before writing to the
* socket.
- *
- * @deprecated the parameter will be ignored
- * @param bufferWrites
- * enabled if true, otherwise disabled
*/
@Deprecated
private Boolean bufferWrites = false;
diff --git a/platforms/spring-boot/components-starter/camel-nagios-starter/src/main/java/org/apache/camel/component/nagios/springboot/NagiosComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-nagios-starter/src/main/java/org/apache/camel/component/nagios/springboot/NagiosComponentConfiguration.java
index 027a1ed..c54abba 100644
--- a/platforms/spring-boot/components-starter/camel-nagios-starter/src/main/java/org/apache/camel/component/nagios/springboot/NagiosComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-nagios-starter/src/main/java/org/apache/camel/component/nagios/springboot/NagiosComponentConfiguration.java
@@ -94,8 +94,6 @@ public class NagiosComponentConfiguration
private String password;
/**
* To specify an encryption method.
- *
- * @deprecated use the {@link #encryption} query parameter instead.
*/
@Deprecated
private NagiosEncryptionMethod encryptionMethod;
diff --git a/platforms/spring-boot/components-starter/camel-netty-http-starter/src/main/java/org/apache/camel/component/netty/http/springboot/NettyHttpComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-netty-http-starter/src/main/java/org/apache/camel/component/netty/http/springboot/NettyHttpComponentConfiguration.java
index 61c4ec0..43d729d 100644
--- a/platforms/spring-boot/components-starter/camel-netty-http-starter/src/main/java/org/apache/camel/component/netty/http/springboot/NettyHttpComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-netty-http-starter/src/main/java/org/apache/camel/component/netty/http/springboot/NettyHttpComponentConfiguration.java
@@ -267,11 +267,10 @@ public class NettyHttpComponentConfiguration
* as a application/x-java-serialized-object content type. On the
* producer side the exception will be deserialized and thrown as is,
* instead of the HttpOperationFailedException. The caused exception is
- * required to be serialized.
- * <p/>
- * This is by default turned off. If you enable this then be aware that
- * Java will deserialize the incoming data from the request to Java and
- * that can be a potential security risk.
+ * required to be serialized. This is by default turned off. If you
+ * enable this then be aware that Java will deserialize the incoming
+ * data from the request to Java and that can be a potential security
+ * risk.
*/
private Boolean transferException = false;
/**
@@ -315,7 +314,7 @@ public class NettyHttpComponentConfiguration
private String path;
/**
* Determines whether or not the raw input stream from Netty
- * HttpRequest#getContent() is cached or not (Camel will read the stream
+ * HttpRequestgetContent() is cached or not (Camel will read the stream
* into a in light-weight memory based Stream caching) cache. By default
* Camel will cache the Netty input stream to support reading it
* multiple times to ensure it Camel can retrieve all data from the
@@ -340,26 +339,22 @@ public class NettyHttpComponentConfiguration
private Integer chunkedMaxContentLength = 1048576;
/**
* The maximum length of all headers. If the sum of the length of each
- * header exceeds this value, a {@link TooLongFrameException} will be
- * raised.
+ * header exceeds this value, a TooLongFrameException will be raised.
*/
private Integer maxHeaderSize = 8192;
private Boolean allowDefaultCodec;
/**
* The status codes which are considered a success response. The values
* are inclusive. Multiple ranges can be defined, separated by comma,
- * e.g. <tt>200-204,209,301-304</tt>. Each range must be a single number
- * or from-to with the dash included.
- * <p/>
- * The default range is <tt>200-299</tt>
+ * e.g. 200-204,209,301-304. Each range must be a single number or
+ * from-to with the dash included. The default range is 200-299
*/
private String okStatusCodeRange = "200-299";
/**
- * Sets whether to use a relative path in HTTP requests.
- * <p/>
- * Some third party backend systems such as IBM Datapower do not support
- * absolute URIs in HTTP POSTs, and setting this option to <tt>true</tt>
- * can work around this problem.
+ * Sets whether to use a relative path in HTTP requests. Some third
+ * party backend systems such as IBM Datapower do not support absolute
+ * URIs in HTTP POSTs, and setting this option to true can work around
+ * this problem.
*/
private Boolean useRelativePath = false;
diff --git a/platforms/spring-boot/components-starter/camel-netty-starter/src/main/java/org/apache/camel/component/netty/springboot/NettyComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-netty-starter/src/main/java/org/apache/camel/component/netty/springboot/NettyComponentConfiguration.java
index 6b48b0b..405a4caa 100644
--- a/platforms/spring-boot/components-starter/camel-netty-starter/src/main/java/org/apache/camel/component/netty/springboot/NettyComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-netty-starter/src/main/java/org/apache/camel/component/netty/springboot/NettyComponentConfiguration.java
@@ -149,14 +149,14 @@ public class NettyComponentConfiguration
/**
* A list of decoders to be used. You can use a String which have values
* separated by comma, and have the values be looked up in the Registry.
- * Just remember to prefix the value with # so Camel knows it should
+ * Just remember to prefix the value with so Camel knows it should
* lookup.
*/
private List decoders;
/**
* A list of encoders to be used. You can use a String which have values
* separated by comma, and have the values be looked up in the Registry.
- * Just remember to prefix the value with # so Camel knows it should
+ * Just remember to prefix the value with so Camel knows it should
* lookup.
*/
private List encoders;
@@ -249,7 +249,7 @@ public class NettyComponentConfiguration
*/
private Integer producerPoolMinIdle;
/**
- * Sets the cap on the number of "idle" instances in the pool.
+ * Sets the cap on the number of idle instances in the pool.
*/
private Integer producerPoolMaxIdle = 100;
/**
@@ -277,7 +277,7 @@ public class NettyComponentConfiguration
private Boolean clientMode = false;
/**
* If the useChannelBuffer is true, netty producer will turn the message
- * body into {@link ChannelBuffer} before sending it out.
+ * body into ChannelBuffer before sending it out.
*/
private Boolean useChannelBuffer = false;
/**
@@ -295,10 +295,8 @@ public class NettyComponentConfiguration
*/
private String protocol;
/**
- * The hostname.
- * <p/>
- * For the consumer the hostname is localhost or 0.0.0.0 For the
- * producer the hostname is the remote host to connect to
+ * The hostname. For the consumer the hostname is localhost or 0.0.0.0
+ * For the producer the hostname is the remote host to connect to
*/
private String host;
/**
@@ -326,7 +324,7 @@ public class NettyComponentConfiguration
private Integer receiveBufferSizePredictor;
/**
* When netty works on nio mode, it uses default workerCount parameter
- * from Netty, which is cpu_core_threads*2. User can use this operation
+ * from Netty, which is cpu_core_threads2. User can use this operation
* to override the default workerCount from Netty
*/
private Integer workerCount;
@@ -357,7 +355,7 @@ public class NettyComponentConfiguration
* Allows to configure a backlog for netty consumer (server). Note the
* backlog is just a best effort depending on the OS. Setting this
* option to a value such as 200, 500 or 1000, tells the TCP stack how
- * long the "accept" queue can be If this option is not configured, then
+ * long the accept queue can be If this option is not configured, then
* the backlog depends on OS setting.
*/
private Integer backlog;
@@ -398,24 +396,24 @@ public class NettyComponentConfiguration
private File trustStoreFile;
/**
* Client side certificate keystore to be used for encryption. Is loaded
- * by default from classpath, but you can prefix with "classpath:",
- * "file:", or "http:" to load the resource from different systems.
+ * by default from classpath, but you can prefix with classpath:, file:,
+ * or http: to load the resource from different systems.
*/
private String keyStoreResource;
/**
* Server side certificate keystore to be used for encryption. Is loaded
- * by default from classpath, but you can prefix with "classpath:",
- * "file:", or "http:" to load the resource from different systems.
+ * by default from classpath, but you can prefix with classpath:, file:,
+ * or http: to load the resource from different systems.
*/
private String trustStoreResource;
/**
- * Keystore format to be used for payload encryption. Defaults to "JKS"
- * if not set
+ * Keystore format to be used for payload encryption. Defaults to JKS if
+ * not set
*/
private String keyStoreFormat = "JKS";
/**
* Security provider to be used for payload encryption. Defaults to
- * "SunX509" if not set.
+ * SunX509 if not set.
*/
private String securityProvider = "SunX509";
/**
@@ -432,10 +430,10 @@ public class NettyComponentConfiguration
*/
private NettyServerBootstrapFactory nettyServerBootstrapFactory;
/**
- * Allows to configure additional netty options using "option." as
- * prefix. For example "option.child.keepAlive=false" to set the netty
- * option "child.keepAlive=false". See the Netty documentation for
- * possible options that can be used.
+ * Allows to configure additional netty options using option. as prefix.
+ * For example option.child.keepAlive=false to set the netty option
+ * child.keepAlive=false. See the Netty documentation for possible
+ * options that can be used.
*/
private Map options;
/**
diff --git a/platforms/spring-boot/components-starter/camel-netty4-http-starter/src/main/java/org/apache/camel/component/netty4/http/springboot/NettyHttpComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-netty4-http-starter/src/main/java/org/apache/camel/component/netty4/http/springboot/NettyHttpComponentConfiguration.java
index 92c6e1d..74e05c7 100644
--- a/platforms/spring-boot/components-starter/camel-netty4-http-starter/src/main/java/org/apache/camel/component/netty4/http/springboot/NettyHttpComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-netty4-http-starter/src/main/java/org/apache/camel/component/netty4/http/springboot/NettyHttpComponentConfiguration.java
@@ -181,11 +181,10 @@ public class NettyHttpComponentConfiguration
* as a application/x-java-serialized-object content type. On the
* producer side the exception will be deserialized and thrown as is,
* instead of the HttpOperationFailedException. The caused exception is
- * required to be serialized.
- * <p/>
- * This is by default turned off. If you enable this then be aware that
- * Java will deserialize the incoming data from the request to Java and
- * that can be a potential security risk.
+ * required to be serialized. This is by default turned off. If you
+ * enable this then be aware that Java will deserialize the incoming
+ * data from the request to Java and that can be a potential security
+ * risk.
*/
private Boolean transferException = false;
/**
@@ -229,8 +228,8 @@ public class NettyHttpComponentConfiguration
private String path;
/**
* Determines whether or not the raw input stream from Netty
- * HttpRequest#getContent() or HttpResponset#getContent() is cached or
- * not (Camel will read the stream into a in light-weight memory based
+ * HttpRequestgetContent() or HttpResponsetgetContent() is cached or not
+ * (Camel will read the stream into a in light-weight memory based
* Stream caching) cache. By default Camel will cache the Netty input
* stream to support reading it multiple times to ensure it Camel can
* retrieve all data from the stream. However you can set this option to
@@ -242,8 +241,8 @@ public class NettyHttpComponentConfiguration
* the Netty stream when the Netty HTTP server/HTTP client is done
* processing, which means that if the asynchronous routing engine is in
* use then any asynchronous thread that may continue routing the
- * {@link org.apache.camel.Exchange} may not be able to read the Netty
- * stream, because Netty has closed it.
+ * org.apache.camel.Exchange may not be able to read the Netty stream,
+ * because Netty has closed it.
*/
private Boolean disableStreamCache = false;
/**
@@ -260,17 +259,15 @@ public class NettyHttpComponentConfiguration
/**
* The maximum length of all headers. If the sum of the length of each
* header exceeds this value, a
- * {@link io.netty.handler.codec.TooLongFrameException} will be raised.
+ * io.netty.handler.codec.TooLongFrameException will be raised.
*/
private Integer maxHeaderSize = 8192;
private Boolean allowDefaultCodec;
/**
* The status codes which are considered a success response. The values
* are inclusive. Multiple ranges can be defined, separated by comma,
- * e.g. <tt>200-204,209,301-304</tt>. Each range must be a single number
- * or from-to with the dash included.
- * <p/>
- * The default range is <tt>200-299</tt>
+ * e.g. 200-204,209,301-304. Each range must be a single number or
+ * from-to with the dash included. The default range is 200-299
*/
private String okStatusCodeRange = "200-299";
/**
diff --git a/platforms/spring-boot/components-starter/camel-netty4-starter/src/main/java/org/apache/camel/component/netty4/springboot/NettyComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-netty4-starter/src/main/java/org/apache/camel/component/netty4/springboot/NettyComponentConfiguration.java
index 22e3ff1..10f8799 100644
--- a/platforms/spring-boot/components-starter/camel-netty4-starter/src/main/java/org/apache/camel/component/netty4/springboot/NettyComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-netty4-starter/src/main/java/org/apache/camel/component/netty4/springboot/NettyComponentConfiguration.java
@@ -162,14 +162,14 @@ public class NettyComponentConfiguration
/**
* A list of decoders to be used. You can use a String which have values
* separated by comma, and have the values be looked up in the Registry.
- * Just remember to prefix the value with # so Camel knows it should
+ * Just remember to prefix the value with so Camel knows it should
* lookup.
*/
private List decoders;
/**
* A list of encoders to be used. You can use a String which have values
* separated by comma, and have the values be looked up in the Registry.
- * Just remember to prefix the value with # so Camel knows it should
+ * Just remember to prefix the value with so Camel knows it should
* lookup.
*/
private List encoders;
@@ -267,7 +267,7 @@ public class NettyComponentConfiguration
*/
private Integer producerPoolMinIdle;
/**
- * Sets the cap on the number of "idle" instances in the pool.
+ * Sets the cap on the number of idle instances in the pool.
*/
private Integer producerPoolMaxIdle = 100;
/**
@@ -285,10 +285,9 @@ public class NettyComponentConfiguration
* reply messages so you can properly correlate the replies to the Camel
* callback that is responsible for continue processing the message in
* Camel. To do this you need to implement
- * {@link NettyCamelStateCorrelationManager} as correlation manager and
- * configure it via the <tt>correlationManager</tt> option.
- * <p/>
- * See also the <tt>correlationManager</tt> option for more details.
+ * NettyCamelStateCorrelationManager as correlation manager and
+ * configure it via the correlationManager option. See also the
+ * correlationManager option for more details.
*/
private Boolean producerPoolEnabled = true;
/**
@@ -304,7 +303,7 @@ public class NettyComponentConfiguration
private Boolean clientMode = false;
/**
* If the useByteBuf is true, netty producer will turn the message body
- * into {@link ByteBuf} before sending it out.
+ * into ByteBuf before sending it out.
*/
private Boolean useByteBuf = false;
/**
@@ -314,17 +313,14 @@ public class NettyComponentConfiguration
private Boolean udpByteArrayCodec = false;
/**
* This option allows producers and consumers (in client mode) to reuse
- * the same Netty {@link Channel} for the lifecycle of processing the
- * {@link Exchange} . This is useful if you need to call a server
- * multiple times in a Camel route and want to use the same network
- * connection. When using this, the channel is not returned to the
- * connection pool until the {@link Exchange} is done; or disconnected
- * if the disconnect option is set to true.
- * <p/>
- * The reused {@link Channel} is stored on the {@link Exchange} as an
- * exchange property with the key {@link NettyConstants#NETTY_CHANNEL}
- * which allows you to obtain the channel during routing and use it as
- * well.
+ * the same Netty Channel for the lifecycle of processing the Exchange.
+ * This is useful if you need to call a server multiple times in a Camel
+ * route and want to use the same network connection. When using this,
+ * the channel is not returned to the connection pool until the Exchange
+ * is done; or disconnected if the disconnect option is set to true. The
+ * reused Channel is stored on the Exchange as an exchange property with
+ * the key link NettyConstantsNETTY_CHANNEL which allows you to obtain
+ * the channel during routing and use it as well.
*/
private Boolean reuseChannel = false;
/**
@@ -336,14 +332,11 @@ public class NettyComponentConfiguration
* concurrent messages on the same channel (aka connection) in netty.
* When doing this you must have a way to correlate the request and
* reply messages so you can store the right reply on the inflight Camel
- * Exchange before its continued routed.
- * <p/>
- * We recommend extending the {@link TimeoutCorrelationManagerSupport}
- * when you build custom correlation managers. This provides support for
- * timeout and other complexities you otherwise would need to implement
- * as well.
- * <p/>
- * See also the <tt>producerPoolEnabled</tt> option for more details.
+ * Exchange before its continued routed. We recommend extending the
+ * TimeoutCorrelationManagerSupport when you build custom correlation
+ * managers. This provides support for timeout and other complexities
+ * you otherwise would need to implement as well. See also the
+ * producerPoolEnabled option for more details.
*/
private NettyCamelStateCorrelationManager correlationManager;
/**
@@ -351,10 +344,8 @@ public class NettyComponentConfiguration
*/
private String protocol;
/**
- * The hostname.
- * <p/>
- * For the consumer the hostname is localhost or 0.0.0.0. For the
- * producer the hostname is the remote host to connect to
+ * The hostname. For the consumer the hostname is localhost or 0.0.0.0.
+ * For the producer the hostname is the remote host to connect to
*/
private String host;
/**
@@ -413,7 +404,7 @@ public class NettyComponentConfiguration
* Allows to configure a backlog for netty consumer (server). Note the
* backlog is just a best effort depending on the OS. Setting this
* option to a value such as 200, 500 or 1000, tells the TCP stack how
- * long the "accept" queue can be If this option is not configured, then
+ * long the accept queue can be If this option is not configured, then
* the backlog depends on OS setting.
*/
private Integer backlog;
@@ -454,24 +445,24 @@ public class NettyComponentConfiguration
private File trustStoreFile;
/**
* Client side certificate keystore to be used for encryption. Is loaded
- * by default from classpath, but you can prefix with "classpath:",
- * "file:", or "http:" to load the resource from different systems.
+ * by default from classpath, but you can prefix with classpath:, file:,
+ * or http: to load the resource from different systems.
*/
private String keyStoreResource;
/**
* Server side certificate keystore to be used for encryption. Is loaded
- * by default from classpath, but you can prefix with "classpath:",
- * "file:", or "http:" to load the resource from different systems.
+ * by default from classpath, but you can prefix with classpath:, file:,
+ * or http: to load the resource from different systems.
*/
private String trustStoreResource;
/**
- * Keystore format to be used for payload encryption. Defaults to "JKS"
- * if not set
+ * Keystore format to be used for payload encryption. Defaults to JKS if
+ * not set
*/
private String keyStoreFormat;
/**
* Security provider to be used for payload encryption. Defaults to
- * "SunX509" if not set.
+ * SunX509 if not set.
*/
private String securityProvider;
/**
@@ -493,10 +484,10 @@ public class NettyComponentConfiguration
*/
private NettyServerBootstrapFactory nettyServerBootstrapFactory;
/**
- * Allows to configure additional netty options using "option." as
- * prefix. For example "option.child.keepAlive=false" to set the netty
- * option "child.keepAlive=false". See the Netty documentation for
- * possible options that can be used.
+ * Allows to configure additional netty options using option. as prefix.
+ * For example option.child.keepAlive=false to set the netty option
+ * child.keepAlive=false. See the Netty documentation for possible
+ * options that can be used.
*/
private Map options;
/**
@@ -532,7 +523,15 @@ public class NettyComponentConfiguration
* Which protocols to enable when using SSL
*/
private String enabledProtocols = "TLSv1,TLSv1.1,TLSv1.2";
+ /**
+ * Used only in clientMode in consumer, the consumer will attempt to
+ * reconnect on disconnection if this is enabled
+ */
private Boolean reconnect = true;
+ /**
+ * Used if reconnect and clientMode is enabled. The interval in milli
+ * seconds to attempt reconnection
+ */
private Integer reconnectInterval = 10000;
public Long getRequestTimeout() {
diff --git a/platforms/spring-boot/components-starter/camel-salesforce-starter/src/main/java/org/apache/camel/component/salesforce/springboot/SalesforceComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-salesforce-starter/src/main/java/org/apache/camel/component/salesforce/springboot/SalesforceComponentConfiguration.java
index f4c882e..6aa02b2 100644
--- a/platforms/spring-boot/components-starter/camel-salesforce-starter/src/main/java/org/apache/camel/component/salesforce/springboot/SalesforceComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-salesforce-starter/src/main/java/org/apache/camel/component/salesforce/springboot/SalesforceComponentConfiguration.java
@@ -584,9 +584,8 @@ public class SalesforceComponentConfiguration
*/
private PayloadFormat format;
/**
- * Use raw payload {@link String} for request and response (either JSON
- * or XML depending on {@code format} ), instead of DTOs, false by
- * default
+ * Use raw payload String for request and response (either JSON or XML
+ * depending on format), instead of DTOs, false by default
*/
private Boolean rawPayload = false;
/**
@@ -682,23 +681,23 @@ public class SalesforceComponentConfiguration
private NotifyForFieldsEnum notifyForFields;
/**
* Notify for operations, options are ALL, CREATE, EXTENDED, UPDATE (API
- * version < 29.0)
+ * version 29.0)
*/
private NotifyForOperationsEnum notifyForOperations;
/**
- * Notify for create operation, defaults to false (API version >= 29.0)
+ * Notify for create operation, defaults to false (API version = 29.0)
*/
private Boolean notifyForOperationCreate;
/**
- * Notify for update operation, defaults to false (API version >= 29.0)
+ * Notify for update operation, defaults to false (API version = 29.0)
*/
private Boolean notifyForOperationUpdate;
/**
- * Notify for delete operation, defaults to false (API version >= 29.0)
+ * Notify for delete operation, defaults to false (API version = 29.0)
*/
private Boolean notifyForOperationDelete;
/**
- * Notify for un-delete operation, defaults to false (API version >=
+ * Notify for un-delete operation, defaults to false (API version =
* 29.0)
*/
private Boolean notifyForOperationUndelete;
@@ -740,10 +739,8 @@ public class SalesforceComponentConfiguration
*/
private Long maxBackoff;
/**
- * Default replayId setting if no value is found in
- * {@link #initialReplayIdMap}
- *
- * @param defaultReplayId
+ * Default replayId setting if no value is found in link
+ * initialReplayIdMap
*/
private Long defaultReplayId;
/**
@@ -753,8 +750,6 @@ public class SalesforceComponentConfiguration
/**
* Limit on number of returned records. Applicable to some of the API,
* check the Salesforce documentation.
- *
- * @param limit
*/
private Integer limit;
/**
@@ -807,9 +802,9 @@ public class SalesforceComponentConfiguration
private Boolean approvalSkipEntryCriteria;
/**
* Sets the behaviour of 404 not found status received from Salesforce
- * API. Should the body be set to NULL {@link NotFoundBehaviour#NULL} or
- * should a exception be signaled on the exchange
- * {@link NotFoundBehaviour#EXCEPTION} - the default.
+ * API. Should the body be set to NULL link NotFoundBehaviourNULL or
+ * should a exception be signaled on the exchange link
+ * NotFoundBehaviourEXCEPTION - the default.
*/
private NotFoundBehaviour notFoundBehaviour;
diff --git a/platforms/spring-boot/components-starter/camel-servicenow-starter/src/main/java/org/apache/camel/component/servicenow/springboot/ServiceNowComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-servicenow-starter/src/main/java/org/apache/camel/component/servicenow/springboot/ServiceNowComponentConfiguration.java
index 6d8ad47..832eabb 100644
--- a/platforms/spring-boot/components-starter/camel-servicenow-starter/src/main/java/org/apache/camel/component/servicenow/springboot/ServiceNowComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-servicenow-starter/src/main/java/org/apache/camel/component/servicenow/springboot/ServiceNowComponentConfiguration.java
@@ -416,6 +416,9 @@ public class ServiceNowComponentConfiguration
* The date-time format used for Json serialization/deserialization
*/
private String dateTimeFormat = "yyyy-MM-dd HH:mm:ss";
+ /**
+ * Defines both request and response models
+ */
private Map models;
/**
* Defines the response model
diff --git a/platforms/spring-boot/components-starter/camel-sip-starter/src/main/java/org/apache/camel/component/sip/springboot/SipComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-sip-starter/src/main/java/org/apache/camel/component/sip/springboot/SipComponentConfiguration.java
index add23b9..512b77d 100644
--- a/platforms/spring-boot/components-starter/camel-sip-starter/src/main/java/org/apache/camel/component/sip/springboot/SipComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-sip-starter/src/main/java/org/apache/camel/component/sip/springboot/SipComponentConfiguration.java
@@ -33,7 +33,7 @@ public class SipComponentConfiguration
ComponentConfigurationPropertiesCommon {
/**
- * Whether to enable auto configuration of the sip component. This is
+ * Whether to enable auto configuration of the sips component. This is
* enabled by default.
*/
private Boolean enabled;
diff --git a/platforms/spring-boot/components-starter/camel-smpp-starter/src/main/java/org/apache/camel/component/smpp/springboot/SmppComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-smpp-starter/src/main/java/org/apache/camel/component/smpp/springboot/SmppComponentConfiguration.java
index 086745e..d7147bc 100644
--- a/platforms/spring-boot/components-starter/camel-smpp-starter/src/main/java/org/apache/camel/component/smpp/springboot/SmppComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-smpp-starter/src/main/java/org/apache/camel/component/smpp/springboot/SmppComponentConfiguration.java
@@ -83,27 +83,21 @@ public class SmppComponentConfiguration
* The system id (username) for connecting to SMSC server.
*/
private String systemId = "smppclient";
+ /**
+ * The password for connecting to SMSC server.
+ */
private String password;
/**
* Defines the data coding according the SMPP 3.4 specification, section
- * 5.2.19. Example data encodings are:
- * <ul>
- * <li>0: SMSC Default Alphabet</li>
- * <li>3: Latin 1 (ISO-8859-1)</li>
- * <li>4: Octet unspecified (8-bit binary)</li>
- * <li>8: UCS2 (ISO/IEC-10646)</li>
- * <li>13: Extended Kanji JIS(X 0212-1990)</li>
- * </ul>
+ * 5.2.19. Example data encodings are: 0: SMSC Default Alphabet 3: Latin
+ * 1 (ISO-8859-1) 4: Octet unspecified (8-bit binary) 8: UCS2
+ * (ISO/IEC-10646) 13: Extended Kanji JIS(X 0212-1990)
*/
private Byte dataCoding;
/**
* Defines encoding of data according the SMPP 3.4 specification,
- * section 5.2.19.
- * <ul>
- * <li>0: SMSC Default Alphabet
- * <li>4: 8 bit Alphabet</li>
- * <li>8: UCS2 Alphabet</li></li>
- * </ul>
+ * section 5.2.19. 0: SMSC Default Alphabet 4: 8 bit Alphabet 8: UCS2
+ * Alphabet
*/
private Byte alphabet;
/**
@@ -131,92 +125,52 @@ public class SmppComponentConfiguration
private String systemType = "cp";
/**
* Is used to request an SMSC delivery receipt and/or SME originated
- * acknowledgements. The following values are defined:
- * <ul>
- * <li>0: No SMSC delivery receipt requested.</li>
- * <li>1: SMSC delivery receipt requested where final delivery outcome
- * is success or failure.</li>
- * <li>2: SMSC delivery receipt requested where the final delivery
- * outcome is delivery failure.</li>
- * </ul>
+ * acknowledgements. The following values are defined: 0: No SMSC
+ * delivery receipt requested. 1: SMSC delivery receipt requested where
+ * final delivery outcome is success or failure. 2: SMSC delivery
+ * receipt requested where the final delivery outcome is delivery
+ * failure.
*/
private Byte registeredDelivery;
/**
* The service type parameter can be used to indicate the SMS
* Application service associated with the message. The following
- * generic service_types are defined:
- * <ul>
- * <li>CMT: Cellular Messaging</li>
- * <li>CPT: Cellular Paging</li>
- * <li>VMN: Voice Mail Notification</li>
- * <li>VMA: Voice Mail Alerting</li>
- * <li>WAP: Wireless Application Protocol</li>
- * <li>USSD: Unstructured Supplementary Services Data</li>
- * </ul>
+ * generic service_types are defined: CMT: Cellular Messaging CPT:
+ * Cellular Paging VMN: Voice Mail Notification VMA: Voice Mail Alerting
+ * WAP: Wireless Application Protocol USSD: Unstructured Supplementary
+ * Services Data
*/
private String serviceType = "CMT";
/**
* Defines the type of number (TON) to be used in the SME originator
- * address parameters. The following TON values are defined:
- * <ul>
- * <li>0: Unknown</li>
- * <li>1: International</li>
- * <li>2: National</li>
- * <li>3: Network Specific</li>
- * <li>4: Subscriber Number</li>
- * <li>5: Alphanumeric</li>
- * <li>6: Abbreviated</li>
- * </ul>
+ * address parameters. The following TON values are defined: 0: Unknown
+ * 1: International 2: National 3: Network Specific 4: Subscriber Number
+ * 5: Alphanumeric 6: Abbreviated
*/
private Byte sourceAddrTon;
/**
* Defines the type of number (TON) to be used in the SME destination
* address parameters. Only for SubmitSm, SubmitMulti, CancelSm and
- * DataSm. The following TON values are defined:
- * <ul>
- * <li>0: Unknown</li>
- * <li>1: International</li>
- * <li>2: National</li>
- * <li>3: Network Specific</li>
- * <li>4: Subscriber Number</li>
- * <li>5: Alphanumeric</li>
- * <li>6: Abbreviated</li>
- * </ul>
+ * DataSm. The following TON values are defined: 0: Unknown 1:
+ * International 2: National 3: Network Specific 4: Subscriber Number 5:
+ * Alphanumeric 6: Abbreviated
*/
private Byte destAddrTon;
/**
* Defines the numeric plan indicator (NPI) to be used in the SME
* originator address parameters. The following NPI values are defined:
- * <ul>
- * <li>0: Unknown</li>
- * <li>1: ISDN (E163/E164)</li>
- * <li>2: Data (X.121)</li>
- * <li>3: Telex (F.69)</li>
- * <li>6: Land Mobile (E.212)</li>
- * <li>8: National</li>
- * <li>9: Private</li>
- * <li>10: ERMES</li>
- * <li>13: Internet (IP)</li>
- * <li>18: WAP Client Id (to be defined by WAP Forum)</li>
- * </ul>
+ * 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6:
+ * Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet
+ * (IP) 18: WAP Client Id (to be defined by WAP Forum)
*/
private Byte sourceAddrNpi;
/**
* Defines the type of number (TON) to be used in the SME destination
* address parameters. Only for SubmitSm, SubmitMulti, CancelSm and
- * DataSm. The following NPI values are defined:
- * <ul>
- * <li>0: Unknown</li>
- * <li>1: ISDN (E163/E164)</li>
- * <li>2: Data (X.121)</li>
- * <li>3: Telex (F.69)</li>
- * <li>6: Land Mobile (E.212)</li>
- * <li>8: National</li>
- * <li>9: Private</li>
- * <li>10: ERMES</li>
- * <li>13: Internet (IP)</li>
- * <li>18: WAP Client Id (to be defined by WAP Forum)</li>
- * </ul>
+ * DataSm. The following NPI values are defined: 0: Unknown 1: ISDN
+ * (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8:
+ * National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to
+ * be defined by WAP Forum)
*/
private Byte destAddrNpi;
/**
@@ -226,13 +180,8 @@ public class SmppComponentConfiguration
/**
* Allows the originating SME to assign a priority level to the short
* message. Only for SubmitSm and SubmitMulti. Four Priority Levels are
- * supported:
- * <ul>
- * <li>0: Level 0 (lowest) priority</li>
- * <li>1: Level 1 priority</li>
- * <li>2: Level 2 priority</li>
- * <li>3: Level 3 (highest) priority</li>
- * </ul>
+ * supported: 0: Level 0 (lowest) priority 1: Level 1 priority 2: Level
+ * 2 priority 3: Level 3 (highest) priority
*/
private Byte priorityFlag;
/**
@@ -240,11 +189,8 @@ public class SmppComponentConfiguration
* that is still pending delivery. The SMSC will replace an existing
* message provided that the source address, destination address and
* service type match the same fields in the new message. The following
- * replace if present flag values are defined:
- * <ul>
- * <li>0: Don't replace</li>
- * <li>1: Replace</li>
- * </ul>
+ * replace if present flag values are defined: 0: Don't replace 1:
+ * Replace
*/
private Byte replaceIfPresentFlag;
/**
@@ -260,33 +206,16 @@ public class SmppComponentConfiguration
private String destAddr = "1717";
/**
* Defines the type of number (TON) to be used in the SME. The following
- * TON values are defined:
- * <ul>
- * <li>0: Unknown</li>
- * <li>1: International</li>
- * <li>2: National</li>
- * <li>3: Network Specific</li>
- * <li>4: Subscriber Number</li>
- * <li>5: Alphanumeric</li>
- * <li>6: Abbreviated</li>
- * </ul>
+ * TON values are defined: 0: Unknown 1: International 2: National 3:
+ * Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated
*/
private Byte typeOfNumber;
/**
* Defines the numeric plan indicator (NPI) to be used in the SME. The
- * following NPI values are defined:
- * <ul>
- * <li>0: Unknown</li>
- * <li>1: ISDN (E163/E164)</li>
- * <li>2: Data (X.121)</li>
- * <li>3: Telex (F.69)</li>
- * <li>6: Land Mobile (E.212)</li>
- * <li>8: National</li>
- * <li>9: Private</li>
- * <li>10: ERMES</li>
- * <li>13: Internet (IP)</li>
- * <li>18: WAP Client Id (to be defined by WAP Forum)</li>
- * </ul>
+ * following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2:
+ * Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9:
+ * Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined
+ * by WAP Forum)
*/
private Byte numberingPlanIndicator;
/**
@@ -304,6 +233,10 @@ public class SmppComponentConfiguration
* succeed.
*/
private Long reconnectDelay = 5000L;
+ /**
+ * Defines the maximum number of attempts to reconnect to the SMSC, if
+ * SMSC returns a negative bind response
+ */
private Integer maxReconnect = 2147483647;
/**
* Sessions can be lazily created to avoid exceptions, if the SMSC is
@@ -346,18 +279,14 @@ public class SmppComponentConfiguration
*/
private String addressRange;
/**
- * You can specify a policy for handling long messages:
- * <ul>
- * <li>ALLOW - the default, long messages are split to 140 bytes per
- * message</li>
- * <li>TRUNCATE - long messages are split and only the first fragment
- * will be sent to the SMSC. Some carriers drop subsequent fragments so
- * this reduces load on the SMPP connection sending parts of a message
- * that will never be delivered.</li>
- * <li>REJECT - if a message would need to be split, it is rejected with
- * an SMPP NegativeResponseException and the reason code signifying the
- * message is too long.</li>
- * </ul>
+ * You can specify a policy for handling long messages: ALLOW - the
+ * default, long messages are split to 140 bytes per message TRUNCATE -
+ * long messages are split and only the first fragment will be sent to
+ * the SMSC. Some carriers drop subsequent fragments so this reduces
+ * load on the SMPP connection sending parts of a message that will
+ * never be delivered. REJECT - if a message would need to be split, it
+ * is rejected with an SMPP NegativeResponseException and the reason
+ * code signifying the message is too long.
*/
private SmppSplittingPolicy splittingPolicy = SmppSplittingPolicy.ALLOW;
/**
diff --git a/platforms/spring-boot/components-starter/camel-ssh-starter/src/main/java/org/apache/camel/component/ssh/springboot/SshComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-ssh-starter/src/main/java/org/apache/camel/component/ssh/springboot/SshComponentConfiguration.java
index d7b6650..dc1050b 100644
--- a/platforms/spring-boot/components-starter/camel-ssh-starter/src/main/java/org/apache/camel/component/ssh/springboot/SshComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-ssh-starter/src/main/java/org/apache/camel/component/ssh/springboot/SshComponentConfiguration.java
@@ -246,69 +246,42 @@ public class SshComponentConfiguration
public static final Class CAMEL_NESTED_CLASS = org.apache.camel.component.ssh.SshConfiguration.class;
/**
* Sets the username to use in logging into the remote SSH server.
- *
- * @param usernameString
- * representing login username.
*/
private String username;
/**
* Sets the hostname of the remote SSH server.
- *
- * @param hostString
- * representing hostname of SSH server.
*/
private String host;
/**
* Sets the port number for the remote SSH server.
- *
- * @param portint
- * representing port number on remote host. Defaults to 22.
*/
private Integer port = 22;
/**
* Sets the password to use in connecting to remote SSH server. Requires
* keyPairProvider to be set to null.
- *
- * @param passwordString
- * representing password for username at remote host.
*/
private String password;
/**
* Sets the command string to send to the remote SSH server during every
* poll cycle. Only works with camel-ssh component being used as a
- * consumer, i.e. from("ssh://...") You may need to end your command
- * with a newline, and that must be URL encoded %0A
- *
- * @param pollCommandString
- * representing the command to send.
+ * consumer, i.e. from(ssh://...) You may need to end your command with
+ * a newline, and that must be URL encoded %0A
*/
private String pollCommand;
/**
* Sets the KeyPairProvider reference to use when connecting using
* Certificates to the remote SSH Server.
- *
- * @param keyPairProviderKeyPairProvider
- * reference to use in authenticating. If set to 'null', then
- * will attempt to connect using username/password settings.
- * @see KeyPairProvider
*/
private KeyPairProvider keyPairProvider;
/**
* Sets the key type to pass to the KeyPairProvider as part of
* authentication. KeyPairProvider.loadKey(...) will be passed this
- * value. Defaults to "ssh-rsa".
- *
- * @param keyTypeString
- * defining the type of KeyPair to use for authentication.
- * @see KeyPairProvider
+ * value. Defaults to ssh-rsa.
*/
private String keyType = "ssh-rsa";
/**
* Sets the timeout in milliseconds to wait in establishing the remote
* SSH server connection. Defaults to 30000 milliseconds.
- *
- * @param timeoutlong
- * milliseconds to wait.
*/
private Long timeout = 30000L;
/**
@@ -319,52 +292,32 @@ public class SshComponentConfiguration
private String certFilename;
/**
* Sets the resource path of the certificate to use for Authentication.
- * Will use {@link ResourceHelperKeyPairProvider} to resolve file based
+ * Will use ResourceHelperKeyPairProvider to resolve file based
* certificate, and depends on keyType setting.
- *
- * @param certResourceString
- * file, classpath, or http url for the certificate
*/
private String certResource;
/**
* Sets the resource path for a known_hosts file
- *
- * @param knownHostsString
- * file, classpath, or http url for the certificate
*/
private String knownHostsResource;
/**
* Specifies whether a connection to an unknown host should fail or not.
* This value is only checked when the property knownHosts is set.
- *
- * @param boolean boolean flag, whether a connection to an unknown host
- * should fail
*/
private Boolean failOnUnknownHost = false;
/**
* Sets the channel type to pass to the Channel as part of command
- * execution. Defaults to "exec".
- *
- * @param channelTypeString
- * defining the type of Channel to use for command execution.
- * @seeorg.apache.sshd.common.channel.Channel
+ * execution. Defaults to exec.
*/
private String channelType = "exec";
/**
* Sets the shellPrompt to be dropped when response is read after
* command execution
- *
- * @param shellPromptString
- * defining ending string of command line which has to be
- * dropped when response is read after command execution.
*/
private String shellPrompt;
/**
* Sets the sleep period in milliseconds to wait reading response from
* shell prompt. Defaults to 100 milliseconds.
- *
- * @param sleepForShellPromptlong
- * milliseconds to wait.
*/
private Long sleepForShellPrompt = 100L;
diff --git a/platforms/spring-boot/components-starter/camel-twilio-starter/src/main/java/org/apache/camel/component/twilio/springboot/TwilioComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-twilio-starter/src/main/java/org/apache/camel/component/twilio/springboot/TwilioComponentConfiguration.java
index 6694b69..c06ffca 100644
--- a/platforms/spring-boot/components-starter/camel-twilio-starter/src/main/java/org/apache/camel/component/twilio/springboot/TwilioComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-twilio-starter/src/main/java/org/apache/camel/component/twilio/springboot/TwilioComponentConfiguration.java
@@ -120,16 +120,10 @@ public class TwilioComponentConfiguration
public static final Class CAMEL_NESTED_CLASS = org.apache.camel.component.twilio.TwilioConfiguration.class;
/**
* What kind of operation to perform
- *
- * @param apiNamethe
- * API Name to set
*/
private TwilioApiName apiName;
/**
* What sub operation to use for the selected operation
- *
- * @param methodNamethe
- * methodName to set
*/
private String methodName;
diff --git a/platforms/spring-boot/components-starter/camel-wordpress-starter/src/main/java/org/apache/camel/component/wordpress/springboot/WordpressComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-wordpress-starter/src/main/java/org/apache/camel/component/wordpress/springboot/WordpressComponentConfiguration.java
index 394e8f0..ad44dd4 100644
--- a/platforms/spring-boot/components-starter/camel-wordpress-starter/src/main/java/org/apache/camel/component/wordpress/springboot/WordpressComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-wordpress-starter/src/main/java/org/apache/camel/component/wordpress/springboot/WordpressComponentConfiguration.java
@@ -70,11 +70,29 @@ public class WordpressComponentConfiguration
public static class WordpressComponentConfigurationNestedConfiguration {
public static final Class CAMEL_NESTED_CLASS = org.apache.camel.component.wordpress.WordpressComponentConfiguration.class;
+ /**
+ * The Wordpress API URL from your site, e.g. http://myblog.com/wp-json/
+ */
private String url;
+ /**
+ * The Wordpress REST API version
+ */
private String apiVersion = "2";
+ /**
+ * Password from authorized user
+ */
private String password;
+ /**
+ * Authorized user to perform writing operations
+ */
private String user;
+ /**
+ * The entity id
+ */
private Integer id;
+ /**
+ * Whether to bypass trash and force deletion.
+ */
private Boolean force = false;
@NestedConfigurationProperty
private SearchCriteria searchCriteria;
diff --git a/platforms/spring-boot/components-starter/camel-xmlsecurity-starter/src/main/java/org/apache/camel/component/xmlsecurity/springboot/XmlSignatureComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-xmlsecurity-starter/src/main/java/org/apache/camel/component/xmlsecurity/springboot/XmlSignatureComponentConfiguration.java
index 59383ea..b410495 100644
--- a/platforms/spring-boot/components-starter/camel-xmlsecurity-starter/src/main/java/org/apache/camel/component/xmlsecurity/springboot/XmlSignatureComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-xmlsecurity-starter/src/main/java/org/apache/camel/component/xmlsecurity/springboot/XmlSignatureComponentConfiguration.java
@@ -23,7 +23,6 @@ import javax.xml.crypto.AlgorithmMethod;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.URIDereferencer;
import javax.xml.crypto.dsig.spec.XPathFilterParameterSpec;
-import org.apache.camel.CamelContext;
import org.apache.camel.component.xmlsecurity.api.KeyAccessor;
import org.apache.camel.component.xmlsecurity.api.ValidationFailedHandler;
import org.apache.camel.component.xmlsecurity.api.XmlSignature2Message;
@@ -94,7 +93,6 @@ public class XmlSignatureComponentConfiguration
public static class XmlSignerConfigurationNestedConfiguration {
public static final Class CAMEL_NESTED_CLASS = org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration.class;
- private CamelContext camelContext;
/**
* For the signing process, a private key is necessary. You specify a
* key accessor bean which provides this private key. The key accessor
@@ -108,7 +106,7 @@ public class XmlSignatureComponentConfiguration
* Canonicalization method used to canonicalize the SignedInfo element
* before the digest is calculated. You can use the helper methods
* XmlSignatureHelper.getCanonicalizationMethod(String algorithm) or
- * getCanonicalizationMethod(String algorithm, List<String>
+ * getCanonicalizationMethod(String algorithm, List
* inclusiveNamespacePrefixes) to create a canonicalization method.
*/
private AlgorithmMethod canonicalizationMethod;
@@ -116,14 +114,14 @@ public class XmlSignatureComponentConfiguration
* Transforms which are executed on the message body before the digest
* is calculated. By default, C14n is added and in the case of enveloped
* signature (see option parentLocalName) also
- * http://www.w3.org/2000/09/xmldsig#enveloped-signature is added at
+ * http://www.w3.org/2000/09/xmldsigenveloped-signature is added at
* position 0 of the list. Use methods in XmlSignatureHelper to create
* the transform methods.
*/
private List transformMethods;
/**
* Signature algorithm. Default value is
- * "http://www.w3.org/2000/09/xmldsig#rsa-sha1".
+ * http://www.w3.org/2000/09/xmldsigrsa-sha1.
*/
private String signatureAlgorithm = "http://www.w3.org/2000/09/xmldsig#rsa-sha1";
/**
@@ -131,50 +129,38 @@ public class XmlSignatureComponentConfiguration
* used for calculating the digest of the input message. If this digest
* algorithm is not specified then the digest algorithm is calculated
* from the signature algorithm. Example:
- * "http://www.w3.org/2001/04/xmlenc#sha256"
+ * http://www.w3.org/2001/04/xmlencsha256
*/
private String digestAlgorithm;
/**
* In order to protect the KeyInfo element from tampering you can add a
* reference to the signed info element so that it is protected via the
- * signature value. The default value is <tt>true</tt>.
- * <p>
- * Only relevant when a KeyInfo is returned by {@link KeyAccessor} . and
- * {@link KeyInfo#getId()} is not <code>null</code>.
+ * signature value. The default value is true. Only relevant when a
+ * KeyInfo is returned by KeyAccessor. and link KeyInfogetId() is not
+ * null.
*/
private Boolean addKeyInfoReference = true;
/**
* Namespace prefix for the XML signature namespace
- * "http://www.w3.org/2000/09/xmldsig#". Default value is "ds". If
- * <code>null</code> or an empty value is set then no prefix is used for
- * the XML signature namespace.
- * <p>
- * See best practice
- * http://www.w3.org/TR/xmldsig-bestpractices/#signing-xml-
+ * http://www.w3.org/2000/09/xmldsig. Default value is ds. If null or an
+ * empty value is set then no prefix is used for the XML signature
+ * namespace. See best practice
+ * http://www.w3.org/TR/xmldsig-bestpractices/signing-xml-
* without-namespaces
- *
- * @param prefixForXmlSignatureNamespaceprefix
*/
private String prefixForXmlSignatureNamespace = "ds";
/**
* Local name of the parent element to which the XML signature element
* will be added. Only relevant for enveloped XML signature.
- * Alternatively you can also use
- * {@link #setParentXpath(XPathFilterParameterSpec)} .
- * <p>
- * Default value is <code>null</code>. The value must be
- * <code>null</code> for enveloping and detached XML signature.
- * <p>
- * This parameter or the parameter
- * {@link #setParentXpath(XPathFilterParameterSpec)} for enveloped
- * signature and the parameter {@link #setXpathsToIdAttributes(List)}
- * for detached signature must not be set in the same configuration.
- * <p>
- * If the parameters <tt>parentXpath</tt> and <tt>parentLocalName</tt>
- * are specified in the same configuration then an exception is thrown.
- *
- * @param parentLocalNamelocal
- * name
+ * Alternatively you can also use link
+ * setParentXpath(XPathFilterParameterSpec). Default value is null. The
+ * value must be null for enveloping and detached XML signature. This
+ * parameter or the parameter link
+ * setParentXpath(XPathFilterParameterSpec) for enveloped signature and
+ * the parameter link setXpathsToIdAttributes(List) for detached
+ * signature must not be set in the same configuration. If the
+ * parameters parentXpath and parentLocalName are specified in the same
+ * configuration then an exception is thrown.
*/
private String parentLocalName;
/**
@@ -184,43 +170,42 @@ public class XmlSignatureComponentConfiguration
private String parentNamespace;
/**
* Sets the content object Id attribute value. By default a UUID is
- * generated. If you set the <code>null</code> value, then a new UUID
- * will be generated. Only used in the enveloping case.
+ * generated. If you set the null value, then a new UUID will be
+ * generated. Only used in the enveloping case.
*/
private String contentObjectId;
/**
* Sets the signature Id. If this parameter is not set (null value) then
* a unique ID is generated for the signature ID (default). If this
- * parameter is set to "" (empty string) then no Id attribute is created
- * in the signature element.
+ * parameter is set to (empty string) then no Id attribute is created in
+ * the signature element.
*/
private String signatureId;
/**
* Reference URI for the content to be signed. Only used in the
* enveloped case. If the reference URI contains an ID attribute value,
- * then the resource schema URI ( {@link #setSchemaResourceUri(String)}
- * ) must also be set because the schema validator will then find out
+ * then the resource schema URI ( link setSchemaResourceUri(String))
+ * must also be set because the schema validator will then find out
* which attributes are ID attributes. Will be ignored in the enveloping
* or detached case.
*/
private String contentReferenceUri;
/**
- * Type of the content reference. The default value is <code>null</code>
- * . This value can be overwritten by the header
- * {@link XmlSignatureConstants#HEADER_CONTENT_REFERENCE_TYPE} .
+ * Type of the content reference. The default value is null. This value
+ * can be overwritten by the header link
+ * XmlSignatureConstantsHEADER_CONTENT_REFERENCE_TYPE.
*/
private String contentReferenceType;
/**
* Indicator whether the message body contains plain text. The default
- * value is <code>false</code>, indicating that the message body
- * contains XML. The value can be overwritten by the header
- * {@link XmlSignatureConstants#HEADER_MESSAGE_IS_PLAIN_TEXT} .
+ * value is false, indicating that the message body contains XML. The
+ * value can be overwritten by the header link
+ * XmlSignatureConstantsHEADER_MESSAGE_IS_PLAIN_TEXT.
*/
private Boolean plainText = false;
/**
* Encoding of the plain text. Only relevant if the message body is
- * plain text (see parameter {@link #plainText} . Default value is
- * "UTF-8".
+ * plain text (see parameter link plainText. Default value is UTF-8.
*/
private String plainTextEncoding = "UTF-8";
/**
@@ -238,85 +223,60 @@ public class XmlSignatureComponentConfiguration
* expressions to ID attributes (attributes of type ID). For each
* element found via the XPATH expression a detached signature is
* created whose reference URI contains the corresponding attribute
- * value (preceded by '#'). The signature becomes the last sibling of
- * the signed element. Elements with deeper hierarchy level are signed
- * first.
- * <p>
- * You can also set the XPATH list dynamically via the header
- * {@link XmlSignatureConstants#HEADER_XPATHS_TO_ID_ATTRIBUTES} .
- * <p>
- * The parameter {@link #setParentLocalName(String)} or
- * {@link #setParentXpath(XPathFilterParameterSpec)} for enveloped
- * signature and this parameter for detached signature must not be set
- * in the same configuration.
+ * value (preceded by ''). The signature becomes the last sibling of the
+ * signed element. Elements with deeper hierarchy level are signed
+ * first. You can also set the XPATH list dynamically via the header
+ * link XmlSignatureConstantsHEADER_XPATHS_TO_ID_ATTRIBUTES. The
+ * parameter link setParentLocalName(String) or link
+ * setParentXpath(XPathFilterParameterSpec) for enveloped signature and
+ * this parameter for detached signature must not be set in the same
+ * configuration.
*/
private List xpathsToIdAttributes;
/**
* Sets the XPath to find the parent node in the enveloped case. Either
* you specify the parent node via this method or the local name and
- * namespace of the parent with the methods
- * {@link #setParentLocalName(String)} and
- * {@link #setParentNamespace(String)} .
- * <p>
- * Default value is <code>null</code>. The value must be
- * <code>null</code> for enveloping and detached XML signature.
- * <p>
- * If the parameters <tt>parentXpath</tt> and <tt>parentLocalName</tt>
- * are specified in the same configuration then an exception is thrown.
- *
- * @param parentXpath
- * xpath to the parent node, if the xpath returns several
- * values then the first Element node is used
+ * namespace of the parent with the methods link
+ * setParentLocalName(String) and link setParentNamespace(String).
+ * Default value is null. The value must be null for enveloping and
+ * detached XML signature. If the parameters parentXpath and
+ * parentLocalName are specified in the same configuration then an
+ * exception is thrown.
*/
private XPathFilterParameterSpec parentXpath;
/**
* If you want to restrict the remote access via reference URIs, you can
* set an own dereferencer. Optional parameter. If not set the provider
* default dereferencer is used which can resolve URI fragments, HTTP,
- * file and XPpointer URIs.
- * <p>
- * Attention: The implementation is provider dependent!
- *
- * @seeXMLCryptoContext#setURIDereferencer(URIDereferencer)
+ * file and XPpointer URIs. Attention: The implementation is provider
+ * dependent!
*/
private URIDereferencer uriDereferencer;
/**
* You can set a base URI which is used in the URI dereferencing.
* Relative URIs are then concatenated with the base URI.
- *
- * @seeXMLCryptoContext#setBaseURI(String)
*/
private String baseUri;
/**
- * Sets the crypto context properties. See
- * {@link XMLCryptoContext#setProperty(String,Object)} . Possible
- * properties are defined in {@link XMLSignContext} an
- * {@link XMLValidateContext} (see Supported Properties).
- * <p>
- * The following properties are set by default to the value
- * {@link Boolean#TRUE} for the XML validation. If you want to switch
- * these features off you must set the property value to
- * {@link Boolean#FALSE} .
- * <ul>
- * <li><code>"org.jcp.xml.dsig.validateManifests"</code></li>
- * <li><code>"javax.xml.crypto.dsig.cacheReference"</code></li>
- * </ul>
+ * Sets the crypto context properties. See link
+ * XMLCryptoContextsetProperty(String, Object). Possible properties are
+ * defined in XMLSignContext an XMLValidateContext (see Supported
+ * Properties). The following properties are set by default to the value
+ * link BooleanTRUE for the XML validation. If you want to switch these
+ * features off you must set the property value to link BooleanFALSE.
+ * org.jcp.xml.dsig.validateManifests
+ * javax.xml.crypto.dsig.cacheReference
*/
private Map cryptoContextProperties;
/**
* Disallows that the incoming XML document contains DTD DOCTYPE
- * declaration. The default value is {@link Boolean#TRUE} .
- *
- * @param disallowDoctypeDecl
- * if set to {@link Boolean#FALSE} then DOCTYPE declaration
- * is allowed, otherwise not
+ * declaration. The default value is link BooleanTRUE.
*/
private Boolean disallowDoctypeDecl = true;
/**
* Indicator whether the XML declaration in the outgoing message body
- * should be omitted. Default value is <code>false</code>. Can be
- * overwritten by the header
- * {@link XmlSignatureConstants#HEADER_OMIT_XML_DECLARATION} .
+ * should be omitted. Default value is false. Can be overwritten by the
+ * header link XmlSignatureConstantsHEADER_OMIT_XML_DECLARATION.
*/
private Boolean omitXmlDeclaration = false;
/**
@@ -329,25 +289,16 @@ public class XmlSignatureComponentConfiguration
* Signature case for determining the ID attributes, might be set in the
* enveloped and enveloping case. If set, then the XML document is
* validated with the specified XML schema. The schema resource URI can
- * be overwritten by the header
- * {@link XmlSignatureConstants#HEADER_SCHEMA_RESOURCE_URI} .
+ * be overwritten by the header link
+ * XmlSignatureConstantsHEADER_SCHEMA_RESOURCE_URI.
*/
private String schemaResourceUri;
/**
- * The character encoding of the resulting signed XML document. If
- * <code>null</code> then the encoding of the original XML document is
- * used.
+ * The character encoding of the resulting signed XML document. If null
+ * then the encoding of the original XML document is used.
*/
private String outputXmlEncoding;
- public CamelContext getCamelContext() {
- return camelContext;
- }
-
- public void setCamelContext(CamelContext camelContext) {
- this.camelContext = camelContext;
- }
-
public KeyAccessor getKeyAccessor() {
return keyAccessor;
}
@@ -594,7 +545,6 @@ public class XmlSignatureComponentConfiguration
public static class XmlVerifierConfigurationNestedConfiguration {
public static final Class CAMEL_NESTED_CLASS = org.apache.camel.component.xmlsecurity.processor.XmlVerifierConfiguration.class;
- private CamelContext camelContext;
/**
* Provides the key for validating the XML signature.
*/
@@ -602,7 +552,7 @@ public class XmlSignatureComponentConfiguration
/**
* This interface allows the application to check the XML signature
* before the validation is executed. This step is recommended in
- * http://www.w3.org/TR/xmldsig-bestpractices/#check-what-is-signed
+ * http://www.w3.org/TR/xmldsig-bestpractices/check-what-is-signed
*/
private XmlSignatureChecker xmlSignatureChecker;
/**
@@ -611,23 +561,23 @@ public class XmlSignatureComponentConfiguration
* options outputNodeSearchType, outputNodeSearch, and
* removeSignatureElements. The default implementation offers three
* possibilities which are related to the three output node search types
- * "Default", "ElementName", and "XPath". The default implementation
+ * Default, ElementName, and XPath. The default implementation
* determines a node which is then serialized and set to the body of the
- * output message If the search type is "ElementName" then the output
- * node (which must be in this case an element) is determined by the
- * local name and namespace defined in the search value (see option
- * outputNodeSearch). If the search type is "XPath" then the output node
+ * output message If the search type is ElementName then the output node
+ * (which must be in this case an element) is determined by the local
+ * name and namespace defined in the search value (see option
+ * outputNodeSearch). If the search type is XPath then the output node
* is determined by the XPath specified in the search value (in this
- * case the output node can be of type "Element", "TextNode" or
- * "Document"). If the output node search type is "Default" then the
- * following rules apply: In the enveloped XML signature case (there is
- * a reference with URI="" and transform
- * "http://www.w3.org/2000/09/xmldsig#enveloped-signature"), the
- * incoming XML document without the Signature element is set to the
- * output message body. In the non-enveloped XML signature case, the
- * message body is determined from a referenced Object; this is
- * explained in more detail in chapter
- * "Output Node Determination in Enveloping XML Signature Case".
+ * case the output node can be of type Element, TextNode or Document).
+ * If the output node search type is Default then the following rules
+ * apply: In the enveloped XML signature case (there is a reference with
+ * URI= and transform
+ * http://www.w3.org/2000/09/xmldsigenveloped-signature), the incoming
+ * XML document without the Signature element is set to the output
+ * message body. In the non-enveloped XML signature case, the message
+ * body is determined from a referenced Object; this is explained in
+ * more detail in chapter Output Node Determination in Enveloping XML
+ * Signature Case.
*/
private XmlSignature2Message xmlSignature2Message;
/**
@@ -645,28 +595,25 @@ public class XmlSignatureComponentConfiguration
* Sets the output node search value for determining the node from the
* XML signature document which shall be set to the output message body.
* The class of the value depends on the type of the output node search.
- * The output node search is forwarded to {@link XmlSignature2Message} .
+ * The output node search is forwarded to XmlSignature2Message.
*/
private Object outputNodeSearch;
/**
* Determines the search type for determining the output node which is
- * serialized into the output message bodyF. See
- * {@link #setOutputNodeSearch(Object)} . The supported default search
- * types you can find in {@link DefaultXmlSignature2Message} .
+ * serialized into the output message bodyF. See link
+ * setOutputNodeSearch(Object). The supported default search types you
+ * can find in DefaultXmlSignature2Message.
*/
private String outputNodeSearchType = "Default";
/**
* Indicator whether the XML signature elements (elements with local
- * name "Signature" and namesapce
- * ""http://www.w3.org/2000/09/xmldsig#"") shall be removed from the
- * document set to the output message. Normally, this is only necessary,
- * if the XML signature is enveloped. The default value is
- * {@link Boolean#FALSE} . This parameter is forwarded to
- * {@link XmlSignature2Message} .
- * <p>
- * This indicator has no effect if the output node search is of type
- * {@link DefaultXmlSignature2Message#OUTPUT_NODE_SEARCH_TYPE_DEFAULT}
- * .F
+ * name Signature and namesapce http://www.w3.org/2000/09/xmldsig) shall
+ * be removed from the document set to the output message. Normally,
+ * this is only necessary, if the XML signature is enveloped. The
+ * default value is link BooleanFALSE. This parameter is forwarded to
+ * XmlSignature2Message. This indicator has no effect if the output node
+ * search is of type link
+ * DefaultXmlSignature2MessageOUTPUT_NODE_SEARCH_TYPE_DEFAULT.F
*/
private Boolean removeSignatureElements = false;
/**
@@ -683,50 +630,35 @@ public class XmlSignatureComponentConfiguration
* If you want to restrict the remote access via reference URIs, you can
* set an own dereferencer. Optional parameter. If not set the provider
* default dereferencer is used which can resolve URI fragments, HTTP,
- * file and XPpointer URIs.
- * <p>
- * Attention: The implementation is provider dependent!
- *
- * @seeXMLCryptoContext#setURIDereferencer(URIDereferencer)
+ * file and XPpointer URIs. Attention: The implementation is provider
+ * dependent!
*/
private URIDereferencer uriDereferencer;
/**
* You can set a base URI which is used in the URI dereferencing.
* Relative URIs are then concatenated with the base URI.
- *
- * @seeXMLCryptoContext#setBaseURI(String)
*/
private String baseUri;
/**
- * Sets the crypto context properties. See
- * {@link XMLCryptoContext#setProperty(String,Object)} . Possible
- * properties are defined in {@link XMLSignContext} an
- * {@link XMLValidateContext} (see Supported Properties).
- * <p>
- * The following properties are set by default to the value
- * {@link Boolean#TRUE} for the XML validation. If you want to switch
- * these features off you must set the property value to
- * {@link Boolean#FALSE} .
- * <ul>
- * <li><code>"org.jcp.xml.dsig.validateManifests"</code></li>
- * <li><code>"javax.xml.crypto.dsig.cacheReference"</code></li>
- * </ul>
+ * Sets the crypto context properties. See link
+ * XMLCryptoContextsetProperty(String, Object). Possible properties are
+ * defined in XMLSignContext an XMLValidateContext (see Supported
+ * Properties). The following properties are set by default to the value
+ * link BooleanTRUE for the XML validation. If you want to switch these
+ * features off you must set the property value to link BooleanFALSE.
+ * org.jcp.xml.dsig.validateManifests
+ * javax.xml.crypto.dsig.cacheReference
*/
private Map cryptoContextProperties;
/**
* Disallows that the incoming XML document contains DTD DOCTYPE
- * declaration. The default value is {@link Boolean#TRUE} .
- *
- * @param disallowDoctypeDecl
- * if set to {@link Boolean#FALSE} then DOCTYPE declaration
- * is allowed, otherwise not
+ * declaration. The default value is link BooleanTRUE.
*/
private Boolean disallowDoctypeDecl = true;
/**
* Indicator whether the XML declaration in the outgoing message body
- * should be omitted. Default value is <code>false</code>. Can be
- * overwritten by the header
- * {@link XmlSignatureConstants#HEADER_OMIT_XML_DECLARATION} .
+ * should be omitted. Default value is false. Can be overwritten by the
+ * header link XmlSignatureConstantsHEADER_OMIT_XML_DECLARATION.
*/
private Boolean omitXmlDeclaration = false;
/**
@@ -739,25 +671,16 @@ public class XmlSignatureComponentConfiguration
* Signature case for determining the ID attributes, might be set in the
* enveloped and enveloping case. If set, then the XML document is
* validated with the specified XML schema. The schema resource URI can
- * be overwritten by the header
- * {@link XmlSignatureConstants#HEADER_SCHEMA_RESOURCE_URI} .
+ * be overwritten by the header link
+ * XmlSignatureConstantsHEADER_SCHEMA_RESOURCE_URI.
*/
private String schemaResourceUri;
/**
- * The character encoding of the resulting signed XML document. If
- * <code>null</code> then the encoding of the original XML document is
- * used.
+ * The character encoding of the resulting signed XML document. If null
+ * then the encoding of the original XML document is used.
*/
private String outputXmlEncoding;
- public CamelContext getCamelContext() {
- return camelContext;
- }
-
- public void setCamelContext(CamelContext camelContext) {
- this.camelContext = camelContext;
- }
-
public KeySelector getKeySelector() {
return keySelector;
}
diff --git a/platforms/spring-boot/components-starter/camel-yammer-starter/src/main/java/org/apache/camel/component/yammer/springboot/YammerComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-yammer-starter/src/main/java/org/apache/camel/component/yammer/springboot/YammerComponentConfiguration.java
index 51c9b22..b5d59b7 100644
--- a/platforms/spring-boot/components-starter/camel-yammer-starter/src/main/java/org/apache/camel/component/yammer/springboot/YammerComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-yammer-starter/src/main/java/org/apache/camel/component/yammer/springboot/YammerComponentConfiguration.java
@@ -144,7 +144,7 @@ public class YammerComponentConfiguration
* Returns messages older than the message ID specified as a numeric
* string. This is useful for paginating messages. For example, if
* you're currently viewing 20 messages and the oldest is number 2912,
- * you could append "?olderThan=2912″ to your request to get the 20
+ * you could append olderThan=2912 to your request to get the 20
* messages prior to those you're seeing.
*/
private Integer olderThan = -1;
@@ -152,7 +152,7 @@ public class YammerComponentConfiguration
* Returns messages newer than the message ID specified as a numeric
* string. This should be used when polling for new messages. If you're
* looking at messages, and the most recent message returned is 3516,
- * you can make a request with the parameter "?newerThan=3516″ to ensure
+ * you can make a request with the parameter newerThan=3516 to ensure
* that you do not get duplicate copies of messages already on your
* page.
*/
diff --git a/platforms/spring-boot/components-starter/camel-zendesk-starter/src/main/java/org/apache/camel/component/zendesk/springboot/ZendeskComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-zendesk-starter/src/main/java/org/apache/camel/component/zendesk/springboot/ZendeskComponentConfiguration.java
index 932efa7..5a5d0c2 100644
--- a/platforms/spring-boot/components-starter/camel-zendesk-starter/src/main/java/org/apache/camel/component/zendesk/springboot/ZendeskComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-zendesk-starter/src/main/java/org/apache/camel/component/zendesk/springboot/ZendeskComponentConfiguration.java
@@ -82,44 +82,26 @@ public class ZendeskComponentConfiguration
public static final Class CAMEL_NESTED_CLASS = org.apache.camel.component.zendesk.ZendeskConfiguration.class;
/**
* What operation to use
- *
- * @param methodNamethe
- * methodName to set
*/
private String methodName;
/**
* The server URL to connect.
- *
- * @param url
- * server URL
*/
private String serverUrl;
/**
* The user name.
- *
- * @param user
- * user name
*/
private String username;
/**
* The security token.
- *
- * @param token
- * security token
*/
private String token;
/**
* The OAuth token.
- *
- * @param token
- * OAuth token
*/
private String oauthToken;
/**
* The password.
- *
- * @param password
- * password
*/
private String password;
diff --git a/platforms/spring-boot/components-starter/camel-zookeeper-starter/src/main/java/org/apache/camel/component/zookeeper/springboot/ZooKeeperComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-zookeeper-starter/src/main/java/org/apache/camel/component/zookeeper/springboot/ZooKeeperComponentConfiguration.java
index 3ccd575..9c83a4e 100644
--- a/platforms/spring-boot/components-starter/camel-zookeeper-starter/src/main/java/org/apache/camel/component/zookeeper/springboot/ZooKeeperComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-zookeeper-starter/src/main/java/org/apache/camel/component/zookeeper/springboot/ZooKeeperComponentConfiguration.java
@@ -91,8 +91,6 @@ public class ZooKeeperComponentConfiguration
private Boolean repeat = false;
/**
* Not in use
- *
- * @deprecated The usage of this option has no effect at all.
*/
@Deprecated
private Boolean awaitExistence = true;
diff --git a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/JSonSchemaHelper.java b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/JSonSchemaHelper.java
index 027a7ae..ee30216 100644
--- a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/JSonSchemaHelper.java
+++ b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/JSonSchemaHelper.java
@@ -154,6 +154,23 @@ public final class JSonSchemaHelper {
return null;
}
+ public static String getPropertyDescriptionValue(List<Map<String, String>> rows, String name) {
+ for (Map<String, String> row : rows) {
+ String description = null;
+ boolean found = false;
+ if (row.containsKey("name")) {
+ found = name.equals(row.get("name"));
+ }
+ if (row.containsKey("description")) {
+ description = row.get("description");
+ }
+ if (found) {
+ return description;
+ }
+ }
+ return null;
+ }
+
public static String getPropertyJavaType(List<Map<String, String>> rows, String name) {
for (Map<String, String> row : rows) {
String javaType = null;
diff --git a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/SpringBootAutoConfigurationMojo.java b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/SpringBootAutoConfigurationMojo.java
index fcfc205..e0d542d 100644
--- a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/SpringBootAutoConfigurationMojo.java
+++ b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/SpringBootAutoConfigurationMojo.java
@@ -50,6 +50,7 @@ import org.apache.camel.maven.packaging.model.LanguageModel;
import org.apache.camel.maven.packaging.model.LanguageOptionModel;
import org.apache.camel.maven.packaging.model.OtherModel;
import org.apache.camel.maven.packaging.model.OtherOptionModel;
+import org.apache.camel.spi.Metadata;
import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
import org.apache.commons.io.FileUtils;
@@ -86,6 +87,7 @@ import org.springframework.context.annotation.Lazy;
import org.springframework.context.annotation.Scope;
import static org.apache.camel.maven.packaging.JSonSchemaHelper.getPropertyDefaultValue;
+import static org.apache.camel.maven.packaging.JSonSchemaHelper.getPropertyDescriptionValue;
import static org.apache.camel.maven.packaging.JSonSchemaHelper.getPropertyJavaType;
import static org.apache.camel.maven.packaging.JSonSchemaHelper.getPropertyType;
import static org.apache.camel.maven.packaging.JSonSchemaHelper.getSafeValue;
@@ -807,6 +809,11 @@ public class SpringBootAutoConfigurationMojo extends AbstractMojo {
PropertySource<JavaClassSource> sourceProp = resolvedProperty.propertySource;
Type<JavaClassSource> propType = sourceProp.getType();
+ // skip these types
+ if (propType.isType("CamelContext")) {
+ continue;
+ }
+
final PropertySource<JavaClassSource> prop = innerClass.addProperty(optionType, sourceProp.getName());
boolean anEnum;
@@ -837,6 +844,7 @@ public class SpringBootAutoConfigurationMojo extends AbstractMojo {
prop.getAccessor().addAnnotation(DeprecatedConfigurationProperty.class);
}
+ // find description for the nested type on its field/setter javadoc or via Camel annotations
String description = null;
final MethodSource<JavaClassSource> mutator = sourceProp.getMutator();
if (mutator.hasJavaDoc()) {
@@ -844,6 +852,15 @@ public class SpringBootAutoConfigurationMojo extends AbstractMojo {
} else if (sourceProp.hasField()) {
description = sourceProp.getField().getJavaDoc().getFullText();
}
+ if (Strings.isBlank(description) && sourceProp.hasAnnotation(UriPath.class)) {
+ description = sourceProp.getAnnotation(UriPath.class).getLiteralValue("description");
+ }
+ if (Strings.isBlank(description) && sourceProp.hasAnnotation(UriParam.class)) {
+ description = sourceProp.getAnnotation(UriParam.class).getLiteralValue("description");
+ }
+ if (Strings.isBlank(description) && sourceProp.hasAnnotation(Metadata.class)) {
+ description = sourceProp.getAnnotation(Metadata.class).getLiteralValue("description");
+ }
if (!Strings.isBlank(description)) {
prop.getField().getJavaDoc().setFullText(description);
}
@@ -880,6 +897,11 @@ public class SpringBootAutoConfigurationMojo extends AbstractMojo {
javaType = getPropertyJavaType(rows, optionName);
type = getPropertyType(rows, optionName);
defaultValue = getPropertyDefaultValue(rows, optionName);
+ // favour description from the model
+ description = getPropertyDescriptionValue(rows, optionName);
+ if (description != null) {
+ prop.getField().getJavaDoc().setFullText(description);
+ }
}
} catch (IOException e) {
// ignore