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/05/16 09:51:37 UTC
[46/50] [abbrv] camel git commit: Component docs
Component docs
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/3b0cec47
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/3b0cec47
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/3b0cec47
Branch: refs/heads/kube-lb
Commit: 3b0cec47427329117ee03edac7ab5566c36ed9cf
Parents: d7f94b2
Author: Claus Ibsen <da...@apache.org>
Authored: Sat May 14 09:28:20 2016 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Mon May 16 09:59:33 2016 +0200
----------------------------------------------------------------------
components/camel-mina/src/main/docs/mina.adoc | 28 ++++++++-------
.../camel/component/mina/MinaConfiguration.java | 26 +++++++-------
components/camel-mina2/src/main/docs/mina2.adoc | 36 +++++++++++---------
.../component/mina2/Mina2Configuration.java | 34 +++++++++---------
4 files changed, 64 insertions(+), 60 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/3b0cec47/components/camel-mina/src/main/docs/mina.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mina/src/main/docs/mina.adoc b/components/camel-mina/src/main/docs/mina.adoc
index 0ea538a..9584f29 100644
--- a/components/camel-mina/src/main/docs/mina.adoc
+++ b/components/camel-mina/src/main/docs/mina.adoc
@@ -83,6 +83,7 @@ The Mina component supports 1 options which are listed below.
+
// endpoint options: START
The Mina component supports 24 endpoint options which are listed below:
@@ -93,33 +94,34 @@ The Mina component supports 24 endpoint options which are listed below:
| protocol | common | | String | *Required* Protocol to use
| host | common | | String | *Required* Hostname to use. Use localhost or 0.0.0.0 for local server as consumer. For producer use the hostname or ip address of the remote server.
| port | common | | int | *Required* Port number
-| allowDefaultCodec | common | true | boolean | The mina component installs a default codec if both codec is null and textline is false. Setting allowDefaultCodec to false prevents the mina component from installing a default codec as the first element in the filter chain. This is useful in scenarios where another filter must be the first in the filter chain like the SSL filter.
-| codec | common | | ProtocolCodecFactory | To use a custom minda codec implementation.
-| decoderMaxLineLength | common | 1024 | int | To set the textline protocol decoder max line length. By default the default value of Mina itself is used which are 1024.
| disconnect | common | false | boolean | Whether or not to disconnect(close) from Mina session right after use. Can be used for both consumer and producer.
-| disconnectOnNoReply | common | true | boolean | If sync is enabled then this option dictates MinaConsumer if it should disconnect where there is no reply to send back.
-| encoderMaxLineLength | common | -1 | int | To set the textline protocol encoder max line length. By default the default value of Mina itself is used which are Integer.MAX_VALUE.
-| encoding | common | | String | You can configure the encoding (a charset name) to use for the TCP textline codec and the UDP protocol. If not provided Camel will use the JVM default Charset
-| filters | common | | List | You can set a list of Mina IoFilters to use.
-| lazySessionCreation | common | true | boolean | Sessions can be lazily created to avoid exceptions if the remote server is not up and running when the Camel producer is started.
| minaLogger | common | false | boolean | You can enable the Apache MINA logging filter. Apache MINA uses slf4j logging at INFO level to log all input and output.
-| noReplyLogLevel | common | WARN | LoggingLevel | If sync is enabled this option dictates MinaConsumer which logging level to use when logging a there is no reply to send back.
| sync | common | true | boolean | Setting to set endpoint as one-way or request-response.
-| textline | common | false | boolean | Only used for TCP. If no codec is specified you can use this flag to indicate a text line based codec; if not specified or the value is false then Object Serialization is assumed over TCP.
-| textlineDelimiter | common | | TextLineDelimiter | Only used for TCP and if textline=true. Sets the text line delimiter to use. If none provided Camel will use DEFAULT. This delimiter is used to mark the end of text.
-| transferExchange | common | false | boolean | Only used for TCP. You can transfer the exchange over the wire instead of just the body. The following fields are transferred: In body Out body fault body In headers Out headers fault headers exchange properties exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level.
+| timeout | common | 30000 | long | You can configure the timeout that specifies how long to wait for a response from a remote server. The timeout unit is in milliseconds so 60000 is 60 seconds.
| bridgeErrorHandler | consumer | false | boolean | 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/ERROR level and ignored.
| clientMode | consumer | false | boolean | If the clientMode is true mina consumer will connect the address as a TCP client.
+| disconnectOnNoReply | consumer (advanced) | true | boolean | If sync is enabled then this option dictates MinaConsumer if it should disconnect where there is no reply to send back.
| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
-| timeout | producer | 30000 | long | You can configure the timeout that specifies how long to wait for a response from a remote server. The timeout unit is in milliseconds so 60000 is 60 seconds.
+| noReplyLogLevel | consumer (advanced) | WARN | LoggingLevel | If sync is enabled this option dictates MinaConsumer which logging level to use when logging a there is no reply to send back.
+| lazySessionCreation | producer (advanced) | true | boolean | Sessions can be lazily created to avoid exceptions if the remote server is not up and running when the Camel producer is started.
| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| transferExchange | advanced | false | boolean | Only used for TCP. You can transfer the exchange over the wire instead of just the body. The following fields are transferred: In body Out body fault body In headers Out headers fault headers exchange properties exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level.
+| allowDefaultCodec | codec | true | boolean | The mina component installs a default codec if both codec is null and textline is false. Setting allowDefaultCodec to false prevents the mina component from installing a default codec as the first element in the filter chain. This is useful in scenarios where another filter must be the first in the filter chain like the SSL filter.
+| codec | codec | | ProtocolCodecFactory | To use a custom minda codec implementation.
+| decoderMaxLineLength | codec | 1024 | int | To set the textline protocol decoder max line length. By default the default value of Mina itself is used which are 1024.
+| encoderMaxLineLength | codec | -1 | int | To set the textline protocol encoder max line length. By default the default value of Mina itself is used which are Integer.MAX_VALUE.
+| encoding | codec | | String | You can configure the encoding (a charset name) to use for the TCP textline codec and the UDP protocol. If not provided Camel will use the JVM default Charset
+| filters | codec | | List | You can set a list of Mina IoFilters to use.
+| textline | codec | false | boolean | Only used for TCP. If no codec is specified you can use this flag to indicate a text line based codec; if not specified or the value is false then Object Serialization is assumed over TCP.
+| textlineDelimiter | codec | | TextLineDelimiter | Only used for TCP and if textline=true. Sets the text line delimiter to use. If none provided Camel will use DEFAULT. This delimiter is used to mark the end of text.
|=======================================================================
{% endraw %}
// endpoint options: END
+
[[MINA-Usingacustomcodec]]
Using a custom codec
^^^^^^^^^^^^^^^^^^^^
http://git-wip-us.apache.org/repos/asf/camel/blob/3b0cec47/components/camel-mina/src/main/java/org/apache/camel/component/mina/MinaConfiguration.java
----------------------------------------------------------------------
diff --git a/components/camel-mina/src/main/java/org/apache/camel/component/mina/MinaConfiguration.java b/components/camel-mina/src/main/java/org/apache/camel/component/mina/MinaConfiguration.java
index d22cd8b..40cad32 100644
--- a/components/camel-mina/src/main/java/org/apache/camel/component/mina/MinaConfiguration.java
+++ b/components/camel-mina/src/main/java/org/apache/camel/component/mina/MinaConfiguration.java
@@ -41,35 +41,35 @@ public class MinaConfiguration implements Cloneable {
private int port;
@UriParam(defaultValue = "true")
private boolean sync = true;
- @UriParam
+ @UriParam(label = "codec")
private boolean textline;
- @UriParam
+ @UriParam(label = "codec")
private TextLineDelimiter textlineDelimiter;
- @UriParam
+ @UriParam(label = "codec")
private ProtocolCodecFactory codec;
- @UriParam
+ @UriParam(label = "codec")
private String encoding;
- @UriParam(label = "producer", defaultValue = "30000")
+ @UriParam(defaultValue = "30000")
private long timeout = 30000;
- @UriParam(defaultValue = "true")
+ @UriParam(label = "producer,advanced", defaultValue = "true")
private boolean lazySessionCreation = true;
- @UriParam
+ @UriParam(label = "advanced")
private boolean transferExchange;
@UriParam
private boolean minaLogger;
- @UriParam(defaultValue = "-1")
+ @UriParam(label = "codec", defaultValue = "-1")
private int encoderMaxLineLength = -1;
- @UriParam(defaultValue = "1024")
+ @UriParam(label = "codec", defaultValue = "1024")
private int decoderMaxLineLength = 1024;
- @UriParam
+ @UriParam(label = "codec")
private List<IoFilter> filters;
- @UriParam(defaultValue = "true")
+ @UriParam(label = "codec", defaultValue = "true")
private boolean allowDefaultCodec = true;
@UriParam
private boolean disconnect;
- @UriParam(defaultValue = "true")
+ @UriParam(label = "consumer,advanced", defaultValue = "true")
private boolean disconnectOnNoReply = true;
- @UriParam(defaultValue = "WARN")
+ @UriParam(label = "consumer,advanced", defaultValue = "WARN")
private LoggingLevel noReplyLogLevel = LoggingLevel.WARN;
@UriParam(label = "consumer")
private boolean clientMode;
http://git-wip-us.apache.org/repos/asf/camel/blob/3b0cec47/components/camel-mina2/src/main/docs/mina2.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mina2/src/main/docs/mina2.adoc b/components/camel-mina2/src/main/docs/mina2.adoc
index 960749f..f91afa3 100644
--- a/components/camel-mina2/src/main/docs/mina2.adoc
+++ b/components/camel-mina2/src/main/docs/mina2.adoc
@@ -84,6 +84,7 @@ The Mina2 component supports 1 options which are listed below.
+
// endpoint options: START
The Mina2 component supports 29 endpoint options which are listed below:
@@ -94,38 +95,39 @@ The Mina2 component supports 29 endpoint options which are listed below:
| protocol | common | | String | *Required* Protocol to use
| host | common | | String | *Required* Hostname to use. Use localhost or 0.0.0.0 for local server as consumer. For producer use the hostname or ip address of the remote server.
| port | common | | int | *Required* Port number
-| allowDefaultCodec | common | true | boolean | The mina component installs a default codec if both codec is null and textline is false. Setting allowDefaultCodec to false prevents the mina component from installing a default codec as the first element in the filter chain. This is useful in scenarios where another filter must be the first in the filter chain like the SSL filter.
-| autoStartTls | common | true | boolean | Whether to auto start SSL handshake.
-| codec | common | | ProtocolCodecFactory | To use a custom minda codec implementation.
-| decoderMaxLineLength | common | 1024 | int | To set the textline protocol decoder max line length. By default the default value of Mina itself is used which are 1024.
| disconnect | common | false | boolean | Whether or not to disconnect(close) from Mina session right after use. Can be used for both consumer and producer.
-| disconnectOnNoReply | common | true | boolean | If sync is enabled then this option dictates MinaConsumer if it should disconnect where there is no reply to send back.
-| encoderMaxLineLength | common | -1 | int | To set the textline protocol encoder max line length. By default the default value of Mina itself is used which are Integer.MAX_VALUE.
-| encoding | common | | String | You can configure the encoding (a charset name) to use for the TCP textline codec and the UDP protocol. If not provided Camel will use the JVM default Charset
-| filters | common | | List | You can set a list of Mina IoFilters to use.
-| lazySessionCreation | common | true | boolean | Sessions can be lazily created to avoid exceptions if the remote server is not up and running when the Camel producer is started.
-| maximumPoolSize | common | 16 | int | Number of worker threads in the worker pool for TCP and UDP
| minaLogger | common | false | boolean | You can enable the Apache MINA logging filter. Apache MINA uses slf4j logging at INFO level to log all input and output.
-| noReplyLogLevel | common | WARN | LoggingLevel | If sync is enabled this option dictates MinaConsumer which logging level to use when logging a there is no reply to send back.
-| orderedThreadPoolExecutor | common | true | boolean | Whether to use ordered thread pool to ensure events are processed orderly on the same channel.
-| sslContextParameters | common | | SSLContextParameters | To configure SSL security.
| sync | common | true | boolean | Setting to set endpoint as one-way or request-response.
-| textline | common | false | boolean | Only used for TCP. If no codec is specified you can use this flag to indicate a text line based codec; if not specified or the value is false then Object Serialization is assumed over TCP.
-| textlineDelimiter | common | | Mina2TextLineDelimiter | Only used for TCP and if textline=true. Sets the text line delimiter to use. If none provided Camel will use DEFAULT. This delimiter is used to mark the end of text.
| timeout | common | 30000 | long | You can configure the timeout that specifies how long to wait for a response from a remote server. The timeout unit is in milliseconds so 60000 is 60 seconds.
-| transferExchange | common | false | boolean | Only used for TCP. You can transfer the exchange over the wire instead of just the body. The following fields are transferred: In body Out body fault body In headers Out headers fault headers exchange properties exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level.
| bridgeErrorHandler | consumer | false | boolean | 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/ERROR level and ignored.
| clientMode | consumer | false | boolean | If the clientMode is true mina consumer will connect the address as a TCP client.
+| disconnectOnNoReply | consumer (advanced) | true | boolean | If sync is enabled then this option dictates MinaConsumer if it should disconnect where there is no reply to send back.
| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
-| cachedAddress | producer | true | boolean | Whether to create the InetAddress once and reuse. Setting this to false allows to pickup DNS changes in the network.
+| noReplyLogLevel | consumer (advanced) | WARN | LoggingLevel | If sync is enabled this option dictates MinaConsumer which logging level to use when logging a there is no reply to send back.
+| cachedAddress | producer (advanced) | true | boolean | Whether to create the InetAddress once and reuse. Setting this to false allows to pickup DNS changes in the network.
+| lazySessionCreation | producer (advanced) | true | boolean | Sessions can be lazily created to avoid exceptions if the remote server is not up and running when the Camel producer is started.
| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
+| maximumPoolSize | advanced | 16 | int | Number of worker threads in the worker pool for TCP and UDP
+| orderedThreadPoolExecutor | advanced | true | boolean | Whether to use ordered thread pool to ensure events are processed orderly on the same channel.
| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| transferExchange | advanced | false | boolean | Only used for TCP. You can transfer the exchange over the wire instead of just the body. The following fields are transferred: In body Out body fault body In headers Out headers fault headers exchange properties exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level.
+| allowDefaultCodec | codec | true | boolean | The mina component installs a default codec if both codec is null and textline is false. Setting allowDefaultCodec to false prevents the mina component from installing a default codec as the first element in the filter chain. This is useful in scenarios where another filter must be the first in the filter chain like the SSL filter.
+| codec | codec | | ProtocolCodecFactory | To use a custom minda codec implementation.
+| decoderMaxLineLength | codec | 1024 | int | To set the textline protocol decoder max line length. By default the default value of Mina itself is used which are 1024.
+| encoderMaxLineLength | codec | -1 | int | To set the textline protocol encoder max line length. By default the default value of Mina itself is used which are Integer.MAX_VALUE.
+| encoding | codec | | String | You can configure the encoding (a charset name) to use for the TCP textline codec and the UDP protocol. If not provided Camel will use the JVM default Charset
+| filters | codec | | List | You can set a list of Mina IoFilters to use.
+| textline | codec | false | boolean | Only used for TCP. If no codec is specified you can use this flag to indicate a text line based codec; if not specified or the value is false then Object Serialization is assumed over TCP.
+| textlineDelimiter | codec | | Mina2TextLineDelimiter | Only used for TCP and if textline=true. Sets the text line delimiter to use. If none provided Camel will use DEFAULT. This delimiter is used to mark the end of text.
+| autoStartTls | security | true | boolean | Whether to auto start SSL handshake.
+| sslContextParameters | security | | SSLContextParameters | To configure SSL security.
|=======================================================================
{% endraw %}
// endpoint options: END
+
[[MINA2-Usingacustomcodec]]
Using a custom codec
^^^^^^^^^^^^^^^^^^^^
http://git-wip-us.apache.org/repos/asf/camel/blob/3b0cec47/components/camel-mina2/src/main/java/org/apache/camel/component/mina2/Mina2Configuration.java
----------------------------------------------------------------------
diff --git a/components/camel-mina2/src/main/java/org/apache/camel/component/mina2/Mina2Configuration.java b/components/camel-mina2/src/main/java/org/apache/camel/component/mina2/Mina2Configuration.java
index 5e52a33..2721791 100644
--- a/components/camel-mina2/src/main/java/org/apache/camel/component/mina2/Mina2Configuration.java
+++ b/components/camel-mina2/src/main/java/org/apache/camel/component/mina2/Mina2Configuration.java
@@ -43,45 +43,45 @@ public class Mina2Configuration implements Cloneable {
private int port;
@UriParam(defaultValue = "true")
private boolean sync = true;
- @UriParam
+ @UriParam(label = "codec")
private boolean textline;
- @UriParam
+ @UriParam(label = "codec")
private Mina2TextLineDelimiter textlineDelimiter;
- @UriParam
+ @UriParam(label = "codec")
private ProtocolCodecFactory codec;
- @UriParam
+ @UriParam(label = "codec")
private String encoding;
@UriParam(defaultValue = "30000")
private long timeout = 30000;
- @UriParam(defaultValue = "true")
+ @UriParam(label = "producer,advanced", defaultValue = "true")
private boolean lazySessionCreation = true;
- @UriParam
+ @UriParam(label = "advanced")
private boolean transferExchange;
@UriParam
private boolean minaLogger;
- @UriParam(defaultValue = "-1")
+ @UriParam(label = "codec", defaultValue = "-1")
private int encoderMaxLineLength = -1;
- @UriParam(defaultValue = "1024")
+ @UriParam(label = "codec", defaultValue = "1024")
private int decoderMaxLineLength = 1024;
- @UriParam
+ @UriParam(label = "codec")
private List<IoFilter> filters;
- @UriParam(defaultValue = "true")
+ @UriParam(label = "codec", defaultValue = "true")
private boolean allowDefaultCodec = true;
@UriParam
private boolean disconnect;
- @UriParam(defaultValue = "true")
+ @UriParam(label = "consumer,advanced", defaultValue = "true")
private boolean disconnectOnNoReply = true;
- @UriParam(defaultValue = "WARN")
+ @UriParam(label = "consumer,advanced", defaultValue = "WARN")
private LoggingLevel noReplyLogLevel = LoggingLevel.WARN;
- @UriParam
+ @UriParam(label = "security")
private SSLContextParameters sslContextParameters;
- @UriParam(defaultValue = "true")
+ @UriParam(label = "security", defaultValue = "true")
private boolean autoStartTls = true;
- @UriParam(defaultValue = "16")
+ @UriParam(label = "advanced", defaultValue = "16")
private int maximumPoolSize = 16; // 16 is the default mina setting
- @UriParam(defaultValue = "true")
+ @UriParam(label = "advanced", defaultValue = "true")
private boolean orderedThreadPoolExecutor = true;
- @UriParam(label = "producer", defaultValue = "true")
+ @UriParam(label = "producer,advanced", defaultValue = "true")
private boolean cachedAddress = true;
@UriParam(label = "consumer")
private boolean clientMode;