This is an automated email from the ASF dual-hosted git repository.
acosentino pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/master by this push:
new e648c9d Regen
e648c9d is described below
commit e648c9dcb212a232f8c1c074b45b25385921f33f
Author: Andrea Cosentino <[email protected]>
AuthorDate: Mon Feb 11 16:19:32 2019 +0100
Regen
---
.../modules/ROOT/pages/file-component.adoc | 2 +-
.../modules/ROOT/pages/ftp-component.adoc | 2 +-
.../modules/ROOT/pages/ftps-component.adoc | 2 +-
.../modules/ROOT/pages/sftp-component.adoc | 2 +-
.../modules/ROOT/pages/yammer-component.adoc | 39 ++++++----------------
5 files changed, 15 insertions(+), 32 deletions(-)
diff --git a/docs/components/modules/ROOT/pages/file-component.adoc
b/docs/components/modules/ROOT/pages/file-component.adoc
index 652c29a..8c55b97 100644
--- a/docs/components/modules/ROOT/pages/file-component.adoc
+++ b/docs/components/modules/ROOT/pages/file-component.adoc
@@ -89,7 +89,7 @@ with the following path and query parameters:
| *preSort* (consumer) | When pre-sort is enabled then the consumer will sort
the file and directory names during polling, that was retrieved from the file
system. You may want to do this in case you need to operate on the files in a
sorted order. The pre-sort is executed before the consumer starts to filter,
and accept files to process by Camel. This option is default=false meaning
disabled. | false | boolean
| *recursive* (consumer) | If a directory, will look for files in all the
sub-directories as well. | 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
-| *directoryMustExist* (consumer) | Similar to startingDirectoryMustExist but
this applies during polling recursive sub directories. | false | boolean
+| *directoryMustExist* (consumer) | Similar to the startingDirectoryMustExist
option but this applies during polling (after starting the consumer). | false |
boolean
| *exceptionHandler* (consumer) | To let the consumer use a custom
ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this
option 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
| *extendedAttributes* (consumer) | To define which file attributes of
interest. Like posix:permissions,posix:owner,basic:lastAccessTime, it supports
basic wildcard like posix:, basic:lastAccessTime | | String
diff --git a/docs/components/modules/ROOT/pages/ftp-component.adoc
b/docs/components/modules/ROOT/pages/ftp-component.adoc
index 3973b1b..44ce825 100644
--- a/docs/components/modules/ROOT/pages/ftp-component.adoc
+++ b/docs/components/modules/ROOT/pages/ftp-component.adoc
@@ -127,7 +127,7 @@ with the following path and query parameters:
| *resumeDownload* (consumer) | Configures whether resume download is enabled.
This must be supported by the FTP server (almost all FTP servers support it).
In addition the options localWorkDirectory must be configured so downloaded
files are stored in a local directory, and the option binary must be enabled,
which is required to support resuming of downloads. | 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
| *streamDownload* (consumer) | Sets the download method to use when not using
a local working directory. If set to true, the remote files are streamed to the
route as they are read. When set to false, the remote files are loaded into
memory before being sent into the route. | false | boolean
-| *directoryMustExist* (consumer) | Similar to startingDirectoryMustExist but
this applies during polling recursive sub directories. | false | boolean
+| *directoryMustExist* (consumer) | Similar to the startingDirectoryMustExist
option but this applies during polling (after starting the consumer). | false |
boolean
| *download* (consumer) | Whether the FTP consumer should download the file.
If this option is set to false, then the message body will be null, but the
consumer will still trigger a Camel Exchange that has details about the file
such as file name, file size, etc. It's just that the file will not be
downloaded. | false | boolean
| *exceptionHandler* (consumer) | To let the consumer use a custom
ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this
option 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
diff --git a/docs/components/modules/ROOT/pages/ftps-component.adoc
b/docs/components/modules/ROOT/pages/ftps-component.adoc
index c4c834a..3993d4f 100644
--- a/docs/components/modules/ROOT/pages/ftps-component.adoc
+++ b/docs/components/modules/ROOT/pages/ftps-component.adoc
@@ -87,7 +87,7 @@ with the following path and query parameters:
| *resumeDownload* (consumer) | Configures whether resume download is enabled.
This must be supported by the FTP server (almost all FTP servers support it).
In addition the options localWorkDirectory must be configured so downloaded
files are stored in a local directory, and the option binary must be enabled,
which is required to support resuming of downloads. | 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
| *streamDownload* (consumer) | Sets the download method to use when not using
a local working directory. If set to true, the remote files are streamed to the
route as they are read. When set to false, the remote files are loaded into
memory before being sent into the route. | false | boolean
-| *directoryMustExist* (consumer) | Similar to startingDirectoryMustExist but
this applies during polling recursive sub directories. | false | boolean
+| *directoryMustExist* (consumer) | Similar to the startingDirectoryMustExist
option but this applies during polling (after starting the consumer). | false |
boolean
| *download* (consumer) | Whether the FTP consumer should download the file.
If this option is set to false, then the message body will be null, but the
consumer will still trigger a Camel Exchange that has details about the file
such as file name, file size, etc. It's just that the file will not be
downloaded. | false | boolean
| *exceptionHandler* (consumer) | To let the consumer use a custom
ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this
option 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
diff --git a/docs/components/modules/ROOT/pages/sftp-component.adoc
b/docs/components/modules/ROOT/pages/sftp-component.adoc
index 4e5f5c2..7679935 100644
--- a/docs/components/modules/ROOT/pages/sftp-component.adoc
+++ b/docs/components/modules/ROOT/pages/sftp-component.adoc
@@ -73,7 +73,7 @@ with the following path and query parameters:
| *recursive* (consumer) | If a directory, will look for files in all the
sub-directories as well. | 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
| *streamDownload* (consumer) | Sets the download method to use when not using
a local working directory. If set to true, the remote files are streamed to the
route as they are read. When set to false, the remote files are loaded into
memory before being sent into the route. | false | boolean
-| *directoryMustExist* (consumer) | Similar to startingDirectoryMustExist but
this applies during polling recursive sub directories. | false | boolean
+| *directoryMustExist* (consumer) | Similar to the startingDirectoryMustExist
option but this applies during polling (after starting the consumer). | false |
boolean
| *download* (consumer) | Whether the FTP consumer should download the file.
If this option is set to false, then the message body will be null, but the
consumer will still trigger a Camel Exchange that has details about the file
such as file name, file size, etc. It's just that the file will not be
downloaded. | false | boolean
| *exceptionHandler* (consumer) | To let the consumer use a custom
ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this
option 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
diff --git a/docs/components/modules/ROOT/pages/yammer-component.adoc
b/docs/components/modules/ROOT/pages/yammer-component.adoc
index c029895..4d0271d 100644
--- a/docs/components/modules/ROOT/pages/yammer-component.adoc
+++ b/docs/components/modules/ROOT/pages/yammer-component.adoc
@@ -5,7 +5,7 @@
The Yammer component allows you to interact with the
https://www.yammer.com[Yammer] enterprise social network. Consuming
-messages, users, and user relationships is supported as well as creating
+messages and users is supported as well as creating
new messages.
Yammer uses OAuth 2 for all client application authentication. In order
@@ -26,14 +26,14 @@ for this component:
</dependency>
----
-### URI format
+=== URI format
[source]
----
yammer:[function]?[options]
----
-### Component options
+=== Component options
The Yammer component can be configured with the Yammer account settings
which are mandatory to configure before using.
@@ -62,7 +62,7 @@ The Yammer component supports 5 options, which are listed
below.
You can also configure these options directly in the endpoint.
-### Endpoint options
+=== Endpoint options
@@ -155,9 +155,7 @@ The component supports 18 options, which are listed below.
-
-
-### Consuming messages
+=== Consuming messages
The Yammer component provides several endpoints for consuming
messages:
@@ -188,7 +186,7 @@ and topics that the user is following.
|=======================================================================
-#### Message format
+==== Message format
All messages by default are converted to a POJO model provided in the
`org.apache.camel.component.yammer.model` package. The original message
@@ -297,7 +295,7 @@ That said, marshaling this data into POJOs is not free so
if you need
you can switch back to using pure JSON by adding the `useJson=false`
option to your URI.
-### Creating messages
+=== Creating messages
To create a new message in the account of the current user, you can use
the following URI:
@@ -342,17 +340,8 @@ assertEquals(1, messages.getMessages().size());
assertEquals("Hi from Camel!",
messages.getMessages().get(0).getBody().getPlain());
----
-### Retrieving user relationships
-The Yammer component can retrieve user relationships:
-
-[source]
-----
-yammer:relationships?[options]
-----
-
-
-### Retrieving users
+=== Retrieving users
The Yammer component provides several endpoints for retrieving
users:
@@ -367,10 +356,10 @@ users:
|=====================================================
-### Using an enricher
+=== Using an enricher
-It is helpful sometimes (or maybe always in the case of users or
-relationship consumers) to use an enricher pattern rather than a route
+It is helpful sometimes (or maybe always in the case of users
+to use an enricher pattern rather than a route
initiated with one of the polling consumers in camel-yammer. This is
because the consumers will fire repeatedly, however often you set the
delay for. If you just want to look up a user's data, or grab a message
@@ -391,9 +380,3 @@ from("direct:start")
This will go out and fetch the current user's `User` object and set it as
the Camel message body.
-### See Also
-
-* Configuring Camel
-* Component
-* Endpoint
-* Getting Started
