This is an automated email from the ASF dual-hosted git repository.
davsclaus 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 c7802f2 Regen
c7802f2 is described below
commit c7802f2bdb1a771af33398c1d33ef1e7195d889f
Author: Claus Ibsen <claus.ib...@gmail.com>
AuthorDate: Fri Feb 7 05:39:47 2020 +0100
Regen
---
.../src/main/docs/yammer-component.adoc | 5 ++
.../modules/ROOT/pages/milo-client-component.adoc | 3 +-
.../modules/ROOT/pages/milo-server-component.adoc | 2 +-
.../modules/ROOT/pages/yammer-component.adoc | 78 ++++++++--------------
4 files changed, 35 insertions(+), 53 deletions(-)
diff --git a/components/camel-yammer/src/main/docs/yammer-component.adoc
b/components/camel-yammer/src/main/docs/yammer-component.adoc
index e32656e..358e090 100644
--- a/components/camel-yammer/src/main/docs/yammer-component.adoc
+++ b/components/camel-yammer/src/main/docs/yammer-component.adoc
@@ -45,6 +45,8 @@ The Yammer component can be configured with the Yammer
account settings which ar
// component options: START
The Yammer component supports 7 options, which are listed below.
+
+
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
@@ -78,14 +80,17 @@ with the following path and query parameters:
=== Path Parameters (1 parameters):
+
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *function* | *Required* The function to use. The value can be one of:
MESSAGES, MY_FEED, ALGO, FOLLOWING, SENT, PRIVATE, RECEIVED, USERS, CURRENT |
| YammerFunctionType
|===
+
=== Query Parameters (31 parameters):
+
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
diff --git a/docs/components/modules/ROOT/pages/milo-client-component.adoc
b/docs/components/modules/ROOT/pages/milo-client-component.adoc
index 3517f7e..8cd9db3 100644
--- a/docs/components/modules/ROOT/pages/milo-client-component.adoc
+++ b/docs/components/modules/ROOT/pages/milo-client-component.adoc
@@ -11,8 +11,7 @@
The Milo Client component provides access to OPC UA servers using the
http://eclipse.org/milo[Eclipse Milo™] implementation.
-*Important*: To successfully use certificates for secured communication,
-JCE Jurisdiction Policy File Default has to be *Unlimited* (which is by
default since jdk 9+).
+*Java 9+*: This component requires Java 9+ at runtime.
Maven users will need to add the following dependency to their `pom.xml`
for this component:
diff --git a/docs/components/modules/ROOT/pages/milo-server-component.adoc
b/docs/components/modules/ROOT/pages/milo-server-component.adoc
index 072675e..d9ac2e5 100644
--- a/docs/components/modules/ROOT/pages/milo-server-component.adoc
+++ b/docs/components/modules/ROOT/pages/milo-server-component.adoc
@@ -11,7 +11,7 @@
The Milo Server component provides an OPC UA server using the
http://eclipse.org/milo[Eclipse Milo™] implementation.
-*Java 8*: This component requires Java 8 at runtime.
+*Java 9+*: This component requires Java 9+ at runtime.
Maven users will need to add the following dependency to their `pom.xml`
for this component:
diff --git a/docs/components/modules/ROOT/pages/yammer-component.adoc
b/docs/components/modules/ROOT/pages/yammer-component.adoc
index 1e5210b..63382cf 100644
--- a/docs/components/modules/ROOT/pages/yammer-component.adoc
+++ b/docs/components/modules/ROOT/pages/yammer-component.adoc
@@ -9,18 +9,16 @@
// HEADER END
The Yammer component allows you to interact with the
-https://www.yammer.com[Yammer] enterprise social network. Consuming
-messages and users is supported as well as creating
-new messages.
-
-Yammer uses OAuth 2 for all client application authentication. In order
-to use camel-yammer with your account, you'll need to create a new
-application within Yammer and grant the application access to your
-account. Finally, generate your access token. More details are at
+https://www.yammer.com[Yammer] enterprise social network.
+Consuming messages and users is supported as well as creating new messages.
+
+Yammer uses OAuth 2 for all client application authentication.
+In order to use camel-yammer with your account, you'll need to create a new
application within Yammer and grant the application access to your account.
+Finally, generate your access token.
+More details are at
https://developer.yammer.com/authentication/.
-Maven users will need to add the following dependency to their pom.xml
-for this component:
+Maven users will need to add the following dependency to their pom.xml for
this component:
[source,xml]
----
@@ -40,8 +38,7 @@ yammer:[function]?[options]
== Component options
-The Yammer component can be configured with the Yammer account settings
-which are mandatory to configure before using.
+The Yammer component can be configured with the Yammer account settings which
are mandatory to configure before using.
@@ -146,11 +143,8 @@ When using Spring Boot make sure to use the following
Maven dependency to have s
</dependency>
----
-
The component supports 20 options, which are listed below.
-
-
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
@@ -181,8 +175,7 @@ The component supports 20 options, which are listed below.
== Consuming messages
-The Yammer component provides several endpoints for consuming
-messages:
+The Yammer component provides several endpoints for consuming messages:
[width="100%",cols="2l,3",options="header",]
|=======================================================================
@@ -209,13 +202,12 @@ and topics that the user is following.
|All messages received by the user
|=======================================================================
-
=== 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
-coming from yammer is in JSON. For all message consuming and producing
-endpoints, a `Messages` object is returned. Take for example a route like:
+`org.apache.camel.component.yammer.model` package.
+The original message coming from yammer is in JSON. For all message consuming
and producing endpoints, a `Messages` object is returned.
+Take for example a route like:
[source,java]
----
@@ -302,8 +294,8 @@ and lets say the yammer server returns:
----
Camel will marshal that into a `Messages` object containing 2 `Message`
-objects. As shown below there is a rich object model that makes it easy
-to get any information you need:
+objects.
+As shown below there is a rich object model that makes it easy to get any
information you need:
[source,java]
----
@@ -315,23 +307,20 @@ assertEquals("Testing yammer API...",
messages.getMessages().get(0).getBody().ge
assertEquals("(Principal Software Engineer) has #joined the redhat.com
network. Take a moment to welcome Jonathan.",
messages.getMessages().get(1).getBody().getPlain());
----
-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`
+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
-To create a new message in the account of the current user, you can use
-the following URI:
+To create a new message in the account of the current user, you can use the
following URI:
[source]
----
yammer:messages?[options]
----
-The current Camel message body is what will be used to set the text of
-the Yammer message. The response body will include the new message
-formatted the same way as when you consume messages (i.e. as a `Messages`
+The current Camel message body is what will be used to set the text of the
Yammer message.
+The response body will include the new message formatted the same way as when
you consume messages (i.e. as a `Messages`
object by default).
Take this route for instance:
@@ -350,10 +339,8 @@ By sending to the `direct:start` endpoint a `"Hi from
Camel!"` message body:
template.sendBody("direct:start", "Hi from Camel!");
----
-a new message will be created in the current user's account on the
-server and also this new message will be returned to Camel and converted
-into a `Messages` object. Like when consuming messages you can interrogate
-the `Messages` object:
+a new message will be created in the current user's account on the server and
also this new message will be returned to Camel and converted into a `Messages`
object.
+Like when consuming messages you can interrogate the `Messages` object:
[source,java]
----
@@ -364,11 +351,9 @@ assertEquals(1, messages.getMessages().size());
assertEquals("Hi from Camel!",
messages.getMessages().get(0).getBody().getPlain());
----
-
== Retrieving users
-The Yammer component provides several endpoints for retrieving
-users:
+The Yammer component provides several endpoints for retrieving users:
[width="100%",cols="2l,3",options="header",]
|=====================================================
@@ -379,20 +364,14 @@ users:
|View data about the current user.
|=====================================================
-
== Using an enricher
-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
-at a point in time, it is better to call that consumer once and then get
-one with your 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 at a point in
time, it is better to call that consumer once and then get one with your route.
-Lets say you have a route that at some point needs to go out and fetch
-user data for the current user. Rather than polling for this user over
-and over again, use the `pollEnrich` DSL method:
+Lets say you have a route that at some point needs to go out and fetch user
data for the current user.
+Rather than polling for this user over and over again, use the `pollEnrich`
DSL method:
[source,java]
----
@@ -401,6 +380,5 @@ from("direct:start")
.to("mock:result");
----
-This will go out and fetch the current user's `User` object and set it as
-the Camel message body.
+This will go out and fetch the current user's `User` object and set it as the
Camel message body.
