You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ac...@apache.org on 2016/01/26 17:38:04 UTC
camel git commit: Added camel-barcode docs to gitbook
Repository: camel
Updated Branches:
refs/heads/master cff089ee6 -> 9fbde5d01
Added camel-barcode 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/9fbde5d0
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/9fbde5d0
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/9fbde5d0
Branch: refs/heads/master
Commit: 9fbde5d01678e97fadaaad7a8633e2a26ec3c772
Parents: cff089e
Author: Andrea Cosentino <an...@gmail.com>
Authored: Tue Jan 26 17:37:29 2016 +0100
Committer: Andrea Cosentino <an...@gmail.com>
Committed: Tue Jan 26 17:37:29 2016 +0100
----------------------------------------------------------------------
.../src/main/docs/barcode-data-format.adoc | 118 +++++++++++++++++++
.../docs/barcode-data-format.data/qr-code.png | Bin 0 -> 307 bytes
docs/user-manual/en/SUMMARY.md | 1 +
3 files changed, 119 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/9fbde5d0/components/camel-barcode/src/main/docs/barcode-data-format.adoc
----------------------------------------------------------------------
diff --git a/components/camel-barcode/src/main/docs/barcode-data-format.adoc b/components/camel-barcode/src/main/docs/barcode-data-format.adoc
new file mode 100644
index 0000000..2e8bfe6
--- /dev/null
+++ b/components/camel-barcode/src/main/docs/barcode-data-format.adoc
@@ -0,0 +1,118 @@
+*Available as of Camel 2.14*
+
+The barcode data format is based on the
+https://github.com/zxing/zxing[zxing library]. The goal of this
+component is to create a barcode image from a String (marshal) and a
+String from a barcode image (unmarshal). You're free to use all features
+that zxing offers.
+
+[[BarcodeDataFormat-Dependencies]]
+Dependencies
+^^^^^^^^^^^^
+
+To use the barcode data format in your camel routes you need to add the
+a dependency on *camel-barcode* which implements this data format.
+
+If you use maven you could just add the following to your pom.xml,
+substituting the version number for the latest & greatest release (see
+link:download.html[the download page for the latest versions]).
+
+[source,java]
+----------------------------------------
+<dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-barcode</artifactId>
+ <version>x.x.x</version>
+</dependency>
+----------------------------------------
+
+[[BarcodeDataFormat-UsingtheJavaDSL]]
+Using the Java DSL
+^^^^^^^^^^^^^^^^^^
+
+First you have to initialize the barcode data fomat class. You can use
+the default constructor, or one of parameterized (see JavaDoc). The
+default values are:
+
+[width="100%",cols="10%,90%",options="header",]
+|=======================================================================
+|Parameter |Default Value
+|image type (BarcodeImageType) |PNG
+
+|width |100 px
+
+|height |100 px
+
+|encoding |UTF-8
+
+|barcode format (BarcodeFormat) |QR-Code
+|=======================================================================
+
+[source,java]
+------------------------------------------
+// QR-Code default
+DataFormat code = new BarcodeDataFormat();
+------------------------------------------
+
+If you want to use zxing hints, you can use the 'addToHintMap' method of
+your BarcodeDataFormat instance:
+
+[source,java]
+-----------------------------------------------------------
+code.addToHintMap(DecodeHintType.TRY_HARDER, Boolean.true);
+-----------------------------------------------------------
+
+For possible hints, please consult the xzing documentation.
+
+[[BarcodeDataFormat-Marshalling]]
+Marshalling
++++++++++++
+
+[source,java]
+----------------------------
+from("direct://code")
+ .marshal(code)
+ .to("file://barcode_out");
+----------------------------
+
+You can call the route from a test class with:
+
+[source,java]
+-------------------------------------------------------------
+template.sendBody("direct://code", "This is a testmessage!");
+-------------------------------------------------------------
+
+You should find inside the 'barcode_out' folder this image:
+
+image:barcode-data-format.data/qr-code.png[image]
+
+[[BarcodeDataFormat-Unmarshalling]]
+Unmarshalling
++++++++++++++
+
+The unmarshaller is generic. For unmarshalling you can use any
+BarcodeDataFormat instance. If you've two instances, one for
+(generating) QR-Code and one for PDF417, it doesn't matter which one
+will be used.
+
+[source,java]
+--------------------------------------------------------------------
+from("file://barcode_in?noop=true")
+ .unmarshal(code) // for unmarshalling, the instance doesn't matter
+ .to("mock:out");
+--------------------------------------------------------------------
+
+If you'll paste the QR-Code image above into the 'barcode_in' folder,
+you should find '`This is a testmessage!`' inside the mock. You can find
+the barcode data format as header variable:
+
+[width="100%",cols="10%,10%,80%",options="header",]
+|=======================================================================
+
+|Name |Type |Description
+
+|BarcodeFormat |String |Value of com.google.zxing.BarcodeFormat.
+|=======================================================================
+
+
+
http://git-wip-us.apache.org/repos/asf/camel/blob/9fbde5d0/components/camel-barcode/src/main/docs/barcode-data-format.data/qr-code.png
----------------------------------------------------------------------
diff --git a/components/camel-barcode/src/main/docs/barcode-data-format.data/qr-code.png b/components/camel-barcode/src/main/docs/barcode-data-format.data/qr-code.png
new file mode 100644
index 0000000..be0e7c8
Binary files /dev/null and b/components/camel-barcode/src/main/docs/barcode-data-format.data/qr-code.png differ
http://git-wip-us.apache.org/repos/asf/camel/blob/9fbde5d0/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index 5901f26..d280282 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -89,6 +89,7 @@
* [AWS SQS](aws-sqs.adoc)
* [AWS SWF](aws-swf.adoc)
* [Bam](bam.adoc)
+ * [Barcode](barcode-data-format.adoc)
* [CDI](cdi.adoc)
* [JMS](jms.adoc)
* [Metrics](metrics.adoc)