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/03/25 11:22:09 UTC
camel git commit: Added camel-gae docs to gitbook
Repository: camel
Updated Branches:
refs/heads/master 330487b4f -> 6436bc714
Added camel-gae 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/6436bc71
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/6436bc71
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/6436bc71
Branch: refs/heads/master
Commit: 6436bc7143a96ea54524ffbbdd76a7e7b10182b9
Parents: 330487b
Author: Andrea Cosentino <an...@gmail.com>
Authored: Fri Mar 25 11:21:10 2016 +0100
Committer: Andrea Cosentino <an...@gmail.com>
Committed: Fri Mar 25 11:21:10 2016 +0100
----------------------------------------------------------------------
components/camel-gae/src/main/docs/gae.adoc | 207 +++++++++++++++++++++++
docs/user-manual/en/SUMMARY.md | 1 +
2 files changed, 208 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/6436bc71/components/camel-gae/src/main/docs/gae.adoc
----------------------------------------------------------------------
diff --git a/components/camel-gae/src/main/docs/gae.adoc b/components/camel-gae/src/main/docs/gae.adoc
new file mode 100644
index 0000000..148169c
--- /dev/null
+++ b/components/camel-gae/src/main/docs/gae.adoc
@@ -0,0 +1,207 @@
+[[GAE-CamelComponentsforGoogleAppEngine]]
+Camel Components for Google App Engine (Deprecated)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+*Tutorials*
+
+* A good starting point for using Camel on GAE is the
+link:tutorial-for-camel-on-google-app-engine.html[Tutorial for Camel on
+Google App Engine]
+* The link:tutorial-oauth.html[OAuth tutorial] demonstrates how to
+implement http://oauth.net/[OAuth] in web applications.
+
+The Camel components for http://code.google.com/appengine/[Google App
+Engine] (GAE) are part of the `camel-gae` project and provide
+connectivity to GAE's
+http://code.google.com/appengine/docs/java/apis.html[cloud computing
+services]. They make the GAE cloud computing environment accessible to
+applications via Camel interfaces. Following this pattern for other
+cloud computing environments could make it easier to port Camel
+applications from one cloud computing provider to another. The following
+table lists the cloud computing services provided by Google and the
+supporting Camel components. The documentation of each component can be
+found by following the link in the _Camel Component_ column.
+
+[width="100%",cols="10%,10%,80%",options="header",]
+|=======================================================================
+|GAE service |Camel component |Component description
+
+|http://code.google.com/appengine/docs/java/urlfetch/[URL fetch service] |link:ghttp.html[ghttp] |Provides connectivity to the GAE URL fetch service but can also be used
+to receive messages from servlets.
+
+|http://code.google.com/appengine/docs/java/taskqueue/[Task queueing
+service] |link:gtask.html[gtask] |Supports asynchronous message processing on GAE by using the task
+queueing service as message queue.
+
+|http://code.google.com/appengine/docs/java/mail/[Mail service] |link:gmail.html[gmail] |Supports sending of emails via the GAE mail service. Receiving mails is
+not supported yet but will be added later.
+
+|http://code.google.com/appengine/docs/java/memcache/[Memcache service] | | Not supported yet.
+
+|http://code.google.com/appengine/docs/java/xmpp/[XMPP service] | | Not supported yet.
+
+|http://code.google.com/appengine/docs/java/images/[Images service] | | Not supported yet.
+
+|http://code.google.com/appengine/docs/java/datastore/[Datastore service] | | Not supported yet.
+
+|http://code.google.com/apis/accounts/[Accounts service] |link:gauth.html[gauth] - link:glogin.html[glogin] |
+|=======================================================================
+
+These components interact with the Google Accounts API for
+authentication and authorization. Google Accounts is not specific to
+Google App Engine but is often used by GAE applications for implementing
+security. The link:gauth.html[gauth] component is used by web
+applications to implement a
+http://code.google.com/apis/accounts/docs/OAuth.html[Google-specific
+OAuth] consumer. This component can also be used to OAuth-enable non-GAE
+web applications. The link:glogin.html[glogin] component is used by Java
+clients (outside GAE) for programmatic login to GAE applications. For
+instructions how to protect GAE applications against unauthorized access
+refer to the link:gsec.html[Security for Camel GAE applications] page.
+
+[[GAE-Camelcontext]]
+Camel context
+^^^^^^^^^^^^^
+
+Setting up a `SpringCamelContext` on Google App Engine differs between
+Camel 2.1 and higher versions. The problem is that usage of the
+Camel-specific Spring configuration XML schema from the
+`http://camel.apache.org/schema/spring` namespace requires JAXB and
+Camel 2.1 depends on a Google App Engine SDK version that doesn't
+support JAXB yet. This limitation has been removed since Camel 2.2.
+
+JMX must be disabled in any case because the `javax.management` package
+isn't on the App Engine JRE whitelist.
+
+[[GAE-Camel2.1]]
+Camel 2.1
++++++++++
+
+`camel-gae` 2.1 comes with the following `CamelContext` implementations.
+
+* `org.apache.camel.component.gae.context.GaeDefaultCamelContext`
+(extends `org.apache.camel.impl.DefaultCamelContext`)
+* `org.apache.camel.component.gae.context.GaeSpringCamelContext`
+(extends `org.apache.camel.spring.SpringCamelContext`)
+
+Both disable JMX before startup. The `GaeSpringCamelContext`
+additionally provides setter methods adding route builders as shown in
+the next example.
+
+*appctx.xml*
+
+[source,xml]
+-----------------------------------------------------------------------------
+<beans xmlns="http://www.springframework.org/schema/beans"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="
+http://www.springframework.org/schema/beans
+http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">
+
+ <bean id="camelContext"
+ class="org.apache.camel.component.gae.context.GaeSpringCamelContext">
+ <property name="routeBuilder" ref="myRouteBuilder" />
+ </bean>
+
+ <bean id="myRouteBuilder"
+ class="org.example.MyRouteBuilder">
+ </bean>
+
+</beans>
+-----------------------------------------------------------------------------
+
+Alternatively, use the `routeBuilders` property of the
+`GaeSpringCamelContext` for setting a list of route builders. Using this
+approach, a `SpringCamelContext` can be configured on GAE without the
+need for JAXB.
+
+[[GAE-Camel2.2orhigher]]
+Camel 2.2 or higher
++++++++++++++++++++
+
+With Camel 2.2 or higher, applications can use the
+`http://camel.apache.org/schema/spring` namespace for configuring a
+`SpringCamelContext` but still need to disable JMX. Here's an example.
+
+*appctx.xml*
+
+[source,xml]
+----------------------------------------------------------------
+<beans xmlns="http://www.springframework.org/schema/beans"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xmlns:camel="http://camel.apache.org/schema/spring"
+ xsi:schemaLocation="
+http://www.springframework.org/schema/beans
+http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
+http://camel.apache.org/schema/spring
+http://camel.apache.org/schema/spring/camel-spring.xsd">
+
+ <camel:camelContext id="camelContext">
+ <camel:jmxAgent id="agent" disabled="true" />
+ <camel:routeBuilder ref="myRouteBuilder"/>
+ </camel:camelContext>
+
+ <bean id="myRouteBuilder"
+ class="org.example.MyRouteBuilder">
+ </bean>
+
+</beans>
+----------------------------------------------------------------
+
+[[GAE-Theweb.xml]]
+The web.xml
+^^^^^^^^^^^
+
+Running Camel on GAE requires usage of the `CamelHttpTransportServlet`
+from `camel-servlet`. The following example shows how to configure this
+servlet together with a Spring application context XML file.
+
+*web.xml*
+
+[source,xml]
+---------------------------------------------------------------------------------------------------
+<web-app
+xmlns="http://java.sun.com/xml/ns/javaee"
+xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
+xsi:schemaLocation="
+http://java.sun.com/xml/ns/javaee
+http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" version="2.5">
+
+ <servlet>
+ <servlet-name>CamelServlet</servlet-name>
+ <servlet-class>org.apache.camel.component.servlet.CamelHttpTransportServlet</servlet-class>
+ <init-param>
+ <param-name>contextConfigLocation</param-name>
+ <param-value>appctx.xml</param-value>
+ </init-param>
+ </servlet>
+
+ <!--
+ Mapping used for external requests
+ -->
+ <servlet-mapping>
+ <servlet-name>CamelServlet</servlet-name>
+ <url-pattern>/camel/*</url-pattern>
+ </servlet-mapping>
+
+ <!--
+ Mapping used for web hooks accessed by task queueing service.
+ -->
+ <servlet-mapping>
+ <servlet-name>CamelServlet</servlet-name>
+ <url-pattern>/worker/*</url-pattern>
+ </servlet-mapping>
+
+</web-app>
+---------------------------------------------------------------------------------------------------
+
+The location of the Spring application context XML file is given by the
+`contextConfigLocation` init parameter. The `appctx.xml` file must be on
+the classpath. The servlet mapping makes the Camel application
+accessible under `http://<appname>.appspot.com/camel/...` when deployed
+to Google App Engine where `<appname>` must be replaced by a real GAE
+application name. The second servlet mapping is used internally by the
+task queueing service for background processing via
+http://www.webhooks.org/[web hooks]. This mapping is relevant for the
+link:gtask.html[gtask] component and is explained there in more detail.
http://git-wip-us.apache.org/repos/asf/camel/blob/6436bc71/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index 5742086..af78053 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -132,6 +132,7 @@
* [FOP](fop.adoc)
* [Freemarker](freemarker.adoc)
* [FTP](ftp.adoc)
+ * [GAE](gae.adoc)
* [Ironmq](ironmq.adoc)
* [JMS](jms.adoc)
* [JMX](jmx.adoc)