http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-netty4/src/main/docs/netty4-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-netty4/src/main/docs/netty4-component.adoc b/components/camel-netty4/src/main/docs/netty4-component.adoc index 543955d..67601c6 100644 --- a/components/camel-netty4/src/main/docs/netty4-component.adoc +++ b/components/camel-netty4/src/main/docs/netty4-component.adoc @@ -1,4 +1,4 @@ -## Netty4 Component +== Netty4 Component *Available as of Camel version 2.14* @@ -58,14 +58,14 @@ The Netty4 component supports 5 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **maximumPoolSize** (advanced) | The thread pool size for the EventExecutorGroup if its in use. The default value is 16. | 16 | int -| **configuration** (advanced) | To use the NettyConfiguration as configuration when creating endpoints. | | NettyConfiguration -| **executorService** (advanced) | To use the given EventExecutorGroup | | EventExecutorGroup -| **useGlobalSslContext Parameters** (security) | Enable usage of global SSL context parameters. | false | boolean -| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean -|======================================================================= +| *maximumPoolSize* (advanced) | The thread pool size for the EventExecutorGroup if its in use. The default value is 16. | 16 | int +| *configuration* (advanced) | To use the NettyConfiguration as configuration when creating endpoints. | | NettyConfiguration +| *executorService* (advanced) | To use the given EventExecutorGroup | | EventExecutorGroup +| *useGlobalSslContext Parameters* (security) | Enable usage of global SSL context parameters. | false | boolean +| *resolveProperty Placeholders* (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean +|=== // component options: END @@ -81,97 +81,99 @@ The Netty4 component supports 5 options which are listed below. // endpoint options: START The Netty4 endpoint is configured using URI syntax: - netty4:protocol:host:port +---- +netty4:protocol:host:port +---- with the following path and query parameters: -#### Path Parameters (3 parameters): +==== Path Parameters (3 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **protocol** | *Required* The protocol to use which can be tcp or udp. | | String -| **host** | *Required* 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 | | String -| **port** | *Required* The host port number | | int -|======================================================================= +| *protocol* | *Required* The protocol to use which can be tcp or udp. | | String +| *host* | *Required* 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 | | String +| *port* | *Required* The host port number | | int +|=== -#### Query Parameters (71 parameters): +==== Query Parameters (71 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **disconnect** (common) | Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer. | false | boolean -| **keepAlive** (common) | Setting to ensure socket is not closed due to inactivity | true | boolean -| **reuseAddress** (common) | Setting to facilitate socket multiplexing | true | boolean -| **reuseChannel** (common) | This option allows producers and consumers (in client mode) to reuse 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. | false | boolean -| **sync** (common) | Setting to set endpoint as one-way or request-response | true | boolean -| **tcpNoDelay** (common) | Setting to improve TCP protocol performance | true | boolean -| **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 -| **broadcast** (consumer) | Setting to choose Multicast over UDP | false | boolean -| **clientMode** (consumer) | If the clientMode is true netty consumer will connect the address as a TCP client. | false | boolean -| **reconnect** (consumer) | Used only in clientMode in consumer the consumer will attempt to reconnect on disconnection if this is enabled | true | boolean -| **reconnectInterval** (consumer) | Used if reconnect and clientMode is enabled. The interval in milli seconds to attempt reconnection | 10000 | int -| **backlog** (consumer) | 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 the backlog depends on OS setting. | | int -| **bossCount** (consumer) | When netty works on nio mode it uses default bossCount parameter from Netty which is 1. User can use this operation to override the default bossCount from Netty | 1 | int -| **bossGroup** (consumer) | Set the BossGroup which could be used for handling the new connection of the server side across the NettyEndpoint | | EventLoopGroup -| **disconnectOnNoReply** (consumer) | If sync is enabled then this option dictates NettyConsumer if it should disconnect where there is no reply to send back. | true | boolean -| **exceptionHandler** (consumer) | 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 or ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern -| **nettyServerBootstrapFactory** (consumer) | To use a custom NettyServerBootstrapFactory | | NettyServerBootstrap Factory -| **networkInterface** (consumer) | When using UDP then this option can be used to specify a network interface by its name such as eth0 to join a multicast group. | | String -| **noReplyLogLevel** (consumer) | If sync is enabled this option dictates NettyConsumer which logging level to use when logging a there is no reply to send back. | WARN | LoggingLevel -| **serverClosedChannel ExceptionCaughtLogLevel** (consumer) | If the server (NettyConsumer) catches an java.nio.channels.ClosedChannelException then its logged using this logging level. This is used to avoid logging the closed channel exceptions as clients can disconnect abruptly and then cause a flood of closed exceptions in the Netty server. | DEBUG | LoggingLevel -| **serverExceptionCaughtLog Level** (consumer) | If the server (NettyConsumer) catches an exception then its logged using this logging level. | WARN | LoggingLevel -| **serverInitializerFactory** (consumer) | To use a custom ServerInitializerFactory | | ServerInitializer Factory -| **usingExecutorService** (consumer) | Whether to use ordered thread pool to ensure events are processed orderly on the same channel. | true | boolean -| **connectTimeout** (producer) | Time to wait for a socket connection to be available. Value is in millis. | 10000 | int -| **requestTimeout** (producer) | Allows to use a timeout for the Netty producer when calling a remote server. By default no timeout is in use. The value is in milli seconds so eg 30000 is 30 seconds. The requestTimeout is using Netty's ReadTimeoutHandler to trigger the timeout. | | long -| **clientInitializerFactory** (producer) | To use a custom ClientInitializerFactory | | ClientInitializer Factory -| **lazyChannelCreation** (producer) | Channels can be lazily created to avoid exceptions if the remote server is not up and running when the Camel producer is started. | true | boolean -| **producerPoolEnabled** (producer) | Whether producer pool is enabled or not. Important: Do not turn this off as the pooling is needed for handling concurrency and reliable request/reply. | true | boolean -| **producerPoolMaxActive** (producer) | Sets the cap on the number of objects that can be allocated by the pool (checked out to clients or idle awaiting checkout) at a given time. Use a negative value for no limit. | -1 | int -| **producerPoolMaxIdle** (producer) | Sets the cap on the number of idle instances in the pool. | 100 | int -| **producerPoolMinEvictable Idle** (producer) | Sets the minimum amount of time (value in millis) an object may sit idle in the pool before it is eligible for eviction by the idle object evictor. | 300000 | long -| **producerPoolMinIdle** (producer) | Sets the minimum number of instances allowed in the producer pool before the evictor thread (if active) spawns new objects. | | int -| **udpConnectionlessSending** (producer) | This option supports connection less udp sending which is a real fire and forget. A connected udp send receive the PortUnreachableException if no one is listen on the receiving port. | false | boolean -| **useByteBuf** (producer) | If the useByteBuf is true netty producer will turn the message body into ByteBuf before sending it out. | false | boolean -| **allowSerializedHeaders** (advanced) | Only used for TCP when transferExchange is true. When set to true serializable objects in headers and properties will be added to the exchange. Otherwise Camel will exclude any non-serializable objects and log it at WARN level. | false | boolean -| **bootstrapConfiguration** (advanced) | To use a custom configured NettyServerBootstrapConfiguration for configuring this endpoint. | | NettyServerBootstrap Configuration -| **channelGroup** (advanced) | To use a explicit ChannelGroup. | | ChannelGroup -| **nativeTransport** (advanced) | Whether to use native transport instead of NIO. Native transport takes advantage of the host operating system and is only supported on some platforms. You need to add the netty JAR for the host operating system you are using. See more details at: http://netty.io/wiki/native-transports.html | false | boolean -| **options** (advanced) | 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. | | Map -| **receiveBufferSize** (advanced) | The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes. | 65536 | int -| **receiveBufferSizePredictor** (advanced) | Configures the buffer size predictor. See details at Jetty documentation and this mail thread. | | int -| **sendBufferSize** (advanced) | The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes. | 65536 | int -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **transferExchange** (advanced) | 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. | false | boolean -| **udpByteArrayCodec** (advanced) | For UDP only. If enabled the using byte array codec instead of Java serialization protocol. | false | boolean -| **workerCount** (advanced) | When netty works on nio mode it uses default workerCount parameter from Netty which is cpu_core_threads2. User can use this operation to override the default workerCount from Netty | | int -| **workerGroup** (advanced) | To use a explicit EventLoopGroup as the boss thread pool. For example to share a thread pool with multiple consumers or producers. By default each consumer or producer has their own worker pool with 2 x cpu count core threads. | | EventLoopGroup -| **allowDefaultCodec** (codec) | The netty component installs a default codec if both encoder/deocder is null and textline is false. Setting allowDefaultCodec to false prevents the netty component from installing a default codec as the first element in the filter chain. | true | boolean -| **autoAppendDelimiter** (codec) | Whether or not to auto append missing end delimiter when sending using the textline codec. | true | boolean -| **decoder** (codec) | *Deprecated* A custom ChannelHandler class that can be used to perform special marshalling of inbound payloads. | | ChannelHandler -| **decoderMaxLineLength** (codec) | The max line length to use for the textline codec. | 1024 | int -| **decoders** (codec) | 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 lookup. | | String -| **delimiter** (codec) | The delimiter to use for the textline codec. Possible values are LINE and NULL. | LINE | TextLineDelimiter -| **encoder** (codec) | *Deprecated* A custom ChannelHandler class that can be used to perform special marshalling of outbound payloads. | | ChannelHandler -| **encoders** (codec) | 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 lookup. | | String -| **encoding** (codec) | The encoding (a charset name) to use for the textline codec. If not provided Camel will use the JVM default Charset. | | String -| **textline** (codec) | 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. | false | boolean -| **enabledProtocols** (security) | Which protocols to enable when using SSL | TLSv1,TLSv1.1,TLSv1.2 | String -| **keyStoreFile** (security) | Client side certificate keystore to be used for encryption | | File -| **keyStoreFormat** (security) | Keystore format to be used for payload encryption. Defaults to JKS if not set | | String -| **keyStoreResource** (security) | 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. | | String -| **needClientAuth** (security) | Configures whether the server needs client authentication when using SSL. | false | boolean -| **passphrase** (security) | Password setting to use in order to encrypt/decrypt payloads sent using SSH | | String -| **securityProvider** (security) | Security provider to be used for payload encryption. Defaults to SunX509 if not set. | | String -| **ssl** (security) | Setting to specify whether SSL encryption is applied to this endpoint | false | boolean -| **sslClientCertHeaders** (security) | When enabled and in SSL mode then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name issuer name serial number and the valid date range. | false | boolean -| **sslContextParameters** (security) | To configure security using SSLContextParameters | | SSLContextParameters -| **sslHandler** (security) | Reference to a class that could be used to return an SSL Handler | | SslHandler -| **trustStoreFile** (security) | Server side certificate keystore to be used for encryption | | File -| **trustStoreResource** (security) | 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. | | String -|======================================================================= +| *disconnect* (common) | Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer. | false | boolean +| *keepAlive* (common) | Setting to ensure socket is not closed due to inactivity | true | boolean +| *reuseAddress* (common) | Setting to facilitate socket multiplexing | true | boolean +| *reuseChannel* (common) | This option allows producers and consumers (in client mode) to reuse 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. | false | boolean +| *sync* (common) | Setting to set endpoint as one-way or request-response | true | boolean +| *tcpNoDelay* (common) | Setting to improve TCP protocol performance | true | boolean +| *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 +| *broadcast* (consumer) | Setting to choose Multicast over UDP | false | boolean +| *clientMode* (consumer) | If the clientMode is true netty consumer will connect the address as a TCP client. | false | boolean +| *reconnect* (consumer) | Used only in clientMode in consumer the consumer will attempt to reconnect on disconnection if this is enabled | true | boolean +| *reconnectInterval* (consumer) | Used if reconnect and clientMode is enabled. The interval in milli seconds to attempt reconnection | 10000 | int +| *backlog* (consumer) | 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 the backlog depends on OS setting. | | int +| *bossCount* (consumer) | When netty works on nio mode it uses default bossCount parameter from Netty which is 1. User can use this operation to override the default bossCount from Netty | 1 | int +| *bossGroup* (consumer) | Set the BossGroup which could be used for handling the new connection of the server side across the NettyEndpoint | | EventLoopGroup +| *disconnectOnNoReply* (consumer) | If sync is enabled then this option dictates NettyConsumer if it should disconnect where there is no reply to send back. | true | boolean +| *exceptionHandler* (consumer) | 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 or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *nettyServerBootstrapFactory* (consumer) | To use a custom NettyServerBootstrapFactory | | NettyServerBootstrap Factory +| *networkInterface* (consumer) | When using UDP then this option can be used to specify a network interface by its name such as eth0 to join a multicast group. | | String +| *noReplyLogLevel* (consumer) | If sync is enabled this option dictates NettyConsumer which logging level to use when logging a there is no reply to send back. | WARN | LoggingLevel +| *serverClosedChannel ExceptionCaughtLogLevel* (consumer) | If the server (NettyConsumer) catches an java.nio.channels.ClosedChannelException then its logged using this logging level. This is used to avoid logging the closed channel exceptions as clients can disconnect abruptly and then cause a flood of closed exceptions in the Netty server. | DEBUG | LoggingLevel +| *serverExceptionCaughtLog Level* (consumer) | If the server (NettyConsumer) catches an exception then its logged using this logging level. | WARN | LoggingLevel +| *serverInitializerFactory* (consumer) | To use a custom ServerInitializerFactory | | ServerInitializer Factory +| *usingExecutorService* (consumer) | Whether to use ordered thread pool to ensure events are processed orderly on the same channel. | true | boolean +| *connectTimeout* (producer) | Time to wait for a socket connection to be available. Value is in millis. | 10000 | int +| *requestTimeout* (producer) | Allows to use a timeout for the Netty producer when calling a remote server. By default no timeout is in use. The value is in milli seconds so eg 30000 is 30 seconds. The requestTimeout is using Netty's ReadTimeoutHandler to trigger the timeout. | | long +| *clientInitializerFactory* (producer) | To use a custom ClientInitializerFactory | | ClientInitializer Factory +| *lazyChannelCreation* (producer) | Channels can be lazily created to avoid exceptions if the remote server is not up and running when the Camel producer is started. | true | boolean +| *producerPoolEnabled* (producer) | Whether producer pool is enabled or not. Important: Do not turn this off as the pooling is needed for handling concurrency and reliable request/reply. | true | boolean +| *producerPoolMaxActive* (producer) | Sets the cap on the number of objects that can be allocated by the pool (checked out to clients or idle awaiting checkout) at a given time. Use a negative value for no limit. | -1 | int +| *producerPoolMaxIdle* (producer) | Sets the cap on the number of idle instances in the pool. | 100 | int +| *producerPoolMinEvictable Idle* (producer) | Sets the minimum amount of time (value in millis) an object may sit idle in the pool before it is eligible for eviction by the idle object evictor. | 300000 | long +| *producerPoolMinIdle* (producer) | Sets the minimum number of instances allowed in the producer pool before the evictor thread (if active) spawns new objects. | | int +| *udpConnectionlessSending* (producer) | This option supports connection less udp sending which is a real fire and forget. A connected udp send receive the PortUnreachableException if no one is listen on the receiving port. | false | boolean +| *useByteBuf* (producer) | If the useByteBuf is true netty producer will turn the message body into ByteBuf before sending it out. | false | boolean +| *allowSerializedHeaders* (advanced) | Only used for TCP when transferExchange is true. When set to true serializable objects in headers and properties will be added to the exchange. Otherwise Camel will exclude any non-serializable objects and log it at WARN level. | false | boolean +| *bootstrapConfiguration* (advanced) | To use a custom configured NettyServerBootstrapConfiguration for configuring this endpoint. | | NettyServerBootstrap Configuration +| *channelGroup* (advanced) | To use a explicit ChannelGroup. | | ChannelGroup +| *nativeTransport* (advanced) | Whether to use native transport instead of NIO. Native transport takes advantage of the host operating system and is only supported on some platforms. You need to add the netty JAR for the host operating system you are using. See more details at: http://netty.io/wiki/native-transports.html | false | boolean +| *options* (advanced) | 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. | | Map +| *receiveBufferSize* (advanced) | The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes. | 65536 | int +| *receiveBufferSizePredictor* (advanced) | Configures the buffer size predictor. See details at Jetty documentation and this mail thread. | | int +| *sendBufferSize* (advanced) | The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes. | 65536 | int +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *transferExchange* (advanced) | 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. | false | boolean +| *udpByteArrayCodec* (advanced) | For UDP only. If enabled the using byte array codec instead of Java serialization protocol. | false | boolean +| *workerCount* (advanced) | When netty works on nio mode it uses default workerCount parameter from Netty which is cpu_core_threads2. User can use this operation to override the default workerCount from Netty | | int +| *workerGroup* (advanced) | To use a explicit EventLoopGroup as the boss thread pool. For example to share a thread pool with multiple consumers or producers. By default each consumer or producer has their own worker pool with 2 x cpu count core threads. | | EventLoopGroup +| *allowDefaultCodec* (codec) | The netty component installs a default codec if both encoder/deocder is null and textline is false. Setting allowDefaultCodec to false prevents the netty component from installing a default codec as the first element in the filter chain. | true | boolean +| *autoAppendDelimiter* (codec) | Whether or not to auto append missing end delimiter when sending using the textline codec. | true | boolean +| *decoder* (codec) | *Deprecated* A custom ChannelHandler class that can be used to perform special marshalling of inbound payloads. | | ChannelHandler +| *decoderMaxLineLength* (codec) | The max line length to use for the textline codec. | 1024 | int +| *decoders* (codec) | 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 lookup. | | String +| *delimiter* (codec) | The delimiter to use for the textline codec. Possible values are LINE and NULL. | LINE | TextLineDelimiter +| *encoder* (codec) | *Deprecated* A custom ChannelHandler class that can be used to perform special marshalling of outbound payloads. | | ChannelHandler +| *encoders* (codec) | 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 lookup. | | String +| *encoding* (codec) | The encoding (a charset name) to use for the textline codec. If not provided Camel will use the JVM default Charset. | | String +| *textline* (codec) | 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. | false | boolean +| *enabledProtocols* (security) | Which protocols to enable when using SSL | TLSv1,TLSv1.1,TLSv1.2 | String +| *keyStoreFile* (security) | Client side certificate keystore to be used for encryption | | File +| *keyStoreFormat* (security) | Keystore format to be used for payload encryption. Defaults to JKS if not set | | String +| *keyStoreResource* (security) | 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. | | String +| *needClientAuth* (security) | Configures whether the server needs client authentication when using SSL. | false | boolean +| *passphrase* (security) | Password setting to use in order to encrypt/decrypt payloads sent using SSH | | String +| *securityProvider* (security) | Security provider to be used for payload encryption. Defaults to SunX509 if not set. | | String +| *ssl* (security) | Setting to specify whether SSL encryption is applied to this endpoint | false | boolean +| *sslClientCertHeaders* (security) | When enabled and in SSL mode then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name issuer name serial number and the valid date range. | false | boolean +| *sslContextParameters* (security) | To configure security using SSLContextParameters | | SSLContextParameters +| *sslHandler* (security) | Reference to a class that could be used to return an SSL Handler | | SslHandler +| *trustStoreFile* (security) | Server side certificate keystore to be used for encryption | | File +| *trustStoreResource* (security) | 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. | | String +|=== // endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-ognl/src/main/docs/ognl-language.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ognl/src/main/docs/ognl-language.adoc b/components/camel-ognl/src/main/docs/ognl-language.adoc index ffcb132..b5e7503 100644 --- a/components/camel-ognl/src/main/docs/ognl-language.adoc +++ b/components/camel-ognl/src/main/docs/ognl-language.adoc @@ -1,4 +1,4 @@ -## OGNL Language +== OGNL Language *Available as of Camel version 1.1* @@ -32,10 +32,10 @@ The OGNL language supports 1 options which are listed below. [width="100%",cols="2,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | trim | true | Boolean | Whether to trim the value to remove leading and trailing whitespaces and line breaks -|======================================================================= +|=== // language options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc b/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc index a4001fb..486c7c2 100644 --- a/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc +++ b/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc @@ -1,4 +1,4 @@ -## Olingo2 Component +== Olingo2 Component *Available as of Camel version 2.14* @@ -48,12 +48,12 @@ The Olingo2 component supports 3 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **configuration** (common) | To use the shared configuration | | Olingo2Configuration -| **useGlobalSslContext Parameters** (security) | Enable usage of global SSL context parameters. | false | boolean -| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean -|======================================================================= +| *configuration* (common) | To use the shared configuration | | Olingo2Configuration +| *useGlobalSslContext Parameters* (security) | Enable usage of global SSL context parameters. | false | boolean +| *resolveProperty Placeholders* (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean +|=== // component options: END @@ -64,39 +64,41 @@ The Olingo2 component supports 3 options which are listed below. // endpoint options: START The Olingo2 endpoint is configured using URI syntax: - olingo2:apiName/methodName +---- +olingo2:apiName/methodName +---- with the following path and query parameters: -#### Path Parameters (2 parameters): +==== Path Parameters (2 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **apiName** | *Required* What kind of operation to perform | | Olingo2ApiName -| **methodName** | *Required* What sub operation to use for the selected operation | | String -|======================================================================= +| *apiName* | *Required* What kind of operation to perform | | Olingo2ApiName +| *methodName* | *Required* What sub operation to use for the selected operation | | String +|=== -#### Query Parameters (14 parameters): +==== Query Parameters (14 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **connectTimeout** (common) | HTTP connection creation timeout in milliseconds defaults to 30000 (30 seconds) | 30000 | int -| **contentType** (common) | Content-Type header value can be used to specify JSON or XML message format defaults to application/json;charset=utf-8 | application/json;charset=utf-8 | String -| **httpAsyncClientBuilder** (common) | Custom HTTP async client builder for more complex HTTP client configuration overrides connectionTimeout socketTimeout proxy and sslContext. Note that a socketTimeout MUST be specified in the builder otherwise OData requests could block indefinitely | | HttpAsyncClientBuilder -| **httpClientBuilder** (common) | Custom HTTP client builder for more complex HTTP client configuration overrides connectionTimeout socketTimeout proxy and sslContext. Note that a socketTimeout MUST be specified in the builder otherwise OData requests could block indefinitely | | HttpClientBuilder -| **httpHeaders** (common) | Custom HTTP headers to inject into every request this could include OAuth tokens etc. | | Map -| **inBody** (common) | Sets the name of a parameter to be passed in the exchange In Body | | String -| **proxy** (common) | HTTP proxy server configuration | | HttpHost -| **serviceUri** (common) | Target OData service base URI e.g. http://services.odata.org/OData/OData.svc | | String -| **socketTimeout** (common) | HTTP request timeout in milliseconds defaults to 30000 (30 seconds) | 30000 | int -| **sslContextParameters** (common) | To configure security using SSLContextParameters | | SSLContextParameters -| **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 -| **exceptionHandler** (consumer) | 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 or ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *connectTimeout* (common) | HTTP connection creation timeout in milliseconds defaults to 30000 (30 seconds) | 30000 | int +| *contentType* (common) | Content-Type header value can be used to specify JSON or XML message format defaults to application/json;charset=utf-8 | application/json;charset=utf-8 | String +| *httpAsyncClientBuilder* (common) | Custom HTTP async client builder for more complex HTTP client configuration overrides connectionTimeout socketTimeout proxy and sslContext. Note that a socketTimeout MUST be specified in the builder otherwise OData requests could block indefinitely | | HttpAsyncClientBuilder +| *httpClientBuilder* (common) | Custom HTTP client builder for more complex HTTP client configuration overrides connectionTimeout socketTimeout proxy and sslContext. Note that a socketTimeout MUST be specified in the builder otherwise OData requests could block indefinitely | | HttpClientBuilder +| *httpHeaders* (common) | Custom HTTP headers to inject into every request this could include OAuth tokens etc. | | Map +| *inBody* (common) | Sets the name of a parameter to be passed in the exchange In Body | | String +| *proxy* (common) | HTTP proxy server configuration | | HttpHost +| *serviceUri* (common) | Target OData service base URI e.g. http://services.odata.org/OData/OData.svc | | String +| *socketTimeout* (common) | HTTP request timeout in milliseconds defaults to 30000 (30 seconds) | 30000 | int +| *sslContextParameters* (common) | To configure security using SSLContextParameters | | SSLContextParameters +| *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 +| *exceptionHandler* (consumer) | 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 or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-olingo4/camel-olingo4-component/src/main/docs/olingo4-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-olingo4/camel-olingo4-component/src/main/docs/olingo4-component.adoc b/components/camel-olingo4/camel-olingo4-component/src/main/docs/olingo4-component.adoc index 2883925..75d65e0 100644 --- a/components/camel-olingo4/camel-olingo4-component/src/main/docs/olingo4-component.adoc +++ b/components/camel-olingo4/camel-olingo4-component/src/main/docs/olingo4-component.adoc @@ -1,4 +1,4 @@ -## Olingo4 Component +== Olingo4 Component *Available as of Camel version 2.19* @@ -49,12 +49,12 @@ The Olingo4 component supports 3 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **configuration** (common) | To use the shared configuration | | Olingo4Configuration -| **useGlobalSslContext Parameters** (security) | Enable usage of global SSL context parameters. | false | boolean -| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean -|======================================================================= +| *configuration* (common) | To use the shared configuration | | Olingo4Configuration +| *useGlobalSslContext Parameters* (security) | Enable usage of global SSL context parameters. | false | boolean +| *resolveProperty Placeholders* (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean +|=== // component options: END @@ -65,39 +65,41 @@ The Olingo4 component supports 3 options which are listed below. // endpoint options: START The Olingo4 endpoint is configured using URI syntax: - olingo4:apiName/methodName +---- +olingo4:apiName/methodName +---- with the following path and query parameters: -#### Path Parameters (2 parameters): +==== Path Parameters (2 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **apiName** | *Required* What kind of operation to perform | | Olingo4ApiName -| **methodName** | *Required* What sub operation to use for the selected operation | | String -|======================================================================= +| *apiName* | *Required* What kind of operation to perform | | Olingo4ApiName +| *methodName* | *Required* What sub operation to use for the selected operation | | String +|=== -#### Query Parameters (14 parameters): +==== Query Parameters (14 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **connectTimeout** (common) | HTTP connection creation timeout in milliseconds defaults to 30000 (30 seconds) | 30000 | int -| **contentType** (common) | Content-Type header value can be used to specify JSON or XML message format defaults to application/json;charset=utf-8 | application/json;charset=utf-8 | String -| **httpAsyncClientBuilder** (common) | Custom HTTP async client builder for more complex HTTP client configuration overrides connectionTimeout socketTimeout proxy and sslContext. Note that a socketTimeout MUST be specified in the builder otherwise OData requests could block indefinitely | | HttpAsyncClientBuilder -| **httpClientBuilder** (common) | Custom HTTP client builder for more complex HTTP client configuration overrides connectionTimeout socketTimeout proxy and sslContext. Note that a socketTimeout MUST be specified in the builder otherwise OData requests could block indefinitely | | HttpClientBuilder -| **httpHeaders** (common) | Custom HTTP headers to inject into every request this could include OAuth tokens etc. | | Map -| **inBody** (common) | Sets the name of a parameter to be passed in the exchange In Body | | String -| **proxy** (common) | HTTP proxy server configuration | | HttpHost -| **serviceUri** (common) | Target OData service base URI e.g. http://services.odata.org/OData/OData.svc | | String -| **socketTimeout** (common) | HTTP request timeout in milliseconds defaults to 30000 (30 seconds) | 30000 | int -| **sslContextParameters** (common) | To configure security using SSLContextParameters | | SSLContextParameters -| **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 -| **exceptionHandler** (consumer) | 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 or ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *connectTimeout* (common) | HTTP connection creation timeout in milliseconds defaults to 30000 (30 seconds) | 30000 | int +| *contentType* (common) | Content-Type header value can be used to specify JSON or XML message format defaults to application/json;charset=utf-8 | application/json;charset=utf-8 | String +| *httpAsyncClientBuilder* (common) | Custom HTTP async client builder for more complex HTTP client configuration overrides connectionTimeout socketTimeout proxy and sslContext. Note that a socketTimeout MUST be specified in the builder otherwise OData requests could block indefinitely | | HttpAsyncClientBuilder +| *httpClientBuilder* (common) | Custom HTTP client builder for more complex HTTP client configuration overrides connectionTimeout socketTimeout proxy and sslContext. Note that a socketTimeout MUST be specified in the builder otherwise OData requests could block indefinitely | | HttpClientBuilder +| *httpHeaders* (common) | Custom HTTP headers to inject into every request this could include OAuth tokens etc. | | Map +| *inBody* (common) | Sets the name of a parameter to be passed in the exchange In Body | | String +| *proxy* (common) | HTTP proxy server configuration | | HttpHost +| *serviceUri* (common) | Target OData service base URI e.g. http://services.odata.org/OData/OData.svc | | String +| *socketTimeout* (common) | HTTP request timeout in milliseconds defaults to 30000 (30 seconds) | 30000 | int +| *sslContextParameters* (common) | To configure security using SSLContextParameters | | SSLContextParameters +| *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 +| *exceptionHandler* (consumer) | 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 or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-openshift/src/main/docs/openshift-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-openshift/src/main/docs/openshift-component.adoc b/components/camel-openshift/src/main/docs/openshift-component.adoc index cee927f..565613e 100644 --- a/components/camel-openshift/src/main/docs/openshift-component.adoc +++ b/components/camel-openshift/src/main/docs/openshift-component.adoc @@ -1,4 +1,4 @@ -## OpenShift Component (deprecated) +== OpenShift Component (deprecated) *Available as of Camel version 2.14* @@ -38,14 +38,14 @@ The OpenShift component supports 5 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **username** (security) | The username to login to openshift server. | | String -| **password** (security) | The password for login to openshift server. | | String -| **domain** (common) | Domain name. If not specified then the default domain is used. | | String -| **server** (common) | Url to the openshift server. If not specified then the default value from the local openshift configuration file /.openshift/express.conf is used. And if that fails as well then openshift.redhat.com is used. | | String -| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean -|======================================================================= +| *username* (security) | The username to login to openshift server. | | String +| *password* (security) | The password for login to openshift server. | | String +| *domain* (common) | Domain name. If not specified then the default domain is used. | | String +| *server* (common) | Url to the openshift server. If not specified then the default value from the local openshift configuration file /.openshift/express.conf is used. And if that fails as well then openshift.redhat.com is used. | | String +| *resolveProperty Placeholders* (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean +|=== // component options: END @@ -54,50 +54,52 @@ The OpenShift component supports 5 options which are listed below. // endpoint options: START The OpenShift endpoint is configured using URI syntax: - openshift:clientId +---- +openshift:clientId +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **clientId** | *Required* The client id | | String -|======================================================================= +| *clientId* | *Required* The client id | | String +|=== -#### Query Parameters (26 parameters): +==== Query Parameters (26 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **domain** (common) | Domain name. If not specified then the default domain is used. | | String -| **password** (common) | *Required* The password for login to openshift server. | | String -| **server** (common) | Url to the openshift server. If not specified then the default value from the local openshift configuration file /.openshift/express.conf is used. And if that fails as well then openshift.redhat.com is used. | | String -| **username** (common) | *Required* The username to login to openshift server. | | String -| **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 -| **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 options 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. | | PollingConsumerPoll Strategy -| **application** (producer) | The application name to start stop restart or get the state. | | String -| **mode** (producer) | Whether to output the message body as a pojo or json. For pojo the message is a List type. | | String -| **operation** (producer) | The operation to perform which can be: list start stop restart and state. The list operation returns information about all the applications in json format. The state operation returns the state such as: started stopped etc. The other operations does not return any value. | | String -| **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 -| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int -| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int -| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long -| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean -| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long -| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel -| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service -| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler -| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map -| **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 -|======================================================================= +| *domain* (common) | Domain name. If not specified then the default domain is used. | | String +| *password* (common) | *Required* The password for login to openshift server. | | String +| *server* (common) | Url to the openshift server. If not specified then the default value from the local openshift configuration file /.openshift/express.conf is used. And if that fails as well then openshift.redhat.com is used. | | String +| *username* (common) | *Required* The username to login to openshift server. | | String +| *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 +| *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 options 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. | | PollingConsumerPoll Strategy +| *application* (producer) | The application name to start stop restart or get the state. | | String +| *mode* (producer) | Whether to output the message body as a pojo or json. For pojo the message is a List type. | | String +| *operation* (producer) | The operation to perform which can be: list start stop restart and state. The list operation returns information about all the applications in json format. The state operation returns the state such as: started stopped etc. The other operations does not return any value. | | String +| *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 +| *backoffIdleThreshold* (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int +| *backoffMultiplier* (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int +| *delay* (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long +| *greedy* (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean +| *initialDelay* (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long +| *runLoggingLevel* (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel +| *scheduledExecutorService* (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service +| *scheduler* (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler +| *schedulerProperties* (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map +| *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 +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc b/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc index c680006..27d82da 100644 --- a/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc @@ -1,4 +1,4 @@ -## OpenStack Cinder Component +== OpenStack Cinder Component *Available as of Camel version 2.19* @@ -41,33 +41,35 @@ The OpenStack Cinder component has no options. // endpoint options: START The OpenStack Cinder endpoint is configured using URI syntax: - openstack-cinder:host +---- +openstack-cinder:host +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **host** | *Required* OpenStack host url | | String -|======================================================================= +| *host* | *Required* OpenStack host url | | String +|=== -#### Query Parameters (9 parameters): +==== Query Parameters (9 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **apiVersion** (producer) | OpenStack API version | V3 | String -| **config** (producer) | OpenStack configuration | | Config -| **domain** (producer) | Authentication domain | default | String -| **operation** (producer) | The operation to do | | String -| **password** (producer) | *Required* OpenStack password | | String -| **project** (producer) | *Required* The project ID | | String -| **subsystem** (producer) | *Required* OpenStack Cinder subsystem | | String -| **username** (producer) | *Required* OpenStack username | | String -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *apiVersion* (producer) | OpenStack API version | V3 | String +| *config* (producer) | OpenStack configuration | | Config +| *domain* (producer) | Authentication domain | default | String +| *operation* (producer) | The operation to do | | String +| *password* (producer) | *Required* OpenStack password | | String +| *project* (producer) | *Required* The project ID | | String +| *subsystem* (producer) | *Required* OpenStack Cinder subsystem | | String +| *username* (producer) | *Required* OpenStack username | | String +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-openstack/src/main/docs/openstack-glance-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-openstack/src/main/docs/openstack-glance-component.adoc b/components/camel-openstack/src/main/docs/openstack-glance-component.adoc index 96cf78b..31a31c9 100644 --- a/components/camel-openstack/src/main/docs/openstack-glance-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-glance-component.adoc @@ -1,4 +1,4 @@ -## OpenStack Glance Component +== OpenStack Glance Component *Available as of Camel version 2.19* @@ -41,32 +41,34 @@ The OpenStack Glance component has no options. // endpoint options: START The OpenStack Glance endpoint is configured using URI syntax: - openstack-glance:host +---- +openstack-glance:host +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **host** | *Required* OpenStack host url | | String -|======================================================================= +| *host* | *Required* OpenStack host url | | String +|=== -#### Query Parameters (8 parameters): +==== Query Parameters (8 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **apiVersion** (producer) | OpenStack API version | V3 | String -| **config** (producer) | OpenStack configuration | | Config -| **domain** (producer) | Authentication domain | default | String -| **operation** (producer) | The operation to do | | String -| **password** (producer) | *Required* OpenStack password | | String -| **project** (producer) | *Required* The project ID | | String -| **username** (producer) | *Required* OpenStack username | | String -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *apiVersion* (producer) | OpenStack API version | V3 | String +| *config* (producer) | OpenStack configuration | | Config +| *domain* (producer) | Authentication domain | default | String +| *operation* (producer) | The operation to do | | String +| *password* (producer) | *Required* OpenStack password | | String +| *project* (producer) | *Required* The project ID | | String +| *username* (producer) | *Required* OpenStack username | | String +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc b/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc index e9ad266..10c7eb2 100644 --- a/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc @@ -1,4 +1,4 @@ -## OpenStack Keystone Component +== OpenStack Keystone Component *Available as of Camel version 2.19* @@ -43,32 +43,34 @@ The OpenStack Keystone component has no options. // endpoint options: START The OpenStack Keystone endpoint is configured using URI syntax: - openstack-keystone:host +---- +openstack-keystone:host +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **host** | *Required* OpenStack host url | | String -|======================================================================= +| *host* | *Required* OpenStack host url | | String +|=== -#### Query Parameters (8 parameters): +==== Query Parameters (8 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **config** (producer) | OpenStack configuration | | Config -| **domain** (producer) | Authentication domain | default | String -| **operation** (producer) | The operation to do | | String -| **password** (producer) | *Required* OpenStack password | | String -| **project** (producer) | *Required* The project ID | | String -| **subsystem** (producer) | *Required* OpenStack Keystone subsystem | | String -| **username** (producer) | *Required* OpenStack username | | String -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *config* (producer) | OpenStack configuration | | Config +| *domain* (producer) | Authentication domain | default | String +| *operation* (producer) | The operation to do | | String +| *password* (producer) | *Required* OpenStack password | | String +| *project* (producer) | *Required* The project ID | | String +| *subsystem* (producer) | *Required* OpenStack Keystone subsystem | | String +| *username* (producer) | *Required* OpenStack username | | String +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc b/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc index d5893bf..4c1c19d 100644 --- a/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc @@ -1,4 +1,4 @@ -## OpenStack Neutron Component +== OpenStack Neutron Component *Available as of Camel version 2.19* @@ -41,33 +41,35 @@ The OpenStack Neutron component has no options. // endpoint options: START The OpenStack Neutron endpoint is configured using URI syntax: - openstack-neutron:host +---- +openstack-neutron:host +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **host** | *Required* OpenStack host url | | String -|======================================================================= +| *host* | *Required* OpenStack host url | | String +|=== -#### Query Parameters (9 parameters): +==== Query Parameters (9 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **apiVersion** (producer) | OpenStack API version | V3 | String -| **config** (producer) | OpenStack configuration | | Config -| **domain** (producer) | Authentication domain | default | String -| **operation** (producer) | The operation to do | | String -| **password** (producer) | *Required* OpenStack password | | String -| **project** (producer) | *Required* The project ID | | String -| **subsystem** (producer) | *Required* OpenStack Neutron subsystem | | String -| **username** (producer) | *Required* OpenStack username | | String -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *apiVersion* (producer) | OpenStack API version | V3 | String +| *config* (producer) | OpenStack configuration | | Config +| *domain* (producer) | Authentication domain | default | String +| *operation* (producer) | The operation to do | | String +| *password* (producer) | *Required* OpenStack password | | String +| *project* (producer) | *Required* The project ID | | String +| *subsystem* (producer) | *Required* OpenStack Neutron subsystem | | String +| *username* (producer) | *Required* OpenStack username | | String +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-openstack/src/main/docs/openstack-nova-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-openstack/src/main/docs/openstack-nova-component.adoc b/components/camel-openstack/src/main/docs/openstack-nova-component.adoc index 4b49103..c0bc6d1 100644 --- a/components/camel-openstack/src/main/docs/openstack-nova-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-nova-component.adoc @@ -1,4 +1,4 @@ -## OpenStack Nova Component +== OpenStack Nova Component *Available as of Camel version 2.19* @@ -41,33 +41,35 @@ The OpenStack Nova component has no options. // endpoint options: START The OpenStack Nova endpoint is configured using URI syntax: - openstack-nova:host +---- +openstack-nova:host +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **host** | *Required* OpenStack host url | | String -|======================================================================= +| *host* | *Required* OpenStack host url | | String +|=== -#### Query Parameters (9 parameters): +==== Query Parameters (9 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **apiVersion** (producer) | OpenStack API version | V3 | String -| **config** (producer) | OpenStack configuration | | Config -| **domain** (producer) | Authentication domain | default | String -| **operation** (producer) | The operation to do | | String -| **password** (producer) | *Required* OpenStack password | | String -| **project** (producer) | *Required* The project ID | | String -| **subsystem** (producer) | *Required* OpenStack Nova subsystem | | String -| **username** (producer) | *Required* OpenStack username | | String -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *apiVersion* (producer) | OpenStack API version | V3 | String +| *config* (producer) | OpenStack configuration | | Config +| *domain* (producer) | Authentication domain | default | String +| *operation* (producer) | The operation to do | | String +| *password* (producer) | *Required* OpenStack password | | String +| *project* (producer) | *Required* The project ID | | String +| *subsystem* (producer) | *Required* OpenStack Nova subsystem | | String +| *username* (producer) | *Required* OpenStack username | | String +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-openstack/src/main/docs/openstack-swift-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-openstack/src/main/docs/openstack-swift-component.adoc b/components/camel-openstack/src/main/docs/openstack-swift-component.adoc index e6091e8..2d5aa99 100644 --- a/components/camel-openstack/src/main/docs/openstack-swift-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-swift-component.adoc @@ -1,4 +1,4 @@ -## OpenStack Swift Component +== OpenStack Swift Component *Available as of Camel version 2.19* @@ -41,33 +41,35 @@ The OpenStack Swift component has no options. // endpoint options: START The OpenStack Swift endpoint is configured using URI syntax: - openstack-swift:host +---- +openstack-swift:host +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **host** | *Required* OpenStack host url | | String -|======================================================================= +| *host* | *Required* OpenStack host url | | String +|=== -#### Query Parameters (9 parameters): +==== Query Parameters (9 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **apiVersion** (producer) | OpenStack API version | V3 | String -| **config** (producer) | OpenStack configuration | | Config -| **domain** (producer) | Authentication domain | default | String -| **operation** (producer) | The operation to do | | String -| **password** (producer) | *Required* OpenStack password | | String -| **project** (producer) | *Required* The project ID | | String -| **subsystem** (producer) | *Required* OpenStack Swift subsystem | | String -| **username** (producer) | *Required* OpenStack username | | String -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *apiVersion* (producer) | OpenStack API version | V3 | String +| *config* (producer) | OpenStack configuration | | Config +| *domain* (producer) | Authentication domain | default | String +| *operation* (producer) | The operation to do | | String +| *password* (producer) | *Required* OpenStack password | | String +| *project* (producer) | *Required* The project ID | | String +| *subsystem* (producer) | *Required* OpenStack Swift subsystem | | String +| *username* (producer) | *Required* OpenStack username | | String +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc b/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc index 300926a..9635c98 100644 --- a/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc +++ b/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc @@ -1,4 +1,4 @@ -## OptaPlanner Component +== OptaPlanner Component *Available as of Camel version 2.13* @@ -47,31 +47,33 @@ The OptaPlanner component has no options. // endpoint options: START The OptaPlanner endpoint is configured using URI syntax: - optaplanner:configFile +---- +optaplanner:configFile +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **configFile** | *Required* Specifies the location to the solver file | | String -|======================================================================= +| *configFile* | *Required* Specifies the location to the solver file | | String +|=== -#### Query Parameters (7 parameters): +==== Query Parameters (7 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **solverId** (common) | Specifies the solverId to user for the solver instance key | DEFAULT_SOLVER | String -| **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 -| **exceptionHandler** (consumer) | 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 or ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern -| **async** (producer) | Specifies to perform operations in async mode | false | boolean -| **threadPoolSize** (producer) | Specifies the thread pool size to use when async is true | 10 | int -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *solverId* (common) | Specifies the solverId to user for the solver instance key | DEFAULT_SOLVER | String +| *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 +| *exceptionHandler* (consumer) | 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 or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *async* (producer) | Specifies to perform operations in async mode | false | boolean +| *threadPoolSize* (producer) | Specifies the thread pool size to use when async is true | 10 | int +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END
