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 2016/12/22 12:38:24 UTC
camel git commit: Component docs
Repository: camel
Updated Branches:
refs/heads/master 7e9047af4 -> f674efdb5
Component docs
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/f674efdb
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/f674efdb
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/f674efdb
Branch: refs/heads/master
Commit: f674efdb5a85fc67e460c615a32aaf7b468f9ed8
Parents: 7e9047a
Author: Claus Ibsen <da...@apache.org>
Authored: Thu Dec 22 13:38:16 2016 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Thu Dec 22 13:38:16 2016 +0100
----------------------------------------------------------------------
components/camel-jms/src/main/docs/jms-component.adoc | 8 ++++----
.../java/org/apache/camel/component/jms/JmsComponent.java | 4 ++--
.../org/apache/camel/component/jms/JmsConfiguration.java | 4 ++--
components/camel-sjms/src/main/docs/sjms-component.adoc | 4 ++--
.../java/org/apache/camel/component/sjms/SjmsEndpoint.java | 4 ++--
5 files changed, 12 insertions(+), 12 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/f674efdb/components/camel-jms/src/main/docs/jms-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-jms/src/main/docs/jms-component.adoc b/components/camel-jms/src/main/docs/jms-component.adoc
index 26480ae..b094357 100644
--- a/components/camel-jms/src/main/docs/jms-component.adoc
+++ b/components/camel-jms/src/main/docs/jms-component.adoc
@@ -243,8 +243,8 @@ The JMS component supports 74 options which are listed below.
| durableSubscriptionName | common | | String | The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well.
| exceptionListener | advanced | | ExceptionListener | Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions.
| errorHandler | advanced | | ErrorHandler | Specifies a org.springframework.util.ErrorHandler to be invoked in case of any uncaught exceptions thrown while processing a Message. By default these exceptions will be logged at the WARN level if no errorHandler has been configured. You can configure logging level and whether stack traces should be logged using errorHandlerLoggingLevel and errorHandlerLogStackTrace options. This makes it much easier to configure than having to code a custom errorHandler.
-| errorHandlerLoggingLevel | advanced | WARN | LoggingLevel | Allows to configure the default errorHandler logging level for logging uncaught exceptions.
-| errorHandlerLogStackTrace | advanced | true | boolean | Allows to control whether stacktraces should be logged or not by the default errorHandler.
+| errorHandlerLoggingLevel | logging | WARN | LoggingLevel | Allows to configure the default errorHandler logging level for logging uncaught exceptions.
+| errorHandlerLogStackTrace | logging | true | boolean | Allows to control whether stacktraces should be logged or not by the default errorHandler.
| explicitQosEnabled | producer | false | boolean | Set if the deliveryMode priority or timeToLive qualities of service should be used when sending messages. This option is based on Spring's JmsTemplate. The deliveryMode priority and timeToLive options are applied to the current endpoint. This contrasts with the preserveMessageQos option which operates at message granularity reading QoS properties exclusively from the Camel In message headers.
| exposeListenerSession | consumer (advanced) | false | boolean | Specifies whether the listener session should be exposed when consuming messages.
| idleTaskExecutionLimit | advanced | 1 | int | Specifies the limit for idle executions of a receive task not having received any message within its execution. If this limit is reached the task will shut down and leave receiving to other executing tasks (in the case of dynamic scheduling; see the maxConcurrentConsumers setting). There is additional doc available from Spring.
@@ -378,8 +378,6 @@ The JMS component supports 85 endpoint options which are listed below:
| asyncStopListener | advanced | false | boolean | Whether to stop the JmsConsumer message listener asynchronously when stopping a route.
| destinationResolver | advanced | | DestinationResolver | A pluggable org.springframework.jms.support.destination.DestinationResolver that allows you to use your own resolver (for example to lookup the real destination in a JNDI registry).
| errorHandler | advanced | | ErrorHandler | Specifies a org.springframework.util.ErrorHandler to be invoked in case of any uncaught exceptions thrown while processing a Message. By default these exceptions will be logged at the WARN level if no errorHandler has been configured. You can configure logging level and whether stack traces should be logged using errorHandlerLoggingLevel and errorHandlerLogStackTrace options. This makes it much easier to configure than having to code a custom errorHandler.
-| errorHandlerLoggingLevel | advanced | WARN | LoggingLevel | Allows to configure the default errorHandler logging level for logging uncaught exceptions.
-| errorHandlerLogStackTrace | advanced | true | boolean | Allows to control whether stacktraces should be logged or not by the default errorHandler.
| exceptionListener | advanced | | ExceptionListener | Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions.
| headerFilterStrategy | advanced | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
| idleConsumerLimit | advanced | 1 | int | Specify the limit for the number of consumers that are allowed to be idle at any given time.
@@ -404,6 +402,8 @@ The JMS component supports 85 endpoint options which are listed below:
| useMessageIDAsCorrelationID | advanced | false | boolean | Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages.
| waitForProvisionCorrelationToBeUpdatedCounter | advanced | 50 | int | Number of times to wait for provisional correlation id to be updated to the actual correlation id when doing request/reply over JMS and when the option useMessageIDAsCorrelationID is enabled.
| waitForProvisionCorrelationToBeUpdatedThreadSleepingTime | advanced | 100 | long | Interval in millis to sleep each time while waiting for provisional correlation id to be updated.
+| errorHandlerLoggingLevel | logging | WARN | LoggingLevel | Allows to configure the default errorHandler logging level for logging uncaught exceptions.
+| errorHandlerLogStackTrace | logging | true | boolean | Allows to control whether stacktraces should be logged or not by the default errorHandler.
| password | security | | String | Password to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory.
| username | security | | String | Username to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory.
| transacted | transaction | false | boolean | Specifies whether to use transacted mode
http://git-wip-us.apache.org/repos/asf/camel/blob/f674efdb/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsComponent.java
----------------------------------------------------------------------
diff --git a/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsComponent.java b/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsComponent.java
index 84463a3..2d3b5cd 100644
--- a/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsComponent.java
+++ b/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsComponent.java
@@ -444,7 +444,7 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
/**
* Allows to configure the default errorHandler logging level for logging uncaught exceptions.
*/
- @Metadata(defaultValue = "WARN", label = "advanced",
+ @Metadata(defaultValue = "WARN", label = "consumer,logging",
description = "Allows to configure the default errorHandler logging level for logging uncaught exceptions.")
public void setErrorHandlerLoggingLevel(LoggingLevel errorHandlerLoggingLevel) {
getConfiguration().setErrorHandlerLoggingLevel(errorHandlerLoggingLevel);
@@ -453,7 +453,7 @@ public class JmsComponent extends HeaderFilterStrategyComponent implements Appli
/**
* Allows to control whether stacktraces should be logged or not, by the default errorHandler.
*/
- @Metadata(defaultValue = "true", label = "advanced",
+ @Metadata(defaultValue = "true", label = "consumer,logging",
description = "Allows to control whether stacktraces should be logged or not, by the default errorHandler.")
public void setErrorHandlerLogStackTrace(boolean errorHandlerLogStackTrace) {
getConfiguration().setErrorHandlerLogStackTrace(errorHandlerLogStackTrace);
http://git-wip-us.apache.org/repos/asf/camel/blob/f674efdb/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsConfiguration.java
----------------------------------------------------------------------
diff --git a/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsConfiguration.java b/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsConfiguration.java
index 5c8e20f..6ac017b 100644
--- a/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsConfiguration.java
+++ b/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsConfiguration.java
@@ -99,10 +99,10 @@ public class JmsConfiguration implements Cloneable {
+ " You can configure logging level and whether stack traces should be logged using errorHandlerLoggingLevel and errorHandlerLogStackTrace options."
+ " This makes it much easier to configure, than having to code a custom errorHandler.")
private ErrorHandler errorHandler;
- @UriParam(defaultValue = "WARN", label = "advanced",
+ @UriParam(defaultValue = "WARN", label = "consumer,logging",
description = "Allows to configure the default errorHandler logging level for logging uncaught exceptions.")
private LoggingLevel errorHandlerLoggingLevel = LoggingLevel.WARN;
- @UriParam(defaultValue = "true", label = "advanced",
+ @UriParam(defaultValue = "true", label = "consumer,logging",
description = "Allows to control whether stacktraces should be logged or not, by the default errorHandler.")
private boolean errorHandlerLogStackTrace = true;
@UriParam(label = "consumer", defaultValue = "true",
http://git-wip-us.apache.org/repos/asf/camel/blob/f674efdb/components/camel-sjms/src/main/docs/sjms-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-sjms/src/main/docs/sjms-component.adoc b/components/camel-sjms/src/main/docs/sjms-component.adoc
index 1132a49..85c4ed9 100644
--- a/components/camel-sjms/src/main/docs/sjms-component.adoc
+++ b/components/camel-sjms/src/main/docs/sjms-component.adoc
@@ -162,14 +162,14 @@ The Simple JMS component supports 36 endpoint options which are listed below:
| connectionFactory | advanced | | ConnectionFactory | Initializes the connectionFactory for the endpoint which takes precedence over the component's connectionFactory if any
| connectionResource | advanced | | ConnectionResource | Initializes the connectionResource for the endpoint which takes precedence over the component's connectionResource if any
| destinationCreationStrategy | advanced | | DestinationCreationStrategy | To use a custom DestinationCreationStrategy.
-| errorHandlerLoggingLevel | advanced | WARN | LoggingLevel | Allows to configure the default errorHandler logging level for logging uncaught exceptions.
-| errorHandlerLogStackTrace | advanced | true | boolean | Allows to control whether stacktraces should be logged or not by the default errorHandler.
| exceptionListener | advanced | | ExceptionListener | Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions.
| headerFilterStrategy | advanced | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
| includeAllJMSXProperties | advanced | false | boolean | Whether to include all JMSXxxx properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply.
| jmsKeyFormatStrategy | advanced | | JmsKeyFormatStrategy | Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS 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.
| mapJmsMessage | advanced | true | boolean | Specifies whether Camel should auto map the received JMS message to a suited payload type such as javax.jms.TextMessage to a String etc. See section about how mapping works below for more details.
| messageCreatedStrategy | advanced | | MessageCreatedStrategy | To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message.
+| errorHandlerLoggingLevel | logging | WARN | LoggingLevel | Allows to configure the default errorHandler logging level for logging uncaught exceptions.
+| errorHandlerLogStackTrace | logging | true | boolean | Allows to control whether stacktraces should be logged or not by the default errorHandler.
| transacted | transaction | false | boolean | Specifies whether to use transacted mode
| transactionBatchCount | transaction | -1 | int | If transacted sets the number of messages to process before committing a transaction.
| transactionBatchTimeout | transaction | 5000 | long | Sets timeout (in millis) for batch transactions the value should be 1000 or higher.
http://git-wip-us.apache.org/repos/asf/camel/blob/f674efdb/components/camel-sjms/src/main/java/org/apache/camel/component/sjms/SjmsEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-sjms/src/main/java/org/apache/camel/component/sjms/SjmsEndpoint.java b/components/camel-sjms/src/main/java/org/apache/camel/component/sjms/SjmsEndpoint.java
index 16e9573..bb03c48 100644
--- a/components/camel-sjms/src/main/java/org/apache/camel/component/sjms/SjmsEndpoint.java
+++ b/components/camel-sjms/src/main/java/org/apache/camel/component/sjms/SjmsEndpoint.java
@@ -132,9 +132,9 @@ public class SjmsEndpoint extends DefaultEndpoint implements AsyncEndpoint, Mult
private Integer connectionCount;
@UriParam(label = "advanced")
private ExceptionListener exceptionListener;
- @UriParam(defaultValue = "WARN", label = "advanced")
+ @UriParam(defaultValue = "WARN", label = "consumer,logging")
private LoggingLevel errorHandlerLoggingLevel = LoggingLevel.WARN;
- @UriParam(defaultValue = "true", label = "advanced")
+ @UriParam(defaultValue = "true", label = "consumer,logging")
private boolean errorHandlerLogStackTrace = true;
private volatile boolean closeConnectionResource;