http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-etcd/src/main/docs/etcd-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-etcd/src/main/docs/etcd-component.adoc b/components/camel-etcd/src/main/docs/etcd-component.adoc index aca5019..182b9d1 100644 --- a/components/camel-etcd/src/main/docs/etcd-component.adoc +++ b/components/camel-etcd/src/main/docs/etcd-component.adoc @@ -1,4 +1,4 @@ -## etcd Component +== etcd Component *Available as of Camel version 2.18* @@ -19,67 +19,69 @@ The etcd component supports 7 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **uris** (common) | To set the URIs the client connects. | | String -| **sslContextParameters** (common) | To configure security using SSLContextParameters. | | SSLContextParameters -| **userName** (common) | The user name to use for basic authentication. | | String -| **password** (common) | The password to use for basic authentication. | | String -| **configuration** (advanced) | Sets the common configuration shared among endpoints | | EtcdConfiguration -| **useGlobalSslContext Parameters** (security) | Enable usage of global SSL context parameters. | false | boolean -| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean -|======================================================================= +| *uris* (common) | To set the URIs the client connects. | | String +| *sslContextParameters* (common) | To configure security using SSLContextParameters. | | SSLContextParameters +| *userName* (common) | The user name to use for basic authentication. | | String +| *password* (common) | The password to use for basic authentication. | | String +| *configuration* (advanced) | Sets the common configuration shared among endpoints | | EtcdConfiguration +| *useGlobalSslContext Parameters* (security) | Enable usage of global SSL context parameters. | false | boolean +| *resolveProperty Placeholders* (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean +|=== // component options: END // endpoint options: START The etcd endpoint is configured using URI syntax: - etcd:namespace/path +---- +etcd:namespace/path +---- with the following path and query parameters: -#### Path Parameters (2 parameters): +==== Path Parameters (2 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **namespace** | *Required* The API namespace to use | | EtcdNamespace -| **path** | The path the endpoint refers to | | String -|======================================================================= +| *namespace* | *Required* The API namespace to use | | EtcdNamespace +| *path* | The path the endpoint refers to | | String +|=== -#### Query Parameters (29 parameters): +==== Query Parameters (29 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **recursive** (common) | To apply an action recursively. | false | boolean -| **servicePath** (common) | The path to look for for service discovery | /services/ | String -| **timeout** (common) | To set the maximum time an action could take to complete. | | Long -| **uris** (common) | To set the URIs the client connects. | http://localhost:2379,http://localhost:4001 | String -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean -| **sendEmptyExchangeOnTimeout** (consumer) | To send an empty message in case of timeout watching for a key. | false | boolean -| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean -| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern -| **fromIndex** (consumer) | The index to watch from | 0 | Long -| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy -| **timeToLive** (producer) | To set the lifespan of a key in milliseconds. | | Integer -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int -| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int -| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int -| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long -| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean -| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long -| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel -| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service -| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler -| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map -| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean -| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit -| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean -| **password** (security) | The password to use for basic authentication. | | String -| **sslContextParameters** (security) | To configure security using SSLContextParameters. | | SSLContextParameters -| **userName** (security) | The user name to use for basic authentication. | | String -|======================================================================= +| *recursive* (common) | To apply an action recursively. | false | boolean +| *servicePath* (common) | The path to look for for service discovery | /services/ | String +| *timeout* (common) | To set the maximum time an action could take to complete. | | Long +| *uris* (common) | To set the URIs the client connects. | http://localhost:2379,http://localhost:4001 | String +| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| *sendEmptyExchangeOnTimeout* (consumer) | To send an empty message in case of timeout watching for a key. | false | boolean +| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean +| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *fromIndex* (consumer) | The index to watch from | 0 | Long +| *pollStrategy* (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy +| *timeToLive* (producer) | To set the lifespan of a key in milliseconds. | | Integer +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int +| *backoffIdleThreshold* (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int +| *backoffMultiplier* (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int +| *delay* (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long +| *greedy* (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean +| *initialDelay* (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long +| *runLoggingLevel* (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel +| *scheduledExecutorService* (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service +| *scheduler* (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler +| *schedulerProperties* (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map +| *startScheduler* (scheduler) | Whether the scheduler should be auto started. | true | boolean +| *timeUnit* (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit +| *useFixedDelay* (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean +| *password* (security) | The password to use for basic authentication. | | String +| *sslContextParameters* (security) | To configure security using SSLContextParameters. | | SSLContextParameters +| *userName* (security) | The user name to use for basic authentication. | | String +|=== // endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-eventadmin/src/main/docs/eventadmin-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-eventadmin/src/main/docs/eventadmin-component.adoc b/components/camel-eventadmin/src/main/docs/eventadmin-component.adoc index 9fedc56..37908d4 100644 --- a/components/camel-eventadmin/src/main/docs/eventadmin-component.adoc +++ b/components/camel-eventadmin/src/main/docs/eventadmin-component.adoc @@ -1,4 +1,4 @@ -## OSGi EventAdmin Component +== OSGi EventAdmin Component *Available as of Camel version 2.6* @@ -38,39 +38,41 @@ The OSGi EventAdmin component supports 2 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **bundleContext** (common) | The OSGi BundleContext is automatic injected by Camel | | BundleContext -| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean -|======================================================================= +| *bundleContext* (common) | The OSGi BundleContext is automatic injected by Camel | | BundleContext +| *resolveProperty Placeholders* (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean +|=== // component options: END // endpoint options: START The OSGi EventAdmin endpoint is configured using URI syntax: - eventadmin:topic +---- +eventadmin:topic +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **topic** | Name of topic to listen or send to | | String -|======================================================================= +| *topic* | Name of topic to listen or send to | | String +|=== -#### Query Parameters (5 parameters): +==== Query Parameters (5 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **send** (common) | Whether to use 'send' or 'synchronous' deliver. Default false (async delivery) | false | boolean -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean -| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *send* (common) | Whether to use 'send' or 'synchronous' deliver. Default false (async delivery) | false | boolean +| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END ### Message headers http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-exec/src/main/docs/exec-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-exec/src/main/docs/exec-component.adoc b/components/camel-exec/src/main/docs/exec-component.adoc index 57b952f..a4c31b0 100644 --- a/components/camel-exec/src/main/docs/exec-component.adoc +++ b/components/camel-exec/src/main/docs/exec-component.adoc @@ -1,4 +1,4 @@ -## Exec Component +== Exec Component *Available as of Camel version 2.3* @@ -40,32 +40,34 @@ The Exec component has no options. // endpoint options: START The Exec endpoint is configured using URI syntax: - exec:executable +---- +exec:executable +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **executable** | *Required* Sets the executable to be executed. The executable must not be empty or null. | | String -|======================================================================= +| *executable* | *Required* Sets the executable to be executed. The executable must not be empty or null. | | String +|=== -#### Query Parameters (8 parameters): +==== Query Parameters (8 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **args** (producer) | The arguments may be one or many whitespace-separated tokens. | | String -| **binding** (producer) | A reference to a org.apache.commons.exec.ExecBinding in the Registry. | | ExecBinding -| **commandExecutor** (producer) | A reference to a org.apache.commons.exec.ExecCommandExecutor in the Registry that customizes the command execution. The default command executor utilizes the commons-exec library which adds a shutdown hook for every executed command. | | ExecCommandExecutor -| **outFile** (producer) | The name of a file created by the executable that should be considered as its output. If no outFile is set the standard output (stdout) of the executable will be used instead. | | String -| **timeout** (producer) | The timeout in milliseconds after which the executable should be terminated. If execution has not completed within the timeout the component will send a termination request. | | long -| **useStderrOnEmptyStdout** (producer) | A boolean indicating that when stdout is empty this component will populate the Camel Message Body with stderr. This behavior is disabled (false) by default. | false | boolean -| **workingDir** (producer) | The directory in which the command should be executed. If null the working directory of the current process will be used. | | String -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *args* (producer) | The arguments may be one or many whitespace-separated tokens. | | String +| *binding* (producer) | A reference to a org.apache.commons.exec.ExecBinding in the Registry. | | ExecBinding +| *commandExecutor* (producer) | A reference to a org.apache.commons.exec.ExecCommandExecutor in the Registry that customizes the command execution. The default command executor utilizes the commons-exec library which adds a shutdown hook for every executed command. | | ExecCommandExecutor +| *outFile* (producer) | The name of a file created by the executable that should be considered as its output. If no outFile is set the standard output (stdout) of the executable will be used instead. | | String +| *timeout* (producer) | The timeout in milliseconds after which the executable should be terminated. If execution has not completed within the timeout the component will send a termination request. | | long +| *useStderrOnEmptyStdout* (producer) | A boolean indicating that when stdout is empty this component will populate the Camel Message Body with stderr. This behavior is disabled (false) by default. | false | boolean +| *workingDir* (producer) | The directory in which the command should be executed. If null the working directory of the current process will be used. | | String +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END ### Message headers http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-facebook/src/main/docs/facebook-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-facebook/src/main/docs/facebook-component.adoc b/components/camel-facebook/src/main/docs/facebook-component.adoc index ad65096..8e75347 100644 --- a/components/camel-facebook/src/main/docs/facebook-component.adoc +++ b/components/camel-facebook/src/main/docs/facebook-component.adoc @@ -1,4 +1,4 @@ -## Facebook Component +== Facebook Component *Available as of Camel version 2.14* @@ -57,11 +57,11 @@ The Facebook component supports 2 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **configuration** (advanced) | To use the shared configuration | | FacebookConfiguration -| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean -|======================================================================= +| *configuration* (advanced) | To use the shared configuration | | FacebookConfiguration +| *resolveProperty Placeholders* (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean +|=== // component options: END @@ -71,126 +71,128 @@ The Facebook component supports 2 options which are listed below. // endpoint options: START The Facebook endpoint is configured using URI syntax: - facebook:methodName +---- +facebook:methodName +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **methodName** | *Required* What operation to perform | | String -|======================================================================= +| *methodName* | *Required* What operation to perform | | String +|=== -#### Query Parameters (102 parameters): +==== Query Parameters (102 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **achievementURL** (common) | The unique URL of the achievement | | URL -| **albumId** (common) | The album ID | | String -| **albumUpdate** (common) | The facebook Album to be created or updated | | AlbumUpdate -| **appId** (common) | The ID of the Facebook Application | | String -| **center** (common) | Location latitude and longitude | | GeoLocation -| **checkinId** (common) | The checkin ID | | String -| **checkinUpdate** (common) | *Deprecated* The checkin to be created. Deprecated instead create a Post with an attached location | | CheckinUpdate -| **clientURL** (common) | Facebook4J API client URL | | String -| **clientVersion** (common) | Facebook4J client API version | | String -| **commentId** (common) | The comment ID | | String -| **commentUpdate** (common) | The facebook Comment to be created or updated | | CommentUpdate -| **debugEnabled** (common) | Enables deubg output. Effective only with the embedded logger | false | Boolean -| **description** (common) | The description text | | String -| **distance** (common) | Distance in meters | | Integer -| **domainId** (common) | The domain ID | | String -| **domainName** (common) | The domain name | | String -| **domainNames** (common) | The domain names | | List -| **eventId** (common) | The event ID | | String -| **eventUpdate** (common) | The event to be created or updated | | EventUpdate -| **friendId** (common) | The friend ID | | String -| **friendlistId** (common) | The friend list ID | | String -| **friendlistName** (common) | The friend list Name | | String -| **friendUserId** (common) | The friend user ID | | String -| **groupId** (common) | The group ID | | String -| **gzipEnabled** (common) | Use Facebook GZIP encoding | true | Boolean -| **httpConnectionTimeout** (common) | Http connection timeout in milliseconds | 20000 | Integer -| **httpDefaultMaxPerRoute** (common) | HTTP maximum connections per route | 2 | Integer -| **httpMaxTotalConnections** (common) | HTTP maximum total connections | 20 | Integer -| **httpReadTimeout** (common) | Http read timeout in milliseconds | 120000 | Integer -| **httpRetryCount** (common) | Number of HTTP retries | 0 | Integer -| **httpRetryIntervalSeconds** (common) | HTTP retry interval in seconds | 5 | Integer -| **httpStreamingReadTimeout** (common) | HTTP streaming read timeout in milliseconds | 40000 | Integer -| **ids** (common) | The ids of users | | List -| **inBody** (common) | Sets the name of a parameter to be passed in the exchange In Body | | String -| **includeRead** (common) | Enables notifications that the user has already read in addition to unread ones | | Boolean -| **isHidden** (common) | Whether hidden | | Boolean -| **jsonStoreEnabled** (common) | If set to true raw JSON forms will be stored in DataObjectFactory | false | Boolean -| **link** (common) | Link URL | | URL -| **linkId** (common) | Link ID | | String -| **locale** (common) | Desired FQL locale | | Locale -| **mbeanEnabled** (common) | If set to true Facebook4J mbean will be registerd | false | Boolean -| **message** (common) | The message text | | String -| **messageId** (common) | The message ID | | String -| **metric** (common) | The metric name | | String -| **milestoneId** (common) | The milestone id | | String -| **name** (common) | Test user name must be of the form 'first last' | | String -| **noteId** (common) | The note ID | | String -| **notificationId** (common) | The notification ID | | String -| **objectId** (common) | The insight object ID | | String -| **offerId** (common) | The offer id | | String -| **optionDescription** (common) | The question's answer option description | | String -| **pageId** (common) | The page id | | String -| **permissionName** (common) | The permission name | | String -| **permissions** (common) | Test user permissions in the format perm1perm2... | | String -| **photoId** (common) | The photo ID | | String -| **pictureId** (common) | The picture id | | Integer -| **pictureId2** (common) | The picture2 id | | Integer -| **pictureSize** (common) | The picture size | | PictureSize -| **placeId** (common) | The place ID | | String -| **postId** (common) | The post ID | | String -| **postUpdate** (common) | The post to create or update | | PostUpdate -| **prettyDebugEnabled** (common) | Prettify JSON debug output if set to true | false | Boolean -| **queries** (common) | FQL queries | | Map -| **query** (common) | FQL query or search terms for search endpoints | | String -| **questionId** (common) | The question id | | String -| **reading** (common) | Optional reading parameters. See Reading Options(reading) | | Reading -| **readingOptions** (common) | To configure Reading using key/value pairs from the Map. | | Map -| **restBaseURL** (common) | API base URL | https://graph.facebook.com/ | String -| **scoreValue** (common) | The numeric score with value | | Integer -| **size** (common) | The picture size one of large normal small or square | | PictureSize -| **source** (common) | The media content from either a java.io.File or java.io.Inputstream | | Media -| **subject** (common) | The note of the subject | | String -| **tabId** (common) | The tab id | | String -| **tagUpdate** (common) | Photo tag information | | TagUpdate -| **testUser1** (common) | Test user 1 | | TestUser -| **testUser2** (common) | Test user 2 | | TestUser -| **testUserId** (common) | The ID of the test user | | String -| **title** (common) | The title text | | String -| **toUserId** (common) | The ID of the user to tag | | String -| **toUserIds** (common) | The IDs of the users to tag | | List -| **userId** (common) | The Facebook user ID | | String -| **userId1** (common) | The ID of a user 1 | | String -| **userId2** (common) | The ID of a user 2 | | String -| **userIds** (common) | The IDs of users to invite to event | | List -| **userLocale** (common) | The test user locale | | String -| **useSSL** (common) | Use SSL | true | Boolean -| **videoBaseURL** (common) | Video API base URL | https://graph-video.facebook.com/ | String -| **videoId** (common) | The video ID | | String -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean -| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **httpProxyHost** (proxy) | HTTP proxy server host name | | String -| **httpProxyPassword** (proxy) | HTTP proxy server password | | String -| **httpProxyPort** (proxy) | HTTP proxy server port | | Integer -| **httpProxyUser** (proxy) | HTTP proxy server user name | | String -| **oAuthAccessToken** (security) | The user access token | | String -| **oAuthAccessTokenURL** (security) | OAuth access token URL | https://graph.facebook.com/oauth/access_token | String -| **oAuthAppId** (security) | The application Id | | String -| **oAuthAppSecret** (security) | The application Secret | | String -| **oAuthAuthorizationURL** (security) | OAuth authorization URL | https://www.facebook.com/dialog/oauth | String -| **oAuthPermissions** (security) | Default OAuth permissions. Comma separated permission names. See https://developers.facebook.com/docs/reference/login/permissions for the detail | | String -|======================================================================= +| *achievementURL* (common) | The unique URL of the achievement | | URL +| *albumId* (common) | The album ID | | String +| *albumUpdate* (common) | The facebook Album to be created or updated | | AlbumUpdate +| *appId* (common) | The ID of the Facebook Application | | String +| *center* (common) | Location latitude and longitude | | GeoLocation +| *checkinId* (common) | The checkin ID | | String +| *checkinUpdate* (common) | *Deprecated* The checkin to be created. Deprecated instead create a Post with an attached location | | CheckinUpdate +| *clientURL* (common) | Facebook4J API client URL | | String +| *clientVersion* (common) | Facebook4J client API version | | String +| *commentId* (common) | The comment ID | | String +| *commentUpdate* (common) | The facebook Comment to be created or updated | | CommentUpdate +| *debugEnabled* (common) | Enables deubg output. Effective only with the embedded logger | false | Boolean +| *description* (common) | The description text | | String +| *distance* (common) | Distance in meters | | Integer +| *domainId* (common) | The domain ID | | String +| *domainName* (common) | The domain name | | String +| *domainNames* (common) | The domain names | | List +| *eventId* (common) | The event ID | | String +| *eventUpdate* (common) | The event to be created or updated | | EventUpdate +| *friendId* (common) | The friend ID | | String +| *friendlistId* (common) | The friend list ID | | String +| *friendlistName* (common) | The friend list Name | | String +| *friendUserId* (common) | The friend user ID | | String +| *groupId* (common) | The group ID | | String +| *gzipEnabled* (common) | Use Facebook GZIP encoding | true | Boolean +| *httpConnectionTimeout* (common) | Http connection timeout in milliseconds | 20000 | Integer +| *httpDefaultMaxPerRoute* (common) | HTTP maximum connections per route | 2 | Integer +| *httpMaxTotalConnections* (common) | HTTP maximum total connections | 20 | Integer +| *httpReadTimeout* (common) | Http read timeout in milliseconds | 120000 | Integer +| *httpRetryCount* (common) | Number of HTTP retries | 0 | Integer +| *httpRetryIntervalSeconds* (common) | HTTP retry interval in seconds | 5 | Integer +| *httpStreamingReadTimeout* (common) | HTTP streaming read timeout in milliseconds | 40000 | Integer +| *ids* (common) | The ids of users | | List +| *inBody* (common) | Sets the name of a parameter to be passed in the exchange In Body | | String +| *includeRead* (common) | Enables notifications that the user has already read in addition to unread ones | | Boolean +| *isHidden* (common) | Whether hidden | | Boolean +| *jsonStoreEnabled* (common) | If set to true raw JSON forms will be stored in DataObjectFactory | false | Boolean +| *link* (common) | Link URL | | URL +| *linkId* (common) | Link ID | | String +| *locale* (common) | Desired FQL locale | | Locale +| *mbeanEnabled* (common) | If set to true Facebook4J mbean will be registerd | false | Boolean +| *message* (common) | The message text | | String +| *messageId* (common) | The message ID | | String +| *metric* (common) | The metric name | | String +| *milestoneId* (common) | The milestone id | | String +| *name* (common) | Test user name must be of the form 'first last' | | String +| *noteId* (common) | The note ID | | String +| *notificationId* (common) | The notification ID | | String +| *objectId* (common) | The insight object ID | | String +| *offerId* (common) | The offer id | | String +| *optionDescription* (common) | The question's answer option description | | String +| *pageId* (common) | The page id | | String +| *permissionName* (common) | The permission name | | String +| *permissions* (common) | Test user permissions in the format perm1perm2... | | String +| *photoId* (common) | The photo ID | | String +| *pictureId* (common) | The picture id | | Integer +| *pictureId2* (common) | The picture2 id | | Integer +| *pictureSize* (common) | The picture size | | PictureSize +| *placeId* (common) | The place ID | | String +| *postId* (common) | The post ID | | String +| *postUpdate* (common) | The post to create or update | | PostUpdate +| *prettyDebugEnabled* (common) | Prettify JSON debug output if set to true | false | Boolean +| *queries* (common) | FQL queries | | Map +| *query* (common) | FQL query or search terms for search endpoints | | String +| *questionId* (common) | The question id | | String +| *reading* (common) | Optional reading parameters. See Reading Options(reading) | | Reading +| *readingOptions* (common) | To configure Reading using key/value pairs from the Map. | | Map +| *restBaseURL* (common) | API base URL | https://graph.facebook.com/ | String +| *scoreValue* (common) | The numeric score with value | | Integer +| *size* (common) | The picture size one of large normal small or square | | PictureSize +| *source* (common) | The media content from either a java.io.File or java.io.Inputstream | | Media +| *subject* (common) | The note of the subject | | String +| *tabId* (common) | The tab id | | String +| *tagUpdate* (common) | Photo tag information | | TagUpdate +| *testUser1* (common) | Test user 1 | | TestUser +| *testUser2* (common) | Test user 2 | | TestUser +| *testUserId* (common) | The ID of the test user | | String +| *title* (common) | The title text | | String +| *toUserId* (common) | The ID of the user to tag | | String +| *toUserIds* (common) | The IDs of the users to tag | | List +| *userId* (common) | The Facebook user ID | | String +| *userId1* (common) | The ID of a user 1 | | String +| *userId2* (common) | The ID of a user 2 | | String +| *userIds* (common) | The IDs of users to invite to event | | List +| *userLocale* (common) | The test user locale | | String +| *useSSL* (common) | Use SSL | true | Boolean +| *videoBaseURL* (common) | Video API base URL | https://graph-video.facebook.com/ | String +| *videoId* (common) | The video ID | | String +| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *httpProxyHost* (proxy) | HTTP proxy server host name | | String +| *httpProxyPassword* (proxy) | HTTP proxy server password | | String +| *httpProxyPort* (proxy) | HTTP proxy server port | | Integer +| *httpProxyUser* (proxy) | HTTP proxy server user name | | String +| *oAuthAccessToken* (security) | The user access token | | String +| *oAuthAccessTokenURL* (security) | OAuth access token URL | https://graph.facebook.com/oauth/access_token | String +| *oAuthAppId* (security) | The application Id | | String +| *oAuthAppSecret* (security) | The application Secret | | String +| *oAuthAuthorizationURL* (security) | OAuth authorization URL | https://www.facebook.com/dialog/oauth | String +| *oAuthPermissions* (security) | Default OAuth permissions. Comma separated permission names. See https://developers.facebook.com/docs/reference/login/permissions for the detail | | String +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-fastjson/src/main/docs/json-fastjson-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-fastjson/src/main/docs/json-fastjson-dataformat.adoc b/components/camel-fastjson/src/main/docs/json-fastjson-dataformat.adoc index 7792e08..fa2938e 100644 --- a/components/camel-fastjson/src/main/docs/json-fastjson-dataformat.adoc +++ b/components/camel-fastjson/src/main/docs/json-fastjson-dataformat.adoc @@ -1,4 +1,4 @@ -## JSon Fastjson DataFormat +== JSon Fastjson DataFormat *Available as of Camel version 2.20* @@ -21,7 +21,7 @@ The JSon Fastjson dataformat supports 17 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | objectMapper | | String | Lookup and use the existing ObjectMapper with the given id when using Jackson. | prettyPrint | false | Boolean | To enable pretty printing output nicely formatted. Is by default false. @@ -40,7 +40,7 @@ The JSon Fastjson dataformat supports 17 options which are listed below. | permissions | | String | Adds permissions that controls which Java packages and classes XStream is allowed to use during unmarshal from xml/json to Java beans. A permission must be configured either here or globally using a JVM system property. The permission can be specified in a syntax where a plus sign is allow and minus sign is deny. Wildcards is supported by using . as prefix. For example to allow com.foo and all subpackages then specfy com.foo.. Multiple permissions can be configured separated by comma such as com.foo.-com.foo.bar.MySecretBean. The following default permission is always included: -java.lang.java.util. unless its overridden by specifying a JVM system property with they key org.apache.camel.xstream.permissions. | allowUnmarshallType | false | Boolean | If enabled then Jackson is allowed to attempt to use the CamelJacksonUnmarshalType header during the unmarshalling. This should only be enabled when desired to be used. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML or application/json for data formats marshalling to JSon etc. -|======================================================================= +|=== // dataformat options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-flatpack/src/main/docs/flatpack-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-flatpack/src/main/docs/flatpack-component.adoc b/components/camel-flatpack/src/main/docs/flatpack-component.adoc index 5a48d6c..d4d36a5 100644 --- a/components/camel-flatpack/src/main/docs/flatpack-component.adoc +++ b/components/camel-flatpack/src/main/docs/flatpack-component.adoc @@ -1,4 +1,4 @@ -## Flatpack Component +== Flatpack Component *Available as of Camel version 1.4* @@ -47,50 +47,52 @@ The Flatpack component has no options. // endpoint options: START The Flatpack endpoint is configured using URI syntax: - flatpack:type:resourceUri +---- +flatpack:type:resourceUri +---- with the following path and query parameters: -#### Path Parameters (2 parameters): +==== Path Parameters (2 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **type** | Whether to use fixed or delimiter | delim | FlatpackType -| **resourceUri** | *Required* URL for loading the flatpack mapping file from classpath or file system | | String -|======================================================================= +| *type* | Whether to use fixed or delimiter | delim | FlatpackType +| *resourceUri* | *Required* URL for loading the flatpack mapping file from classpath or file system | | String +|=== -#### Query Parameters (25 parameters): +==== Query Parameters (25 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **allowShortLines** (common) | Allows for lines to be shorter than expected and ignores the extra characters | false | boolean -| **delimiter** (common) | The default character delimiter for delimited files. | , | char -| **ignoreExtraColumns** (common) | Allows for lines to be longer than expected and ignores the extra characters | false | boolean -| **ignoreFirstRecord** (common) | Whether the first line is ignored for delimited files (for the column headers). | true | boolean -| **splitRows** (common) | Sets the Component to send each row as a separate exchange once parsed | true | boolean -| **textQualifier** (common) | The text qualifier for delimited files. | | char -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean -| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean -| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern -| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int -| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int -| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int -| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long -| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean -| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long -| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel -| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service -| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler -| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map -| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean -| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit -| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean -|======================================================================= +| *allowShortLines* (common) | Allows for lines to be shorter than expected and ignores the extra characters | false | boolean +| *delimiter* (common) | The default character delimiter for delimited files. | , | char +| *ignoreExtraColumns* (common) | Allows for lines to be longer than expected and ignores the extra characters | false | boolean +| *ignoreFirstRecord* (common) | Whether the first line is ignored for delimited files (for the column headers). | true | boolean +| *splitRows* (common) | Sets the Component to send each row as a separate exchange once parsed | true | boolean +| *textQualifier* (common) | The text qualifier for delimited files. | | char +| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean +| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *pollStrategy* (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int +| *backoffIdleThreshold* (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int +| *backoffMultiplier* (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int +| *delay* (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long +| *greedy* (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean +| *initialDelay* (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long +| *runLoggingLevel* (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel +| *scheduledExecutorService* (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service +| *scheduler* (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler +| *schedulerProperties* (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map +| *startScheduler* (scheduler) | Whether the scheduler should be auto started. | true | boolean +| *timeUnit* (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit +| *useFixedDelay* (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean +|=== // endpoint options: END ### Examples http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-flatpack/src/main/docs/flatpack-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-flatpack/src/main/docs/flatpack-dataformat.adoc b/components/camel-flatpack/src/main/docs/flatpack-dataformat.adoc index 43f0431..c9e1fa8 100644 --- a/components/camel-flatpack/src/main/docs/flatpack-dataformat.adoc +++ b/components/camel-flatpack/src/main/docs/flatpack-dataformat.adoc @@ -1,4 +1,4 @@ -## Flatpack DataFormat +== Flatpack DataFormat *Available as of Camel version 2.1* @@ -26,7 +26,7 @@ The Flatpack dataformat supports 9 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | parserFactoryRef | | String | References to a custom parser factory to lookup in the registry | definition | | String | The flatpack pzmap configuration file. Can be omitted in simpler situations but its preferred to use the pzmap. @@ -37,7 +37,7 @@ The Flatpack dataformat supports 9 options which are listed below. | allowShortLines | false | Boolean | Allows for lines to be shorter than expected and ignores the extra characters | ignoreExtraColumns | false | Boolean | Allows for lines to be longer than expected and ignores the extra characters. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML or application/json for data formats marshalling to JSon etc. -|======================================================================= +|=== // dataformat options: END ### Usage http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-flink/src/main/docs/flink-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-flink/src/main/docs/flink-component.adoc b/components/camel-flink/src/main/docs/flink-component.adoc index c581d61..39afaf4 100644 --- a/components/camel-flink/src/main/docs/flink-component.adoc +++ b/components/camel-flink/src/main/docs/flink-component.adoc @@ -1,4 +1,4 @@ -## Apache Flink Component +== Apache Flink Component *Available as of Camel version 2.18* @@ -41,30 +41,32 @@ FlinkEndpoint Options // endpoint options: START The Apache Flink endpoint is configured using URI syntax: - flink:endpointType +---- +flink:endpointType +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **endpointType** | *Required* Type of the endpoint (dataset datastream). | | EndpointType -|======================================================================= +| *endpointType* | *Required* Type of the endpoint (dataset datastream). | | EndpointType +|=== -#### Query Parameters (6 parameters): +==== Query Parameters (6 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **collect** (producer) | Indicates if results should be collected or counted. | true | boolean -| **dataSet** (producer) | DataSet to compute against. | | DataSet -| **dataSetCallback** (producer) | Function performing action against a DataSet. | | DataSetCallback -| **dataStream** (producer) | DataStream to compute against. | | DataStream -| **dataStreamCallback** (producer) | Function performing action against a DataStream. | | DataStreamCallback -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *collect* (producer) | Indicates if results should be collected or counted. | true | boolean +| *dataSet* (producer) | DataSet to compute against. | | DataSet +| *dataSetCallback* (producer) | Function performing action against a DataSet. | | DataSetCallback +| *dataStream* (producer) | DataStream to compute against. | | DataStream +| *dataStreamCallback* (producer) | Function performing action against a DataStream. | | DataStreamCallback +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END @@ -80,14 +82,14 @@ The Apache Flink component supports 5 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **dataSet** (producer) | DataSet to compute against. | | DataSet -| **dataStream** (producer) | DataStream to compute against. | | DataStream -| **dataSetCallback** (producer) | Function performing action against a DataSet. | | DataSetCallback -| **dataStreamCallback** (producer) | Function performing action against a DataStream. | | DataStreamCallback -| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean -|======================================================================= +| *dataSet* (producer) | DataSet to compute against. | | DataSet +| *dataStream* (producer) | DataStream to compute against. | | DataStream +| *dataSetCallback* (producer) | Function performing action against a DataSet. | | DataSetCallback +| *dataStreamCallback* (producer) | Function performing action against a DataStream. | | DataStreamCallback +| *resolveProperty Placeholders* (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean +|=== // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-fop/src/main/docs/fop-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-fop/src/main/docs/fop-component.adoc b/components/camel-fop/src/main/docs/fop-component.adoc index 0b79ace..e20e7a3 100644 --- a/components/camel-fop/src/main/docs/fop-component.adoc +++ b/components/camel-fop/src/main/docs/fop-component.adoc @@ -1,4 +1,4 @@ -## FOP Component +== FOP Component *Available as of Camel version 2.10* @@ -70,27 +70,29 @@ The FOP component has no options. // endpoint options: START The FOP endpoint is configured using URI syntax: - fop:outputType +---- +fop:outputType +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **outputType** | *Required* The primary output format is PDF but other output formats are also supported. | | FopOutputType -|======================================================================= +| *outputType* | *Required* The primary output format is PDF but other output formats are also supported. | | FopOutputType +|=== -#### Query Parameters (3 parameters): +==== Query Parameters (3 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **fopFactory** (producer) | Allows to use a custom configured or implementation of org.apache.fop.apps.FopFactory. | | FopFactory -| **userConfigURL** (producer) | The location of a configuration file which can be loaded from classpath or file system. | | String -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *fopFactory* (producer) | Allows to use a custom configured or implementation of org.apache.fop.apps.FopFactory. | | FopFactory +| *userConfigURL* (producer) | The location of a configuration file which can be loaded from classpath or file system. | | String +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-freemarker/src/main/docs/freemarker-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-freemarker/src/main/docs/freemarker-component.adoc b/components/camel-freemarker/src/main/docs/freemarker-component.adoc index dd6025e..b4becb0 100644 --- a/components/camel-freemarker/src/main/docs/freemarker-component.adoc +++ b/components/camel-freemarker/src/main/docs/freemarker-component.adoc @@ -1,4 +1,4 @@ -## Freemarker Component +== Freemarker Component *Available as of Camel version 2.10* @@ -44,11 +44,11 @@ The Freemarker component supports 2 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **configuration** (advanced) | To use an existing freemarker.template.Configuration instance as the configuration. | | Configuration -| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean -|======================================================================= +| *configuration* (advanced) | To use an existing freemarker.template.Configuration instance as the configuration. | | Configuration +| *resolveProperty Placeholders* (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean +|=== // component options: END @@ -58,29 +58,31 @@ The Freemarker component supports 2 options which are listed below. // endpoint options: START The Freemarker endpoint is configured using URI syntax: - freemarker:resourceUri +---- +freemarker:resourceUri +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **resourceUri** | *Required* Path to the resource. You can prefix with: classpath file http ref or bean. classpath file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot eg bean:myBean.myMethod. | | String -|======================================================================= +| *resourceUri* | *Required* Path to the resource. You can prefix with: classpath file http ref or bean. classpath file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot eg bean:myBean.myMethod. | | String +|=== -#### Query Parameters (5 parameters): +==== Query Parameters (5 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **configuration** (producer) | Sets the Freemarker configuration to use | | Configuration -| **contentCache** (producer) | Sets whether to use resource content cache or not | false | boolean -| **encoding** (producer) | Sets the encoding to be used for loading the template file. | | String -| **templateUpdateDelay** (producer) | Number of seconds the loaded template resource will remain in the cache. | | int -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *configuration* (producer) | Sets the Freemarker configuration to use | | Configuration +| *contentCache* (producer) | Sets whether to use resource content cache or not | false | boolean +| *encoding* (producer) | Sets the encoding to be used for loading the template file. | | String +| *templateUpdateDelay* (producer) | Number of seconds the loaded template resource will remain in the cache. | | int +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END
