camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From acosent...@apache.org
Subject camel git commit: Added camel-paxlogging docs to Gitbook
Date Tue, 17 May 2016 08:53:48 GMT
Repository: camel
Updated Branches:
  refs/heads/master b941f3f5a -> 473714e7d


Added camel-paxlogging 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/473714e7
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/473714e7
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/473714e7

Branch: refs/heads/master
Commit: 473714e7da1f8563f7ab8c34c10d7ee9d1fb2de8
Parents: b941f3f
Author: Andrea Cosentino <ancosen@gmail.com>
Authored: Tue May 17 10:52:51 2016 +0200
Committer: Andrea Cosentino <ancosen@gmail.com>
Committed: Tue May 17 10:52:51 2016 +0200

----------------------------------------------------------------------
 .../src/main/docs/paxlogging.adoc               | 102 +++++++++++++++++++
 docs/user-manual/en/SUMMARY.md                  |   1 +
 2 files changed, 103 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/473714e7/components/camel-paxlogging/src/main/docs/paxlogging.adoc
----------------------------------------------------------------------
diff --git a/components/camel-paxlogging/src/main/docs/paxlogging.adoc b/components/camel-paxlogging/src/main/docs/paxlogging.adoc
new file mode 100644
index 0000000..994b751
--- /dev/null
+++ b/components/camel-paxlogging/src/main/docs/paxlogging.adoc
@@ -0,0 +1,102 @@
+[[Pax-Logging-PaxLoggingcomponent]]
+PaxLogging component
+~~~~~~~~~~~~~~~~~~~~
+
+*Available in Camel 2.6*
+
+The `paxlogging` component can be used in an OSGi environment to receive
+http://wiki.ops4j.org/display/paxlogging/Pax+Logging[PaxLogging] events
+and process them.
+
+[[Pax-Logging-Dependencies]]
+Dependencies
+^^^^^^^^^^^^
+
+Maven users need to add the following dependency to their `pom.xml`
+
+[source,xml]
+-------------------------------------------
+<dependency>
+  <groupId>org.apache.camel</groupId>
+  <artifactId>camel-paxlogging</artifactId>
+  <version>${camel-version}</version>
+</dependency>
+-------------------------------------------
+
+where `${camel-version`} must be replaced by the actual version of Camel
+(2.6.0 or higher).
+
+[[Pax-Logging-URIformat]]
+URI format
+^^^^^^^^^^
+
+[source,xml]
+-----------------------------
+paxlogging:appender[?options]
+-----------------------------
+
+where `appender` is the name of the pax appender that need to be
+configured in the PaxLogging service configuration.
+
+[[Pax-Logging-URIoptions]]
+URI options
+^^^^^^^^^^^
+
+
+// component options: START
+The OSGi PAX Logging component supports 1 options which are listed below.
+
+
+
+{% raw %}
+[width="100%",cols="2s,1m,8",options="header"]
+|=======================================================================
+| Name | Java Type | Description
+| bundleContext | BundleContext | The OSGi BundleContext is automatic injected by Camel
+|=======================================================================
+{% endraw %}
+// component options: END
+
+
+
+// endpoint options: START
+The OSGi PAX Logging component supports 5 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| appender | consumer |  | String | *Required* Appender is the name of the pax appender that
need to be configured in the PaxLogging service configuration.
+| 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
+
+
+[[Pax-Logging-Messagebody]]
+Message body
+^^^^^^^^^^^^
+
+The `in` message body will be set to the received PaxLoggingEvent.
+
+[[Pax-Logging-Exampleusage]]
+Example usage
+^^^^^^^^^^^^^
+
+[source,xml]
+----------------------------------
+<route>
+    <from uri="paxlogging:camel"/>
+    <to uri="stream:out"/>
+</route>
+----------------------------------
+
+Configuration:
+
+[source,java]
+----------------------------------------------------------
+log4j.rootLogger=INFO, out, osgi:VmLogAppender, osgi:camel
+----------------------------------------------------------

http://git-wip-us.apache.org/repos/asf/camel/blob/473714e7/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index 17c1c7b..6670d3a 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -213,6 +213,7 @@
     * [Openshift](openshift.adoc)
     * [Optaplanner](optaplanner.adoc)
     * [Paho](paho.adoc)
+    * [Paxlogging](paxlogging.adoc)
     * [Properties](properties.adoc)
     * [Quickfix](quickfix.adoc)
     * [Scp](scp.adoc)


Mime
View raw message