camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From davscl...@apache.org
Subject [28/31] camel git commit: Component docs - Adjust tables to have group label span column which makes more room to show the description as there is one row less.
Date Fri, 17 Mar 2017 10:28:46 GMT
http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-ahc-ws/src/main/docs/ahc-ws-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-ahc-ws/src/main/docs/ahc-ws-component.adoc b/components/camel-ahc-ws/src/main/docs/ahc-ws-component.adoc
index f02fffd..627c379 100644
--- a/components/camel-ahc-ws/src/main/docs/ahc-ws-component.adoc
+++ b/components/camel-ahc-ws/src/main/docs/ahc-ws-component.adoc
@@ -45,16 +45,23 @@ The AHC Websocket component supports 7 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
-| client | advanced |  | AsyncHttpClient | To use a custom AsyncHttpClient
-| binding | advanced |  | AhcBinding | To use a custom AhcBinding which allows to control
how to bind between AHC and Camel.
-| clientConfig | advanced |  | AsyncHttpClientConfig | To configure the AsyncHttpClient to
use a custom com.ning.http.client.AsyncHttpClientConfig instance.
-| sslContextParameters | security |  | SSLContextParameters | Reference to a org.apache.camel.util.jsse.SSLContextParameters
in the Registry. Note that configuring this option will override any SSL/TLS configuration
options provided through the clientConfig option at the endpoint or component level.
-| 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| advanced
+| client |  | AsyncHttpClient | To use a custom AsyncHttpClient
+
+| binding |  | AhcBinding | To use a custom AhcBinding which allows to control how to bind
between AHC and Camel.
+
+| clientConfig |  | AsyncHttpClientConfig | To configure the AsyncHttpClient to use a custom
com.ning.http.client.AsyncHttpClientConfig instance.
+ 4+^s| security
+| sslContextParameters |  | SSLContextParameters | Reference to a org.apache.camel.util.jsse.SSLContextParameters
in the Registry. Note that configuring this option will override any SSL/TLS configuration
options provided through the clientConfig option at the endpoint or component level.
+ 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
 
@@ -78,27 +85,45 @@ with the following path and query parameters:
 
 #### Query Parameters (18 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
