[2/4] camel git commit: Added camel-pgevent docs to Gitbook

[ac...@apache.org]

Added camel-pgevent docs to Gitbook


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

Branch: refs/heads/master
Commit: a7afc19e501835f7ac116f4d1685b686e72b0a0d
Parents: a21e37b
Author: Andrea Cosentino <an...@gmail.com>
Authored: Tue May 17 11:11:13 2016 +0200
Committer: Andrea Cosentino <an...@gmail.com>
Committed: Tue May 17 11:11:13 2016 +0200

----------------------------------------------------------------------
 .../camel-pgevent/src/main/docs/pgevent.adoc    | 78 ++++++++++++++++++++
 docs/user-manual/en/SUMMARY.md                  |  1 +
 2 files changed, 79 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/a7afc19e/components/camel-pgevent/src/main/docs/pgevent.adoc
----------------------------------------------------------------------
diff --git a/components/camel-pgevent/src/main/docs/pgevent.adoc b/components/camel-pgevent/src/main/docs/pgevent.adoc
new file mode 100644
index 0000000..a0fa19d
--- /dev/null
+++ b/components/camel-pgevent/src/main/docs/pgevent.adoc
@@ -0,0 +1,78 @@
+[[PGEvent-PGEventComponentPostgresSQLEvent]]
+PGEvent Component (PostgresSQL Event)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This is a component for Apache Camel which allows for
+Producing/Consuming PostgreSQL events related to the LISTEN/NOTIFY
+commands added since PostgreSQL 8.3.
+
+Maven users will need to add the following dependency to their `pom.xml`
+for this component:
+
+[source,xml]
+------------------------------------------------------------
+<dependency>
+    <groupId>org.apache.camel</groupId>
+    <artifactId>camel-pgevent</artifactId>
+    <version>x.x.x</version>
+    <!-- use the same version as your Camel core version -->
+</dependency>
+------------------------------------------------------------
+
+URI format
+
+The pgevent component uses the following two styles of endpoint URI
+notation:
+
+[source,java]
+-------------------------------------------------
+pgevent:datasource[?parameters]
+pgevent://host:port/database/channel[?parameters]
+-------------------------------------------------
+
+You can append query options to the URI in the following format,
+`?option=value&option=value&...`
+
+[[PGEvent-Options]]
+Options
+^^^^^^^
+
+
+// component options: START
+The PostgresSQL Event component has no options.
+// component options: END
+
+
+
+// endpoint options: START
+The PostgresSQL Event component supports 11 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| host | common | localhost | String | To connect using hostname and port to the database.
+| port | common | 5432 | Integer | To connect using hostname and port to the database.
+| database | common |  | String | *Required* The database name
+| channel | common |  | String | *Required* The channel name
+| datasource | common |  | DataSource | To connect using the given javax.sql.DataSource instead of using hostname and port.
+| pass | common |  | String | Password for login
+| user | common | postgres | String | Username for login
+| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| exceptionHandler | consumer (advanced) |  | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+|=======================================================================
+{% endraw %}
+// endpoint options: END
+
+
+[[PGEvent-SeeAlso]]
+See Also
+^^^^^^^^
+
+* link:configuring-camel.html[Configuring Camel]
+* link:component.html[Component]
+* link:endpoint.html[Endpoint]
+* link:getting-started.html[Getting Started]
+

http://git-wip-us.apache.org/repos/asf/camel/blob/a7afc19e/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index 91b1b29..2ee7085 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -215,6 +215,7 @@
     * [Paho](paho.adoc)
     * [Paxlogging](paxlogging.adoc)
     * [PDF](pdf.adoc)
+    * [PGEvent](pgevent.adoc)
     * [Properties](properties.adoc)
     * [Quickfix](quickfix.adoc)
     * [Scp](scp.adoc)