camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From davscl...@apache.org
Subject camel git commit: Polished docs
Date Thu, 05 Oct 2017 08:00:11 GMT
Repository: camel
Updated Branches:
  refs/heads/master 6fe1ec4b0 -> 267cc222a


Polished docs


Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/267cc222
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/267cc222
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/267cc222

Branch: refs/heads/master
Commit: 267cc222a6c54a285624bc12757e3b95a83b0954
Parents: 6fe1ec4
Author: Claus Ibsen <davsclaus@apache.org>
Authored: Thu Oct 5 09:59:17 2017 +0200
Committer: Claus Ibsen <davsclaus@apache.org>
Committed: Thu Oct 5 10:00:04 2017 +0200

----------------------------------------------------------------------
 .../src/main/docs/google-pubsub-component.adoc  | 67 +++++++++-----------
 .../google/pubsub/GooglePubsubEndpoint.java     |  5 +-
 components/readme.adoc                          |  2 +-
 .../GooglePubsubComponentConfiguration.java     |  3 +-
 4 files changed, 34 insertions(+), 43 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/267cc222/components/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc b/components/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc
index ecc7650..9272893 100644
--- a/components/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc
+++ b/components/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc
@@ -2,8 +2,6 @@
 
 *Available as of Camel version 2.19*
 
-### Component Description
-
 The Google Pubsub component provides access
 to https://cloud.google.com/pubsub/[Cloud Pub/Sub Infrastructure] via
 the https://cloud.google.com/apis/docs/client-libraries-explained[Google Client Services
API].
@@ -23,37 +21,17 @@ for this component:
 
 ------------------------------------------------------
 
-[[GooglePubsub-AuthenticationConfiguration]]
-Authentication Configuration
-
-Google Pubsub component authentication is targeted for use with the GCP Service Accounts.
-For more information please refer to https://cloud.google.com/docs/authentication[Google
Cloud Platform Auth Guide]
-
-Google security credentials can be set explicitly via one of the two options:
-
-* Service Account Email and Service Account Key (PEM format)
-* GCP credentials file location
-
-If both are set, the Service Account Email/Key will take precedence.
-
-Or implicitly, where the connection factory falls back on
-https://developers.google.com/identity/protocols/application-default-credentials#howtheywork[Application
Default Credentials].
-
-*OBS!* The location of the default credentials file is configurable - via GOOGLE_APPLICATION_CREDENTIALS
environment variable.
-
-Service Account Email and Service Account Key can be found in the GCP JSON credentials file
as client_email and private_key respectively.
-
-### URI Format
+=== URI Format
 
 The GoogleMail Component uses the following URI format:
 
---------------------------------------------------------
-        google-pubsub://project-id:destinationName?[options]
---------------------------------------------------------
+----
+google-pubsub://project-id:destinationName?[options]
+----
 
 Destination Name can be either a topic or a subscription name.
 
-### GooglePubsubComponent
+=== Options
 
 // component options: START
 The Google Pubsub component supports 2 options which are listed below.
@@ -103,7 +81,7 @@ with the following path and query parameters:
 |===
 // endpoint options: END
 
-### Producer Endpoints
+=== Producer Endpoints
 
 Producer endpoints can accept and deliver to PubSub individual and grouped
 exchanges alike. Grouped exchanges have `Exchange.GROUPED_EXCHANGE` property set.
@@ -118,7 +96,7 @@ A Map set as message header `GooglePubsubConstants.ATTRIBUTES` will be
sent as P
 Once exchange has been delivered to PubSub the PubSub Message ID will be assigned to
 the header `GooglePubsubConstants.MESSAGE_ID`.
 
-### Consumer Endpoints
+=== Consumer Endpoints
 Google PubSub will redeliver the message if it has not been acknowledged within the time
period set
 as a configuration option on the subscription.
 