-| bridgeEndpoint | common | false | boolean | If the option is true then the Exchange.HTTP_URI
header is ignored and use the endpoint's URI for request. You may also set the throwExceptionOnFailure
to be false to let the AhcProducer send all the fault response back.
-| bufferSize | common | 4096 | int | The initial in-memory buffer size used when transferring
data between Camel and AHC Client.
-| headerFilterStrategy | common |  | HeaderFilterStrategy | To use a custom HeaderFilterStrategy
to filter header to and from Camel message.
-| throwExceptionOnFailure | common | true | boolean | Option to disable throwing the AhcOperationFailedException
in case of failed responses from the remote server. This allows you to get all responses regardless
of the HTTP status code.
-| 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 (for example using Jetty or Servlet
Camel components). On the producer side the exception will be deserialized and thrown as is
instead of the AhcOperationFailedException. 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.
-| 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.
-| sendMessageOnError | consumer | false | boolean | Whether to send an message if the web-socket
listener received an error.
-| 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.
-| connectionClose | producer | false | boolean | Define if the Connection Close header has
to be added to HTTP Request. This parameter is false by default
-| cookieHandler | producer |  | CookieHandler | Configure a cookie handler to maintain a
HTTP session
-| useStreaming | producer | false | boolean | To enable streaming to send data as multiple
text fragments.
-| binding | advanced |  | AhcBinding | To use a custom AhcBinding which allows to control
how to bind between AHC and Camel.
-| clientConfig | advanced |  | AsyncHttpClientConfig | To configure the AsyncHttpClient to
use a custom com.ning.http.client.AsyncHttpClientConfig instance.
-| clientConfigOptions | advanced |  | Map | To configure the AsyncHttpClientConfig using
the key/values from the Map.
-| synchronous | advanced | false | boolean | Sets whether synchronous processing should be
strictly used or Camel is allowed to use asynchronous processing (if supported).
-| clientConfigRealmOptions | security |  | Map | To configure the AsyncHttpClientConfig Realm
using the key/values from the Map.
-| sslContextParameters | security |  | SSLContextParameters | Reference to a org.apache.camel.util.jsse.SSLContextParameters
in the Registry. This reference overrides any configured SSLContextParameters at the component
level. See Using the JSSE Configuration Utility. Note that configuring this option will override
any SSL/TLS configuration options provided through the clientConfig option at the endpoint
or component level.
+| Name | Default | Java Type | Description
+
+| bridgeEndpoint | false | boolean | If the option is true then the Exchange.HTTP_URI header
is ignored and use the endpoint's URI for request. You may also set the throwExceptionOnFailure
to be false to let the AhcProducer send all the fault response back.
+
+| bufferSize | 4096 | int | The initial in-memory buffer size used when transferring data
between Camel and AHC Client.
+
+| headerFilterStrategy |  | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to
filter header to and from Camel message.
+
+| throwExceptionOnFailure | true | boolean | Option to disable throwing the AhcOperationFailedException
in case of failed responses from the remote server. This allows you to get all responses regardless
of the HTTP status code.
+
+| 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 (for example using Jetty or Servlet Camel components). On the producer side the
exception will be deserialized and thrown as is instead of the AhcOperationFailedException.
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| 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.
+
+| sendMessageOnError | false | boolean | Whether to send an message if the web-socket listener
received an error.
+ 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| producer
+| connectionClose | false | boolean | Define if the Connection Close header has to be added
to HTTP Request. This parameter is false by default
+
+| cookieHandler |  | CookieHandler | Configure a cookie handler to maintain a HTTP session
+
+| useStreaming | false | boolean | To enable streaming to send data as multiple text fragments.
+ 4+^s| advanced
+| binding |  | AhcBinding | To use a custom AhcBinding which allows to control how to bind
between AHC and Camel.
+
+| clientConfig |  | AsyncHttpClientConfig | To configure the AsyncHttpClient to use a custom
com.ning.http.client.AsyncHttpClientConfig instance.
+
+| clientConfigOptions |  | Map | To configure the AsyncHttpClientConfig using the key/values
from the Map.
+
+| synchronous | false | boolean | Sets whether synchronous processing should be strictly
used or Camel is allowed to use asynchronous processing (if supported).
+ 4+^s| security
+| clientConfigRealmOptions |  | Map | To configure the AsyncHttpClientConfig Realm using
the key/values from the Map.
+
+| sslContextParameters |  | SSLContextParameters | Reference to a org.apache.camel.util.jsse.SSLContextParameters
in the Registry. This reference overrides any configured SSLContextParameters at the component
level. See Using the JSSE Configuration Utility. Note that configuring this option will override
any SSL/TLS configuration options provided through the clientConfig option at the endpoint
or component level.
 |=======================================================================
 // endpoint options: END
 

