[CONF] Apache Camel: Bean (page edited)

Mon, 28 Jul 2008 01:37:01 -0700

Page Edited : CAMEL : Bean

Bean has been edited by willem jiang (Jul 28, 2008).

Change summary:

CAMEL-759

(View changes)

Content:

Bean Component

The bean: component binds beans to Camel message exchanges.

URI format

bean:someName[?options]

Where someName can be any string which is used to lookup the bean in the Registry



Options






 Name 
 Description 
 Example 
 Required? 
 default value 




 method 
 The method name that bean will be inovked 
 method=someMethod 
 No 
 someMethod defines the name of the method to invoke,This will use the Bean Binding to map the message exchange to the bean.




 multiParameterArray 
 How to treat the parameters which are passed from the message body, if it is true, the in message body should be the an array of parameters 
 mulitParamterArray=true 
 No 
 false 








Using



The object instance that is used to consume messages must be explicitly registered with the Registry. For example if you are using Spring you must define the bean in the spring.xml; or if you don't use Spring then put the bean in JNDI.





// lets populate the context with the services we need
// note that we could just use a spring.xml file to avoid this step
JndiContext context = new JndiContext();
context.bind("bye", new SayService("Good Bye!"));

CamelContext camelContext = new DefaultCamelContext(context);





Once an endpoint has been registered, you can build Camel routes that use it to process exchanges.





// lets add simple route
camelContext.addRoutes(new RouteBuilder() {
    public void configure() {
        from("direct:hello").to("pojo:bye");
    }
});





A bean: endpoint cannot be defined as the input to the route; i.e. you cannot consume from it, you can only route from some inbound message Endpoint to the bean endpoint as output.  So consider using a direct: or queue: endpoint as the input.  



You can use the createProxy() methods on ProxyHelper to create a proxy that will generate BeanExchanges and send them to any endpoint:





Endpoint endpoint = camelContext.getEndpoint("direct:hello");
ISay proxy = ProxyHelper.createProxy(endpoint, ISay.class);
String rc = proxy.say();
assertEquals("Good Bye!", rc);





Bean binding



The binding of a Camel Message to a bean method call can occur in different ways



    
	
  • if the bean can be converted to a Processor using the Type Converter mechanism then this is used to process the message. This mechanism is used by the ActiveMQ component to allow any MessageListener to be invoked by the Bean component
    • 
	
  • if the body of the message can be converted to a BeanInvocation (the default payload used by the ProxyHelper) - then that its used to invoke the method and pass the arguments
    • 
	
  • if the message contains the header org.apache.camel.MethodName then that method is invoked, converting the body to whatever the argument is to the method
    • 
	
  • otherwise the type of the method body is used to try find a method which matches; an error is thrown if a single method cannot be chosen unambiguously.
    • 
	
  • you can also use Exchange as the parameter itself, but then the return type must be void.
    • 





By default the return value is set on the outbound message body.



For example a POJO such as:




public class Bar {

    public String doSomething(String body) {
      // process the in body and return whatever you want
      return "Bye World";
   }





Or the Exchange example. Notice that the return type must be void:




public class Bar {

    public void doSomething(Exchange exchange) {
      // process the exchange
      exchange.getIn().setBody("Bye World");
   }





For example you could write a method like this (showing also a feature in Camel, the @MessageDrive annotation):





public class Foo {

    @MessageDriven(uri = "activemq:my.queue")
    public void doSomething(String body) {
		// process the inbound message here
    }

}





Here Camel with subscribe to an ActiveMQ queue, then convert the message payload to a String (so dealing with TextMessage, ObjectMessage and BytesMessage in JMS), then process this method.



Using Annotations to bind parameters to the Exchange



The annotations can be used to bind in situations where traditional methods would result in ambiguous methods. So by adding annotations you can decorate your bean to help Camel invoke the correct method.



You can also use the following annotations to bind parameters to different kinds of _expression_






 Annotation 
 Meaning 




 @Body 
 To bind to an inbound message body 




 @Header 
 To bind to an inbound message header 




 @Headers 
 To bind to the Map of the inbound message headers 




 @OutHeader 
 To bind to an outbound message header 




 @OutHeaders 
 To bind to the Map of the outbound message headers 




 @Property 
 To bind to a named property on the exchange 




 @Properties 
 To bind to the property map on the exchange 






For example





public class Foo {
	
    @MessageDriven(uri = "activemq:my.queue")
    public void doSomething(@Header('JMSCorrelationID') String correlationID, @Body String body) {
		// process the inbound message here
    }

}





In the above you can now pass the Message.getJMSCorrelationID() as a parameter to the method (using the Type Converter to adapt the value to the type of the parameter).



Finally you don't need the @MessageDriven annotation; as the Camel route could describe which method to invoke.



e.g. a route could look like





from("activemq:someQueue").
  to("bean:myBean");





Here myBean would be looked up in the Registry (such as JNDI or the Spring ApplicationContext), then the body of the message would be used to try figure out what method to call.



If you want to be explicit you can use





from("activemq:someQueue").
  to("bean:myBean?methodName=doSomething");





And here we have a nifty example for you to show some great power in Camel. You can mix and match the annotations with the normal parameters, so we can have this example with annotations and the Exchange also:




public void doSomething(@Header(name = "user") String user, @Body String body, Exchange exchange) {
        exchange.getIn().setBody(body + "MyBean");
    }





Using _expression_ Languages



You can also use any of the Languages supported in Camel to bind expressions to method parameters when using bean integration. For example you can use any of these annotations...






Annotation
Description




@BeanShell 
 Inject a BeanShell _expression_ 




@EL 
 Inject an EL _expression_ 




@Groovy 
 Inject a Groovy _expression_ 




@_javascript_ 
 Inject a _javascript_ _expression_ 




@OGNL 
 Inject an OGNL _expression_ 




@PHP 
 Inject a PHP _expression_ 




@Python 
 Inject a Python _expression_ 




@Ruby 
 Inject a Ruby _expression_ 




@Simple 
 Inject an Simple _expression_ 




@XPath 
 Inject an XPath _expression_ 




@XQuery 
 Inject an XQuery _expression_ 






For example





public class Foo {
	
    @MessageDriven(uri = "activemq:my.queue")
    public void doSomething(@Path("/foo/bar/text()") String correlationID, @Body String body) {
		// process the inbound message here
    }
}





See Also

Powered by Atlassian Confluence (Version: 2.2.9 Build:#527 Sep 07, 2006) - Bug/feature request

Unsubscribe or edit your notifications preferences

Reply via email to