http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-jcache/src/main/docs/jcache-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jcache/src/main/docs/jcache-component.adoc b/components/camel-jcache/src/main/docs/jcache-component.adoc index 15c42a9..d9a2483 100644 --- a/components/camel-jcache/src/main/docs/jcache-component.adoc +++ b/components/camel-jcache/src/main/docs/jcache-component.adoc @@ -30,31 +30,53 @@ with the following path and query parameters: #### Query Parameters (22 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| cacheConfiguration | common | | Configuration | A Configuration for the Cache -| cacheConfigurationProperties | common | | Properties | The Properties for the javax.cache.spi.CachingProvider to create the CacheManager -| cachingProvider | common | | String | The fully qualified class name of the javax.cache.spi.CachingProvider -| configurationUri | common | | String | An implementation specific URI for the CacheManager -| managementEnabled | common | false | boolean | Whether management gathering is enabled -| readThrough | common | false | boolean | If read-through caching should be used -| statisticsEnabled | common | false | boolean | Whether statistics gathering is enabled -| storeByValue | common | true | boolean | If cache should use store-by-value or store-by-reference semantics -| writeThrough | common | false | boolean | If write-through caching should be used -| 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 or ERROR level and ignored. -| filteredEvents | consumer | | List | Events a consumer should filter. If using filteredEvents option then eventFilters one will be ignored -| oldValueRequired | consumer | false | boolean | if the old value is required for events -| synchronous | consumer | false | boolean | if the the event listener should block the thread causing the event -| eventFilters | consumer (advanced) | | List | The CacheEntryEventFilter. If using eventFilters option then filteredEvents one will be ignored -| 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 or ERROR level and ignored. -| exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| action | producer | | String | To configure using a cache operation by default. If an operation in the message header then the operation from the header takes precedence. -| cacheLoaderFactory | advanced | | CacheLoader> | The CacheLoader factory -| cacheWriterFactory | advanced | | CacheWriter> | The CacheWriter factory -| createCacheIfNotExists | advanced | true | boolean | Configure if a cache need to be created if it does exist or can't be pre-configured. -| expiryPolicyFactory | advanced | | ExpiryPolicy> | The ExpiryPolicy factory -| lookupProviders | advanced | false | boolean | Configure if a camel-cache should try to find implementations of jcache api in runtimes like OSGi. +| Name | Default | Java Type | Description + +| cacheConfiguration | | Configuration | A Configuration for the Cache + +| cacheConfigurationProperties | | Properties | The Properties for the javax.cache.spi.CachingProvider to create the CacheManager + +| cachingProvider | | String | The fully qualified class name of the javax.cache.spi.CachingProvider + +| configurationUri | | String | An implementation specific URI for the CacheManager + +| managementEnabled | false | boolean | Whether management gathering is enabled + +| readThrough | false | boolean | If read-through caching should be used + +| statisticsEnabled | false | boolean | Whether statistics gathering is enabled + +| storeByValue | true | boolean | If cache should use store-by-value or store-by-reference semantics + +| writeThrough | false | boolean | If write-through caching should be used + 4+^s| consumer +| bridgeErrorHandler | 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 or ERROR level and ignored. + +| filteredEvents | | List | Events a consumer should filter. If using filteredEvents option then eventFilters one will be ignored + +| oldValueRequired | false | boolean | if the old value is required for events + +| synchronous | false | boolean | if the the event listener should block the thread causing the event + 4+^s| consumer (advanced) +| eventFilters | | List | The CacheEntryEventFilter. If using eventFilters option then filteredEvents one will be ignored + +| exceptionHandler | | 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 or ERROR level and ignored. + +| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. + 4+^s| producer +| action | | String | To configure using a cache operation by default. If an operation in the message header then the operation from the header takes precedence. + 4+^s| advanced +| cacheLoaderFactory | | CacheLoader> | The CacheLoader factory + +| cacheWriterFactory | | CacheWriter> | The CacheWriter factory + +| createCacheIfNotExists | true | boolean | Configure if a cache need to be created if it does exist or can't be pre-configured. + +| expiryPolicyFactory | | ExpiryPolicy> | The ExpiryPolicy factory + +| lookupProviders | false | boolean | Configure if a camel-cache should try to find implementations of jcache api in runtimes like OSGi. |======================================================================= // endpoint options: END @@ -70,13 +92,18 @@ The JCache component supports 5 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| cachingProvider | common | | String | The fully qualified class name of the javax.cache.spi.CachingProvider -| cacheConfiguration | common | | Configuration | A Configuration for the Cache -| cacheConfigurationProperties | common | | Properties | The Properties for the javax.cache.spi.CachingProvider to create the CacheManager -| configurationUri | common | | String | An implementation specific URI for the CacheManager -| resolvePropertyPlaceholders | advanced | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Default | Java Type | Description + 4+^s| common +| cachingProvider | | String | The fully qualified class name of the javax.cache.spi.CachingProvider + +| cacheConfiguration | | Configuration | A Configuration for the Cache + +| cacheConfigurationProperties | | Properties | The Properties for the javax.cache.spi.CachingProvider to create the CacheManager + +| configurationUri | | String | An implementation specific URI for the CacheManager + 4+^s| advanced +| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. |======================================================================= // component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-jclouds/src/main/docs/jclouds-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jclouds/src/main/docs/jclouds-component.adoc b/components/camel-jclouds/src/main/docs/jclouds-component.adoc index 61794f4..f5296e3 100644 --- a/components/camel-jclouds/src/main/docs/jclouds-component.adoc +++ b/components/camel-jclouds/src/main/docs/jclouds-component.adoc @@ -106,12 +106,15 @@ The JClouds component supports 3 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| blobStores | common | | List | To use the given BlobStore which must be configured when using blobstore. -| computeServices | common | | List | To use the given ComputeService which must be configured when use compute. -| resolvePropertyPlaceholders | advanced | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Default | Java Type | Description + 4+^s| common +| blobStores | | List | To use the given BlobStore which must be configured when using blobstore. + +| computeServices | | List | To use the given ComputeService which must be configured when use compute. + 4+^s| advanced +| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. |======================================================================= // component options: END @@ -138,24 +141,39 @@ with the following path and query parameters: #### Query Parameters (15 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| 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 or ERROR level and ignored. -| 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 or ERROR level and ignored. -| exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -| blobName | blobstore | | String | The name of the blob. -| container | blobstore | | String | The name of the blob container. -| directory | blobstore | | String | An optional directory name to use -| group | compute | | String | The group that will be assigned to the newly created node. Values depend on the actual cloud provider. -| hardwareId | compute | | String | The hardware that will be used for creating a node. Values depend on the actual cloud provider. -| imageId | compute | | String | The imageId that will be used for creating a node. Values depend on the actual cloud provider. -| locationId | compute | | String | The location that will be used for creating a node. Values depend on the actual cloud provider. -| nodeId | compute | | String | The id of the node that will run the script or destroyed. -| nodeState | compute | | String | To filter by node status to only select running nodes etc. -| operation | compute | | String | Specifies the type of operation that will be performed to the blobstore. -| user | compute | | String | The user on the target node that will run the script. +| Name | Default | Java Type | Description + 4+^s| consumer +| bridgeErrorHandler | 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 or ERROR level and ignored. + 4+^s| consumer (advanced) +| exceptionHandler | | 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 or ERROR level and ignored. + +| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. + 4+^s| advanced +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). + 4+^s| blobstore +| blobName | | String | The name of the blob. + +| container | | String | The name of the blob container. + +| directory | | String | An optional directory name to use + 4+^s| compute +| group | | String | The group that will be assigned to the newly created node. Values depend on the actual cloud provider. + +| hardwareId | | String | The hardware that will be used for creating a node. Values depend on the actual cloud provider. + +| imageId | | String | The imageId that will be used for creating a node. Values depend on the actual cloud provider. + +| locationId | | String | The location that will be used for creating a node. Values depend on the actual cloud provider. + +| nodeId | | String | The id of the node that will run the script or destroyed. + +| nodeState | | String | To filter by node status to only select running nodes etc. + +| operation | | String | Specifies the type of operation that will be performed to the blobstore. + +| user | | String | The user on the target node that will run the script. |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-jcr/src/main/docs/jcr-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jcr/src/main/docs/jcr-component.adoc b/components/camel-jcr/src/main/docs/jcr-component.adoc index 5e61e4e..76adb76 100644 --- a/components/camel-jcr/src/main/docs/jcr-component.adoc +++ b/components/camel-jcr/src/main/docs/jcr-component.adoc @@ -65,23 +65,37 @@ with the following path and query parameters: #### Query Parameters (14 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| deep | common | false | boolean | When isDeep is true events whose associated parent node is at absPath or within its subgraph are received. -| eventTypes | common | | int | eventTypes (a combination of one or more event types encoded as a bit mask value such as javax.jcr.observation.Event.NODE_ADDED javax.jcr.observation.Event.NODE_REMOVED etc.). -| nodeTypeNames | common | | String | When a comma separated nodeTypeName list string is set only events whose associated parent node has one of the node types (or a subtype of one of the node types) in this list will be received. -| noLocal | common | false | boolean | If noLocal is true then events generated by the session through which the listener was registered are ignored. Otherwise they are not ignored. -| password | common | | String | Password for login -| sessionLiveCheckInterval | common | 60000 | long | Interval in milliseconds to wait before each session live checking The default value is 60000 ms. -| sessionLiveCheckIntervalOnStart | common | 3000 | long | Interval in milliseconds to wait before the first session live checking. The default value is 3000 ms. -| username | common | | String | Username for login -| uuids | common | | String | When a comma separated uuid list string is set only events whose associated parent node has one of the identifiers in the comma separated uuid list will be received. -| workspaceName | common | | String | The workspace to access. If it's not specified then the default one will be used -| 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 or ERROR level and ignored. -| 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 or ERROR level and ignored. -| exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Default | Java Type | Description + +| deep | false | boolean | When isDeep is true events whose associated parent node is at absPath or within its subgraph are received. + +| eventTypes | | int | eventTypes (a combination of one or more event types encoded as a bit mask value such as javax.jcr.observation.Event.NODE_ADDED javax.jcr.observation.Event.NODE_REMOVED etc.). + +| nodeTypeNames | | String | When a comma separated nodeTypeName list string is set only events whose associated parent node has one of the node types (or a subtype of one of the node types) in this list will be received. + +| noLocal | false | boolean | If noLocal is true then events generated by the session through which the listener was registered are ignored. Otherwise they are not ignored. + +| password | | String | Password for login + +| sessionLiveCheckInterval | 60000 | long | Interval in milliseconds to wait before each session live checking The default value is 60000 ms. + +| sessionLiveCheckIntervalOnStart | 3000 | long | Interval in milliseconds to wait before the first session live checking. The default value is 3000 ms. + +| username | | String | Username for login + +| uuids | | String | When a comma separated uuid list string is set only events whose associated parent node has one of the identifiers in the comma separated uuid list will be received. + +| workspaceName | | String | The workspace to access. If it's not specified then the default one will be used + 4+^s| consumer +| bridgeErrorHandler | 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 or ERROR level and ignored. + 4+^s| consumer (advanced) +| exceptionHandler | | 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 or ERROR level and ignored. + +| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. + 4+^s| advanced +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-jdbc/src/main/docs/jdbc-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jdbc/src/main/docs/jdbc-component.adoc b/components/camel-jdbc/src/main/docs/jdbc-component.adoc index cdf7384..a14f67d 100644 --- a/components/camel-jdbc/src/main/docs/jdbc-component.adoc +++ b/components/camel-jdbc/src/main/docs/jdbc-component.adoc @@ -46,11 +46,13 @@ The JDBC component supports 2 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| dataSource | producer | | DataSource | To use the DataSource instance instead of looking up the data source by name from the registry. -| resolvePropertyPlaceholders | advanced | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Default | Java Type | Description + 4+^s| producer +| dataSource | | DataSource | To use the DataSource instance instead of looking up the data source by name from the registry. + 4+^s| advanced +| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. |======================================================================= // component options: END @@ -76,22 +78,35 @@ with the following path and query parameters: #### Query Parameters (13 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| allowNamedParameters | producer | true | boolean | Whether to allow using named parameters in the queries. -| outputClass | producer | | String | Specify the full package and class name to use as conversion when outputType=SelectOne or SelectList. -| outputType | producer | SelectList | JdbcOutputType | Determines the output the producer should use. -| parameters | producer | | Map | Optional parameters to the java.sql.Statement. For example to set maxRows fetchSize etc. -| readSize | producer | | int | The default maximum number of rows that can be read by a polling query. The default value is 0. -| resetAutoCommit | producer | true | boolean | Camel will set the autoCommit on the JDBC connection to be false commit the change after executed the statement and reset the autoCommit flag of the connection at the end if the resetAutoCommit is true. If the JDBC connection doesn't support to reset the autoCommit flag you can set the resetAutoCommit flag to be false and Camel will not try to reset the autoCommit flag. When used with XA transactions you most likely need to set it to false so that the transaction manager is in charge of committing this tx. -| transacted | producer | false | boolean | Whether transactions are in use. -| useGetBytesForBlob | producer | false | boolean | To read BLOB columns as bytes instead of string data. This may be needed for certain databases such as Oracle where you must read BLOB columns as bytes. -| useHeadersAsParameters | producer | false | boolean | Set this option to true to use the prepareStatementStrategy with named parameters. This allows to define queries with named placeholders and use headers with the dynamic values for the query placeholders. -| useJDBC4ColumnNameAndLabelSemantics | producer | true | boolean | Sets whether to use JDBC 4 or JDBC 3.0 or older semantic when retrieving column name. JDBC 4.0 uses columnLabel to get the column name where as JDBC 3.0 uses both columnName or columnLabel. Unfortunately JDBC drivers behave differently so you can use this option to work out issues around your JDBC driver if you get problem using this component This option is default true. -| beanRowMapper | advanced | | BeanRowMapper | To use a custom org.apache.camel.component.jdbc.BeanRowMapper when using outputClass. The default implementation will lower case the row names and skip underscores and dashes. For example CUST_ID is mapped as custId. -| prepareStatementStrategy | advanced | | JdbcPrepareStatementStrategy | Allows to plugin to use a custom org.apache.camel.component.jdbc.JdbcPrepareStatementStrategy to control preparation of the query and prepared statement. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Default | Java Type | Description + +| allowNamedParameters | true | boolean | Whether to allow using named parameters in the queries. + +| outputClass | | String | Specify the full package and class name to use as conversion when outputType=SelectOne or SelectList. + +| outputType | SelectList | JdbcOutputType | Determines the output the producer should use. + +| parameters | | Map | Optional parameters to the java.sql.Statement. For example to set maxRows fetchSize etc. + +| readSize | | int | The default maximum number of rows that can be read by a polling query. The default value is 0. + +| resetAutoCommit | true | boolean | Camel will set the autoCommit on the JDBC connection to be false commit the change after executed the statement and reset the autoCommit flag of the connection at the end if the resetAutoCommit is true. If the JDBC connection doesn't support to reset the autoCommit flag you can set the resetAutoCommit flag to be false and Camel will not try to reset the autoCommit flag. When used with XA transactions you most likely need to set it to false so that the transaction manager is in charge of committing this tx. + +| transacted | false | boolean | Whether transactions are in use. + +| useGetBytesForBlob | false | boolean | To read BLOB columns as bytes instead of string data. This may be needed for certain databases such as Oracle where you must read BLOB columns as bytes. + +| useHeadersAsParameters | false | boolean | Set this option to true to use the prepareStatementStrategy with named parameters. This allows to define queries with named placeholders and use headers with the dynamic values for the query placeholders. + +| useJDBC4ColumnNameAndLabelSemantics | true | boolean | Sets whether to use JDBC 4 or JDBC 3.0 or older semantic when retrieving column name. JDBC 4.0 uses columnLabel to get the column name where as JDBC 3.0 uses both columnName or columnLabel. Unfortunately JDBC drivers behave differently so you can use this option to work out issues around your JDBC driver if you get problem using this component This option is default true. + 4+^s| advanced +| beanRowMapper | | BeanRowMapper | To use a custom org.apache.camel.component.jdbc.BeanRowMapper when using outputClass. The default implementation will lower case the row names and skip underscores and dashes. For example CUST_ID is mapped as custId. + +| prepareStatementStrategy | | JdbcPrepareStatementStrategy | Allows to plugin to use a custom org.apache.camel.component.jdbc.JdbcPrepareStatementStrategy to control preparation of the query and prepared statement. + +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-jetty9/src/main/docs/jetty-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jetty9/src/main/docs/jetty-component.adoc b/components/camel-jetty9/src/main/docs/jetty-component.adoc index e132c4f..b31d915 100644 --- a/components/camel-jetty9/src/main/docs/jetty-component.adoc +++ b/components/camel-jetty9/src/main/docs/jetty-component.adoc @@ -56,41 +56,73 @@ The Jetty 9 component supports 32 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| sslKeyPassword | security | | String | The key password which is used to access the certificate's key entry in the keystore (this is the same password that is supplied to the keystore command's -keypass option). -| sslPassword | security | | String | The ssl password which is required to access the keystore file (this is the same password that is supplied to the keystore command's -storepass option). -| keystore | security | | String | Specifies the location of the Java keystore file which contains the Jetty server's own X.509 certificate in a key entry. -| errorHandler | advanced | | ErrorHandler | This option is used to set the ErrorHandler that Jetty server uses. -| sslSocketConnectors | security | | Map | A map which contains per port number specific SSL connectors. -| socketConnectors | security | | Map | A map which contains per port number specific HTTP connectors. Uses the same principle as sslSocketConnectors. -| httpClientMinThreads | producer | | Integer | To set a value for minimum number of threads in HttpClient thread pool. Notice that both a min and max size must be configured. -| httpClientMaxThreads | producer | | Integer | To set a value for maximum number of threads in HttpClient thread pool. Notice that both a min and max size must be configured. -| minThreads | consumer | | Integer | To set a value for minimum number of threads in server thread pool. Notice that both a min and max size must be configured. -| maxThreads | consumer | | Integer | To set a value for maximum number of threads in server thread pool. Notice that both a min and max size must be configured. -| threadPool | consumer (advanced) | | ThreadPool | To use a custom thread pool for the server. This option should only be used in special circumstances. -| enableJmx | common | false | boolean | If this option is true Jetty JMX support will be enabled for this endpoint. -| jettyHttpBinding | advanced | | JettyHttpBinding | To use a custom org.apache.camel.component.jetty.JettyHttpBinding which are used to customize how a response should be written for the producer. -| httpBinding | advanced | | HttpBinding | Not to be used - use JettyHttpBinding instead. -| httpConfiguration | advanced | | HttpConfiguration | Jetty component does not use HttpConfiguration. -| mbContainer | advanced | | MBeanContainer | To use a existing configured org.eclipse.jetty.jmx.MBeanContainer if JMX is enabled that Jetty uses for registering mbeans. -| sslSocketConnectorProperties | security | | Map | A map which contains general SSL connector properties. -| socketConnectorProperties | security | | Map | A map which contains general HTTP connector properties. Uses the same principle as sslSocketConnectorProperties. -| continuationTimeout | consumer | 30000 | Long | Allows to set a timeout in millis when using Jetty as consumer (server). By default Jetty uses 30000. You can use a value of = 0 to never expire. If a timeout occurs then the request will be expired and Jetty will return back a http error 503 to the client. This option is only in use when using Jetty with the Asynchronous Routing Engine. -| useContinuation | consumer | true | boolean | Whether or not to use Jetty continuations for the Jetty Server. -| sslContextParameters | security | | SSLContextParameters | To configure security using SSLContextParameters -| responseBufferSize | common | | Integer | Allows to configure a custom value of the response buffer size on the Jetty connectors. -| requestBufferSize | common | | Integer | Allows to configure a custom value of the request buffer size on the Jetty connectors. -| requestHeaderSize | common | | Integer | Allows to configure a custom value of the request header size on the Jetty connectors. -| responseHeaderSize | common | | Integer | Allows to configure a custom value of the response header size on the Jetty connectors. -| proxyHost | proxy | | String | To use a http proxy to configure the hostname. -| proxyPort | proxy | | Integer | To use a http proxy to configure the port number. -| useXForwardedForHeader | common | false | boolean | To use the X-Forwarded-For header in HttpServletRequest.getRemoteAddr. -| sendServerVersion | consumer | true | boolean | If the option is true jetty server will send the date header to the client which sends the request. NOTE please make sure there is no any other camel-jetty endpoint is share the same port otherwise this option may not work as expected. -| allowJavaSerializedObject | advanced | false | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. -| headerFilterStrategy | filter | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. -| resolvePropertyPlaceholders | advanced | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Default | Java Type | Description + 4+^s| security +| sslKeyPassword | | String | The key password which is used to access the certificate's key entry in the keystore (this is the same password that is supplied to the keystore command's -keypass option). + +| sslPassword | | String | The ssl password which is required to access the keystore file (this is the same password that is supplied to the keystore command's -storepass option). + +| keystore | | String | Specifies the location of the Java keystore file which contains the Jetty server's own X.509 certificate in a key entry. + 4+^s| advanced +| errorHandler | | ErrorHandler | This option is used to set the ErrorHandler that Jetty server uses. + 4+^s| security +| sslSocketConnectors | | Map | A map which contains per port number specific SSL connectors. + +| socketConnectors | | Map | A map which contains per port number specific HTTP connectors. Uses the same principle as sslSocketConnectors. + 4+^s| producer +| httpClientMinThreads | | Integer | To set a value for minimum number of threads in HttpClient thread pool. Notice that both a min and max size must be configured. + +| httpClientMaxThreads | | Integer | To set a value for maximum number of threads in HttpClient thread pool. Notice that both a min and max size must be configured. + 4+^s| consumer +| minThreads | | Integer | To set a value for minimum number of threads in server thread pool. Notice that both a min and max size must be configured. + +| maxThreads | | Integer | To set a value for maximum number of threads in server thread pool. Notice that both a min and max size must be configured. + 4+^s| consumer (advanced) +| threadPool | | ThreadPool | To use a custom thread pool for the server. This option should only be used in special circumstances. + 4+^s| common +| enableJmx | false | boolean | If this option is true Jetty JMX support will be enabled for this endpoint. + 4+^s| advanced +| jettyHttpBinding | | JettyHttpBinding | To use a custom org.apache.camel.component.jetty.JettyHttpBinding which are used to customize how a response should be written for the producer. + +| httpBinding | | HttpBinding | Not to be used - use JettyHttpBinding instead. + +| httpConfiguration | | HttpConfiguration | Jetty component does not use HttpConfiguration. + +| mbContainer | | MBeanContainer | To use a existing configured org.eclipse.jetty.jmx.MBeanContainer if JMX is enabled that Jetty uses for registering mbeans. + 4+^s| security +| sslSocketConnectorProperties | | Map | A map which contains general SSL connector properties. + +| socketConnectorProperties | | Map | A map which contains general HTTP connector properties. Uses the same principle as sslSocketConnectorProperties. + 4+^s| consumer +| continuationTimeout | 30000 | Long | Allows to set a timeout in millis when using Jetty as consumer (server). By default Jetty uses 30000. You can use a value of = 0 to never expire. If a timeout occurs then the request will be expired and Jetty will return back a http error 503 to the client. This option is only in use when using Jetty with the Asynchronous Routing Engine. + +| useContinuation | true | boolean | Whether or not to use Jetty continuations for the Jetty Server. + 4+^s| security +| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters + 4+^s| common +| responseBufferSize | | Integer | Allows to configure a custom value of the response buffer size on the Jetty connectors. + +| requestBufferSize | | Integer | Allows to configure a custom value of the request buffer size on the Jetty connectors. + +| requestHeaderSize | | Integer | Allows to configure a custom value of the request header size on the Jetty connectors. + +| responseHeaderSize | | Integer | Allows to configure a custom value of the response header size on the Jetty connectors. + 4+^s| proxy +| proxyHost | | String | To use a http proxy to configure the hostname. + +| proxyPort | | Integer | To use a http proxy to configure the port number. + 4+^s| common +| useXForwardedForHeader | false | boolean | To use the X-Forwarded-For header in HttpServletRequest.getRemoteAddr. + 4+^s| consumer +| sendServerVersion | true | boolean | If the option is true jetty server will send the date header to the client which sends the request. NOTE please make sure there is no any other camel-jetty endpoint is share the same port otherwise this option may not work as expected. + 4+^s| advanced +| allowJavaSerializedObject | false | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. + 4+^s| filter +| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. + 4+^s| advanced +| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. |======================================================================= // component options: END @@ -119,64 +151,119 @@ with the following path and query parameters: #### Query Parameters (55 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| chunked | common | true | boolean | If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response -| disableStreamCache | common | false | boolean | Determines whether or not the raw input stream from Servlet is cached or not (Camel will read the stream into a in memory/overflow to file Stream caching) cache. By default Camel will cache the Servlet input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance in case you do not need to read the message payload multiple times. The http/http4 producer will by default cache the response body stream. If setting this option to true then the producers will not ca che the response body stream but use the response stream as-is as the message body. -| enableMultipartFilter | common | false | boolean | Whether Jetty org.eclipse.jetty.servlets.MultiPartFilter is enabled or not. You should set this value to false when bridging endpoints to ensure multipart requests is proxied/bridged as well. -| headerFilterStrategy | common | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message. -| transferException | common | false | boolean | If enabled and an Exchange failed processing on the consumer side and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. -| httpBinding | common (advanced) | | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. -| async | consumer | false | boolean | Configure the consumer to work in async mode -| 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 or ERROR level and ignored. -| continuationTimeout | consumer | 30000 | Long | Allows to set a timeout in millis when using Jetty as consumer (server). By default Jetty uses 30000. You can use a value of = 0 to never expire. If a timeout occurs then the request will be expired and Jetty will return back a http error 503 to the client. This option is only in use when using Jetty with the Asynchronous Routing Engine. -| enableCORS | consumer | false | boolean | If the option is true Jetty server will setup the CrossOriginFilter which supports the CORS out of box. -| enableJmx | consumer | false | boolean | If this option is true Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details. -| httpMethodRestrict | consumer | | String | Used to only allow consuming if the HttpMethod matches such as GET/POST/PUT etc. Multiple methods can be specified separated by comma. -| matchOnUriPrefix | consumer | false | boolean | Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found. -| responseBufferSize | consumer | | Integer | To use a custom buffer size on the javax.servlet.ServletResponse. -| sendDateHeader | consumer | false | boolean | If the option is true jetty server will send the date header to the client which sends the request. NOTE please make sure there is no any other camel-jetty endpoint is share the same port otherwise this option may not work as expected. -| sendServerVersion | consumer | true | boolean | If the option is true jetty will send the server header with the jetty version information to the client which sends the request. NOTE please make sure there is no any other camel-jetty endpoint is share the same port otherwise this option may not work as expected. -| sessionSupport | consumer | false | boolean | Specifies whether to enable the session manager on the server side of Jetty. -| useContinuation | consumer | | Boolean | Whether or not to use Jetty continuations for the Jetty Server. -| eagerCheckContentAvailable | consumer (advanced) | false | boolean | Whether to eager check whether the HTTP requests has content if the content-length header is 0 or not present. This can be turned on in case HTTP clients do not send streamed data. -| 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 or ERROR level and ignored. -| exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| filterInitParameters | consumer (advanced) | | Map | Configuration of the filter init parameters. These parameters will be applied to the filter list before starting the jetty server. -| filtersRef | consumer (advanced) | | String | Allows using a custom filters which is putted into a list and can be find in the Registry. Multiple values can be separated by comma. -| handlers | consumer (advanced) | | String | Specifies a comma-delimited set of Handler instances to lookup in your Registry. These handlers are added to the Jetty servlet context (for example to add security). Important: You can not use different handlers with different Jetty endpoints using the same port number. The handlers is associated to the port number. If you need different handlers then use different port numbers. -| httpBindingRef | consumer (advanced) | | String | Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code. -| multipartFilter | consumer (advanced) | | Filter | Allows using a custom multipart filter. Note: setting multipartFilterRef forces the value of enableMultipartFilter to true. -| multipartFilterRef | consumer (advanced) | | String | Allows using a custom multipart filter. Note: setting multipartFilterRef forces the value of enableMultipartFilter to true. -| optionsEnabled | consumer (advanced) | false | boolean | Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off. -| traceEnabled | consumer (advanced) | false | boolean | Specifies whether to enable HTTP TRACE for this Servlet consumer. By default TRACE is turned off. -| bridgeEndpoint | producer | false | boolean | If the option is true HttpProducer will ignore the Exchange.HTTP_URI header and use the endpoint's URI for request. You may also set the option throwExceptionOnFailure to be false to let the HttpProducer send all the fault response back. -| connectionClose | producer | false | boolean | Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false. -| cookieHandler | producer | | CookieHandler | Configure a cookie handler to maintain a HTTP session -| copyHeaders | producer | true | boolean | If this option is true then IN exchange headers will be copied to OUT exchange headers according to copy strategy. Setting this to false allows to only include the headers from the HTTP response (not propagating IN headers). -| httpClientMaxThreads | producer | 254 | Integer | To set a value for maximum number of threads in HttpClient thread pool. This setting override any setting configured on component level. Notice that both a min and max size must be configured. If not set it default to max 254 threads used in Jettys thread pool. -| httpClientMinThreads | producer | 8 | Integer | To set a value for minimum number of threads in HttpClient thread pool. This setting override any setting configured on component level. Notice that both a min and max size must be configured. If not set it default to min 8 threads used in Jettys thread pool. -| httpMethod | producer | | HttpMethods | Configure the HTTP method to use. The HttpMethod header cannot override this option if set. -| ignoreResponseBody | producer | false | boolean | If this option is true The http producer won't read response body and cache the input stream -| preserveHostHeader | producer | false | boolean | If the option is true HttpProducer will set the Host header to the value contained in the current exchange Host header useful in reverse proxy applications where you want the Host header received by the downstream server to reflect the URL called by the upstream client this allows applications which use the Host header to generate accurate URL's for a proxied service -| throwExceptionOnFailure | producer | true | boolean | Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code. -| httpClient | producer (advanced) | | HttpClient | Sets a shared HttpClient to use for all producers created by this endpoint. By default each producer will use a new http client and not share. Important: Make sure to handle the lifecycle of the shared client such as stopping the client when it is no longer in use. Camel will call the start method on the client to ensure its started when this endpoint creates a producer. This options should only be used in special circumstances. -| httpClientParameters | producer (advanced) | | Map | Configuration of Jetty's HttpClient. For example setting httpClient.idleTimeout=30000 sets the idle timeout to 30 seconds. And httpClient.timeout=30000 sets the request timeout to 30 seconds in case you want to timeout sooner if you have long running request/response calls. -| jettyBinding | producer (advanced) | | JettyHttpBinding | To use a custom JettyHttpBinding which be used to customize how a response should be written for the producer. -| jettyBindingRef | producer (advanced) | | String | To use a custom JettyHttpBinding which be used to customize how a response should be written for the producer. -| okStatusCodeRange | producer (advanced) | 200-299 | String | The status codes which is considered a success response. The values are inclusive. The range must be defined as from-to with the dash included. -| urlRewrite | producer (advanced) | | UrlRewrite | Refers to a custom org.apache.camel.component.http.UrlRewrite which allows you to rewrite urls when you bridge/proxy endpoints. See more details at http://camel.apache.org/urlrewrite.html -| mapHttpMessageBody | advanced | true | boolean | If this option is true then IN exchange Body of the exchange will be mapped to HTTP body. Setting this to false will avoid the HTTP mapping. -| mapHttpMessageFormUrlEncodedBody | advanced | true | boolean | If this option is true then IN exchange Form Encoded body of the exchange will be mapped to HTTP. Setting this to false will avoid the HTTP Form Encoded body mapping. -| mapHttpMessageHeaders | advanced | true | boolean | If this option is true then IN exchange Headers of the exchange will be mapped to HTTP headers. Setting this to false will avoid the HTTP Headers mapping. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -| proxyAuthScheme | proxy | | String | Proxy authentication scheme to use -| proxyHost | proxy | | String | Proxy hostname to use -| proxyPort | proxy | | int | Proxy port to use -| authHost | security | | String | Authentication host to use with NTML -| sslContextParameters | security | | SSLContextParameters | To configure security using SSLContextParameters -| sslContextParametersRef | security | | String | To configure security using SSLContextParameters +| Name | Default | Java Type | Description + 4+^s| common +| chunked | true | boolean | If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response + +| disableStreamCache | false | boolean | Determines whether or not the raw input stream from Servlet is cached or not (Camel will read the stream into a in memory/overflow to file Stream caching) cache. By default Camel will cache the Servlet input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance in case you do not need to read the message payload multiple times. The http/http4 producer will by default cache the response body stream. If setting this option to true then the producers will not cache the r esponse body stream but use the response stream as-is as the message body. + +| enableMultipartFilter | false | boolean | Whether Jetty org.eclipse.jetty.servlets.MultiPartFilter is enabled or not. You should set this value to false when bridging endpoints to ensure multipart requests is proxied/bridged as well. + +| headerFilterStrategy | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message. + +| transferException | false | boolean | If enabled and an Exchange failed processing on the consumer side and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. + 4+^s| common (advanced) +| httpBinding | | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. + 4+^s| consumer +| async | false | boolean | Configure the consumer to work in async mode + +| bridgeErrorHandler | 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 or ERROR level and ignored. + +| continuationTimeout | 30000 | Long | Allows to set a timeout in millis when using Jetty as consumer (server). By default Jetty uses 30000. You can use a value of = 0 to never expire. If a timeout occurs then the request will be expired and Jetty will return back a http error 503 to the client. This option is only in use when using Jetty with the Asynchronous Routing Engine. + +| enableCORS | false | boolean | If the option is true Jetty server will setup the CrossOriginFilter which supports the CORS out of box. + +| enableJmx | false | boolean | If this option is true Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details. + +| httpMethodRestrict | | String | Used to only allow consuming if the HttpMethod matches such as GET/POST/PUT etc. Multiple methods can be specified separated by comma. + +| matchOnUriPrefix | false | boolean | Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found. + +| responseBufferSize | | Integer | To use a custom buffer size on the javax.servlet.ServletResponse. + +| sendDateHeader | false | boolean | If the option is true jetty server will send the date header to the client which sends the request. NOTE please make sure there is no any other camel-jetty endpoint is share the same port otherwise this option may not work as expected. + +| sendServerVersion | true | boolean | If the option is true jetty will send the server header with the jetty version information to the client which sends the request. NOTE please make sure there is no any other camel-jetty endpoint is share the same port otherwise this option may not work as expected. + +| sessionSupport | false | boolean | Specifies whether to enable the session manager on the server side of Jetty. + +| useContinuation | | Boolean | Whether or not to use Jetty continuations for the Jetty Server. + 4+^s| consumer (advanced) +| eagerCheckContentAvailable | false | boolean | Whether to eager check whether the HTTP requests has content if the content-length header is 0 or not present. This can be turned on in case HTTP clients do not send streamed data. + +| exceptionHandler | | 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 or ERROR level and ignored. + +| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. + +| filterInitParameters | | Map | Configuration of the filter init parameters. These parameters will be applied to the filter list before starting the jetty server. + +| filtersRef | | String | Allows using a custom filters which is putted into a list and can be find in the Registry. Multiple values can be separated by comma. + +| handlers | | String | Specifies a comma-delimited set of Handler instances to lookup in your Registry. These handlers are added to the Jetty servlet context (for example to add security). Important: You can not use different handlers with different Jetty endpoints using the same port number. The handlers is associated to the port number. If you need different handlers then use different port numbers. + +| httpBindingRef | | String | Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code. + +| multipartFilter | | Filter | Allows using a custom multipart filter. Note: setting multipartFilterRef forces the value of enableMultipartFilter to true. + +| multipartFilterRef | | String | Allows using a custom multipart filter. Note: setting multipartFilterRef forces the value of enableMultipartFilter to true. + +| optionsEnabled | false | boolean | Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off. + +| traceEnabled | false | boolean | Specifies whether to enable HTTP TRACE for this Servlet consumer. By default TRACE is turned off. + 4+^s| producer +| bridgeEndpoint | false | boolean | If the option is true HttpProducer will ignore the Exchange.HTTP_URI header and use the endpoint's URI for request. You may also set the option throwExceptionOnFailure to be false to let the HttpProducer send all the fault response back. + +| connectionClose | false | boolean | Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false. + +| cookieHandler | | CookieHandler | Configure a cookie handler to maintain a HTTP session + +| copyHeaders | true | boolean | If this option is true then IN exchange headers will be copied to OUT exchange headers according to copy strategy. Setting this to false allows to only include the headers from the HTTP response (not propagating IN headers). + +| httpClientMaxThreads | 254 | Integer | To set a value for maximum number of threads in HttpClient thread pool. This setting override any setting configured on component level. Notice that both a min and max size must be configured. If not set it default to max 254 threads used in Jettys thread pool. + +| httpClientMinThreads | 8 | Integer | To set a value for minimum number of threads in HttpClient thread pool. This setting override any setting configured on component level. Notice that both a min and max size must be configured. If not set it default to min 8 threads used in Jettys thread pool. + +| httpMethod | | HttpMethods | Configure the HTTP method to use. The HttpMethod header cannot override this option if set. + +| ignoreResponseBody | false | boolean | If this option is true The http producer won't read response body and cache the input stream + +| preserveHostHeader | false | boolean | If the option is true HttpProducer will set the Host header to the value contained in the current exchange Host header useful in reverse proxy applications where you want the Host header received by the downstream server to reflect the URL called by the upstream client this allows applications which use the Host header to generate accurate URL's for a proxied service + +| throwExceptionOnFailure | true | boolean | Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code. + 4+^s| producer (advanced) +| httpClient | | HttpClient | Sets a shared HttpClient to use for all producers created by this endpoint. By default each producer will use a new http client and not share. Important: Make sure to handle the lifecycle of the shared client such as stopping the client when it is no longer in use. Camel will call the start method on the client to ensure its started when this endpoint creates a producer. This options should only be used in special circumstances. + +| httpClientParameters | | Map | Configuration of Jetty's HttpClient. For example setting httpClient.idleTimeout=30000 sets the idle timeout to 30 seconds. And httpClient.timeout=30000 sets the request timeout to 30 seconds in case you want to timeout sooner if you have long running request/response calls. + +| jettyBinding | | JettyHttpBinding | To use a custom JettyHttpBinding which be used to customize how a response should be written for the producer. + +| jettyBindingRef | | String | To use a custom JettyHttpBinding which be used to customize how a response should be written for the producer. + +| okStatusCodeRange | 200-299 | String | The status codes which is considered a success response. The values are inclusive. The range must be defined as from-to with the dash included. + +| urlRewrite | | UrlRewrite | Refers to a custom org.apache.camel.component.http.UrlRewrite which allows you to rewrite urls when you bridge/proxy endpoints. See more details at http://camel.apache.org/urlrewrite.html + 4+^s| advanced +| mapHttpMessageBody | true | boolean | If this option is true then IN exchange Body of the exchange will be mapped to HTTP body. Setting this to false will avoid the HTTP mapping. + +| mapHttpMessageFormUrlEncodedBody | true | boolean | If this option is true then IN exchange Form Encoded body of the exchange will be mapped to HTTP. Setting this to false will avoid the HTTP Form Encoded body mapping. + +| mapHttpMessageHeaders | true | boolean | If this option is true then IN exchange Headers of the exchange will be mapped to HTTP headers. Setting this to false will avoid the HTTP Headers mapping. + +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). + 4+^s| proxy +| proxyAuthScheme | | String | Proxy authentication scheme to use + +| proxyHost | | String | Proxy hostname to use + +| proxyPort | | int | Proxy port to use + 4+^s| security +| authHost | | String | Authentication host to use with NTML + +| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters + +| sslContextParametersRef | | String | To configure security using SSLContextParameters |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-jgroups/src/main/docs/jgroups-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jgroups/src/main/docs/jgroups-component.adoc b/components/camel-jgroups/src/main/docs/jgroups-component.adoc index 7481e2e..40ec9a9 100644 --- a/components/camel-jgroups/src/main/docs/jgroups-component.adoc +++ b/components/camel-jgroups/src/main/docs/jgroups-component.adoc @@ -53,13 +53,17 @@ The JGroups component supports 4 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| channel | common | | JChannel | Channel to use -| channelProperties | common | | String | Specifies configuration properties of the JChannel used by the endpoint. -| enableViewMessages | consumer | false | boolean | If set to true the consumer endpoint will receive org.jgroups.View messages as well (not only org.jgroups.Message instances). By default only regular messages are consumed by the endpoint. -| resolvePropertyPlaceholders | advanced | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Default | Java Type | Description + 4+^s| common +| channel | | JChannel | Channel to use + +| channelProperties | | String | Specifies configuration properties of the JChannel used by the endpoint. + 4+^s| consumer +| enableViewMessages | false | boolean | If set to true the consumer endpoint will receive org.jgroups.View messages as well (not only org.jgroups.Message instances). By default only regular messages are consumed by the endpoint. + 4+^s| advanced +| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. |======================================================================= // component options: END @@ -85,15 +89,21 @@ with the following path and query parameters: #### Query Parameters (6 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| channelProperties | common | | String | Specifies configuration properties of the JChannel used by the endpoint. -| 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 or ERROR level and ignored. -| enableViewMessages | consumer | false | boolean | If set to true the consumer endpoint will receive org.jgroups.View messages as well (not only org.jgroups.Message instances). By default only regular messages are consumed by the endpoint. -| 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 or ERROR level and ignored. -| exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Default | Java Type | Description + +| channelProperties | | String | Specifies configuration properties of the JChannel used by the endpoint. + 4+^s| consumer +| bridgeErrorHandler | 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 or ERROR level and ignored. + +| enableViewMessages | false | boolean | If set to true the consumer endpoint will receive org.jgroups.View messages as well (not only org.jgroups.Message instances). By default only regular messages are consumed by the endpoint. + 4+^s| consumer (advanced) +| exceptionHandler | | 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 or ERROR level and ignored. + +| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. + 4+^s| advanced +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-jing/src/main/docs/jing-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jing/src/main/docs/jing-component.adoc b/components/camel-jing/src/main/docs/jing-component.adoc index 3519a6f..4a49314 100644 --- a/components/camel-jing/src/main/docs/jing-component.adoc +++ b/components/camel-jing/src/main/docs/jing-component.adoc @@ -63,11 +63,13 @@ with the following path and query parameters: #### Query Parameters (2 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| compactSyntax | producer | false | boolean | Whether to validate using RelaxNG compact syntax or not. By default this is false for using RelaxNG XML Syntax (rng) And true is for using RelaxNG Compact Syntax (rnc) -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Default | Java Type | Description + +| compactSyntax | false | boolean | Whether to validate using RelaxNG compact syntax or not. By default this is false for using RelaxNG XML Syntax (rng) And true is for using RelaxNG Compact Syntax (rnc) + 4+^s| advanced +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-jira/src/main/docs/jira-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jira/src/main/docs/jira-component.adoc b/components/camel-jira/src/main/docs/jira-component.adoc index 71e10ce..f448508 100644 --- a/components/camel-jira/src/main/docs/jira-component.adoc +++ b/components/camel-jira/src/main/docs/jira-component.adoc @@ -65,18 +65,27 @@ with the following path and query parameters: #### Query Parameters (9 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| password | common | | String | Password for login -| serverUrl | common | | String | *Required* URL to the JIRA server -| username | common | | String | Username for login -| 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 or ERROR level and ignored. -| delay | consumer | 6000 | int | Delay in seconds when querying JIRA using the consumer. -| jql | consumer | | String | JQL is the query language from JIRA which allows you to retrieve the data you want. For example jql=project=MyProject Where MyProject is the product key in Jira. -| 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 or ERROR level and ignored. -| exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Default | Java Type | Description + +| password | | String | Password for login + +| serverUrl | | String | *Required* URL to the JIRA server + +| username | | String | Username for login + 4+^s| consumer +| bridgeErrorHandler | 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 or ERROR level and ignored. + +| delay | 6000 | int | Delay in seconds when querying JIRA using the consumer. + +| jql | | String | JQL is the query language from JIRA which allows you to retrieve the data you want. For example jql=project=MyProject Where MyProject is the product key in Jira. + 4+^s| consumer (advanced) +| exceptionHandler | | 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 or ERROR level and ignored. + +| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. + 4+^s| advanced +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= // endpoint options: END
