diff --git a/akka-camel/src/main/scala/akka/camel/internal/component/ActorComponent.scala b/akka-camel/src/main/scala/akka/camel/internal/component/ActorComponent.scala index d52f74f2f6..cbadc08c8b 100644 --- a/akka-camel/src/main/scala/akka/camel/internal/component/ActorComponent.scala +++ b/akka-camel/src/main/scala/akka/camel/internal/component/ActorComponent.scala @@ -231,18 +231,53 @@ private[camel] case class ActorEndpointPath private (actorPath: String) { import ActorEndpointPath._ require(actorPath != null) require(actorPath.length() > 0) - def toCamelPath(config: ConsumerConfig = consumerConfig): String = "actor://path:%s?%s" format (actorPath, config.toCamelParameters) + def toCamelPath(config: ConsumerConfig = consumerConfig): String = CamelPath.toCamelUri(actorPath, config) def findActorIn(system: ActorSystem): Option[ActorRef] = { val ref = system.actorFor(actorPath) if (ref.isTerminated) None else Some(ref) } } + +/** + * Converts ActorRefs and actorPaths to uri's that point to the actor through the Camel Actor Component. + * Can also be used in the Java API as a helper for custom route builders. the Scala API has an implicit conversion in the camel package to + * directly use `to(actorRef)`. In java you could use `to(CamelPath.toCamelUri(actorRef)`. + */ +object CamelPath { + private val uriFormat = "actor://path:%s?%s" + + /** + * Converts the actorRef to a camel URI (string) which can be used in custom routes. + * @param actorRef the actorRef + * @return the camel URI to the actor. + */ + def toCamelUri(actorRef: ActorRef): String = uriFormat format (actorRef.path.toString, ActorEndpointPath.consumerConfig.toCamelParameters) + + /** + * Converts the actorRef to a camel URI (string) which can be used in custom routes. the consumerConfig that is supplied is used to determine the parameters of + * the URI. + * @param actorRef the actorRef + * @param consumerConfig the configuration of the Consumer actor + * @return the camel URI to the actor. + */ + def toCamelUri(actorRef: ActorRef, consumerConfig: ConsumerConfig): String = uriFormat format (actorRef.path.toString, consumerConfig.toCamelParameters) + + /** + * Converts the actorPath to a camel URI (string) which can be used in custom routes. the consumerConfig that is supplied is used to determine the parameters of + * the URI to the consumer actor. + * @param actorPath the actor path string + * @param consumerConfig the configuration of the Consumer actor + * @return the camel URI to the actor. + */ + def toCamelUri(actorPath: String, consumerConfig: ConsumerConfig): String = uriFormat format (actorPath, consumerConfig.toCamelParameters) +} + /** * For internal use only. Companion of `ActorEndpointPath` */ private[camel] object ActorEndpointPath { - private val consumerConfig: ConsumerConfig = new ConsumerConfig {} + private[camel] val consumerConfig: ConsumerConfig = new ConsumerConfig {} def apply(actorRef: ActorRef): ActorEndpointPath = new ActorEndpointPath(actorRef.path.toString) diff --git a/akka-docs/java/camel.rst b/akka-docs/java/camel.rst new file mode 100644 index 0000000000..d5f7a6f3d5 --- /dev/null +++ b/akka-docs/java/camel.rst @@ -0,0 +1,611 @@ + +.. _camel-java: + +############# + Camel (Java) +############# + +Additional Resources +==================== +For an introduction to akka-camel 2, see also the Peter Gabryanczyk's talk `Migrating akka-camel module to Akka 2.x`_. + +For an introduction to akka-camel 1, see also the `Appendix E - Akka and Camel`_ +(pdf) of the book `Camel in Action`_. + +.. _Appendix E - Akka and Camel: http://www.manning.com/ibsen/appEsample.pdf +.. _Camel in Action: http://www.manning.com/ibsen/ +.. _Migrating akka-camel module to Akka 2.x: http://skillsmatter.com/podcast/scala/akka-2-x + +Other, more advanced external articles (for version 1) are: + +* `Akka Consumer Actors: New Features and Best Practices `_ +* `Akka Producer Actors: New Features and Best Practices `_ + +Introduction +============ + +The akka-camel module allows actors to receive +and send messages over a great variety of protocols and APIs (akka-camel version 1.x also provided +this functionality to Typed Actors. In akka-camel 2, support for Typed Actors has been removed.) +This section gives a brief overview of the general ideas behind the akka-camel module, the +remaining sections go into the details. In addition to the native Scala and Java +actor API, actors can now exchange messages with other systems over large number +of protocols and APIs such as HTTP, SOAP, TCP, FTP, SMTP or JMS, to mention a +few. At the moment, approximately 80 protocols and APIs are supported. + +Apache Camel +------------ +The akka-camel module is based on `Apache Camel`_, a powerful and light-weight +integration framework for the JVM. For an introduction to Apache Camel you may +want to read this `Apache Camel article`_. Camel comes with a +large number of `components`_ that provide bindings to different protocols and +APIs. The `camel-extra`_ project provides further components. + +.. _Apache Camel: http://camel.apache.org/ +.. _Apache Camel article: http://architects.dzone.com/articles/apache-camel-integration +.. _components: http://camel.apache.org/components.html +.. _camel-extra: http://code.google.com/p/camel-extra/ + +Consumer +-------- +Here's an example of using Camel's integration components in Akka. + +.. includecode:: code/docs/camel/MyEndpoint.java#Consumer-mina + +The above example exposes an actor over a TCP endpoint on port 6200 via Apache +Camel's `Mina component`_. The actor implements the `getEndpointUri` method to define +an endpoint from which it can receive messages. After starting the actor, TCP +clients can immediately send messages to and receive responses from that +actor. If the message exchange should go over HTTP (via Camel's `Jetty +component`_), the actor's `getEndpointUri` method should return a different URI, for instance "jetty:http://localhost:8877/example". +In the above case an extra constructor is added that can set the endpoint URI, which would result in +the `getEndpointUri` returning the URI that was set using this constructor. + +.. _Mina component: http://camel.apache.org/mina.html +.. _Jetty component: http://camel.apache.org/jetty.html + +Producer +-------- +Actors can also trigger message exchanges with external systems i.e. produce to +Camel endpoints. + +.. includecode:: code/docs/camel/Orders.java#Producer + +In the above example, any message sent to this actor will be sent to +the JMS queue ``Orders``. Producer actors may choose from the same set of Camel +components as Consumer actors do. +Below an example of how to send a message to the Orders producer. + +.. includecode:: code/docs/camel/ProducerTestBase.java#TellProducer + +CamelMessage +------------ +The number of Camel components is constantly increasing. The akka-camel module +can support these in a plug-and-play manner. Just add them to your application's +classpath, define a component-specific endpoint URI and use it to exchange +messages over the component-specific protocols or APIs. This is possible because +Camel components bind protocol-specific message formats to a Camel-specific +`normalized message format`__. The normalized message format hides +protocol-specific details from Akka and makes it therefore very easy to support +a large number of protocols through a uniform Camel component interface. The +akka-camel module further converts mutable Camel messages into immutable +representations which are used by Consumer and Producer actors for pattern +matching, transformation, serialization or storage. In the above example of the Orders Producer, +the XML message is put in the body of a newly created Camel Message with an empty set of headers. +You can also create a CamelMessage yourself with the appropriate body and headers as you see fit. + +__ https://svn.apache.org/repos/asf/camel/tags/camel-2.8.0/camel-core/src/main/java/org/apache/camel/Message.java + +CamelExtension +-------------- +The akka-camel module is implemented as an Akka Extension, the ``CamelExtension`` object. +Extensions will only be loaded once per ``ActorSystem``, which will be managed by Akka. +The ``CamelExtension`` object provides access to the `Camel`_ interface. +The `Camel`_ interface in turn provides access to two important Apache Camel objects, the `CamelContext`_ and the `ProducerTemplate`_. +Below you can see how you can get access to these Apache Camel objects. + +.. includecode:: code/docs/camel/CamelExtensionTestBase.java#CamelExtension + +One ``CamelExtension`` is only loaded once for every one ``ActorSystem``, which makes it safe to call the ``CamelExtension`` at any point in your code to get to the +Apache Camel objects associated with it. There is one `CamelContext`_ and one `ProducerTemplate`_ for every one ``ActorSystem`` that uses a ``CamelExtension``. +Below an example on how to add the ActiveMQ component to the `CamelContext`_, which is required when you would like to use the ActiveMQ component. + +.. includecode:: code/docs/camel/CamelExtensionTestBase.java#CamelExtensionAddComponent + +The `CamelContext`_ joins the lifecycle of the ``ActorSystem`` and ``CamelExtension`` it is associated with; the `CamelContext`_ is started when +the ``CamelExtension`` is created, and it is shut down when the associated ``ActorSystem`` is shut down. The same is true for the `ProducerTemplate`_. + +The ``CamelExtension`` is used by both `Producer` and `Consumer` actors to interact with Apache Camel internally. +You can access the ``CamelExtension`` inside a `Producer` or a `Consumer` using the ``camel`` method, or get straight at the `CamelContext` +using the ``getCamelContext`` method or to the `ProducerTemplate` using the `getProducerTemplate` method. +Actors are created and started asynchronously. When a `Consumer` actor is created, the `Consumer` is published at its Camel endpoint +(more precisely, the route is added to the `CamelContext`_ from the `Endpoint`_ to the actor). +When a `Producer` actor is created, a `SendProcessor`_ and `Endpoint`_ are created so that the Producer can send messages to it. +Publication is done asynchronously; setting up an endpoint may still be in progress after you have +requested the actor to be created. Some Camel components can take a while to startup, and in some cases you might want to know when the endpoints are activated and ready to be used. +The `Camel`_ interface allows you to find out when the endpoint is activated or deactivated. + +.. includecode:: code/docs/camel/ActivationTestBase.java#CamelActivation + +The above code shows that you can get a ``Future`` to the activation of the route from the endpoint to the actor, or you can wait in a blocking fashion on the activation of the route. +An ``ActivationTimeoutException`` is thrown if the endpoint could not be activated within the specified timeout. Deactivation works in a similar fashion: + +.. includecode:: code/docs/camel/ActivationTestBase.java#CamelDeactivation + +Deactivation of a Consumer or a Producer actor happens when the actor is terminated. For a Consumer, the route to the actor is stopped. For a Producer, the `SendProcessor`_ is stopped. +A ``DeActivationTimeoutException`` is thrown if the associated camel objects could not be deactivated within the specified timeout. + +.. _Camel: http://github.com/akka/akka/blob/master/akka-camel/src/main/scala/akka/camel/Camel.scala +.. _CamelContext: https://svn.apache.org/repos/asf/camel/tags/camel-2.8.0/camel-core/src/main/java/org/apache/camel/CamelContext.java +.. _ProducerTemplate: https://svn.apache.org/repos/asf/camel/tags/camel-2.8.0/camel-core/src/main/java/org/apache/camel/ProducerTemplate.java +.. _SendProcessor: https://svn.apache.org/repos/asf/camel/tags/camel-2.8.0/camel-core/src/main/java/org/apache/camel/processor/SendProcessor.java +.. _Endpoint: https://svn.apache.org/repos/asf/camel/tags/camel-2.8.0/camel-core/src/main/java/org/apache/camel/Endpoint.java + +Dependencies +============ + +SBT +--- +.. code-block:: scala + + "com.typesafe.akka" % "akka-camel" % "2.1-SNAPSHOT" + +Maven +----- +.. code-block:: xml + + + com.typesafe.akka + akka-camel + 2.1-SNAPSHOT + + +.. _camel-consumer-actors: + + +Consumer Actors +================ + +For objects to receive messages, they must inherit from the `UntypedConsumerActor`_ +class. For example, the following actor class (Consumer1) implements the +`getEndpointUri` method, which is declared in the `UntypedConsumerActor`_ class, in order to receive +messages from the ``file:data/input/actor`` Camel endpoint. + +.. _UntypedConsumerActor: https://github.com/akka/akka/blob/master/akka-camel/src/main/scala/akka/camel/javaapi/UntypedConsumer.scala + +.. includecode:: code/docs/camel/Consumer1.java#Consumer1 + +Whenever a file is put into the data/input/actor directory, its content is +picked up by the Camel `file component`_ and sent as message to the +actor. Messages consumed by actors from Camel endpoints are of type +`CamelMessage`_. These are immutable representations of Camel messages. + +.. _file component: http://camel.apache.org/file2.html +.. _Message: http://github.com/akka/akka/blob/master/akka-camel/src/main/scala/akka/camel/CamelMessage.scala + + +Here's another example that sets the endpointUri to +``jetty:http://localhost:8877/camel/default``. It causes Camel's `Jetty +component`_ to start an embedded `Jetty`_ server, accepting HTTP connections +from localhost on port 8877. + +.. _Jetty component: http://camel.apache.org/jetty.html +.. _Jetty: http://www.eclipse.org/jetty/ + +.. includecode:: code/docs/camel/Consumer2.java#Consumer2 + +After starting the actor, clients can send messages to that actor by POSTing to +``http://localhost:8877/camel/default``. The actor sends a response by using the +getSender().tell method. For returning a message body and headers to the HTTP +client the response type should be `CamelMessage`_. For any other response type, a +new CamelMessage object is created by akka-camel with the actor response as message +body. + +.. _Message: http://github.com/akka/akka/blob/master/akka-camel/src/main/scala/akka/camel/CamelMessage.scala + +.. _camel-acknowledgements-java: + +Delivery acknowledgements +------------------------- + +With in-out message exchanges, clients usually know that a message exchange is +done when they receive a reply from a consumer actor. The reply message can be a +CamelMessage (or any object which is then internally converted to a CamelMessage) on +success, and a Failure message on failure. + +With in-only message exchanges, by default, an exchange is done when a message +is added to the consumer actor's mailbox. Any failure or exception that occurs +during processing of that message by the consumer actor cannot be reported back +to the endpoint in this case. To allow consumer actors to positively or +negatively acknowledge the receipt of a message from an in-only message +exchange, they need to override the ``autoack`` method to return false. +In this case, consumer actors must reply either with a +special Ack message (positive acknowledgement) or a Failure (negative +acknowledgement). + +.. includecode:: code/docs/camel/Consumer3.java#Consumer3 + +.. _camel-timeout: + +Consumer timeout +---------------- + +Camel Exchanges (and their corresponding endpoints) that support two-way communications need to wait for a response from +an actor before returning it to the initiating client. +For some endpoint types, timeout values can be defined in an endpoint-specific +way which is described in the documentation of the individual `Camel +components`_. Another option is to configure timeouts on the level of consumer actors. + +.. _Camel components: http://camel.apache.org/components.html + +Two-way communications between a Camel endpoint and an actor are +initiated by sending the request message to the actor with the ask pattern +and the actor replies to the endpoint when the response is ready. The ask request to the actor can timeout, which will +result in the `Exchange`_ failing with a TimeoutException set on the failure of the `Exchange`_. +The timeout on the consumer actor can be overridden with the ``replyTimeout``, as shown below. + +.. includecode:: code/docs/camel/Consumer4.java#Consumer4 +.. _Exchange: https://svn.apache.org/repos/asf/camel/tags/camel-2.8.0/camel-core/src/main/java/org/apache/camel/Exchange.java + +Producer Actors +=============== + +For sending messages to Camel endpoints, actors need to inherit from the `UntypedProducerActor`_ class and implement the getEndpointUri method. + +.. includecode:: code/docs/camel/Producer1.java#Producer1 + +Producer1 inherits a default implementation of the onReceive method from the +UntypedProducerActor class. To customize a producer actor's default behavior it is +recommended to override the `UntypedProducerActor`_.onTransformResponse and +`UntypedProducerActor`_.onTransformOutgoingMessage methods. This is explained later in more detail. +Actors should not override the default `UntypedProducerActor`_.onReceive method. + +Any message sent to a Producer actor will be sent to +the associated Camel endpoint, in the above example to +``http://localhost:8080/news``. The `UntypedProducerActor`_ always sends messages asynchronously. Response messages (if supported by the +configured endpoint) will, by default, be returned to the original sender. The +following example uses the ask pattern to send a message to a +Producer actor and waits for a response. + +.. includecode:: code/docs/camel/ProducerTestBase.java#AskProducer + +The future contains the response CamelMessage, or an ``AkkaCamelException`` when an error occurred, which contains the headers of the response. + +.. _camel-custom-processing: + +Custom Processing +----------------- + +Instead of replying to the initial sender, producer actors can implement custom +response processing by overriding the onRouteResponse method. In the following example, the response +message is forwarded to a target actor instead of being replied to the original +sender. + +.. includecode:: code/docs/camel/ResponseReceiver.java#RouteResponse +.. includecode:: code/docs/camel/Forwarder.java#RouteResponse +.. includecode:: code/docs/camel/OnRouteResponseTestBase.java#RouteResponse + +Before producing messages to endpoints, producer actors can pre-process them by +overriding the `UntypedProducerActor`_.onTransformOutgoingMessage method. + +.. includecode:: code/docs/camel/Transformer.java#TransformOutgoingMessage + +Producer configuration options +------------------------------ + +The interaction of producer actors with Camel endpoints can be configured to be +one-way or two-way (by initiating in-only or in-out message exchanges, +respectively). By default, the producer initiates an in-out message exchange +with the endpoint. For initiating an in-only exchange, producer actors have to override the isOneway method to return true. + +.. includecode:: code/docs/camel/OnewaySender.java#Oneway + +Message correlation +------------------- + +To correlate request with response messages, applications can set the +Message.MessageExchangeId message header. + +.. includecode:: code/docs/camel/ProducerTestBase.java#Correlate + +ProducerTemplate +---------------- + +The `UntypedProducerActor`_ class is a very +convenient way for actors to produce messages to Camel endpoints. Actors may also use a Camel `ProducerTemplate`_ for producing +messages to endpoints. + +.. includecode:: code/docs/camel/MyActor.java#ProducerTemplate + +For initiating a a two-way message exchange, one of the +``ProducerTemplate.request*`` methods must be used. + +.. includecode:: code/docs/camel/RequestBodyActor.java#RequestProducerTemplate + +.. _UntypedProducerActor: http://github.com/akka/akka/blob/master/akka-camel/src/main/scala/akka/camel/javaapi/UntypedProducerActor.scala +.. _ProducerTemplate: https://svn.apache.org/repos/asf/camel/tags/camel-2.8.0/camel-core/src/main/java/org/apache/camel/ProducerTemplate.java + +.. _camel-asynchronous-routing: + +Asynchronous routing +==================== + +Since Akka 0.10, in-out message exchanges between endpoints and actors are +designed to be asynchronous. This is the case for both, consumer and producer +actors. + +* A consumer endpoint sends request messages to its consumer actor using the ``!`` + (bang) operator and the actor returns responses with ``sender !`` once they are + ready. + +* A producer actor sends request messages to its endpoint using Camel's + asynchronous routing engine. Asynchronous responses are wrapped and added to the + producer actor's mailbox for later processing. By default, response messages are + returned to the initial sender but this can be overridden by Producer + implementations (see also description of the ``onRouteResponse`` method + in :ref:`camel-custom-processing`). + +However, asynchronous two-way message exchanges, without allocating a thread for +the full duration of exchange, cannot be generically supported by Camel's +asynchronous routing engine alone. This must be supported by the individual +`Camel components`_ (from which endpoints are created) as well. They must be +able to suspend any work started for request processing (thereby freeing threads +to do other work) and resume processing when the response is ready. This is +currently the case for a `subset of components`_ such as the `Jetty component`_. +All other Camel components can still be used, of course, but they will cause +allocation of a thread for the duration of an in-out message exchange. There's +also a :ref:`camel-async-example-java` that implements both, an asynchronous +consumer and an asynchronous producer, with the jetty component. + +.. _Camel components: http://camel.apache.org/components.html +.. _subset of components: http://camel.apache.org/asynchronous-routing-engine.html +.. _Jetty component: http://camel.apache.org/jetty.html + +Custom Camel routes +=================== + +In all the examples so far, routes to consumer actors have been automatically +constructed by akka-camel, when the actor was started. Although the default +route construction templates, used by akka-camel internally, are sufficient for +most use cases, some applications may require more specialized routes to actors. +The akka-camel module provides two mechanisms for customizing routes to actors, +which will be explained in this section. These are: + +* Usage of :ref:`camel-components` to access actors. + Any Camel route can use these components to access Akka actors. + +* :ref:`camel-intercepting-route-construction-java` to actors. + Default routes to consumer actors are extended using predefined extension + points. + + +.. _camel-components: + +Akka Camel components +--------------------- + +Akka actors can be accessed from Camel routes using the `actor`_ Camel component. This component can be used to +access any Akka actor (not only consumer actors) from Camel routes, as described +in the following sections. + +.. _actor: https://github.com/akka/akka/blob/master/akka-camel/src/main/scala/akka/camel/internal/component/ActorComponent.scala + +.. _access-to-actors: + +Access to actors +---------------- + +To access actors from custom Camel routes, the `actor`_ Camel +component should be used. It fully supports Camel's `asynchronous routing +engine`_. + +.. _actor: https://github.com/akka/akka/blob/master/akka-camel/src/main/scala/akka/camel/internal/component/ActorComponent.scala +.. _asynchronous routing engine: http://camel.apache.org/asynchronous-routing-engine.html + +This component accepts the following endpoint URI format: + +* ``actor://path:[]?`` + +where ```` is the ``ActorPath`` to the actor. The ```` are +name-value pairs separated by ``&`` (i.e. ``name1=value1&name2=value2&...``). + + +URI options +^^^^^^^^^^^ + +The following URI options are supported: + ++--------------+----------+---------+------------------------------------------------+ +| Name | Type | Default | Description | ++==============+==========+=========+================================================+ +| replyTimeout | Duration | false | The reply timeout, specified in the same | +| | | | way that you use the duration in akka, | +| | | | for instance ``10 seconds`` except that | +| | | | in the url it is handy to use a + | +| | | | between the amount and the unit, like | +| | | | for example ``200+millis`` | +| | | | | +| | | | See also :ref:`camel-timeout`. | ++--------------+----------+---------+------------------------------------------------+ +| autoack | Boolean | true | If set to true, in-only message exchanges | +| | | | are auto-acknowledged when the message is | +| | | | added to the actor's mailbox. If set to | +| | | | false, actors must acknowledge the | +| | | | receipt of the message. | +| | | | | +| | | | See also :ref:`camel-acknowledgements-java`. | ++--------------+----------+---------+------------------------------------------------+ + +Here's an actor endpoint URI example containing an actor uuid:: + + actor://path:akka://some-system/user/myconsumer?autoack=false&replyTimeout=100+millis + +In the following example, a custom route to an actor is created, using the +actor's path. + +.. includecode:: code/docs/camel/Responder.java#CustomRoute +.. includecode:: code/docs/camel/CustomRouteBuilder.java#CustomRoute +.. includecode:: code/docs/camel/CustomRouteTestBase.java#CustomRoute + +The `CamelPath.toCamelUri` converts the `ActorRef` to the Camel actor component URI format which points to the actor endpoint as described above. +When a message is received on the jetty endpoint, it is routed to the Responder actor, which in return replies back to the client of +the HTTP request. + + +.. _camel-intercepting-route-construction-java: + +Intercepting route construction +------------------------------- + +The previous section, :ref:`camel-components`, explained how to setup a route to +an actor manually. It was the application's +responsibility to define the route and add it to the current CamelContext. This +section explains a more convenient way to define custom routes: akka-camel is +still setting up the routes to consumer actors (and adds these routes to the +current CamelContext) but applications can define extensions to these routes. +Extensions can be defined with Camel's `Java DSL`_ or `Scala DSL`_. For example, +an extension could be a custom error handler that redelivers messages from an +endpoint to an actor's bounded mailbox when the mailbox was full. + +.. _Java DSL: http://camel.apache.org/dsl.html +.. _Scala DSL: http://camel.apache.org/scala-dsl.html + +The following examples demonstrate how to extend a route to a consumer actor for +handling exceptions thrown by that actor. + +.. includecode:: code/docs/camel/ErrorThrowingConsumer.java#ErrorThrowingConsumer + +The above ErrorThrowingConsumer sends the Failure back to the sender in preRestart +because the Exception that is thrown in the actor would +otherwise just crash the actor, by default the actor would be restarted, and the response would never reach the client of the Consumer. + +The akka-camel module creates a RouteDefinition instance by calling +from(endpointUri) on a Camel RouteBuilder (where endpointUri is the endpoint URI +of the consumer actor) and passes that instance as argument to the route +definition handler \*). The route definition handler then extends the route and +returns a ProcessorDefinition (in the above example, the ProcessorDefinition +returned by the end method. See the `org.apache.camel.model`__ package for +details). After executing the route definition handler, akka-camel finally calls +a to(targetActorUri) on the returned ProcessorDefinition to complete the +route to the consumer actor (where targetActorUri is the actor component URI as described in :ref:`access-to-actors`). + +\*) Before passing the RouteDefinition instance to the route definition handler, +akka-camel may make some further modifications to it. + +__ https://svn.apache.org/repos/asf/camel/tags/camel-2.8.0/camel-core/src/main/java/org/apache/camel/model/ + +.. _camel-examples-java: + +Examples +======== + +.. _camel-async-example-java: + +Asynchronous routing and transformation example +----------------------------------------------- + +This example demonstrates how to implement consumer and producer actors that +support :ref:`camel-asynchronous-routing` with their Camel endpoints. The sample +application transforms the content of the Akka homepage, http://akka.io, by +replacing every occurrence of *Akka* with *AKKA*. To run this example, add +a Boot class that starts the actors. After starting +the :ref:`microkernel-java`, direct the browser to http://localhost:8875 and the +transformed Akka homepage should be displayed. Please note that this example +will probably not work if you're behind an HTTP proxy. + +The following figure gives an overview how the example actors interact with +external systems and with each other. A browser sends a GET request to +http://localhost:8875 which is the published endpoint of the ``HttpConsumer`` +actor. The ``HttpConsumer`` actor forwards the requests to the ``HttpProducer`` +actor which retrieves the Akka homepage from http://akka.io. The retrieved HTML +is then forwarded to the ``HttpTransformer`` actor which replaces all occurrences +of *Akka* with *AKKA*. The transformation result is sent back the HttpConsumer +which finally returns it to the browser. + +.. image:: ../modules/camel-async-interact.png + +Implementing the example actor classes and wiring them together is rather easy +as shown in the following snippet. + +.. includecode:: code/docs/camel/sample/http/HttpConsumer.java#HttpExample +.. includecode:: code/docs/camel/sample/http/HttpProducer.java#HttpExample +.. includecode:: code/docs/camel/sample/http/HttpTransformer.java#HttpExample +.. includecode:: code/docs/camel/sample/http/HttpSample.java#HttpExample + +The `jetty endpoints`_ of HttpConsumer and HttpProducer support asynchronous +in-out message exchanges and do not allocate threads for the full duration of +the exchange. This is achieved by using `Jetty continuations`_ on the +consumer-side and by using `Jetty's asynchronous HTTP client`_ on the producer +side. The following high-level sequence diagram illustrates that. + +.. _jetty endpoints: http://camel.apache.org/jetty.html +.. _Jetty continuations: http://wiki.eclipse.org/Jetty/Feature/Continuations +.. _Jetty's asynchronous HTTP client: http://wiki.eclipse.org/Jetty/Tutorial/HttpClient + +.. image:: ../modules/camel-async-sequence.png + +Custom Camel route example +-------------------------- + +This section also demonstrates the combined usage of a ``Producer`` and a +``Consumer`` actor as well as the inclusion of a custom Camel route. The +following figure gives an overview. + +.. image:: ../modules/camel-custom-route.png + +* A consumer actor receives a message from an HTTP client + +* It forwards the message to another actor that transforms the message (encloses + the original message into hyphens) + +* The transformer actor forwards the transformed message to a producer actor + +* The producer actor sends the message to a custom Camel route beginning at the + ``direct:welcome`` endpoint + +* A processor (transformer) in the custom Camel route prepends "Welcome" to the + original message and creates a result message + +* The producer actor sends the result back to the consumer actor which returns + it to the HTTP client + + +The consumer, transformer and +producer actor implementations are as follows. + +.. includecode:: code/docs/camel/sample/route/Consumer3.java#CustomRouteExample +.. includecode:: code/docs/camel/sample/route/Transformer.java#CustomRouteExample +.. includecode:: code/docs/camel/sample/route/Producer1.java#CustomRouteExample +.. includecode:: code/docs/camel/sample/route/CustomRouteSample.java#CustomRouteExample + +The producer actor knows where to reply the message to because the consumer and +transformer actors have forwarded the original sender reference as well. The +application configuration and the route starting from direct:welcome are done in the code above. + +To run the example, add the lines shown in the example to a Boot class and the start the :ref:`microkernel-java` and POST a message to +``http://localhost:8877/camel/welcome``. + +.. code-block:: none + + curl -H "Content-Type: text/plain" -d "Anke" http://localhost:8877/camel/welcome + +The response should be: + +.. code-block:: none + + Welcome - Anke - + +Quartz Scheduler Example +------------------------ + +Here is an example showing how simple is to implement a cron-style scheduler by +using the Camel Quartz component in Akka. + +The following example creates a "timer" actor which fires a message every 2 +seconds: + +.. includecode:: code/docs/camel/sample/quartz/MyQuartzActor.java#QuartzExample +.. includecode:: code/docs/camel/sample/quartz/QuartzSample.java#QuartzExample + +For more information about the Camel Quartz component, see here: +http://camel.apache.org/quartz.html \ No newline at end of file diff --git a/akka-docs/java/code/docs/camel/ActivationTestBase.java b/akka-docs/java/code/docs/camel/ActivationTestBase.java new file mode 100644 index 0000000000..292de5fcb7 --- /dev/null +++ b/akka-docs/java/code/docs/camel/ActivationTestBase.java @@ -0,0 +1,49 @@ +package docs.camel; + +import akka.actor.ActorRef; +import akka.actor.ActorSystem; +import akka.actor.Props; +import akka.camel.Camel; +import akka.camel.CamelExtension; +import akka.camel.javaapi.UntypedConsumerActor; +import akka.dispatch.Future; +import akka.util.Duration; +import akka.util.FiniteDuration; +import org.junit.Test; + +import java.util.concurrent.TimeUnit; + +public class ActivationTestBase { + + @Test + public void testActivation() { + //#CamelActivation + ActorSystem system = ActorSystem.create("some-system"); + Props props = new Props(MyConsumer.class); + ActorRef producer = system.actorOf(props,"myproducer"); + Camel camel = CamelExtension.get(system); + // get a future reference to the activation of the endpoint of the Consumer Actor + FiniteDuration duration = Duration.create(10, TimeUnit.SECONDS); + Future activationFuture = camel.activationFutureFor(producer, duration); + // or, block wait on the activation + camel.awaitActivation(producer, duration); + //#CamelActivation + //#CamelDeactivation + system.stop(producer); + // get a future reference to the deactivation of the endpoint of the Consumer Actor + Future deactivationFuture = camel.activationFutureFor(producer, duration); + // or, block wait on the deactivation + camel.awaitDeactivation(producer, duration); + //#CamelDeactivation + system.shutdown(); + } + + public static class MyConsumer extends UntypedConsumerActor { + public String getEndpointUri() { + return "direct:test"; + } + + public void onReceive(Object message) { + } + } +} diff --git a/akka-docs/java/code/docs/camel/CamelExtensionDocTest.scala b/akka-docs/java/code/docs/camel/CamelExtensionDocTest.scala new file mode 100644 index 0000000000..4408d247e7 --- /dev/null +++ b/akka-docs/java/code/docs/camel/CamelExtensionDocTest.scala @@ -0,0 +1,5 @@ +package docs.camel + +import org.scalatest.junit.JUnitSuite + +class CamelExtensionDocTest extends CamelExtensionTestBase with JUnitSuite diff --git a/akka-docs/java/code/docs/camel/CamelExtensionTestBase.java b/akka-docs/java/code/docs/camel/CamelExtensionTestBase.java new file mode 100644 index 0000000000..fa34af2f7b --- /dev/null +++ b/akka-docs/java/code/docs/camel/CamelExtensionTestBase.java @@ -0,0 +1,31 @@ +package docs.camel; + +import akka.actor.ActorSystem; +import akka.camel.Camel; +import akka.camel.CamelExtension; +import org.apache.camel.CamelContext; +import org.apache.camel.ProducerTemplate; +import org.junit.Test; + +public class CamelExtensionTestBase { + @Test + public void getCamelExtension() { + //#CamelExtension + ActorSystem system = ActorSystem.create("some-system"); + Camel camel = CamelExtension.get(system); + CamelContext camelContext= camel.context(); + ProducerTemplate producerTemplate = camel.template(); + //#CamelExtension + system.shutdown(); + } + public void addActiveMQComponent() { + //#CamelExtensionAddComponent + ActorSystem system = ActorSystem.create("some-system"); + Camel camel = CamelExtension.get(system); + CamelContext camelContext= camel.context(); + // camelContext.addComponent("activemq", ActiveMQComponent.activeMQComponent("vm://localhost?broker.persistent=false")) + //#CamelExtensionAddComponent + system.shutdown(); + } + +} diff --git a/akka-docs/java/code/docs/camel/Consumer1.java b/akka-docs/java/code/docs/camel/Consumer1.java new file mode 100644 index 0000000000..df21ee3fcc --- /dev/null +++ b/akka-docs/java/code/docs/camel/Consumer1.java @@ -0,0 +1,24 @@ +package docs.camel; +//#Consumer1 +import akka.camel.CamelMessage; +import akka.camel.javaapi.UntypedConsumerActor; +import akka.event.Logging; +import akka.event.LoggingAdapter; + +public class Consumer1 extends UntypedConsumerActor { + LoggingAdapter log = Logging.getLogger(getContext().system(), this); + + public String getEndpointUri() { + return "file:data/input/actor"; + } + + public void onReceive(Object message) { + if (message instanceof CamelMessage) { + CamelMessage camelMessage = (CamelMessage) message; + String body = camelMessage.getBodyAs(String.class, getCamelContext()); + log.info("Received message: {}", body); + } else + unhandled(message); + } +} +//#Consumer1 diff --git a/akka-docs/java/code/docs/camel/Consumer2.java b/akka-docs/java/code/docs/camel/Consumer2.java new file mode 100644 index 0000000000..b22c324877 --- /dev/null +++ b/akka-docs/java/code/docs/camel/Consumer2.java @@ -0,0 +1,20 @@ +package docs.camel; +//#Consumer2 +import akka.camel.CamelMessage; +import akka.camel.javaapi.UntypedConsumerActor; + +public class Consumer2 extends UntypedConsumerActor { + public String getEndpointUri() { + return "jetty:http://localhost:8877/camel/default"; + } + + public void onReceive(Object message) { + if (message instanceof CamelMessage) { + CamelMessage camelMessage = (CamelMessage) message; + String body = camelMessage.getBodyAs(String.class, getCamelContext()); + getSender().tell(String.format("Received message: %s",body)); + } else + unhandled(message); + } +} +//#Consumer2 diff --git a/akka-docs/java/code/docs/camel/Consumer3.java b/akka-docs/java/code/docs/camel/Consumer3.java new file mode 100644 index 0000000000..431318dc2c --- /dev/null +++ b/akka-docs/java/code/docs/camel/Consumer3.java @@ -0,0 +1,31 @@ +package docs.camel; +//#Consumer3 +import akka.actor.Status; +import akka.camel.Ack; +import akka.camel.CamelMessage; +import akka.camel.javaapi.UntypedConsumerActor; + +public class Consumer3 extends UntypedConsumerActor{ + + @Override + public boolean autoack() { + return false; + } + + public String getEndpointUri() { + return "jms:queue:test"; + } + + public void onReceive(Object message) { + if (message instanceof CamelMessage) { + getSender().tell(Ack.getInstance()); + // on success + // .. + Exception someException = new Exception("e1"); + // on failure + getSender().tell(new Status.Failure(someException)); + } else + unhandled(message); + } +} +//#Consumer3 diff --git a/akka-docs/java/code/docs/camel/Consumer4.java b/akka-docs/java/code/docs/camel/Consumer4.java new file mode 100644 index 0000000000..b6ca904f7c --- /dev/null +++ b/akka-docs/java/code/docs/camel/Consumer4.java @@ -0,0 +1,31 @@ +package docs.camel; +//#Consumer4 +import akka.camel.CamelMessage; +import akka.camel.javaapi.UntypedConsumerActor; +import akka.util.Duration; +import akka.util.FiniteDuration; + +import java.util.concurrent.TimeUnit; + +public class Consumer4 extends UntypedConsumerActor { + private final static FiniteDuration timeout = Duration.create(500, TimeUnit.MILLISECONDS); + + @Override + public Duration replyTimeout() { + return timeout; + } + + public String getEndpointUri() { + return "jetty:http://localhost:8877/camel/default"; + } + + public void onReceive(Object message) { + if (message instanceof CamelMessage) { + CamelMessage camelMessage = (CamelMessage) message; + String body = camelMessage.getBodyAs(String.class, getCamelContext()); + getSender().tell(String.format("Hello %s",body)); + } else + unhandled(message); + } +} +//#Consumer4 \ No newline at end of file diff --git a/akka-docs/java/code/docs/camel/CustomRouteBuilder.java b/akka-docs/java/code/docs/camel/CustomRouteBuilder.java new file mode 100644 index 0000000000..f30856b2a5 --- /dev/null +++ b/akka-docs/java/code/docs/camel/CustomRouteBuilder.java @@ -0,0 +1,18 @@ +package docs.camel; +//#CustomRoute +import akka.actor.ActorRef; +import akka.camel.internal.component.CamelPath; +import org.apache.camel.builder.RouteBuilder; + +public class CustomRouteBuilder extends RouteBuilder{ + private ActorRef responder; + + public CustomRouteBuilder(ActorRef responder) { + this.responder = responder; + } + + public void configure() throws Exception { + from("jetty:http://localhost:8877/camel/custom").to(CamelPath.toCamelUri(responder)); + } +} +//#CustomRoute diff --git a/akka-docs/java/code/docs/camel/CustomRouteTestBase.java b/akka-docs/java/code/docs/camel/CustomRouteTestBase.java new file mode 100644 index 0000000000..8e6b3dc1bf --- /dev/null +++ b/akka-docs/java/code/docs/camel/CustomRouteTestBase.java @@ -0,0 +1,20 @@ +package docs.camel; + +import akka.actor.ActorRef; +import akka.actor.ActorSystem; +import akka.actor.Props; +import akka.camel.Camel; +import akka.camel.CamelExtension; + +public class CustomRouteTestBase { + public void customRoute() throws Exception{ + //#CustomRoute + ActorSystem system = ActorSystem.create("some-system"); + Camel camel = CamelExtension.get(system); + ActorRef responder = system.actorOf(new Props(Responder.class), "TestResponder"); + camel.context().addRoutes(new CustomRouteBuilder(responder)); + //#CustomRoute + system.stop(responder); + system.shutdown(); + } +} diff --git a/akka-docs/java/code/docs/camel/ErrorThrowingConsumer.java b/akka-docs/java/code/docs/camel/ErrorThrowingConsumer.java new file mode 100644 index 0000000000..23790021be --- /dev/null +++ b/akka-docs/java/code/docs/camel/ErrorThrowingConsumer.java @@ -0,0 +1,42 @@ +package docs.camel; +//#ErrorThrowingConsumer +import akka.actor.Status; +import akka.camel.CamelMessage; +import akka.camel.javaapi.UntypedConsumerActor; +import org.apache.camel.builder.Builder; +import org.apache.camel.model.ProcessorDefinition; +import org.apache.camel.model.RouteDefinition; +import scala.Option; + +public class ErrorThrowingConsumer extends UntypedConsumerActor{ + private String uri; + + public ErrorThrowingConsumer(String uri){ + this.uri = uri; + } + + public String getEndpointUri() { + return uri; + } + + public void onReceive(Object message) throws Exception{ + if (message instanceof CamelMessage) { + CamelMessage camelMessage = (CamelMessage) message; + String body = camelMessage.getBodyAs(String.class, getCamelContext()); + throw new Exception(String.format("error: %s",body)); + } else + unhandled(message); + } + + @Override + public ProcessorDefinition onRouteDefinition(RouteDefinition rd) { + // Catch any exception and handle it by returning the exception message as response + return rd.onException(Exception.class).handled(true).transform(Builder.exceptionMessage()).end(); + } + + @Override + public void preRestart(Throwable reason, Option message) { + getSender().tell(new Status.Failure(reason)); + } +} +//#ErrorThrowingConsumer \ No newline at end of file diff --git a/akka-docs/java/code/docs/camel/FirstProducer.java b/akka-docs/java/code/docs/camel/FirstProducer.java new file mode 100644 index 0000000000..c1b0c03698 --- /dev/null +++ b/akka-docs/java/code/docs/camel/FirstProducer.java @@ -0,0 +1,10 @@ +package docs.camel; + +//#Producer1 +import akka.camel.javaapi.UntypedProducerActor; +public class FirstProducer extends UntypedProducerActor { + public String getEndpointUri() { + return "http://localhost:8080/news"; + } +} +//#Producer1 \ No newline at end of file diff --git a/akka-docs/java/code/docs/camel/Forwarder.java b/akka-docs/java/code/docs/camel/Forwarder.java new file mode 100644 index 0000000000..3d35df82e5 --- /dev/null +++ b/akka-docs/java/code/docs/camel/Forwarder.java @@ -0,0 +1,23 @@ +package docs.camel; +//#RouteResponse +import akka.actor.ActorRef; +import akka.camel.javaapi.UntypedProducerActor; + +public class Forwarder extends UntypedProducerActor { + private String uri; + private ActorRef target; + + public Forwarder(String uri, ActorRef target) { + this.uri = uri; + this.target = target; + } + public String getEndpointUri() { + return uri; + } + + @Override + public void onRouteResponse(Object message) { + target.forward(message,getContext()); + } +} +//#RouteResponse diff --git a/akka-docs/java/code/docs/camel/MyActor.java b/akka-docs/java/code/docs/camel/MyActor.java new file mode 100644 index 0000000000..7e99792a1f --- /dev/null +++ b/akka-docs/java/code/docs/camel/MyActor.java @@ -0,0 +1,15 @@ +package docs.camel; +//#ProducerTemplate +import akka.actor.UntypedActor; +import akka.camel.Camel; +import akka.camel.CamelExtension; +import org.apache.camel.ProducerTemplate; + +public class MyActor extends UntypedActor{ + public void onReceive(Object message) { + Camel camel = CamelExtension.get(getContext().system()); + ProducerTemplate template = camel.template(); + template.sendBody("direct:news", message); + } +} +//#ProducerTemplate \ No newline at end of file diff --git a/akka-docs/java/code/docs/camel/MyEndpoint.java b/akka-docs/java/code/docs/camel/MyEndpoint.java new file mode 100644 index 0000000000..7393513634 --- /dev/null +++ b/akka-docs/java/code/docs/camel/MyEndpoint.java @@ -0,0 +1,31 @@ +package docs.camel; + +//#Consumer-mina +import akka.camel.CamelMessage; +import akka.camel.javaapi.UntypedConsumerActor; + +public class MyEndpoint extends UntypedConsumerActor{ + private String uri = "mina:tcp://localhost:6200?textline=true"; + + public String getEndpointUri() { + return uri; + } + + public void onReceive(Object message) throws Exception { + if (message instanceof CamelMessage) { + /* ... */ + } else { + /* ... */ + } + } + + // Extra constructor to change the default uri, + // for instance to "jetty:http://localhost:8877/example" + public MyEndpoint(String uri) { + this.uri = uri; + } + + public MyEndpoint() { + } +} +//#Consumer-mina \ No newline at end of file diff --git a/akka-docs/java/code/docs/camel/OnRouteResponseTestBase.java b/akka-docs/java/code/docs/camel/OnRouteResponseTestBase.java new file mode 100644 index 0000000000..7bcb9e16db --- /dev/null +++ b/akka-docs/java/code/docs/camel/OnRouteResponseTestBase.java @@ -0,0 +1,27 @@ +package docs.camel; + +import akka.actor.*; +import org.junit.Test; + +public class OnRouteResponseTestBase { + + public void onRouteResponse(){ + //#RouteResponse + ActorSystem system = ActorSystem.create("some-system"); + Props receiverProps = new Props(ResponseReceiver.class); + final ActorRef receiver = system.actorOf(receiverProps,"responseReceiver"); + UntypedActorFactory factory = new UntypedActorFactory() { + public Actor create() { + return new Forwarder("http://localhost:8080/news/akka", receiver); + } + }; + ActorRef forwardResponse = system.actorOf(new Props(factory)); + // the Forwarder sends out a request to the web page and forwards the response to + // the ResponseReceiver + forwardResponse.tell("some request"); + //#RouteResponse + system.stop(receiver); + system.stop(forwardResponse); + system.shutdown(); + } +} diff --git a/akka-docs/java/code/docs/camel/OnewaySender.java b/akka-docs/java/code/docs/camel/OnewaySender.java new file mode 100644 index 0000000000..232e095730 --- /dev/null +++ b/akka-docs/java/code/docs/camel/OnewaySender.java @@ -0,0 +1,20 @@ +package docs.camel; +//#Oneway +import akka.camel.javaapi.UntypedProducerActor; + +public class OnewaySender extends UntypedProducerActor{ + private String uri; + + public OnewaySender(String uri) { + this.uri = uri; + } + public String getEndpointUri() { + return uri; + } + + @Override + public boolean isOneway() { + return true; + } +} +//#Oneway diff --git a/akka-docs/java/code/docs/camel/Orders.java b/akka-docs/java/code/docs/camel/Orders.java new file mode 100644 index 0000000000..cd40f5f14a --- /dev/null +++ b/akka-docs/java/code/docs/camel/Orders.java @@ -0,0 +1,10 @@ +package docs.camel; +//#Producer +import akka.camel.javaapi.UntypedProducerActor; + +public class Orders extends UntypedProducerActor{ + public String getEndpointUri() { + return "jms:queue:Orders"; + } +} +//#Producer \ No newline at end of file diff --git a/akka-docs/java/code/docs/camel/Producer1.java b/akka-docs/java/code/docs/camel/Producer1.java new file mode 100644 index 0000000000..e478ba4f77 --- /dev/null +++ b/akka-docs/java/code/docs/camel/Producer1.java @@ -0,0 +1,10 @@ +package docs.camel; +//#Producer1 +import akka.camel.javaapi.UntypedProducerActor; + +public class Producer1 extends UntypedProducerActor{ + public String getEndpointUri() { + return "http://localhost:8080/news"; + } +} +//#Producer1 \ No newline at end of file diff --git a/akka-docs/java/code/docs/camel/ProducerTestBase.java b/akka-docs/java/code/docs/camel/ProducerTestBase.java new file mode 100644 index 0000000000..de7853a282 --- /dev/null +++ b/akka-docs/java/code/docs/camel/ProducerTestBase.java @@ -0,0 +1,53 @@ +package docs.camel; + +import akka.actor.*; +import akka.camel.Camel; +import akka.camel.CamelExtension; +import akka.camel.CamelMessage; +import akka.dispatch.Future; +import akka.pattern.Patterns; +import akka.util.Duration; +import akka.util.FiniteDuration; +import org.apache.camel.CamelContext; +import org.apache.camel.ProducerTemplate; +import org.junit.Test; + +import java.util.HashMap; +import java.util.Map; +import java.util.concurrent.TimeUnit; + +public class ProducerTestBase { + public void tellJmsProducer() { + //#TellProducer + ActorSystem system = ActorSystem.create("some-system"); + Props props = new Props(Orders.class); + ActorRef producer = system.actorOf(props, "jmsproducer"); + producer.tell(""); + //#TellProducer + system.shutdown(); + } + + public void askProducer() { + //#AskProducer + ActorSystem system = ActorSystem.create("some-system"); + Props props = new Props(FirstProducer.class); + ActorRef producer = system.actorOf(props,"myproducer"); + Future future = Patterns.ask(producer, "some request", 1000); + //#AskProducer + system.stop(producer); + system.shutdown(); + } + + public void correlate(){ + //#Correlate + ActorSystem system = ActorSystem.create("some-system"); + Props props = new Props(Orders.class); + ActorRef producer = system.actorOf(props,"jmsproducer"); + Map headers = new HashMap(); + headers.put(CamelMessage.MessageExchangeId(),"123"); + producer.tell(new CamelMessage("",headers)); + //#Correlate + system.stop(producer); + system.shutdown(); + } +} diff --git a/akka-docs/java/code/docs/camel/RequestBodyActor.java b/akka-docs/java/code/docs/camel/RequestBodyActor.java new file mode 100644 index 0000000000..009b0f380f --- /dev/null +++ b/akka-docs/java/code/docs/camel/RequestBodyActor.java @@ -0,0 +1,15 @@ +package docs.camel; +//#RequestProducerTemplate +import akka.actor.UntypedActor; +import akka.camel.Camel; +import akka.camel.CamelExtension; +import org.apache.camel.ProducerTemplate; + +public class RequestBodyActor extends UntypedActor { + public void onReceive(Object message) { + Camel camel = CamelExtension.get(getContext().system()); + ProducerTemplate template = camel.template(); + getSender().tell(template.requestBody("direct:news", message)); + } +} +//#RequestProducerTemplate \ No newline at end of file diff --git a/akka-docs/java/code/docs/camel/Responder.java b/akka-docs/java/code/docs/camel/Responder.java new file mode 100644 index 0000000000..304ed4bb5d --- /dev/null +++ b/akka-docs/java/code/docs/camel/Responder.java @@ -0,0 +1,25 @@ +package docs.camel; +//#CustomRoute +import akka.actor.UntypedActor; +import akka.camel.CamelMessage; +import akka.japi.Function; + +public class Responder extends UntypedActor{ + + public void onReceive(Object message) { + if (message instanceof CamelMessage) { + CamelMessage camelMessage = (CamelMessage) message; + getSender().tell(createResponse(camelMessage)); + } else + unhandled(message); + } + + private CamelMessage createResponse(CamelMessage msg) { + return msg.mapBody(new Function() { + public String apply(String body) { + return String.format("received %s", body); + } + }); + } +} +//#CustomRoute \ No newline at end of file diff --git a/akka-docs/java/code/docs/camel/ResponseReceiver.java b/akka-docs/java/code/docs/camel/ResponseReceiver.java new file mode 100644 index 0000000000..d87a731592 --- /dev/null +++ b/akka-docs/java/code/docs/camel/ResponseReceiver.java @@ -0,0 +1,13 @@ +package docs.camel; +//#RouteResponse +import akka.actor.UntypedActor; +import akka.camel.CamelMessage; + +public class ResponseReceiver extends UntypedActor{ + public void onReceive(Object message) { + if(message instanceof CamelMessage) { + // do something with the forwarded response + } + } +} +//#RouteResponse diff --git a/akka-docs/java/code/docs/camel/Transformer.java b/akka-docs/java/code/docs/camel/Transformer.java new file mode 100644 index 0000000000..be077cf27d --- /dev/null +++ b/akka-docs/java/code/docs/camel/Transformer.java @@ -0,0 +1,36 @@ +package docs.camel; +//#TransformOutgoingMessage +import akka.camel.CamelMessage; +import akka.camel.javaapi.UntypedProducerActor; +import akka.japi.Function; + +public class Transformer extends UntypedProducerActor{ + private String uri; + + public Transformer(String uri) { + this.uri = uri; + } + + public String getEndpointUri() { + return uri; + } + + private CamelMessage upperCase(CamelMessage msg) { + return msg.mapBody(new Function() { + public String apply(String body) { + return body.toUpperCase(); + } + }); + } + + @Override + public Object onTransformOutgoingMessage(Object message) { + if(message instanceof CamelMessage) { + CamelMessage camelMessage = (CamelMessage) message; + return upperCase(camelMessage); + } else { + return message; + } + } +} +//#TransformOutgoingMessage diff --git a/akka-docs/java/code/docs/camel/sample/http/HttpConsumer.java b/akka-docs/java/code/docs/camel/sample/http/HttpConsumer.java new file mode 100644 index 0000000000..9ca5fbb886 --- /dev/null +++ b/akka-docs/java/code/docs/camel/sample/http/HttpConsumer.java @@ -0,0 +1,23 @@ +package docs.camel.sample.http; + +import akka.actor.ActorRef; +import akka.camel.javaapi.UntypedConsumerActor; + +//#HttpExample +public class HttpConsumer extends UntypedConsumerActor{ + + private ActorRef producer; + + public HttpConsumer(ActorRef producer){ + this.producer = producer; + } + + public String getEndpointUri() { + return "jetty:http://0.0.0.0:8875/"; + } + + public void onReceive(Object message) { + producer.forward(message, getContext()); + } +} +//#HttpExample \ No newline at end of file diff --git a/akka-docs/java/code/docs/camel/sample/http/HttpProducer.java b/akka-docs/java/code/docs/camel/sample/http/HttpProducer.java new file mode 100644 index 0000000000..5fb2dfaba2 --- /dev/null +++ b/akka-docs/java/code/docs/camel/sample/http/HttpProducer.java @@ -0,0 +1,38 @@ +package docs.camel.sample.http; + +import akka.actor.ActorRef; +import akka.camel.CamelMessage; +import akka.camel.javaapi.UntypedProducerActor; +import org.apache.camel.Exchange; + +import java.util.HashSet; +import java.util.Set; + +//#HttpExample +public class HttpProducer extends UntypedProducerActor{ + private ActorRef transformer; + + public HttpProducer(ActorRef transformer) { + this.transformer = transformer; + } + + public String getEndpointUri() { + return "jetty://http://akka.io/?bridgeEndpoint=true"; + } + + @Override + public Object onTransformOutgoingMessage(Object message) { + if (message instanceof CamelMessage) { + CamelMessage camelMessage = (CamelMessage) message; + Set httpPath = new HashSet(); + httpPath.add(Exchange.HTTP_PATH); + return camelMessage.addHeaders(camelMessage.getHeaders(httpPath)); + } else return super.onTransformOutgoingMessage(message); + } + + @Override + public void onRouteResponse(Object message) { + transformer.forward(message, getContext()); + } +} +//#HttpExample \ No newline at end of file diff --git a/akka-docs/java/code/docs/camel/sample/http/HttpSample.java b/akka-docs/java/code/docs/camel/sample/http/HttpSample.java new file mode 100644 index 0000000000..0ae15f78dd --- /dev/null +++ b/akka-docs/java/code/docs/camel/sample/http/HttpSample.java @@ -0,0 +1,26 @@ +package docs.camel.sample.http; + +import akka.actor.*; + +public class HttpSample { + public static void main(String[] args) { + //#HttpExample + // Create the actors. this can be done in a Boot class so you can + // run the example in the MicroKernel. just add the below three lines to your boot class. + ActorSystem system = ActorSystem.create("some-system"); + final ActorRef httpTransformer = system.actorOf(new Props(HttpTransformer.class)); + + final ActorRef httpProducer = system.actorOf(new Props(new UntypedActorFactory(){ + public Actor create() { + return new HttpProducer(httpTransformer); + } + })); + + ActorRef httpConsumer = system.actorOf(new Props(new UntypedActorFactory(){ + public Actor create() { + return new HttpConsumer(httpProducer); + } + })); + //#HttpExample + } +} diff --git a/akka-docs/java/code/docs/camel/sample/http/HttpTransformer.java b/akka-docs/java/code/docs/camel/sample/http/HttpTransformer.java new file mode 100644 index 0000000000..6c897c858b --- /dev/null +++ b/akka-docs/java/code/docs/camel/sample/http/HttpTransformer.java @@ -0,0 +1,25 @@ +package docs.camel.sample.http; + +import akka.actor.Status; +import akka.actor.UntypedActor; +import akka.camel.CamelMessage; +import akka.japi.Function; + +//#HttpExample +public class HttpTransformer extends UntypedActor{ + public void onReceive(Object message) { + if (message instanceof CamelMessage) { + CamelMessage camelMessage = (CamelMessage) message; + CamelMessage replacedMessage = camelMessage.mapBody(new Function(){ + public String apply(String body) { + return body.replaceAll("Akka ", "AKKA "); + } + }); + getSender().tell(replacedMessage); + } else if (message instanceof Status.Failure) { + getSender().tell(message); + } else + unhandled(message); + } +} +//#HttpExample \ No newline at end of file diff --git a/akka-docs/java/code/docs/camel/sample/quartz/MyQuartzActor.java b/akka-docs/java/code/docs/camel/sample/quartz/MyQuartzActor.java new file mode 100644 index 0000000000..7f38d01943 --- /dev/null +++ b/akka-docs/java/code/docs/camel/sample/quartz/MyQuartzActor.java @@ -0,0 +1,20 @@ +package docs.camel.sample.quartz; +//#QuartzExample +import akka.camel.CamelMessage; +import akka.camel.javaapi.UntypedConsumerActor; + +public class MyQuartzActor extends UntypedConsumerActor{ + public String getEndpointUri() { + return "quartz://example?cron=0/2+*+*+*+*+?"; + } + + public void onReceive(Object message) { + if (message instanceof CamelMessage) { + CamelMessage camelMessage = (CamelMessage) message; + String body = camelMessage.getBodyAs(String.class, getCamelContext()); + System.out.println(String.format("==============> received %s ", body)); + } else + unhandled(message); + } +} +//#QuartzExample \ No newline at end of file diff --git a/akka-docs/java/code/docs/camel/sample/quartz/QuartzSample.java b/akka-docs/java/code/docs/camel/sample/quartz/QuartzSample.java new file mode 100644 index 0000000000..479aed1200 --- /dev/null +++ b/akka-docs/java/code/docs/camel/sample/quartz/QuartzSample.java @@ -0,0 +1,12 @@ +package docs.camel.sample.quartz; +//#QuartzExample +import akka.actor.ActorSystem; +import akka.actor.Props; + +public class QuartzSample { + public static void main(String[] args) { + ActorSystem system = ActorSystem.create("my-quartz-system"); + system.actorOf(new Props(MyQuartzActor.class)); + } +} +//#QuartzExample \ No newline at end of file diff --git a/akka-docs/java/code/docs/camel/sample/route/Consumer3.java b/akka-docs/java/code/docs/camel/sample/route/Consumer3.java new file mode 100644 index 0000000000..3235135c59 --- /dev/null +++ b/akka-docs/java/code/docs/camel/sample/route/Consumer3.java @@ -0,0 +1,27 @@ +package docs.camel.sample.route; + +//#CustomRouteExample +import akka.actor.ActorRef; +import akka.camel.CamelMessage; +import akka.camel.javaapi.UntypedConsumerActor; + +public class Consumer3 extends UntypedConsumerActor{ + private ActorRef transformer; + + public Consumer3(ActorRef transformer){ + this.transformer = transformer; + } + + public String getEndpointUri() { + return "jetty:http://0.0.0.0:8877/camel/welcome"; + } + + public void onReceive(Object message) { + if (message instanceof CamelMessage) { + CamelMessage camelMessage = (CamelMessage) message; + transformer.forward(camelMessage.getBodyAs(String.class, getCamelContext()),getContext()); + } else + unhandled(message); + } +} +//#CustomRouteExample diff --git a/akka-docs/java/code/docs/camel/sample/route/CustomRouteBuilder.java b/akka-docs/java/code/docs/camel/sample/route/CustomRouteBuilder.java new file mode 100644 index 0000000000..af9cb54fa8 --- /dev/null +++ b/akka-docs/java/code/docs/camel/sample/route/CustomRouteBuilder.java @@ -0,0 +1,17 @@ +package docs.camel.sample.route; + +//#CustomRouteExample +import org.apache.camel.Exchange; +import org.apache.camel.Processor; +import org.apache.camel.builder.RouteBuilder; + +public class CustomRouteBuilder extends RouteBuilder{ + public void configure() throws Exception { + from("direct:welcome").process(new Processor(){ + public void process(Exchange exchange) throws Exception { + exchange.getOut().setBody(String.format("Welcome %s",exchange.getIn().getBody())); + } + }); + } +} +//#CustomRouteExample diff --git a/akka-docs/java/code/docs/camel/sample/route/CustomRouteSample.java b/akka-docs/java/code/docs/camel/sample/route/CustomRouteSample.java new file mode 100644 index 0000000000..76f42ab04b --- /dev/null +++ b/akka-docs/java/code/docs/camel/sample/route/CustomRouteSample.java @@ -0,0 +1,31 @@ +package docs.camel.sample.route; + +import akka.actor.*; +import akka.camel.CamelExtension; + +public class CustomRouteSample { + public static void main(String[] args) { + try { + //#CustomRouteExample + // the below lines can be added to a Boot class, so that you can run the example from a MicroKernel + ActorSystem system = ActorSystem.create("some-system"); + final ActorRef producer = system.actorOf(new Props(Producer1.class)); + final ActorRef mediator = system.actorOf(new Props(new UntypedActorFactory() { + public Actor create() { + return new Transformer(producer); + + } + })); + ActorRef consumer = system.actorOf(new Props(new UntypedActorFactory() { + public Actor create() { + return new Consumer3(mediator); + + } + })); + CamelExtension.get(system).context().addRoutes(new CustomRouteBuilder()); + //#CustomRouteExample + } catch (Exception e) { + e.printStackTrace(); + } + } +} diff --git a/akka-docs/java/code/docs/camel/sample/route/Producer1.java b/akka-docs/java/code/docs/camel/sample/route/Producer1.java new file mode 100644 index 0000000000..4f937fc95f --- /dev/null +++ b/akka-docs/java/code/docs/camel/sample/route/Producer1.java @@ -0,0 +1,10 @@ +package docs.camel.sample.route; +//#CustomRouteExample +import akka.camel.javaapi.UntypedProducerActor; + +public class Producer1 extends UntypedProducerActor{ + public String getEndpointUri() { + return "direct:welcome"; + } +} +//#CustomRouteExample diff --git a/akka-docs/java/code/docs/camel/sample/route/Transformer.java b/akka-docs/java/code/docs/camel/sample/route/Transformer.java new file mode 100644 index 0000000000..6ea647edd5 --- /dev/null +++ b/akka-docs/java/code/docs/camel/sample/route/Transformer.java @@ -0,0 +1,29 @@ +package docs.camel.sample.route; +//#CustomRouteExample +import akka.actor.ActorRef; +import akka.actor.UntypedActor; +import akka.camel.CamelMessage; +import akka.japi.Function; + +public class Transformer extends UntypedActor { + private ActorRef producer; + + public Transformer(ActorRef producer) { + this.producer = producer; + } + + public void onReceive(Object message) { + if (message instanceof CamelMessage) { + // example: transform message body "foo" to "- foo -" and forward result to producer + CamelMessage camelMessage = (CamelMessage) message; + CamelMessage transformedMessage = camelMessage.mapBody(new Function(){ + public String apply(String body) { + return String.format("- %s -",body); + } + }); + producer.forward(transformedMessage, getContext()); + } else + unhandled(message); + } +} +//#CustomRouteExample \ No newline at end of file diff --git a/akka-docs/java/index.rst b/akka-docs/java/index.rst index 669bd7c362..b0f29c27ef 100644 --- a/akka-docs/java/index.rst +++ b/akka-docs/java/index.rst @@ -24,5 +24,6 @@ Java API extending-akka zeromq microkernel + camel testing howto diff --git a/akka-docs/scala/camel.rst b/akka-docs/scala/camel.rst index acffeadd90..1eec932b44 100644 --- a/akka-docs/scala/camel.rst +++ b/akka-docs/scala/camel.rst @@ -1,9 +1,9 @@ .. _camel-scala: -####### - Camel -####### +############## + Camel (Scala) +############## Additional Resources ==================== @@ -53,9 +53,9 @@ one-liner. Here's an example. .. includecode:: code/docs/camel/Introduction.scala#Consumer-mina -The above example exposes an actor over a tcp endpoint on port 6200 via Apache +The above example exposes an actor over a TCP endpoint on port 6200 via Apache Camel's `Mina component`_. The actor implements the endpointUri method to define -an endpoint from which it can receive messages. After starting the actor, tcp +an endpoint from which it can receive messages. After starting the actor, TCP clients can immediately send messages to and receive responses from that actor. If the message exchange should go over HTTP (via Camel's `Jetty component`_), only the actor's endpointUri method must be changed. @@ -193,17 +193,17 @@ from localhost on port 8877. After starting the actor, clients can send messages to that actor by POSTing to ``http://localhost:8877/camel/default``. The actor sends a response by using the -self.reply method (Scala). For returning a message body and headers to the HTTP -client the response type should be `Message`_. For any other response type, a -new Message object is created by akka-camel with the actor response as message +sender `!` method. For returning a message body and headers to the HTTP +client the response type should be `CamelMessage`_. For any other response type, a +new CamelMessage object is created by akka-camel with the actor response as message body. -.. _Message: http://github.com/akka/akka/blob/master/akka-camel/src/main/scala/akka/camel/CamelMessage.scala +.. _CamelMessage: http://github.com/akka/akka/blob/master/akka-camel/src/main/scala/akka/camel/CamelMessage.scala .. _camel-acknowledgements: Delivery acknowledgements ----------------- +------------------------- With in-out message exchanges, clients usually know that a message exchange is done when they receive a reply from a consumer actor. The reply message can be a @@ -379,7 +379,7 @@ which will be explained in this section. These are: Akka Camel components --------------------- -Akka actors can be access from Camel routes using the `actor`_ Camel components, respectively. These components can be used to +Akka actors can be accessed from Camel routes using the `actor`_ Camel component. This component can be used to access any Akka actor (not only consumer actors) from Camel routes, as described in the following sections. @@ -596,4 +596,4 @@ seconds: .. includecode:: code/docs/camel/QuartzExample.scala#Quartz For more information about the Camel Quartz component, see here: -http://camel.apache.org/quartz.html \ No newline at end of file +http://camel.apache.org/quartz.html diff --git a/akka-docs/scala/code/docs/camel/Producers.scala b/akka-docs/scala/code/docs/camel/Producers.scala index 58ee243d7b..2953ef2269 100644 --- a/akka-docs/scala/code/docs/camel/Producers.scala +++ b/akka-docs/scala/code/docs/camel/Producers.scala @@ -91,7 +91,7 @@ object Producers { import akka.actor.{ Props, ActorSystem } class Producer2 extends Actor with Producer { - def endpointUri = "activemg:FOO.BAR" + def endpointUri = "activemq:FOO.BAR" } val system = ActorSystem("some-system") val producer = system.actorOf(Props[Producer2])