Updated camel-cometd docs, by enabling options documentation automatic upgrade
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/6f3e8d29 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/6f3e8d29 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/6f3e8d29 Branch: refs/heads/master Commit: 6f3e8d29dfb514b77ec7a07992267dfe35e7a257 Parents: 720e76d Author: Andrea Cosentino <anco...@gmail.com> Authored: Thu Apr 21 14:47:19 2016 +0200 Committer: Andrea Cosentino <anco...@gmail.com> Committed: Thu Apr 21 15:18:41 2016 +0200 ---------------------------------------------------------------------- .../camel-cometd/src/main/docs/cometd.adoc | 77 ++++++++++---------- 1 file changed, 39 insertions(+), 38 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/6f3e8d29/components/camel-cometd/src/main/docs/cometd.adoc ---------------------------------------------------------------------- diff --git a/components/camel-cometd/src/main/docs/cometd.adoc b/components/camel-cometd/src/main/docs/cometd.adoc index 01cf2d6..efb4dca 100644 --- a/components/camel-cometd/src/main/docs/cometd.adoc +++ b/components/camel-cometd/src/main/docs/cometd.adoc @@ -49,54 +49,55 @@ where `cometds:` represents an SSL configured endpoint. [[Cometd-Options]] Options ^^^^^^^ -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Name |Default Value |Description - -|`resourceBase` | | The root directory for the web resources or classpath. Use the protocol -file: or classpath: depending if you want that the component loads the -resource from file system or classpath. Classpath is required for OSGI -deployment where the resources are packaged in the jar. Notice this -option has been renamed to `baseResource` from *Camel 2.7* onwards. - -|`baseResource` | | *Camel 2.7:* The root directory for the web resources or classpath. Use -the protocol file: or classpath: depending if you want that the -component loads the resource from file system or classpath. Classpath is -required for OSGI deployment where the resources are packaged in the jar - -|`timeout` |`240000` |The server side poll timeout in milliseconds. This is how long the -server will hold a reconnect request before responding. -|`interval` |`0` |The client side poll timeout in milliseconds. How long a client will -wait between reconnects -|`maxInterval` |`30000` |The max client side poll timeout in milliseconds. A client will be -removed if a connection is not received in this time. +// component options: START +The CometD component supports 6 options which are listed below. -|`multiFrameInterval` |`1500` |The client side poll timeout, if multiple connections are detected from -the same browser. -|`jsonCommented` |`true` |If `true`, the server will accept JSON wrapped in a comment and will -generate JSON wrapped in a comment. This is a defence against Ajax -Hijacking. -|`logLevel` |`1` |`0`=none, `1`=info, `2`=debug. +[width="100%",cols="2s,1m,8",options="header"] +|======================================================================= +| Name | Java Type | Description +| sslKeyPassword | String | The password for the keystore when using SSL. +| sslPassword | String | The password when using SSL. +| sslKeystore | String | The path to the keystore. +| securityPolicy | SecurityPolicy | To use a custom configured SecurityPolicy to control authorization +| extensions | List | To use a list of custom BayeuxServer.Extension that allows modifying incoming and outgoing requests. +| sslContextParameters | SSLContextParameters | To configure security using SSLContextParameters +|======================================================================= +// component options: END -|`crossOriginFilterOn` |`false` |*Camel 2.10:* If `true`, the server will support for cross-domain -filtering -|`allowedOrigins` |`*` |*Camel 2.10:* The origins domain that support to cross, if the -`crosssOriginFilterOn` is `true` -|`filterPath` | | *Camel 2.10:* The filterPath will be used by the CrossOriginFilter, if -the `crosssOriginFilterOn` is `true` +// endpoint options: START +The CometD component supports 19 endpoint options which are listed below: -|`disconnectLocalSession` | | *Camel 2.10.5/2.11.1: (Producer only)*: Whether to disconnect local -sessions after publishing a message to its channel. Disconnecting local -session is needed as they are not swept by default by CometD, and -therefore you can run out of memory. In Camel 2.16.1/2.15.5 or older the -default value is true. From newer versions the default value is false. +[width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= +| Name | Group | Default | Java Type | Description +| host | common | | String | *Required* Hostname +| port | common | | int | *Required* Host port number +| channelName | common | | String | *Required* The channelName represents a topic that can be subscribed to by the Camel endpoints. +| allowedOrigins | common | * | String | The origins domain that support to cross if the crosssOriginFilterOn is true +| baseResource | common | | String | The root directory for the web resources or classpath. Use the protocol file: or classpath: depending if you want that the component loads the resource from file system or classpath. Classpath is required for OSGI deployment where the resources are packaged in the jar +| crossOriginFilterOn | common | false | boolean | If true the server will support for cross-domain filtering +| filterPath | common | | String | The filterPath will be used by the CrossOriginFilter if the crosssOriginFilterOn is true +| interval | common | | int | The client side poll timeout in milliseconds. How long a client will wait between reconnects +| jsonCommented | common | true | boolean | If true the server will accept JSON wrapped in a comment and will generate JSON wrapped in a comment. This is a defence against Ajax Hijacking. +| logLevel | common | 1 | int | Logging level. 0=none 1=info 2=debug. +| maxInterval | common | 30000 | int | The max client side poll timeout in milliseconds. A client will be removed if a connection is not received in this time. +| multiFrameInterval | common | 1500 | int | The client side poll timeout if multiple connections are detected from the same browser. +| timeout | common | 240000 | int | The server side poll timeout in milliseconds. This is how long the server will hold a reconnect request before responding. +| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. +| sessionHeadersEnabled | consumer | false | boolean | Whether to include the server session headers in the Camel message when creating a Camel Message for incoming requests. +| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. +| disconnectLocalSession | producer | false | boolean | Whether to disconnect local sessions after publishing a message to its channel. Disconnecting local session is needed as they are not swept by default by CometD and therefore you can run out of memory. +| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange +| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +|======================================================================= +// endpoint options: END + You can append query options to the URI in the following format, `?option=value&option=value&...`
