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 eb4e9f1 Add labels to options
eb4e9f1 is described below
commit eb4e9f156d84b929e758762e36b5c8cd36a0f1d6
Author: Claus Ibsen <[email protected]>
AuthorDate: Fri Dec 27 13:05:17 2019 +0100
Add labels to options
---
.../camel-jt400/src/main/docs/jt400-component.adoc | 8 +-
.../camel/component/jt400/Jt400Configuration.java | 20 +-
.../endpoint/dsl/Jt400EndpointBuilderFactory.java | 328 +++++----------------
.../modules/ROOT/pages/jt400-component.adoc | 8 +-
4 files changed, 95 insertions(+), 269 deletions(-)
diff --git a/components/camel-jt400/src/main/docs/jt400-component.adoc
b/components/camel-jt400/src/main/docs/jt400-component.adoc
index 0339b7c..63ffb91 100644
--- a/components/camel-jt400/src/main/docs/jt400-component.adoc
+++ b/components/camel-jt400/src/main/docs/jt400-component.adoc
@@ -91,17 +91,18 @@ with the following path and query parameters:
| *format* (common) | Sets the data format for sending messages. | text |
Format
| *guiAvailable* (common) | Sets whether AS/400 prompting is enabled in the
environment running Camel. | false | boolean
| *keyed* (common) | Whether to use keyed or non-keyed data queues. | false |
boolean
-| *outputFieldsIdxArray* (common) | Specifies which fields (program
parameters) are output parameters. | | Integer[]
-| *outputFieldsLengthArray* (common) | Specifies the fields (program
parameters) length as in the AS/400 program definition. | | Integer[]
| *searchKey* (common) | Search key for keyed data queues. | | String
-| *searchType* (common) | Search type such as EQ for equal etc. | EQ |
SearchType
| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the
Camel routing Error Handler, which mean any exceptions occurred while the
consumer is trying to pickup incoming messages, or the likes, will now be
processed as a message and handled by the routing Error Handler. By default the
consumer will use the org.apache.camel.spi.ExceptionHandler to deal with
exceptions, that will be logged at WARN or ERROR level and ignored. | false |
boolean
| *readTimeout* (consumer) | Timeout in millis the consumer will wait while
trying to read a new message of the data queue. | 30000 | int
+| *searchType* (consumer) | Search type such as EQ for equal etc. | EQ |
SearchType
| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll
any files, you can enable this option to send an empty message (no body)
instead. | false | boolean
| *exceptionHandler* (consumer) | To let the consumer use a custom
ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this
option is not in use. By default the consumer will deal with exceptions, that
will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer
creates an exchange. | | ExchangePattern
| *pollStrategy* (consumer) | A pluggable
org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your
custom implementation to control error handling usually occurred during the
poll operation before an Exchange have been created and being routed in Camel.
| | PollingConsumerPollStrategy
| *lazyStartProducer* (producer) | Whether the producer should be started lazy
(on the first message). By starting lazy you can use this to allow CamelContext
and routes to startup in situations where a producer may otherwise fail during
starting and cause the route to fail being started. By deferring this startup
to be lazy then the startup failure can be handled during routing messages via
Camel's routing error handlers. Beware that when the first message is processed
then creating and [...]
+| *outputFieldsIdxArray* (producer) | Specifies which fields (program
parameters) are output parameters. | | Integer[]
+| *outputFieldsLengthArray* (producer) | Specifies the fields (program
parameters) length as in the AS/400 program definition. | | Integer[]
+| *procedureName* (producer) | Procedure name from a service program to call |
| String
| *basicPropertyBinding* (advanced) | Whether the endpoint should use basic
property binding (Camel 2.x) or the newer property binding with additional
capabilities | false | boolean
| *synchronous* (advanced) | Sets whether synchronous processing should be
strictly used, or Camel is allowed to use asynchronous processing (if
supported). | false | boolean
| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls
(failed due some error) that should happen before the backoffMultipler should
kick-in. | | int
@@ -118,7 +119,6 @@ with the following path and query parameters:
| *startScheduler* (scheduler) | Whether the scheduler should be auto started.
| true | boolean
| *timeUnit* (scheduler) | Time unit for initialDelay and delay options. |
MILLISECONDS | TimeUnit
| *useFixedDelay* (scheduler) | Controls if fixed delay or fixed rate is used.
See ScheduledExecutorService in JDK for details. | true | boolean
-| *procedureName* (procedureName) | Procedure name from a service program to
call | | String
| *secured* (security) | Whether connections to AS/400 are secured with SSL. |
false | boolean
|===
// endpoint options: END
diff --git
a/components/camel-jt400/src/main/java/org/apache/camel/component/jt400/Jt400Configuration.java
b/components/camel-jt400/src/main/java/org/apache/camel/component/jt400/Jt400Configuration.java
index d367957..5630203 100644
---
a/components/camel-jt400/src/main/java/org/apache/camel/component/jt400/Jt400Configuration.java
+++
b/components/camel-jt400/src/main/java/org/apache/camel/component/jt400/Jt400Configuration.java
@@ -71,15 +71,18 @@ public class Jt400Configuration {
private final AS400ConnectionPool connectionPool;
- @UriPath @Metadata(required = true, secret = true)
+ @UriPath(label = "security") @Metadata(required = true, secret = true)
private String userID;
- @UriPath @Metadata(required = true, secret = true)
+ @UriPath(label = "security") @Metadata(required = true, secret = true)
private String password;
- @UriPath @Metadata(required = true)
+ @UriPath(label = "security") @Metadata(required = true)
private String systemName;
+ @UriParam(label = "security")
+ private boolean secured;
+
@UriPath @Metadata(required = true)
private String objectPath;
@@ -101,22 +104,19 @@ public class Jt400Configuration {
@UriParam
private String searchKey;
- @UriParam(defaultValue = "EQ")
+ @UriParam(label = "consumer", defaultValue = "EQ")
private SearchType searchType = SearchType.EQ;
- @UriParam(label = "security")
- private boolean secured;
-
- @UriParam
+ @UriParam(label = "producer")
private Integer[] outputFieldsIdxArray;
- @UriParam
+ @UriParam(label = "producer")
private Integer[] outputFieldsLengthArray;
@UriParam(label = "consumer", defaultValue = "30000")
private int readTimeout = 30000;
- @UriParam(label = "procedureName")
+ @UriParam(label = "producer")
private String procedureName;
public Jt400Configuration(String endpointUri, AS400ConnectionPool
connectionPool) throws URISyntaxException {
diff --git
a/core/camel-endpointdsl/src/main/java/org/apache/camel/builder/endpoint/dsl/Jt400EndpointBuilderFactory.java
b/core/camel-endpointdsl/src/main/java/org/apache/camel/builder/endpoint/dsl/Jt400EndpointBuilderFactory.java
index df6806a..ded2f62 100644
---
a/core/camel-endpointdsl/src/main/java/org/apache/camel/builder/endpoint/dsl/Jt400EndpointBuilderFactory.java
+++
b/core/camel-endpointdsl/src/main/java/org/apache/camel/builder/endpoint/dsl/Jt400EndpointBuilderFactory.java
@@ -140,58 +140,6 @@ public interface Jt400EndpointBuilderFactory {
return this;
}
/**
- * Specifies which fields (program parameters) are output parameters.
- *
- * The option is a: <code>java.lang.Integer[]</code> type.
- *
- * Group: common
- */
- default Jt400EndpointConsumerBuilder outputFieldsIdxArray(
- Integer[] outputFieldsIdxArray) {
- doSetProperty("outputFieldsIdxArray", outputFieldsIdxArray);
- return this;
- }
- /**
- * Specifies which fields (program parameters) are output parameters.
- *
- * The option will be converted to a <code>java.lang.Integer[]</code>
- * type.
- *
- * Group: common
- */
- default Jt400EndpointConsumerBuilder outputFieldsIdxArray(
- String outputFieldsIdxArray) {
- doSetProperty("outputFieldsIdxArray", outputFieldsIdxArray);
- return this;
- }
- /**
- * Specifies the fields (program parameters) length as in the AS/400
- * program definition.
- *
- * The option is a: <code>java.lang.Integer[]</code> type.
- *
- * Group: common
- */
- default Jt400EndpointConsumerBuilder outputFieldsLengthArray(
- Integer[] outputFieldsLengthArray) {
- doSetProperty("outputFieldsLengthArray", outputFieldsLengthArray);
- return this;
- }
- /**
- * Specifies the fields (program parameters) length as in the AS/400
- * program definition.
- *
- * The option will be converted to a <code>java.lang.Integer[]</code>
- * type.
- *
- * Group: common
- */
- default Jt400EndpointConsumerBuilder outputFieldsLengthArray(
- String outputFieldsLengthArray) {
- doSetProperty("outputFieldsLengthArray", outputFieldsLengthArray);
- return this;
- }
- /**
* Search key for keyed data queues.
*
* The option is a: <code>java.lang.String</code> type.
@@ -203,30 +151,6 @@ public interface Jt400EndpointBuilderFactory {
return this;
}
/**
- * Search type such as EQ for equal etc.
- *
- * The option is a:
- *
<code>org.apache.camel.component.jt400.Jt400Configuration$SearchType</code>
type.
- *
- * Group: common
- */
- default Jt400EndpointConsumerBuilder searchType(SearchType searchType)
{
- doSetProperty("searchType", searchType);
- return this;
- }
- /**
- * Search type such as EQ for equal etc.
- *
- * The option will be converted to a
- *
<code>org.apache.camel.component.jt400.Jt400Configuration$SearchType</code>
type.
- *
- * Group: common
- */
- default Jt400EndpointConsumerBuilder searchType(String searchType) {
- doSetProperty("searchType", searchType);
- return this;
- }
- /**
* Allows for bridging the consumer to the Camel routing Error Handler,
* which mean any exceptions occurred while the consumer is trying to
* pickup incoming messages, or the likes, will now be processed as a
@@ -287,6 +211,30 @@ public interface Jt400EndpointBuilderFactory {
return this;
}
/**
+ * Search type such as EQ for equal etc.
+ *
+ * The option is a:
+ *
<code>org.apache.camel.component.jt400.Jt400Configuration$SearchType</code>
type.
+ *
+ * Group: consumer
+ */
+ default Jt400EndpointConsumerBuilder searchType(SearchType searchType)
{
+ doSetProperty("searchType", searchType);
+ return this;
+ }
+ /**
+ * Search type such as EQ for equal etc.
+ *
+ * The option will be converted to a
+ *
<code>org.apache.camel.component.jt400.Jt400Configuration$SearchType</code>
type.
+ *
+ * Group: consumer
+ */
+ default Jt400EndpointConsumerBuilder searchType(String searchType) {
+ doSetProperty("searchType", searchType);
+ return this;
+ }
+ /**
* If the polling consumer did not poll any files, you can enable this
* option to send an empty message (no body) instead.
*
@@ -670,17 +618,6 @@ public interface Jt400EndpointBuilderFactory {
return this;
}
/**
- * Procedure name from a service program to call.
- *
- * The option is a: <code>java.lang.String</code> type.
- *
- * Group: procedureName
- */
- default Jt400EndpointConsumerBuilder procedureName(String
procedureName) {
- doSetProperty("procedureName", procedureName);
- return this;
- }
- /**
* Whether connections to AS/400 are secured with SSL.
*
* The option is a: <code>boolean</code> type.
@@ -958,58 +895,6 @@ public interface Jt400EndpointBuilderFactory {
return this;
}
/**
- * Specifies which fields (program parameters) are output parameters.
- *
- * The option is a: <code>java.lang.Integer[]</code> type.
- *
- * Group: common
- */
- default Jt400EndpointProducerBuilder outputFieldsIdxArray(
- Integer[] outputFieldsIdxArray) {
- doSetProperty("outputFieldsIdxArray", outputFieldsIdxArray);
- return this;
- }
- /**
- * Specifies which fields (program parameters) are output parameters.
- *
- * The option will be converted to a <code>java.lang.Integer[]</code>
- * type.
- *
- * Group: common
- */
- default Jt400EndpointProducerBuilder outputFieldsIdxArray(
- String outputFieldsIdxArray) {
- doSetProperty("outputFieldsIdxArray", outputFieldsIdxArray);
- return this;
- }
- /**
- * Specifies the fields (program parameters) length as in the AS/400
- * program definition.
- *
- * The option is a: <code>java.lang.Integer[]</code> type.
- *
- * Group: common
- */
- default Jt400EndpointProducerBuilder outputFieldsLengthArray(
- Integer[] outputFieldsLengthArray) {
- doSetProperty("outputFieldsLengthArray", outputFieldsLengthArray);
- return this;
- }
- /**
- * Specifies the fields (program parameters) length as in the AS/400
- * program definition.
- *
- * The option will be converted to a <code>java.lang.Integer[]</code>
- * type.
- *
- * Group: common
- */
- default Jt400EndpointProducerBuilder outputFieldsLengthArray(
- String outputFieldsLengthArray) {
- doSetProperty("outputFieldsLengthArray", outputFieldsLengthArray);
- return this;
- }
- /**
* Search key for keyed data queues.
*
* The option is a: <code>java.lang.String</code> type.
@@ -1021,30 +906,6 @@ public interface Jt400EndpointBuilderFactory {
return this;
}
/**
- * Search type such as EQ for equal etc.
- *
- * The option is a:
- *
<code>org.apache.camel.component.jt400.Jt400Configuration$SearchType</code>
type.
- *
- * Group: common
- */
- default Jt400EndpointProducerBuilder searchType(SearchType searchType)
{
- doSetProperty("searchType", searchType);
- return this;
- }
- /**
- * Search type such as EQ for equal etc.
- *
- * The option will be converted to a
- *
<code>org.apache.camel.component.jt400.Jt400Configuration$SearchType</code>
type.
- *
- * Group: common
- */
- default Jt400EndpointProducerBuilder searchType(String searchType) {
- doSetProperty("searchType", searchType);
- return this;
- }
- /**
* Whether the producer should be started lazy (on the first message).
* By starting lazy you can use this to allow CamelContext and routes
to
* startup in situations where a producer may otherwise fail during
@@ -1085,11 +946,63 @@ public interface Jt400EndpointBuilderFactory {
return this;
}
/**
+ * Specifies which fields (program parameters) are output parameters.
+ *
+ * The option is a: <code>java.lang.Integer[]</code> type.
+ *
+ * Group: producer
+ */
+ default Jt400EndpointProducerBuilder outputFieldsIdxArray(
+ Integer[] outputFieldsIdxArray) {
+ doSetProperty("outputFieldsIdxArray", outputFieldsIdxArray);
+ return this;
+ }
+ /**
+ * Specifies which fields (program parameters) are output parameters.
+ *
+ * The option will be converted to a <code>java.lang.Integer[]</code>
+ * type.
+ *
+ * Group: producer
+ */
+ default Jt400EndpointProducerBuilder outputFieldsIdxArray(
+ String outputFieldsIdxArray) {
+ doSetProperty("outputFieldsIdxArray", outputFieldsIdxArray);
+ return this;
+ }
+ /**
+ * Specifies the fields (program parameters) length as in the AS/400
+ * program definition.
+ *
+ * The option is a: <code>java.lang.Integer[]</code> type.
+ *
+ * Group: producer
+ */
+ default Jt400EndpointProducerBuilder outputFieldsLengthArray(
+ Integer[] outputFieldsLengthArray) {
+ doSetProperty("outputFieldsLengthArray", outputFieldsLengthArray);
+ return this;
+ }
+ /**
+ * Specifies the fields (program parameters) length as in the AS/400
+ * program definition.
+ *
+ * The option will be converted to a <code>java.lang.Integer[]</code>
+ * type.
+ *
+ * Group: producer
+ */
+ default Jt400EndpointProducerBuilder outputFieldsLengthArray(
+ String outputFieldsLengthArray) {
+ doSetProperty("outputFieldsLengthArray", outputFieldsLengthArray);
+ return this;
+ }
+ /**
* Procedure name from a service program to call.
*
* The option is a: <code>java.lang.String</code> type.
*
- * Group: procedureName
+ * Group: producer
*/
default Jt400EndpointProducerBuilder procedureName(String
procedureName) {
doSetProperty("procedureName", procedureName);
@@ -1284,58 +1197,6 @@ public interface Jt400EndpointBuilderFactory {
return this;
}
/**
- * Specifies which fields (program parameters) are output parameters.
- *
- * The option is a: <code>java.lang.Integer[]</code> type.
- *
- * Group: common
- */
- default Jt400EndpointBuilder outputFieldsIdxArray(
- Integer[] outputFieldsIdxArray) {
- doSetProperty("outputFieldsIdxArray", outputFieldsIdxArray);
- return this;
- }
- /**
- * Specifies which fields (program parameters) are output parameters.
- *
- * The option will be converted to a <code>java.lang.Integer[]</code>
- * type.
- *
- * Group: common
- */
- default Jt400EndpointBuilder outputFieldsIdxArray(
- String outputFieldsIdxArray) {
- doSetProperty("outputFieldsIdxArray", outputFieldsIdxArray);
- return this;
- }
- /**
- * Specifies the fields (program parameters) length as in the AS/400
- * program definition.
- *
- * The option is a: <code>java.lang.Integer[]</code> type.
- *
- * Group: common
- */
- default Jt400EndpointBuilder outputFieldsLengthArray(
- Integer[] outputFieldsLengthArray) {
- doSetProperty("outputFieldsLengthArray", outputFieldsLengthArray);
- return this;
- }
- /**
- * Specifies the fields (program parameters) length as in the AS/400
- * program definition.
- *
- * The option will be converted to a <code>java.lang.Integer[]</code>
- * type.
- *
- * Group: common
- */
- default Jt400EndpointBuilder outputFieldsLengthArray(
- String outputFieldsLengthArray) {
- doSetProperty("outputFieldsLengthArray", outputFieldsLengthArray);
- return this;
- }
- /**
* Search key for keyed data queues.
*
* The option is a: <code>java.lang.String</code> type.
@@ -1347,41 +1208,6 @@ public interface Jt400EndpointBuilderFactory {
return this;
}
/**
- * Search type such as EQ for equal etc.
- *
- * The option is a:
- *
<code>org.apache.camel.component.jt400.Jt400Configuration$SearchType</code>
type.
- *
- * Group: common
- */
- default Jt400EndpointBuilder searchType(SearchType searchType) {
- doSetProperty("searchType", searchType);
- return this;
- }
- /**
- * Search type such as EQ for equal etc.
- *
- * The option will be converted to a
- *
<code>org.apache.camel.component.jt400.Jt400Configuration$SearchType</code>
type.
- *
- * Group: common
- */
- default Jt400EndpointBuilder searchType(String searchType) {
- doSetProperty("searchType", searchType);
- return this;
- }
- /**
- * Procedure name from a service program to call.
- *
- * The option is a: <code>java.lang.String</code> type.
- *
- * Group: procedureName
- */
- default Jt400EndpointBuilder procedureName(String procedureName) {
- doSetProperty("procedureName", procedureName);
- return this;
- }
- /**
* Whether connections to AS/400 are secured with SSL.
*
* The option is a: <code>boolean</code> type.
diff --git a/docs/components/modules/ROOT/pages/jt400-component.adoc
b/docs/components/modules/ROOT/pages/jt400-component.adoc
index ef6e568..b513b93 100644
--- a/docs/components/modules/ROOT/pages/jt400-component.adoc
+++ b/docs/components/modules/ROOT/pages/jt400-component.adoc
@@ -92,17 +92,18 @@ with the following path and query parameters:
| *format* (common) | Sets the data format for sending messages. | text |
Format
| *guiAvailable* (common) | Sets whether AS/400 prompting is enabled in the
environment running Camel. | false | boolean
| *keyed* (common) | Whether to use keyed or non-keyed data queues. | false |
boolean
-| *outputFieldsIdxArray* (common) | Specifies which fields (program
parameters) are output parameters. | | Integer[]
-| *outputFieldsLengthArray* (common) | Specifies the fields (program
parameters) length as in the AS/400 program definition. | | Integer[]
| *searchKey* (common) | Search key for keyed data queues. | | String
-| *searchType* (common) | Search type such as EQ for equal etc. | EQ |
SearchType
| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the
Camel routing Error Handler, which mean any exceptions occurred while the
consumer is trying to pickup incoming messages, or the likes, will now be
processed as a message and handled by the routing Error Handler. By default the
consumer will use the org.apache.camel.spi.ExceptionHandler to deal with
exceptions, that will be logged at WARN or ERROR level and ignored. | false |
boolean
| *readTimeout* (consumer) | Timeout in millis the consumer will wait while
trying to read a new message of the data queue. | 30000 | int
+| *searchType* (consumer) | Search type such as EQ for equal etc. | EQ |
SearchType
| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll
any files, you can enable this option to send an empty message (no body)
instead. | false | boolean
| *exceptionHandler* (consumer) | To let the consumer use a custom
ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this
option is not in use. By default the consumer will deal with exceptions, that
will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer
creates an exchange. | | ExchangePattern
| *pollStrategy* (consumer) | A pluggable
org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your
custom implementation to control error handling usually occurred during the
poll operation before an Exchange have been created and being routed in Camel.
| | PollingConsumerPollStrategy
| *lazyStartProducer* (producer) | Whether the producer should be started lazy
(on the first message). By starting lazy you can use this to allow CamelContext
and routes to startup in situations where a producer may otherwise fail during
starting and cause the route to fail being started. By deferring this startup
to be lazy then the startup failure can be handled during routing messages via
Camel's routing error handlers. Beware that when the first message is processed
then creating and [...]
+| *outputFieldsIdxArray* (producer) | Specifies which fields (program
parameters) are output parameters. | | Integer[]
+| *outputFieldsLengthArray* (producer) | Specifies the fields (program
parameters) length as in the AS/400 program definition. | | Integer[]
+| *procedureName* (producer) | Procedure name from a service program to call |
| String
| *basicPropertyBinding* (advanced) | Whether the endpoint should use basic
property binding (Camel 2.x) or the newer property binding with additional
capabilities | false | boolean
| *synchronous* (advanced) | Sets whether synchronous processing should be
strictly used, or Camel is allowed to use asynchronous processing (if
supported). | false | boolean
| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls
(failed due some error) that should happen before the backoffMultipler should
kick-in. | | int
@@ -119,7 +120,6 @@ with the following path and query parameters:
| *startScheduler* (scheduler) | Whether the scheduler should be auto started.
| true | boolean
| *timeUnit* (scheduler) | Time unit for initialDelay and delay options. |
MILLISECONDS | TimeUnit
| *useFixedDelay* (scheduler) | Controls if fixed delay or fixed rate is used.
See ScheduledExecutorService in JDK for details. | true | boolean
-| *procedureName* (procedureName) | Procedure name from a service program to
call | | String
| *secured* (security) | Whether connections to AS/400 are secured with SSL. |
false | boolean
|===
// endpoint options: END