http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-ahc/src/main/docs/ahc-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-ahc/src/main/docs/ahc-component.adoc b/components/camel-ahc/src/main/docs/ahc-component.adoc
index 03edd6d..9b06f24 100644
--- a/components/camel-ahc/src/main/docs/ahc-component.adoc
+++ b/components/camel-ahc/src/main/docs/ahc-component.adoc
@@ -60,22 +60,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
-| bridgeEndpoint | producer | false | boolean | If the option is true then the Exchange.HTTP_URI
header is ignored and use the endpoint's URI for request. You may also set the throwExceptionOnFailure
to be false to let the AhcProducer send all the fault response back.
-| bufferSize | producer | 4096 | int | The initial in-memory buffer size used when transferring
data between Camel and AHC Client.
-| connectionClose | producer | false | boolean | Define if the Connection Close header has
to be added to HTTP Request. This parameter is false by default
-| cookieHandler | producer |  | CookieHandler | Configure a cookie handler to maintain a
HTTP session
-| headerFilterStrategy | producer |  | HeaderFilterStrategy | To use a custom HeaderFilterStrategy
to filter header to and from Camel message.
-| throwExceptionOnFailure | producer | true | boolean | Option to disable throwing the AhcOperationFailedException
in case of failed responses from the remote server. This allows you to get all responses regardless
of the HTTP status code.
-| transferException | producer | 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 (for example using Jetty or Servlet
Camel components). On the producer side the exception will be deserialized and thrown as is
instead of the AhcOperationFailedException. 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.
-| binding | advanced |  | AhcBinding | To use a custom AhcBinding which allows to control
how to bind between AHC and Camel.
-| clientConfig | advanced |  | AsyncHttpClientConfig | To configure the AsyncHttpClient to
use a custom com.ning.http.client.AsyncHttpClientConfig instance.
-| clientConfigOptions | advanced |  | Map | To configure the AsyncHttpClientConfig using
the key/values from the Map.
-| synchronous | advanced | false | boolean | Sets whether synchronous processing should be
strictly used or Camel is allowed to use asynchronous processing (if supported).
-| clientConfigRealmOptions | security |  | Map | To configure the AsyncHttpClientConfig Realm
using the key/values from the Map.
-| sslContextParameters | security |  | SSLContextParameters | Reference to a org.apache.camel.util.jsse.SSLContextParameters
in the Registry. This reference overrides any configured SSLContextParameters at the component
level. See Using the JSSE Configuration Utility. Note that configuring this option will override
any SSL/TLS configuration options provided through the clientConfig option at the endpoint
or component level.
+| Name | Default | Java Type | Description
+
+| bridgeEndpoint | false | boolean | If the option is true then the Exchange.HTTP_URI header
is ignored and use the endpoint's URI for request. You may also set the throwExceptionOnFailure
to be false to let the AhcProducer send all the fault response back.
+
+| bufferSize | 4096 | int | The initial in-memory buffer size used when transferring data
between Camel and AHC Client.
+
+| connectionClose | false | boolean | Define if the Connection Close header has to be added
to HTTP Request. This parameter is false by default
+
+| cookieHandler |  | CookieHandler | Configure a cookie handler to maintain a HTTP session
+
+| headerFilterStrategy |  | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to
filter header to and from Camel message.
+
+| throwExceptionOnFailure | true | boolean | Option to disable throwing the AhcOperationFailedException
in case of failed responses from the remote server. This allows you to get all responses regardless
of the HTTP status code.
+
+| 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 (for example using Jetty or Servlet Camel components). On the producer side the
exception will be deserialized and thrown as is instead of the AhcOperationFailedException.
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| advanced
+| binding |  | AhcBinding | To use a custom AhcBinding which allows to control how to bind
between AHC and Camel.
+
+| clientConfig |  | AsyncHttpClientConfig | To configure the AsyncHttpClient to use a custom
com.ning.http.client.AsyncHttpClientConfig instance.
+
+| clientConfigOptions |  | Map | To configure the AsyncHttpClientConfig using the key/values
from the Map.
+
+| synchronous | false | boolean | Sets whether synchronous processing should be strictly
used or Camel is allowed to use asynchronous processing (if supported).
+ 4+^s| security
+| clientConfigRealmOptions |  | Map | To configure the AsyncHttpClientConfig Realm using
the key/values from the Map.
+
+| sslContextParameters |  | SSLContextParameters | Reference to a org.apache.camel.util.jsse.SSLContextParameters
in the Registry. This reference overrides any configured SSLContextParameters at the component
level. See Using the JSSE Configuration Utility. Note that configuring this option will override
any SSL/TLS configuration options provided through the clientConfig option at the endpoint
or component level.
 |=======================================================================
 // endpoint options: END
 
@@ -101,16 +114,23 @@ The AHC component supports 7 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
-| client | advanced |  | AsyncHttpClient | To use a custom AsyncHttpClient
-| binding | advanced |  | AhcBinding | To use a custom AhcBinding which allows to control
how to bind between AHC and Camel.
-| clientConfig | advanced |  | AsyncHttpClientConfig | To configure the AsyncHttpClient to
use a custom com.ning.http.client.AsyncHttpClientConfig instance.
-| sslContextParameters | security |  | SSLContextParameters | Reference to a org.apache.camel.util.jsse.SSLContextParameters
in the Registry. Note that configuring this option will override any SSL/TLS configuration
options provided through the clientConfig option at the endpoint or component level.
-| 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| advanced
+| client |  | AsyncHttpClient | To use a custom AsyncHttpClient
+
+| binding |  | AhcBinding | To use a custom AhcBinding which allows to control how to bind
between AHC and Camel.
+
+| clientConfig |  | AsyncHttpClientConfig | To configure the AsyncHttpClient to use a custom
com.ning.http.client.AsyncHttpClientConfig instance.
+ 4+^s| security
+| sslContextParameters |  | SSLContextParameters | Reference to a org.apache.camel.util.jsse.SSLContextParameters
in the Registry. Note that configuring this option will override any SSL/TLS configuration
options provided through the clientConfig option at the endpoint or component level.
+ 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
 


Mime
View raw message