@@ -131,7 +109,7 @@ To ack/nack the message the component uses Acknowledgement ID stored as
header `
 If the header is removed or tampered with, the ack will fail and the message will be redelivered
 again after the ack deadline.
 
-### Message Headers
+=== Message Headers
 Headers set by the consumer endpoints:
 
 * GooglePubsubConstants.MESSAGE_ID
@@ -139,12 +117,31 @@ Headers set by the consumer endpoints:
 * GooglePubsubConstants.PUBLISH_TIME
 * GooglePubsubConstants.ACK_ID
 
-### Message Body
+=== Message Body
 
 The consumer endpoint returns the content of the message as byte[] - exactly as the underlying
system sends it.
 It is up for the route to convert/unmarshall the contents.
 
-### Rollback and Redelivery
+=== Authentication Configuration
+
+Google Pubsub component authentication is targeted for use with the GCP Service Accounts.
+For more information please refer to https://cloud.google.com/docs/authentication[Google
Cloud Platform Auth Guide]
+
+Google security credentials can be set explicitly via one of the two options:
+
+* Service Account Email and Service Account Key (PEM format)
+* GCP credentials file location
+
+If both are set, the Service Account Email/Key will take precedence.
+
+Or implicitly, where the connection factory falls back on
+https://developers.google.com/identity/protocols/application-default-credentials#howtheywork[Application
Default Credentials].
+
+*OBS!* The location of the default credentials file is configurable - via GOOGLE_APPLICATION_CREDENTIALS
environment variable.
+
+Service Account Email and Service Account Key can be found in the GCP JSON credentials file
as client_email and private_key respectively.
+
+=== Rollback and Redelivery
 
 The rollback for Google PubSub relies on the idea of the Acknowledgement Deadline - the time
period where Google PubSub expects to receive the acknowledgement.
 If the acknowledgement has not been received, the message is redelivered.
@@ -157,8 +154,4 @@ So, rollback is effectively a deadline extension API call with zero value
- i.e.
 be redelivered to the next consumer.
 
 It is possible to delay the message redelivery by setting the acknowledgement deadline explicitly
for the rollback by
-setting the message header
-
-* GooglePubsubConstants.ACK_DEADLINE
-
-to the value in seconds.
+setting the message header `GooglePubsubConstants.ACK_DEADLINE` to the value in seconds.

http://git-wip-us.apache.org/repos/asf/camel/blob/267cc222/components/camel-google-pubsub/src/main/java/org/apache/camel/component/google/pubsub/GooglePubsubEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-google-pubsub/src/main/java/org/apache/camel/component/google/pubsub/GooglePubsubEndpoint.java
b/components/camel-google-pubsub/src/main/java/org/apache/camel/component/google/pubsub/GooglePubsubEndpoint.java
index 8aa42bb..193596f 100644
--- a/components/camel-google-pubsub/src/main/java/org/apache/camel/component/google/pubsub/GooglePubsubEndpoint.java
+++ b/components/camel-google-pubsub/src/main/java/org/apache/camel/component/google/pubsub/GooglePubsubEndpoint.java
@@ -34,9 +34,8 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
- * Messaging client for Google Cloud Platform PubSub Service:
- * https://cloud.google.com/pubsub/
- *
+ * Messaging client for Google Cloud Platform PubSub Service
+ * <p/>
  * Built on top of the Service API libraries (v1).
  */
 @UriEndpoint(firstVersion = "2.19.0", scheme = "google-pubsub", title = "Google Pubsub",

http://git-wip-us.apache.org/repos/asf/camel/blob/267cc222/components/readme.adoc
----------------------------------------------------------------------
diff --git a/components/readme.adoc b/components/readme.adoc
index 0a6bd2b..7085dbf 100644
--- a/components/readme.adoc
+++ b/components/readme.adoc
@@ -288,7 +288,7 @@ Number of Components: 283 in 194 JAR artifacts (17 deprecated)
 `google-mail:apiName/methodName` | 2.15 | The google-mail component provides access to Google
Mail.
 
 | link:camel-google-pubsub/src/main/docs/google-pubsub-component.adoc[Google Pubsub] (camel-google-pubsub)
+
-`google-pubsub:projectId:destinationName` | 2.19 | Messaging client for Google Cloud Platform
PubSub Service: https://cloud.google.com/pubsub/
+`google-pubsub:projectId:destinationName` | 2.19 | Messaging client for Google Cloud Platform
PubSub Service
 
 | link:camel-gora/src/main/docs/gora-component.adoc[Gora] (camel-gora) +
 `gora:name` | 2.14 | The gora component allows you to work with NoSQL databases using the
Apache Gora framework.

http://git-wip-us.apache.org/repos/asf/camel/blob/267cc222/platforms/spring-boot/components-starter/camel-google-pubsub-starter/src/main/java/org/apache/camel/component/google/pubsub/springboot/GooglePubsubComponentConfiguration.java
----------------------------------------------------------------------
diff --git a/platforms/spring-boot/components-starter/camel-google-pubsub-starter/src/main/java/org/apache/camel/component/google/pubsub/springboot/GooglePubsubComponentConfiguration.java
b/platforms/spring-boot/components-starter/camel-google-pubsub-starter/src/main/java/org/apache/camel/component/google/pubsub/springboot/GooglePubsubComponentConfiguration.java
index 58b6464..cadf487 100644
--- a/platforms/spring-boot/components-starter/camel-google-pubsub-starter/src/main/java/org/apache/camel/component/google/pubsub/springboot/GooglePubsubComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-google-pubsub-starter/src/main/java/org/apache/camel/component/google/pubsub/springboot/GooglePubsubComponentConfiguration.java
@@ -21,8 +21,7 @@ import org.apache.camel.spring.boot.ComponentConfigurationPropertiesCommon;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 
 /**
- * Messaging client for Google Cloud Platform PubSub Service:
- * https://cloud.google.com/pubsub/
+ * Messaging client for Google Cloud Platform PubSub Service
  * 
  * Generated by camel-package-maven-plugin - do not edit this file!
  */


Mime
View raw message